Computer Assisted Medical Intervention Tool Kit  version 5.2
 
Loading...
Searching...
No Matches
Monitor Class Referenceabstract

A monitor calculate and store followed data (ex:calculation between current position and references) At current time (current state of simulation is given by Parameters class) A monitor is active between startAt and stopAt time. More...

#include <Monitor.h>

Public Types

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

Public Member Functions

virtual void calculate ()=0
 calculate current followed data and store them in values vector
 
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 ()
 
virtual std::string getTypeName ()=0
 
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
 

Static Public Attributes

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

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 calculate and store followed data (ex:calculation between current position and references) At current time (current state of simulation is given by Parameters class) A monitor is active between startAt and stopAt time.

Member Enumeration Documentation

◆ type

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

Enumerator
SCALAR 
SCALARSET 
VECTORSET 
MATRIX_33SET 

Constructor & Destructor Documentation

◆ Monitor()

◆ ~Monitor()

Monitor::~Monitor ( )
virtual

destructor

References references.

Member Function Documentation

◆ calculate()

◆ getIndex()

int Monitor::getIndex ( )

References index.

Referenced by MonitorForce::calculate().

◆ getIndexOfValues()

int Monitor::getIndexOfValues ( const unsigned int  i)

get index i of indexes vector

References indexes.

Referenced by Arrows::update(), Colors::update(), and Tabular::update().

◆ getNumberOfIndex()

unsigned int Monitor::getNumberOfIndex ( )

get number of index in indexes vetor

References indexes, and indexToValuesMap.

Referenced by Arrows::update(), Colors::update(), and Tabular::update().

◆ getNumberOfValues()

unsigned int Monitor::getNumberOfValues ( )

get number of value in values vetor

References values.

Referenced by Statistics::update().

◆ getReferenceName()

std::string Monitor::getReferenceName ( )

References references.

Referenced by MonitoringDialog::updateMonitors().

◆ getStartAt()

double Monitor::getStartAt ( )

References startAt.

Referenced by MonitoringDialog::updateMonitors().

◆ getStopAt()

double Monitor::getStopAt ( )

References stopAt.

Referenced by MonitoringDialog::updateMonitors().

◆ getTargetName()

std::string Monitor::getTargetName ( )

References target.

Referenced by MonitoringDialog::updateMonitors().

◆ getTypeName()

◆ getValue()

double Monitor::getValue ( const unsigned int  i)

get value i of values vector

References values.

Referenced by Arrows::update(), Colors::update(), Statistics::update(), and Tabular::update().

◆ getValuesOfIndex()

bool Monitor::getValuesOfIndex ( int  i,
double  values[] 
)

populate values with the corresponding values at index i

References dimension, indexToValuesMap, and values.

◆ getValueType()

Monitor::type Monitor::getValueType ( )

◆ write()

Member Data Documentation

◆ dimension

int Monitor::dimension
protected

dimension of data stored

Referenced by getValuesOfIndex(), and Monitor().

◆ dx

◆ dy

◆ dz

◆ index

int Monitor::index
protected

index of monitor

Referenced by getIndex(), and Monitor().

◆ indexes

std::vector<int> Monitor::indexes
protected

vector which contains target's atoms index (in same order that values associate with)

Referenced by getIndexOfValues(), getNumberOfIndex(), Monitor(), and write().

◆ indexToValuesMap

std::map<int, std::vector<double> > Monitor::indexToValuesMap
protected

map between indexes and values

Referenced by getNumberOfIndex(), getValuesOfIndex(), and Monitor().

◆ mappedObject

mml::Monitor* Monitor::mappedObject
protected

the xsdcxx object representing monitor, used for serialization

Referenced by Monitor(), write(), and MonitorVolume::write().

◆ monitoringManager

◆ references

◆ startAt

double Monitor::startAt
protected

time to start monitoring

Referenced by getStartAt(), and Monitor().

◆ stopAt

double Monitor::stopAt
protected

time to stop monitoring

Referenced by getStopAt(), and Monitor().

◆ target

◆ typeCount

const unsigned int Monitor::typeCount = 4
static

number of possible types (siez of the previous enum). Please always update if the enum is updated.

Referenced by MMLMonitorDisplayFactory::registerClass().

◆ values

◆ valueType

Monitor::type Monitor::valueType
protected

type of the values stored

Referenced by getValueType(), and Monitor().


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