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 | Protected Attributes | Private Attributes | List of all members
Properties Class Reference

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

#include <Properties.h>

+ Inheritance diagram for Properties:

Public Member Functions

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...
 
Field methods (manages any custom fields)
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...
 

Protected Attributes

std::map< std::string,
std::string
fields
 map containing all the different fields (name, value stored as string ) More...
 

Private Attributes

PhysicalModelmyPM
 pointer to the physical model the object is in More...
 
std::string name
 name of the physical model object More...
 

Detailed Description

Describes the properties common to all structures and components.

Properties uses a generic mechanisms to store any kind of properties, henceforth called "fields". A field is a (name:string, value:string) pair.

Fields are read directly from XML, and then can be changed through the modificators methods.

The field accessors allows you to get the value in the form of different basic types (string, double, bool, int).

Method numberOfFields():usigned and getField(unsigned):string help you to get information about available fields.

Constructor & Destructor Documentation

Properties::Properties ( const std::string  n = "")

A nice simple constructor, with a given name.

Properties::Properties ( PhysicalModel ,
const std::string  n = "" 
)

Another nice constructor, with the PM and a name.

virtual Properties::~Properties ( )
virtual

The default destructor.

Member Function Documentation

void Properties::domToFields ( xmlNodePtr  node)

convert the xml node parameters to data fields

void Properties::get ( std::string  attName,
std::string attVal 
) const
inline

field accessor: get the field attName as a string value in attVal, if field does not exist, empty string is return

References fields.

bool Properties::getBool ( std::string  attName) const
inline

field accessor: get the field attName as a bool value, if field does not exist, false is return

References fields.

double Properties::getDouble ( std::string  attName)
inline

field accessor: get the field attName as a double value, if field does not exist, 0.0 is return

References fields.

std::string Properties::getField ( unsigned  int) const

get the name of field of given index

Returns
the field name if i is valid, otherwise return blank string ""
int Properties::getInt ( std::string  attName) const
inline

field accessor: get the field attName as an int value, if field does not exist, 0 is return

References fields.

std::string Properties::getName ( ) const
inline

get the name (be careful, this method DOES NOT return a copy, so you got the direct ptr to the name!!!)

References name.

Referenced by BasicSCProperties::beginXML(), Component::getName(), and PhysicalModel::getName().

PhysicalModel * Properties::getPhysicalModel ( ) const
inline

get the physical model

References myPM.

Referenced by Component::getPhysicalModel().

std::string Properties::getString ( std::string  attName) const
inline

field accessor: get the field attName as a string value, if field does not exist, empty string is return

References fields.

bool Properties::isAField ( std::string  attName) const
inline

check if the field exist in the XML document, return false if it does not

References fields.

unsigned int Properties::numberOfFields ( ) const

get the number of extra fields found in the PML

void Properties::set ( std::string  attName,
double  val 
)
inline

field modificator: set field attName using a double value

References fields.

void Properties::set ( std::string  attName,
int  val 
)
inline

field modificator: set field attName using an int value

References fields.

void Properties::set ( std::string  attName,
bool  val 
)
inline

field modificator: set field attName using a bool value

References fields.

void Properties::set ( std::string  attName,
std::string  val 
)
inline

field modificator: set field attName using a string value

References fields.

void Properties::setName ( std::string  n)
inline

set the name (use the string = operator)

References name, and string().

Referenced by Component::setName(), and PhysicalModel::setName().

void Properties::setPhysicalModel ( PhysicalModel pm)
inline

set the physical model

References myPM.

Referenced by Component::setPhysicalModel().

Member Data Documentation

std::map<std::string, std::string> Properties::fields
protected

map containing all the different fields (name, value stored as string )

Referenced by get(), getBool(), getDouble(), getInt(), getString(), isAField(), and set().

PhysicalModel* Properties::myPM
private

pointer to the physical model the object is in

Referenced by getPhysicalModel(), and setPhysicalModel().

std::string Properties::name
private

name of the physical model object

Referenced by getName(), and setName().


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