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

A monitor for forces. More...

#include <MonitorForce.h>

Public Member Functions

void calculate () override
 calculate current followed data and store them in values vector
 
std::string getTypeName () override
 return a string relative to monitor type
 
 MonitorForce (mml::Monitor *m, MonitoringManager *monitoringManager)
 constructor
 
 ~MonitorForce () override
 destructor
 
- Public Member Functions inherited from Monitor
int getIndex ()
 
int getIndexOfValues (const unsigned int i)
 get index i of indexes vector
 
unsigned int getNumberOfIndex ()
 get number of index in indexes vetor
 
unsigned int getNumberOfValues ()
 get number of value in values vetor
 
std::string getReferenceName ()
 
double getStartAt ()
 
double getStopAt ()
 
std::string getTargetName ()
 
double getValue (const unsigned int i)
 get value i of values vector
 
bool getValuesOfIndex (int i, double values[])
 populate values with the corresponding values at index i
 
Monitor::type getValueType ()
 
 Monitor (mml::Monitor *m, MonitoringManager *monitoringManager, Monitor::type type)
 constructor
 
virtual void write ()
 write data stored in values vector into mmlOut file
 
virtual ~Monitor ()
 destructor
 

Additional Inherited Members

- Public Types inherited from Monitor
enum  type { SCALAR , SCALARSET , VECTORSET , MATRIX_33SET }
 type of the values stored (please update typeCount and doc if you update the enum) SCALAR: the monitor store a single scalar value SCALARSET: the monitor stores a scalar value for each atom VECTORSET: the monitor stores 3 scalar values for each atom MATRIX_33SET: the monitor stores a matrix 3x3 for each atom More...
 
- Static Public Attributes inherited from Monitor
static const unsigned int typeCount = 4
 number of possible types (siez of the previous enum). Please always update if the enum is updated.
 
- Protected Attributes inherited from Monitor
int dimension
 dimension of data stored
 
double dx
 offset in x direction (if reference is not aligned)
 
double dy
 offset in y direction (if reference is not aligned)
 
double dz
 offset in z direction (if reference is not aligned)
 
int index
 index of monitor
 
std::vector< int > indexes
 vector which contains target's atoms index (in same order that values associate with)
 
std::map< int, std::vector< double > > indexToValuesMap
 map between indexes and values
 
mml::Monitor * mappedObject
 the xsdcxx object representing monitor, used for serialization
 
MonitoringManagermonitoringManager
 monitoring manager
 
std::vector< Reference * > references
 references used when monitor need references
 
double startAt
 time to start monitoring
 
double stopAt
 time to stop monitoring
 
std::string target
 the name of the component targeted by the monitor
 
std::vector< double > values
 the vector which contains data monitored
 
Monitor::type valueType
 type of the values stored
 

Detailed Description

A monitor for forces.

Constructor & Destructor Documentation

◆ MonitorForce()

MonitorForce::MonitorForce ( mml::Monitor *  m,
MonitoringManager monitoringManager 
)

constructor

Parameters
mthe xsdcxx generated monitor

◆ ~MonitorForce()

MonitorForce::~MonitorForce ( )
override

destructor

Member Function Documentation

◆ calculate()

◆ getTypeName()

std::string MonitorForce::getTypeName ( )
overridevirtual

return a string relative to monitor type

Implements Monitor.


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