A monitor that calculate the distance between two points. More...

#include <MonitorDistanceZ.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
	MonitorDistanceZ (mml::Monitor m, MonitoringManager monitoringManager)
	constructor
	~MonitorDistanceZ () override=default
	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
MonitoringManager *	monitoringManager
	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 that calculate the distance between two points.

Constructor & Destructor Documentation

◆ MonitorDistanceZ()

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

constructor

Parameters

m	the xsdcxx generated monitor

References Monitor::Monitor(), Monitor::monitoringManager, and Monitor::SCALARSET.

◆ ~MonitorDistanceZ()

MonitorDistanceZ::~MonitorDistanceZ ( )

overridedefault

destructor

Member Function Documentation

◆ calculate()

void MonitorDistanceZ::calculate ( )

overridevirtual

calculate current followed data and store them in values vector

Implements Monitor.

References AtomIterator::begin(), AtomIterator::currentAtom(), Monitor::dz, AtomIterator::end(), Structure::getIndex(), Atom::getPosition(), Monitor::monitoringManager, AtomIterator::next(), Monitor::references, Monitor::target, Monitor::values, and Monitor::write().

◆ getTypeName()

std::string MonitorDistanceZ::getTypeName ( )

overridevirtual

return a string relative to monitor type