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 Member Functions | Protected Attributes | List of all members
StructuralComponentProperties Class Reference

This is an automatically generated class for custom StructuralComponent properties. More...

#include <StructuralComponentProperties.h>

+ Inheritance diagram for StructuralComponentProperties:

Public Member Functions

int getMyCustomProperty1 () const
 
std::string getMyCustomProperty2 () const
 
void setMyCustomProperty1 (const int)
 Set and get method for all the properties. More...
 
void setMyCustomProperty2 (const std::string)
 
 StructuralComponentProperties (PhysicalModel *p)
 Constructors (do not change) More...
 
 StructuralComponentProperties (PhysicalModel *p, xmlNodePtr node)
 
 StructuralComponentProperties (PhysicalModel *p, const std::string n)
 
 StructuralComponentProperties (PhysicalModel *p, const Color c)
 
 StructuralComponentProperties (PhysicalModel *p, const Color c, const std::string n)
 
 StructuralComponentProperties (PhysicalModel *p, const double *rgb)
 
 StructuralComponentProperties (PhysicalModel *p, const double *rgb, const std::string n)
 
 StructuralComponentProperties (PhysicalModel *p, const double r, const double g, const double b)
 
 StructuralComponentProperties (PhysicalModel *p, const double r, const double g, const double b, const std::string n)
 
void xmlPrint (std::ostream &)
 Print the properties in xml. More...
 
virtual ~StructuralComponentProperties ()
 
- Public Member Functions inherited from BasicSCProperties
 BasicSCProperties (PhysicalModel *p, const Color c)
 use a Color constant to set the color More...
 
 BasicSCProperties (PhysicalModel *p, xmlNodePtr node)
 
 BasicSCProperties (PhysicalModel *p, const Color c, const std::string n)
 
 BasicSCProperties (PhysicalModel *p, const double *rgb)
 use a double[3] array to set the color More...
 
 BasicSCProperties (PhysicalModel *p, const double *rgb, const std::string n)
 
 BasicSCProperties (PhysicalModel *p, const double r, const double g, const double b)
 use 3 floats to set the color More...
 
 BasicSCProperties (PhysicalModel *p, const double r, const double g, const double b, const std::string n)
 
 BasicSCProperties (PhysicalModel *p)
 defaultcolor is gray More...
 
 BasicSCProperties (PhysicalModel *p, const std::string n)
 
double getAlpha () const
 
double getBlue () const
 
Color getColor () const
 
double getGreen () const
 
RenderingMode::Mode getMode () const
 
std::string getModeString () const
 get the string equivalent to the enum rendering mode More...
 
double getRed () const
 
double * getRGB () const
 
double * getRGBA () const
 
bool isVisible (const RenderingMode::Mode mode) const
 
void setAlpha (const double a)
 
void setBlue (const double b)
 
void setColor (Color c)
 
void setGreen (const double g)
 
void setMode (const RenderingMode::Mode)
 
void setRed (const double r)
 
void setRGB (const double *rgb)
 
void setRGB (const double r, const double g, const double b)
 
void setRGBA (const double r, const double g, const double b, const double a)
 
void setRGBA (const double *rgba)
 
void setVisible (const RenderingMode::Mode, const bool)
 
virtual ~BasicSCProperties ()
 
- 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...
 

Protected Member Functions

virtual void init ()
 
- Protected Member Functions inherited from BasicSCProperties
void beginXML (std::ostream &)
 write the default xml properties (beginning) More...
 
void endXML (std::ostream &)
 write the default xml properties (end) More...
 

Protected Attributes

int myCustomProperty1
 
std::string myCustomProperty2
 
- Protected Attributes inherited from Properties
std::map< std::string,
std::string
fields
 map containing all the different fields (name, value stored as string ) More...
 

Additional Inherited Members

- Public Types inherited from BasicSCProperties
enum  Color {
  DEFAULT, RED, GREEN, BLUE,
  GRAY, OTHER
}
 Default color settings. More...
 

Detailed Description

This is an automatically generated class for custom StructuralComponent properties.

It was generated by the customPhysicalProperties stylesheet from the following xml document:

This class inherits BasicSCProperties. Here is all the specific attributes of StructuralComponent properties (custom physical properties).

Constructor & Destructor Documentation

StructuralComponentProperties::StructuralComponentProperties ( PhysicalModel p)
inline

Constructors (do not change)

References init().

StructuralComponentProperties::StructuralComponentProperties ( PhysicalModel p,
xmlNodePtr  node 
)
inline

References init().

StructuralComponentProperties::StructuralComponentProperties ( PhysicalModel p,
const std::string  n 
)
inline

References init().

StructuralComponentProperties::StructuralComponentProperties ( PhysicalModel p,
const Color  c 
)
inline

References init().

StructuralComponentProperties::StructuralComponentProperties ( PhysicalModel p,
const Color  c,
const std::string  n 
)
inline

References init().

StructuralComponentProperties::StructuralComponentProperties ( PhysicalModel p,
const double *  rgb 
)
inline

References init().

StructuralComponentProperties::StructuralComponentProperties ( PhysicalModel p,
const double *  rgb,
const std::string  n 
)
inline

References init().

StructuralComponentProperties::StructuralComponentProperties ( PhysicalModel p,
const double  r,
const double  g,
const double  b 
)
inline

References init().

StructuralComponentProperties::StructuralComponentProperties ( PhysicalModel p,
const double  r,
const double  g,
const double  b,
const std::string  n 
)
inline

References init().

virtual StructuralComponentProperties::~StructuralComponentProperties ( )
virtual

Member Function Documentation

int StructuralComponentProperties::getMyCustomProperty1 ( ) const
inline

References myCustomProperty1.

std::string StructuralComponentProperties::getMyCustomProperty2 ( ) const
inline

References myCustomProperty2.

virtual void StructuralComponentProperties::init ( )
protectedvirtual
void StructuralComponentProperties::setMyCustomProperty1 ( const int  value)
inline

Set and get method for all the properties.

References myCustomProperty1.

void StructuralComponentProperties::setMyCustomProperty2 ( const std::string  value)
inline

References myCustomProperty2.

void StructuralComponentProperties::xmlPrint ( std::ostream &  )
virtual

Print the properties in xml.

Implements BasicSCProperties.

Member Data Documentation

int StructuralComponentProperties::myCustomProperty1
protected
std::string StructuralComponentProperties::myCustomProperty2
protected

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