Computer Assited Medical Intervention Tool Kit  version 3.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Private Attributes | List of all members
BasicCellProperties Class Referenceabstract

Describes the properties common to all cells. More...

#include <BasicCellProperties.h>

+ Inheritance diagram for BasicCellProperties:

Public Member Functions

 BasicCellProperties (PhysicalModel *myPM, const StructureProperties::GeometricType t)
 Default constructor : generate an unique index. More...
 
 BasicCellProperties (PhysicalModel *myPM, const StructureProperties::GeometricType t, xmlNodePtr n)
 constructor from xml node: try to read and get the properties from xml More...
 
 BasicCellProperties (PhysicalModel *myPM, const StructureProperties::GeometricType t, const unsigned int ind)
 Use this constructor when you specifically want to set the index. More...
 
virtual void xmlPrint (std::ostream &)=0
 print to an output stream in "pseaudo" XML format. More...
 
virtual ~BasicCellProperties ()
 the destructor... More...
 
- Public Member Functions inherited from StructureProperties
unsigned int getIndex () const
 return the unique index in the global structure More...
 
GeometricType getType () const
 Return the type of force. More...
 
void setIndex (const unsigned int)
 set the index (BECAREFUL: it MUST be unique !!!) More...
 
void setType (const GeometricType t)
 Set the force type. More...
 
 StructureProperties (PhysicalModel *, const GeometricType)
 the only default constructor : type must be set More...
 
void xmlPrint (std::ostream &) const
 print to an output stream in "pseaudo" XML format. More...
 
virtual ~StructureProperties ()
 
- Public Member Functions inherited from Properties
std::string getName () const
 get the name (be careful, this method DOES NOT return a copy, so you got the direct ptr to the name!!!) More...
 
PhysicalModelgetPhysicalModel () const
 get the physical model More...
 
 Properties (const std::string n="")
 A nice simple constructor, with a given name. More...
 
 Properties (PhysicalModel *, const std::string n="")
 Another nice constructor, with the PM and a name. More...
 
void setName (std::string)
 set the name (use the string = operator) More...
 
void setPhysicalModel (PhysicalModel *)
 set the physical model More...
 
virtual ~Properties ()
 The default destructor. More...
 
void domToFields (xmlNodePtr node)
 convert the xml node parameters to data fields More...
 
unsigned int numberOfFields () const
 get the number of extra fields found in the PML More...
 
bool isAField (std::string attName) const
 check if the field exist in the XML document, return false if it does not More...
 
std::string getField (unsigned int) const
 get the name of field of given index More...
 
double getDouble (std::string attName)
 field accessor: get the field attName as a double value, if field does not exist, 0.0 is return More...
 
int getInt (std::string attName) const
 field accessor: get the field attName as an int value, if field does not exist, 0 is return More...
 
bool getBool (std::string attName) const
 field accessor: get the field attName as a bool value, if field does not exist, false is return More...
 
std::string getString (std::string attName) const
 field accessor: get the field attName as a string value, if field does not exist, empty string is return More...
 
void get (std::string attName, std::string &attVal) const
 field accessor: get the field attName as a string value in attVal, if field does not exist, empty string is return More...
 
void set (std::string attName, double val)
 field modificator: set field attName using a double value More...
 
void set (std::string attName, int val)
 field modificator: set field attName using an int value More...
 
void set (std::string attName, bool val)
 field modificator: set field attName using a bool value More...
 
void set (std::string attName, std::string val)
 field modificator: set field attName using a string value More...
 

Static Public Member Functions

static void resetUniqueIndex ()
 Reinitialize the unique index to zero (usually that what you want to do when you start to load a new PhysicalModel. More...
 
- Static Public Member Functions inherited from StructureProperties
static std::string toString (const GeometricType)
 return the string equivalent to this geometric type More...
 
static GeometricType toType (const std::string)
 return the enum corresponding to this string More...
 

Protected Member Functions

void beginXML (std::ostream &)
 write the default xml properties (beginning) More...
 
void endXML (std::ostream &)
 write the default xml properties (end) More...
 

Static Private Attributes

static unsigned int maxUniqueIndex
 unique number (used to generate unique index for cells if not given at the instanciation) More...
 

Additional Inherited Members

- Public Types inherited from StructureProperties
enum  GeometricType {
  INVALID, ATOM, LINE, TRIANGLE,
  QUAD, TETRAHEDRON, WEDGE, PYRAMID,
  HEXAHEDRON, POLY_LINE, POLY_VERTEX
}
 Geometric type gives information about which kind of geometric representation is the structure. More...
 
- Protected Attributes inherited from StructureProperties
unsigned int index
 unique index in the global structure More...
 
- Protected Attributes inherited from Properties
std::map< std::string,
std::string
fields
 map containing all the different fields (name, value stored as string ) More...
 

Detailed Description

Describes the properties common to all cells.

Constructor & Destructor Documentation

BasicCellProperties::BasicCellProperties ( PhysicalModel myPM,
const StructureProperties::GeometricType  t 
)

Default constructor : generate an unique index.

Parameters
myPMthe physical model the atom belongs to
tthe type of the cell
BasicCellProperties::BasicCellProperties ( PhysicalModel myPM,
const StructureProperties::GeometricType  t,
xmlNodePtr  n 
)

constructor from xml node: try to read and get the properties from xml

Parameters
myPMthe physical model the atom belongs to
tthe type of the cell
nthe xml node to read to get the information
BasicCellProperties::BasicCellProperties ( PhysicalModel myPM,
const StructureProperties::GeometricType  t,
const unsigned int  ind 
)

Use this constructor when you specifically want to set the index.

Parameters
myPMthe physical model the atom belongs to
tthe type of the cell
indan unique index
virtual BasicCellProperties::~BasicCellProperties ( )
inlinevirtual

the destructor...

Member Function Documentation

void BasicCellProperties::beginXML ( std::ostream &  )
protected

write the default xml properties (beginning)

void BasicCellProperties::endXML ( std::ostream &  )
protected

write the default xml properties (end)

static void BasicCellProperties::resetUniqueIndex ( )
static

Reinitialize the unique index to zero (usually that what you want to do when you start to load a new PhysicalModel.

virtual void BasicCellProperties::xmlPrint ( std::ostream &  )
pure virtual

print to an output stream in "pseaudo" XML format.

Implemented in CellProperties.

Member Data Documentation

unsigned int BasicCellProperties::maxUniqueIndex
staticprivate

unique number (used to generate unique index for cells if not given at the instanciation)


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