Hosted by: BerliOS Developer Logo

OpenMBV C++ Interface

BerliOS Project Page
Public Member Functions | Protected Member Functions | Protected Attributes | Friends
OpenMBV::Group Class Reference

A container for bodies. More...

#include <group.h>

Inheritance diagram for OpenMBV::Group:
OpenMBV::Object

List of all members.

Public Member Functions

std::string getClassName ()
 Retrun the class name.
void setExpand (bool expand)
 Expand this tree node in a view if true (the default)
bool getExpand ()
void addObject (boost::shared_ptr< Object > object)
 Add a object to this object container.
std::vector< boost::shared_ptr
< Object > > & 
getObjects ()
void setSeparateFile (bool sepFile)
 Plot a separate xml and h5 file for this group if truee.
bool getSeparateFile ()
boost::shared_ptr< H5::File > & getHDF5File ()
std::string getFileName ()
 Returns the file name of the .ombv.xml file of this separateFile Group including the absolute or relatvie path.
std::string getFullName (bool includingFileName=false, bool stopAtSeparateFile=false)
 Returns the full name (path) of the object.
void setFileName (const std::string &fn)
 Sets the file name of the .ombv.xml file of this separateFile Group including the absolute or relatvie path.
void write (bool writeXMLFile=true, bool writeH5File=true)
 Initialisze/Wrtie the tree (XML and h5).
void read (bool readXMLFile=true, bool readH5File=true)
 Read the tree (XML and h5).
void terminate ()
 terminate the tree.
virtual void initializeUsingXML (xercesc::DOMElement *element)
 Initializes the time invariant part of the object using a XML node.
xercesc::DOMElement * writeXMLFile (xercesc::DOMNode *parent)
boost::shared_ptr< Group > getSeparateGroup ()
 return the first Group in the tree which is an separateFile
boost::shared_ptr< Group > getTopLevelGroup ()
 return the top level Group

Protected Member Functions

void createHDF5File ()
void openHDF5File ()
void writeXML ()
 Initialisze/Write the XML file.
void readXML ()
 Read the XML file.
void writeH5 ()
 Initialisze/Write the h5 file.
void readH5 ()
 Read/open an existing h5 file.

Protected Attributes

std::vector< boost::shared_ptr
< Object > > 
object
std::string expandStr
std::string fileName
bool separateFile
boost::shared_ptr< H5::File > hdf5File

Friends

class Body
class Object
class ObjectFactory

Detailed Description

A container for bodies.


Member Function Documentation

void OpenMBV::Group::read ( bool  readXMLFile = true,
bool  readH5File = true 
)

Read the tree (XML and h5).

This function simply calls readXML() and readH5().

void OpenMBV::Group::readH5 ( ) [protected]

Read/open an existing h5 file.

Before calling this function readXML() must be called or simply call read().

void OpenMBV::Group::readXML ( ) [protected]

Read the XML file.

Call this function to read an OpenMBV XML file and creating the Object tree.

void OpenMBV::Group::terminate ( ) [virtual]

terminate the tree.

Call this function for the root node of the free after all writing has done.

Implements OpenMBV::Object.

void OpenMBV::Group::write ( bool  writeXMLFile = true,
bool  writeH5File = true 
)

Initialisze/Wrtie the tree (XML and h5).

This function simply calls writeXML() and writeH5().

void OpenMBV::Group::writeH5 ( ) [protected]

Initialisze/Write the h5 file.

Call this function for the root node of the tree to init the h5 file. (Only the h5 tree i written, but do data. Use append() to write date to h5 file after calling this function)

void OpenMBV::Group::writeXML ( ) [protected]

Initialisze/Write the XML file.

Call this function for the root node of the tree to create/write/ the XML file.


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