Description

Base class for probe objects, used to record data during simulations.

#include <ChProbe.h>

Inheritance diagram for chrono::ChProbe:

Collaboration diagram for chrono::ChProbe:

Public Member Functions
	ChProbe (const ChProbe &other)

virtual ChProbe *	Clone () const override
	"Virtual" copy constructor.

virtual void	Record (double mtime)
	Record the value. More...

virtual void	Reset ()

virtual void	ArchiveOUT (ChArchiveOut &marchive) override
	Method to allow serialization of transient data to archives.

virtual void	ArchiveIN (ChArchiveIn &marchive) override
	Method to allow de serialization of transient data from archives.

Public Member Functions inherited from chrono::ChObj
	ChObj (const ChObj &other)

int	GetIdentifier () const
	Gets the numerical identifier of the object.

void	SetIdentifier (int id)
	Sets the numerical identifier of the object.

double	GetChTime () const
	Gets the simulation time of this object.

void	SetChTime (double m_time)
	Sets the simulation time of this object.

const char *	GetName () const
	Gets the name of the object as C Ascii null-terminated string -for reading only!

void	SetName (const char myname[])
	Sets the name of this object, as ascii string.

std::string	GetNameString () const
	Gets the name of the object as C Ascii null-terminated string.

void	SetNameString (const std::string &myname)
	Sets the name of this object, as std::string.

void	MFlagsSetAllOFF (int &mflag)

void	MFlagsSetAllON (int &mflag)

void	MFlagSetON (int &mflag, int mask)

void	MFlagSetOFF (int &mflag, int mask)

int	MFlagGet (int &mflag, int mask)

virtual std::string &	ArchiveContainerName ()

Additional Inherited Members
Protected Attributes inherited from chrono::ChObj
double	ChTime
	the time of simulation for the object

Member Function Documentation

◆ Record()

virtual void chrono::ChProbe::Record ( double mtime )

inlinevirtual

Record the value.

Note that X and Y variables must be already set, using the probe data. Usually mtime is used for X var (default), while a script is used to specify the Y variable. Record() is called for each integration step, by the system object which contains all probes.

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

/builds/uwsbel/chrono/src/chrono/physics/ChProbe.h
/builds/uwsbel/chrono/src/chrono/physics/ChProbe.cpp

Description

Public Member Functions

Additional Inherited Members

Member Function Documentation

◆ Record()