openmbvcppinterface  3.1.0
OpenMBV C++ Interface
OpenMBV::Object Class Referenceabstract

#include <object.h>

Inheritance diagram for OpenMBV::Object:
[legend]

Public Member Functions

void setEnable (bool enable)
 
bool getEnable ()
 
void setBoundingBox (bool bbox)
 
bool getBoundingBox ()
 
void setName (const std::string &name_)
 
std::string getName ()
 
virtual std::string getFullName ()
 
void setEnvironment (bool env)
 
bool getEnvironment ()
 
virtual void initializeUsingXML (xercesc::DOMElement *element)
 
virtual xercesc::DOMElement * writeXMLFile (xercesc::DOMNode *parent)
 
std::shared_ptr< GroupgetTopLevelGroup ()
 
std::weak_ptr< GroupgetParent ()
 
H5::GroupBasegetHDF5Group ()
 
std::string getID () const
 
void setID (std::string ID_)
 

Protected Member Functions

virtual void createHDF5File ()=0
 
virtual void openHDF5File ()=0
 

Protected Attributes

std::string name
 
std::string enableStr
 
std::string boundingBoxStr
 
std::string ID
 
std::string environmentStr
 
std::weak_ptr< Groupparent
 
H5::GroupBasehdf5Group {nullptr}
 
std::string fullName
 

Friends

class Group
 

Detailed Description

Abstract base class

Member Function Documentation

◆ createHDF5File()

virtual void OpenMBV::Object::createHDF5File ( )
protectedpure virtual

◆ getEnvironment()

bool OpenMBV::Object::getEnvironment ( )

Returns true if this or any parent object is an environment objects

◆ getFullName()

string OpenMBV::Object::getFullName ( )
virtual

Returns the full name (path) of the object

Reimplemented in OpenMBV::Group, and OpenMBV::RigidBody.

◆ getID()

std::string OpenMBV::Object::getID ( ) const
inline

get the ID sting of the Object (Note: the ID is metadata and stored as a processing instruction in XML)

◆ getTopLevelGroup()

std::shared_ptr< Group > OpenMBV::Object::getTopLevelGroup ( )

return the top level Group

◆ initializeUsingXML()

◆ setBoundingBox()

void OpenMBV::Object::setBoundingBox ( bool  bbox)
inline

Draw bounding box of this object in the viewer if true (the default)

◆ setEnable()

void OpenMBV::Object::setEnable ( bool  enable)
inline

Enable this object in the viewer if true (the default)

◆ setEnvironment()

void OpenMBV::Object::setEnvironment ( bool  env)
inline

If set to true than this object is an environment object: a static object which has no time dependent part (does not read anything from the h5 file).

◆ setID()

void OpenMBV::Object::setID ( std::string  ID_)
inline

set the ID sting of the Object (Note: the ID is metadata and stored as a processing instruction in XML)

◆ setName()

void OpenMBV::Object::setName ( const std::string &  name_)
inline

Set the name of this object

◆ writeXMLFile()

DOMElement * OpenMBV::Object::writeXMLFile ( xercesc::DOMNode *  parent)
virtual

The documentation for this class was generated from the following files: