Computer Assisted Medical Intervention Tool Kit  version 5.2
 
Loading...
Searching...
No Matches
CellProperties Class Reference

Describes and manages the properties attached to cells. More...

#include <CellProperties.h>

+ Inheritance diagram for CellProperties:
+ Collaboration diagram for CellProperties:

Public Member Functions

 CellProperties (PhysicalModel *myPM, const StructureProperties::GeometricType t)
 Default constructor : generate an unique index.
 
 CellProperties (PhysicalModel *myPM, const StructureProperties::GeometricType t, const unsigned int ind)
 Use this constructor when you specifically want to set the index.
 
 CellProperties (PhysicalModel *myPM, const StructureProperties::GeometricType t, physicalModel::CellProperties xmlCellProp)
 constructor from xml node: try to read and get the properties from xml
 
virtual void xmlPrint (std::ostream &)
 print to an output stream in "pseaudo" XML format.
 
 ~CellProperties ()=default
 the destructor...
 
- Public Member Functions inherited from StructureProperties
unsigned int getIndex () const
 return the unique index in the global structure
 
GeometricType getType () const
 Return the type of force.
 
void setIndex (const unsigned int)
 set the index (BECAREFUL: it MUST be unique !!!)
 
void setType (const GeometricType t)
 Set the force type.
 
 StructureProperties (PhysicalModel *, const GeometricType)
 the only default constructor : type must be set
 
void xmlPrint (std::ostream &) const
 print to an output stream in "pseaudo" XML format.
 
 ~StructureProperties ()=default
 
- 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!!!)
 
PhysicalModelgetPhysicalModel () const
 get the physical model
 
 Properties (const std::string n="")
 A nice simple constructor, with a given name.
 
 Properties (PhysicalModel *, const std::string n="")
 Another nice constructor, with the PM and a name.
 
void setName (std::string)
 set the name (use the string = operator)
 
void setPhysicalModel (PhysicalModel *)
 set the physical model
 
virtual ~Properties ()=default
 The default destructor.
 
void xmlToFields (xsd::cxx::tree::attribute_set< char > attrs)
 convert the xml node parameters to data fields
 
unsigned int numberOfFields () const
 get the number of extra fields found in the PML
 
bool isAField (std::string attName) const
 check if the field exist in the XML document, return false if it does not
 
std::string getField (unsigned int) const
 get the name of field of given index
 
double getDouble (std::string attName)
 field accessor: get the field attName as a double value, if field does not exist, 0.0 is return
 
int getInt (std::string attName) const
 field accessor: get the field attName as an int value, if field does not exist, 0 is return
 
bool getBool (std::string attName) const
 field accessor: get the field attName as a bool value, if field does not exist, false is return
 
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
 
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
 
void set (std::string attName, double val)
 field modificator: set field attName using a double value
 
void set (std::string attName, int val)
 field modificator: set field attName using an int value
 
void set (std::string attName, bool val)
 field modificator: set field attName using a bool value
 
void set (std::string attName, std::string val)
 field modificator: set field attName using a string value
 

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.
 
- Static Public Member Functions inherited from StructureProperties
static std::string toString (const GeometricType)
 return the string equivalent to this geometric type
 
static GeometricType toType (const std::string)
 return the enum corresponding to this string
 

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
 
- Protected Attributes inherited from Properties
std::map< std::string, std::string > fields
 map containing all the different fields (name, value stored as string )
 

Detailed Description

Describes and manages the properties attached to cells.

Constructor & Destructor Documentation

◆ CellProperties() [1/3]

CellProperties::CellProperties ( 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

References StructureProperties::index.

◆ CellProperties() [2/3]

CellProperties::CellProperties ( PhysicalModel myPM,
const StructureProperties::GeometricType  t,
physicalModel::CellProperties  xmlCellProp 
)

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

References StructureProperties::index, Properties::setName(), and Properties::xmlToFields().

+ Here is the call graph for this function:

◆ CellProperties() [3/3]

CellProperties::CellProperties ( 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

References StructureProperties::index.

◆ ~CellProperties()

CellProperties::~CellProperties ( )
default

the destructor...

Member Function Documentation

◆ resetUniqueIndex()

void CellProperties::resetUniqueIndex ( )
static

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

◆ xmlPrint()

void CellProperties::xmlPrint ( std::ostream &  o)
virtual

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