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

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

#include <StructureProperties.h>

+ Inheritance diagram for StructureProperties:

Public Types

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...
 

Public Member Functions

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 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 Attributes

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...
 

Private Attributes

GeometricType type
 The geometric type,. More...
 

Detailed Description

Describes the properties common to all structures.

Constructor & Destructor Documentation

StructureProperties::StructureProperties ( PhysicalModel ,
const GeometricType   
)

the only default constructor : type must be set

virtual StructureProperties::~StructureProperties ( )
inlinevirtual

Member Function Documentation

unsigned int StructureProperties::getIndex ( ) const
inline

return the unique index in the global structure

References index.

StructureProperties::GeometricType StructureProperties::getType ( ) const
inline

Return the type of force.

References type.

void StructureProperties::setIndex ( const unsigned int  newIndex)
inline

set the index (BECAREFUL: it MUST be unique !!!)

References index.

void StructureProperties::setType ( const GeometricType  t)
inline

Set the force type.

References type.

static std::string StructureProperties::toString ( const GeometricType  )
static

return the string equivalent to this geometric type

static GeometricType StructureProperties::toType ( const std::string  )
static

return the enum corresponding to this string

void StructureProperties::xmlPrint ( std::ostream &  ) const

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

Member Data Documentation

unsigned int StructureProperties::index
protected

unique index in the global structure

Referenced by getIndex(), and setIndex().

GeometricType StructureProperties::type
private

The geometric type,.

See also
StructureProperties::GeometricType

Referenced by getType(), and setType().


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