Monitor Class Reference

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>

Inheritance diagram for Monitor:

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 More...
int	getIndex ()
int	getIndexOfValues (const unsigned int i)
	get index i of indexes vector More...
unsigned int	getNumberOfIndex ()
	get number of index in indexes vetor More...
unsigned int	getNumberOfValues ()
	get number of value in values vetor More...
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 More...
bool	getValuesOfIndex (int i, double values[])
	populate values with the corresponding values at index i More...
Monitor::type	getValueType ()
	Monitor (mml::Monitor *m, MonitoringManager *monitoringManager, Monitor::type type)
	constructor More...
void	write ()
	write data stored in values vector into mmlOut file More...
virtual	~Monitor ()
	destructor More...

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

Protected Attributes
int	dimension
	dimension of data stored More...
double	dx
	offset in x direction (if reference is not aligned) More...
double	dy
	offset in y direction (if reference is not aligned) More...
double	dz
	offset in z direction (if reference is not aligned) More...
int	index
	index of monitor More...
std::vector< int >	indexes
	vector which contains target's atoms index (in same order that values associate with) More...
std::map< int, std::vector < double > >	indexToValuesMap
	map between indexes and values More...
mml::Monitor *	mappedObject
	the xsdcxx object representing monitor, used for serialization More...
MonitoringManager *	monitoringManager
	monitoring manager More...
std::vector< Reference * >	references
	references used when monitor need references More...
double	startAt
	time to start monitoring More...
double	stopAt
	time to stop monitoring More...
std::string	target
	the name of the component targeted by the monitor More...
std::vector< double >	values
	the vector which contains data monitored More...
Monitor::type	valueType
	type of the values stored More...

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.

Constructor & Destructor Documentation

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

constructor

Parameters

m	the xsdcxx generated monitor

virtual Monitor::~Monitor ( )

virtual

destructor

Member Function Documentation

virtual void Monitor::calculate ( )

pure virtual

calculate current followed data and store them in values vector

Implemented in MonitorPointFinalSetDistance, MonitorPointToTriangleMeshDistanceFinal, MonitorComputingTime, MonitorDisplacement, MonitorDistanceX, MonitorDistanceY, MonitorDistanceZ, MonitorForce, MonitorGeometricDeviation, MonitorNormDisplacement, MonitorPointSetDistance, MonitorPosition, MonitorRen, MonitorSurface, and MonitorVolume.

int Monitor::getIndex

(

)

int Monitor::getIndexOfValues

(

const unsigned int

i

)

get index i of indexes vector

unsigned int Monitor::getNumberOfIndex

(

)

get number of index in indexes vetor

unsigned int Monitor::getNumberOfValues

(

)

get number of value in values vetor

std::string Monitor::getReferenceName

(

)

double Monitor::getStartAt

(

)

double Monitor::getStopAt

(

)

std::string Monitor::getTargetName

(

)

virtual std::string Monitor::getTypeName ( )

pure virtual

Implemented in MonitorPointFinalSetDistance, MonitorPointToTriangleMeshDistanceFinal, MonitorComputingTime, MonitorDisplacement, MonitorDistanceX, MonitorDistanceY, MonitorDistanceZ, MonitorForce, MonitorGeometricDeviation, MonitorNormDisplacement, MonitorPointSetDistance, MonitorPosition, MonitorRen, MonitorSurface, and MonitorVolume.

double Monitor::getValue

(

const unsigned int

i

)

get value i of values vector

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

populate values with the corresponding values at index i

Monitor::type Monitor::getValueType

(

)

void Monitor::write

(

)

write data stored in values vector into mmlOut file

Member Data Documentation

int Monitor::dimension

protected

dimension of data stored

double Monitor::dx

protected

offset in x direction (if reference is not aligned)

double Monitor::dy

protected

offset in y direction (if reference is not aligned)

double Monitor::dz

protected

offset in z direction (if reference is not aligned)

int Monitor::index

protected

index of monitor

std::vector<int> Monitor::indexes

protected

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

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

protected

map between indexes and values

mml::Monitor* Monitor::mappedObject

protected

the xsdcxx object representing monitor, used for serialization

MonitoringManager* Monitor::monitoringManager

protected

monitoring manager

std::vector<Reference*> Monitor::references

protected

references used when monitor need references

double Monitor::startAt

protected

time to start monitoring

double Monitor::stopAt

protected

time to stop monitoring

std::string Monitor::target

protected

the name of the component targeted by the monitor

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

std::vector<double> Monitor::values

protected

the vector which contains data monitored

Monitor::type Monitor::valueType

protected

type of the values stored

---

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

• Monitor.h