|
Computer Assited Medical Intervention Tool Kit
version 5.0
|
|
Go to the documentation of this file.
26 #ifndef PHYSICALMODEL_H
27 #define PHYSICALMODEL_H
33 class ExclusiveComponent;
34 class InformativeComponent;
55 #if defined(_WIN32) && !defined(__MINGW32__) // MSVC only
56 #pragma warning( disable : 4290 )
116 const std::string
getName()
const;
118 void setName(
const std::string);
145 void xmlPrint(std::ostream& o,
bool opt =
false);
261 virtual void setProgress(
const float donePercentage);
289 bool parseTree(std::unique_ptr<physicalModel::PhysicalModel> root, std::string defaultName);
291 bool parseAtoms(physicalModel::Atoms atomsRoot);
391 if (quickAccessed && quickAccessed->
getIndex() == id) {
392 return quickAccessed;
400 return ((mapIt ==
atomMap.end()) ? nullptr : (
Atom*) mapIt->second);
413 mapIt =
cellMap.find(cellIndex);
416 return ((mapIt ==
cellMap.end()) ?
nullptr : (
Cell*) mapIt->second);
427 while (mapIt !=
cellMap.end() && mapIt->second->getName() != n) {
433 return mapIt->second;
439 while (mapIt !=
atomMap.end() && mapIt->second->getName() != n) {
445 return mapIt->second;
StructuralComponent * atoms
List of all the atoms : this is the basic stuff for a physicall model.
Definition: PhysicalModel.h:318
bool addGlobalIndexAtomPair(std::GlobalIndexStructurePair)
add or update a pair to the atom map.
Definition: PhysicalModel.cpp:605
std::vector< Cell * > optimizedCellList
optimized consecutive cell vector (in here optimizedCellList[i]->getIndex() == i )
Definition: PhysicalModel.h:327
bool setIndex(const unsigned int) override
set the index.
Definition: Cell.cpp:139
Component * getExclusiveComponent(const unsigned int) const
get an exclusive component by its index in the list
Definition: PhysicalModel.cpp:726
void setModified()
tell the physical model something has changed (for example: a property was modified/added).
Definition: PhysicalModel.h:370
MultiComponent * getExclusiveComponents() const
get all the exclusive components
Definition: PhysicalModel.h:374
void setExclusiveComponents(MultiComponent *)
set the exclusive multi component. Becareful: the physical model takes control of this MultiComponent
Definition: PhysicalModel.cpp:676
double * getPositionPointer() const
get the pointer to the memory space allocated for the atom's position.
Definition: PhysicalModel.cpp:145
unsigned int getNumberOfCells() const
get the total nr of cell in the physical model (exclusive as well as informative)
Definition: PhysicalModel.cpp:130
Component * getComponentByName(const std::string)
conveniant method to get the sub component of the name given in parameter
Definition: MultiComponent.h:137
@ WEDGE
the structure is a wedge (like the Pink Floyd's "Dark Side Of the Moon" prism), it must be a cell and...
Definition: StructureProperties.h:160
@ TETRAHEDRON
the structure is a tetrahedron, it must be a cell and have sub-structures that are atoms
Definition: StructureProperties.h:159
void xmlPrint(std::ostream &) const override
print to an output stream in "pseaudo" XML format (do nothing if there are no sub components).
Definition: MultiComponent.cpp:58
unsigned int getNumberOfStructures() const
get the number of structures
Definition: StructuralComponent.h:252
Properties * properties
all physical model properties
Definition: PhysicalModel.h:296
void getPosition(double pos[3]) const
get the position of the atom (array of 3 doubles)
Definition: Atom.h:121
bool addGlobalIndexCellPair(std::GlobalIndexStructurePair)
add or update a pair to the cell map.
Definition: PhysicalModel.cpp:633
StructureProperties::GeometricType getType() const
get the type of index
Definition: Structure.cpp:40
virtual bool isInstanceOf(const char *) const =0
pure virtual method, implemented in the child-class
Structure * getStructureByName(const std::string n)
get a cell using its name
Definition: PhysicalModel.h:421
Component * getSubComponent(const unsigned int) const
get a subcomponent by its order number (index in the list of subcomponents)
Definition: MultiComponent.h:114
An atom has an unique index in the physical model object, a 3D position, and different basic properti...
Definition: Atom.h:49
void xmlToFields(xsd::cxx::tree::attribute_set< char > attrs)
convert the xml node parameters to data fields
Definition: Properties.cpp:41
void exportPatran(std::string filename)
Save the geometry (atoms/cells) of this PhysicalModel in the Patran format.
Definition: PhysicalModel.cpp:896
std::pair< unsigned int, Structure * > GlobalIndexStructurePair
definition of a couple (=STL pair) (int , Structure *) this associates a global cell/atom index to th...
Definition: PhysicalModel.h:66
const std::string getName() const
Return the name of the physical model.
Definition: PhysicalModel.h:358
std::string getField(unsigned int) const
get the name of field of given index
Definition: Properties.cpp:68
MultiComponent * getInformativeComponents() const
get all the informative components
Definition: PhysicalModel.h:377
static void resetUniqueIndex()
Reinitialize the unique index to zero (usually that what you want to do when you start to load a new ...
Definition: CellProperties.cpp:31
unsigned int getNumberOfAtoms() const
get the number of atoms
Definition: PhysicalModel.cpp:716
void setPhysicalModel(PhysicalModel *) override
set the physical model (recursively)
Definition: MultiComponent.cpp:133
void setName(const std::string)
set the name of the physical model
Definition: PhysicalModel.h:362
Atom * getAtom(const unsigned int id)
Get the atom that has the global index given in parameters.
Definition: PhysicalModel.h:385
unsigned int getIndex() const
get the structure unique index (stored in its property)
Definition: Structure.cpp:30
virtual bool isInstanceOf(const char *) const =0
pure virtual method, implemented in the child-class
unsigned int getNumberOfSubComponents() const
return the number of subcomponents
Definition: MultiComponent.h:111
virtual void setProgress(const float donePercentage)
this method is called during a long process everytime a little bit of the process is finished.
Definition: PhysicalModel.cpp:84
void setExclusive(const bool)
set the exclusive flag
Definition: modeling/libraries/pml/Component.h:141
PtrToSetProgressFunction setProgressFunction
the progress function
Definition: PhysicalModel.h:346
unsigned int getNumberOfExclusiveComponents() const
get the total number of exclusive components
Definition: PhysicalModel.cpp:696
bool isModifiedFlag
is the current property state modified
Definition: PhysicalModel.h:299
A structural component is composed either by cell or by atoms.
Definition: StructuralComponent.h:52
bool makePrintData(const StructuralComponent *)
is this sc the one that will be the one that will make the cell to print out all its data or is this ...
Definition: Cell.cpp:147
Exception class to handle abortion in the xmlReading Particularly useful to handle constructor's abor...
Definition: PMLAbortException.h:39
unsigned int numberOfFields() const
get the number of extra fields found in the PML
Definition: Properties.cpp:63
Pure virtual class that represent an element of the structure. This implies that every structure coul...
Definition: Structure.h:43
void addStructure(Structure *s, bool check=true)
Add a Structure in the list (and tells the structure to add this structural component in its list).
Definition: StructuralComponent.h:212
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!...
Definition: Properties.h:250
PhysicalModel() noexcept
Default constructor : this one just initialize everything.
Definition: PhysicalModel.cpp:54
This is the main class of this project. Following a nice concept, a physical model is able to represe...
Definition: PhysicalModel.h:86
static const char * VERSION
Current PML library version.
Definition: PhysicalModel.h:109
virtual unsigned int getNumberOfCells() const =0
get the total nr of cell of the component
A cell has an unique index in the physical model object, is composed by atoms, and different basic pr...
Definition: Cell.h:46
Properties * getProperties()
get all properties (beware of what you do with them!): please consider calling setModified().
Definition: PhysicalModel.h:354
void optimizeIndexes()
optimize atom and cell indexes so that each order number is equal to the index
Definition: PhysicalModel.cpp:232
virtual Cell * getCell(unsigned int) const =0
conveniant method to get cell by order number (not cell index)
void xmlPrint(std::ostream &o, bool opt=false)
print the physical model to an output stream in a XML format (see physicalmodel.xsd for detail about ...
Definition: PhysicalModel.cpp:258
bool cellIndexOptimized
tell if optimizedCellList can be used
Definition: PhysicalModel.h:330
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 ret...
Definition: Properties.h:178
Component * getComponentByName(const std::string n)
get a structural or multi component by its name.
Definition: PhysicalModel.cpp:553
Component * getInformativeComponent(const unsigned int) const
get an informative component by its index in the list
Definition: PhysicalModel.cpp:736
bool isModified()
check if something have changed
Definition: PhysicalModel.h:366
void exportAnsysMesh(std::string filename)
Save the mesh (atoms/cells) of this PhysicalModel in the Ansys format.
Definition: PhysicalModel.cpp:747
void setPosition(const double[3])
set the position of the atom
Definition: Atom.h:125
virtual ComposedBy composedBy()
return the type of structure composing the structural component: a structural component is either a l...
Definition: StructuralComponent.cpp:296
@ HEXAHEDRON
the structure is a hexahedron, it must be a cell and have sub-structures that are atoms
Definition: StructureProperties.h:162
MultiComponent * informativeComponents
Informative components could be overlaping with other components : they are extra components that giv...
Definition: PhysicalModel.h:313
void setName(std::string)
set the name (use the string = operator)
Definition: Properties.h:254
unsigned int getNumberOfCells() const override
get the total nr of cell of the component
Definition: MultiComponent.cpp:79
void clear()
Clear everything. That allows one to restart an allready instantiated object from scratch.
Definition: PhysicalModel.cpp:91
Structure * getStructure(const unsigned int) const
get a structure by its index (fisrt structure is at index 0)
Definition: StructuralComponent.h:220
bool parseTree(std::unique_ptr< physicalModel::PhysicalModel > root, std::string defaultName)
read the xml tree and call other parse methods to build the physicalModel.
Definition: PhysicalModel.cpp:401
void xmlPrint(std::ostream &) const override
print to an output stream in "pseudo" XML format (do nothing if there are no sub structures).
Definition: StructuralComponent.cpp:154
A component is something that composed something and could also be a part of something.
Definition: modeling/libraries/pml/Component.h:48
MultiComponent * exclusiveComponents
Exclusive components are the non-overlaping components : they defined all the components of the physi...
Definition: PhysicalModel.h:306
Cell * getCell(const unsigned int id)
get the cell that has the global index given in parameters.
Definition: PhysicalModel.h:405
bool parseAtoms(physicalModel::Atoms atomsRoot)
read the atom list in the xml tree and build them.
Definition: PhysicalModel.cpp:461
std::map< unsigned int, Structure * > ::iterator GlobalIndexStructureMapIterator
the iterator corresponding to GlobalIndexStructureMap
Definition: PhysicalModel.h:73
void setName(const std::string)
set the name of the component
Definition: modeling/libraries/pml/Component.h:150
StructuralComponent * getAtoms() const
get all the atoms
Definition: PhysicalModel.h:380
virtual ~PhysicalModel()
destructor
Definition: PhysicalModel.cpp:67
void xmlRead(const char *n)
use the XML Parser/Reader to read an XML file conform to physicalmodel.dtd This method may throw a PM...
Definition: PhysicalModel.cpp:332
bool addAtom(Atom *)
Add a new atom to the atoms' structural component.
Definition: PhysicalModel.cpp:592
void setInformativeComponents(MultiComponent *)
set the exclusive multi component. Becareful: the physical model takes control of this MultiComponent
Definition: PhysicalModel.cpp:686
Describes the properties common to all structures and components.
Definition: Properties.h:59
@ QUAD
the structure is a quad, i.e it must be a cell composed of 4 atoms
Definition: StructureProperties.h:158
virtual void setAtomPosition(Atom *atom, const double pos[3])
Set the new position of an atom.
Definition: PhysicalModel.cpp:671
std::map< unsigned int, Structure * > GlobalIndexStructureMap
definition of the association set (=map in STL) globalIndexStructureMap.
Definition: PhysicalModel.h:71
void(*)(const float donePercentage) PtrToSetProgressFunction
Definition of a function/method that could be called by the setProgress method.
Definition: PhysicalModel.h:60
std::GlobalIndexStructureMap atomMap
the association couple list, which contains the direct map between the atom's global index and the at...
Definition: PhysicalModel.h:340
@ ATOMS
the structural component is made of atoms
Definition: StructuralComponent.h:176
A multi-component stores other components, hence providing a way to have an tree representation of co...
Definition: MultiComponent.h:44
unsigned int getNumberOfInformativeComponents() const
get the total number of informative components
Definition: PhysicalModel.cpp:706
std::GlobalIndexStructureMap cellMap
the association couple list, which contains the direct map between the cell's global index and the ce...
Definition: PhysicalModel.h:324
double * positionPtr
the big memory space where all the atom's position are stored (it is one big block,...
Definition: PhysicalModel.h:349
void plannedNumberOfStructures(const unsigned int)
optimize the I/O of the std:vector structures.
Definition: StructuralComponent.h:270
bool parseComponents(physicalModel::MultiComponent mcFather, Component *father, bool isExclusive)
read the exclusive components list in the xml tree and build them.
Definition: PhysicalModel.cpp:490
static void resetUniqueIndex()
Reinitialize the unique index to zero (usually that what you want to do when you start to load a new ...
Definition: AtomProperties.cpp:36
void setAtoms(StructuralComponent *, bool deleteOld=true)
set the atom structural component.
Definition: PhysicalModel.cpp:572
void init()
initialization method
Definition: PhysicalModel.cpp:72