openmbvcppinterface  3.1.0
OpenMBV C++ Interface
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
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 (bool includingFileName=false, bool stopAtSeparateFile=false)
 
void setEnvironment (bool env)
 
bool getEnvironment ()
 
virtual void initializeUsingXML (xercesc::DOMElement *element)
 
virtual xercesc::DOMElement * writeXMLFile (xercesc::DOMNode *parent)
 
std::shared_ptr< Group > getSeparateGroup ()
 
std::shared_ptr< Group > getTopLevelGroup ()
 
std::weak_ptr< Group > getParent ()
 
H5::GroupBase * getHDF5Group ()
 
std::string getID () const
 
void setID (std::string ID_)
 
bool getSelected () const
 
void setSelected (bool selected_)
 
- Public Member Functions inherited from fmatvec::Atom
Atom & operator= (const Atom &)
 
void setMessageStreamActive (MsgType type, bool activeFlag)
 
void getMessageStream (MsgType type, std::shared_ptr< bool > &a, std::shared_ptr< std::ostream > &s) const
 
void adoptMessageStreams (const Atom *src=nullptr)
 
std::ostream & msg (MsgType type) const
 
bool msgAct (MsgType type) const
 

Protected Member Functions

virtual void createHDF5File ()=0
 
virtual void openHDF5File ()=0
 
virtual void terminate ()=0
 
- Protected Member Functions inherited from fmatvec::Atom
 Atom (const Atom &src)
 

Protected Attributes

std::string name
 
std::string enableStr
 
std::string boundingBoxStr
 
std::string ID
 
std::string environmentStr
 
bool selected {false}
 
std::weak_ptr< Group > parent
 
H5::GroupBase * hdf5Group {nullptr}
 

Friends

class Group
 

Additional Inherited Members

- Public Types inherited from fmatvec::Atom
enum  MsgType
 
- Static Public Member Functions inherited from fmatvec::Atom
static void setCurrentMessageStream (MsgType type, const std::shared_ptr< bool > &a=std::make_shared< bool >(true), const std::shared_ptr< std::ostream > &s=std::make_shared< std::ostream >(std::cout.rdbuf()))
 
static std::ostream & msgStatic (MsgType type)
 
static bool msgActStatic (MsgType type)
 

Detailed Description

Abstract base class

Member Function Documentation

◆ getFullName()

string OpenMBV::Object::getFullName ( bool  includingFileName = false,
bool  stopAtSeparateFile = false 
)
virtual

Returns the full name (path) of the object

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

◆ 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)

◆ getSelected()

bool OpenMBV::Object::getSelected ( ) const
inline

get the selected flag (Note: the selected flag is metadata and not stored in XML but used by OpenMBVGUI)

◆ getSeparateGroup()

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

return the first Group in the tree which is an separateFile

◆ getTopLevelGroup()

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

return the top level Group

◆ initializeUsingXML()

void OpenMBV::Object::initializeUsingXML ( xercesc::DOMElement *  element)
virtual

◆ 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

◆ setSelected()

void OpenMBV::Object::setSelected ( bool  selected_)
inline

set the selected flag (Note: the selected flag is metadata and not stored in XML but used by OpenMBVGUI)


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