Base class for high level objects. More...

#include <cmnGenericObject.h>

Inheritance diagram for cmnGenericObject:

Public Member Functions
virtual	~cmnGenericObject (void)
virtual const cmnClassServicesBase *	Services (void) const =0
bool	ReconstructFrom (const cmnGenericObject &other)
std::string	ToString (void) const
virtual void	ToStream (std::ostream &outputStream) const
virtual void	ToStreamRaw (std::ostream &outputStream, const char delimiter=' ', bool headerOnly=false, const std::string &headerPrefix="") const
virtual bool	FromStreamRaw (std::istream &inputStream, const char delimiter=' ')
virtual void	SerializeRaw (std::ostream &outputStream) const
virtual void	DeSerializeRaw (std::istream &inputStream)
virtual cmnLogger::StreamBufType *	GetLogMultiplexer (void) const
virtual size_t	ScalarNumber (void) const
virtual bool	ScalarNumberIsFixed (void) const
virtual double	Scalar (const size_t CMN_UNUSED(index)) const CISST_THROW(std
virtual std::string	ScalarDescription (const size_t CMN_UNUSED(index), const std::string &CMN_UNUSED(userDescription)) const

Detailed Description

Base class for high level objects.

See also: cmnClassRegister cmnClassServiceBase

Constructor & Destructor Documentation

◆ ~cmnGenericObject()

virtual cmnGenericObject::~cmnGenericObject ( void )

inlinevirtual

Destructor. Does nothing specific.

Member Function Documentation

◆ DeSerializeRaw()

virtual void cmnGenericObject::DeSerializeRaw ( std::istream & inputStream )

virtual

De-serialize the content of the object without any extra information, i.e. no class type nor format version.

◆ FromStreamRaw()

virtual bool cmnGenericObject::FromStreamRaw	(	std::istream &	inputStream,
		const char	delimiter = ' ' )

virtual

Read from an unformatted text input (e.g., one created by ToStreamRaw). Returns true if successful.

◆ GetLogMultiplexer()

virtual cmnLogger::StreamBufType * cmnGenericObject::GetLogMultiplexer ( void ) const

virtual

Get the multiplexer to use for logging. This is used by the macro CMN_LOG_CLASS to determine the log destination. By default, it uses cmnLogger. This method can be overloaded to define a log file/stream per object.

Reimplemented in mtsComponent.

◆ ReconstructFrom()

bool cmnGenericObject::ReconstructFrom ( const cmnGenericObject & other )

Use the placement new with the copy constructor to re-construct this object based on an existing one. This method will call the destructor to free any memory allocated by the previous constructor. It is important to note that the memory allocated for the object itself is not freed/re-allocated and therefore the object's address remains valid.

\other An object of the same type, if the types (class derived from cmnGenericObject) don't correspond the method will return false and will not call the destructor and copy constructor.

Returns: false if the object other is not of the right type.

◆ Scalar()

virtual double cmnGenericObject::Scalar ( const size_t CMN_UNUSEDindex ) const

inlinevirtual

Return the index-th (zero-based) value of data typecasted to double. Note that this method will throw an exception of type std::outputStream if the index exceeds the number of scalars.

◆ ScalarDescription()

virtual std::string cmnGenericObject::ScalarDescription	(	const size_t	CMN_UNUSEDindex,
		const std::string &	CMN_UNUSEDuserDescription ) const

inlinevirtual

Return the name of index-th (zero-based) data typecasted to double. As for the Scalar, this method will throw an exception of type std::out_of_range if the index exceeds the number of scalar.

◆ ScalarNumber()

virtual size_t cmnGenericObject::ScalarNumber ( void ) const

inlinevirtual

Methods for data visualization. Derived classes should override the following methods in order to be properly processed by the data visualizer of the global component manager.

Return a number of data (which can be visualized, i.e., type-casted to double)

Reimplemented in mtsComponentConstructorArg, mtsGenericObject, mtsTaskConstructorArg, mtsTaskContinuousConstructorArg, mtsTaskPeriodicConstructorArg, prmBaseFrame, prmCameraInfo, prmCartesianImpedance, prmConfigurationJoint, prmDepthMap, prmForceTorqueJointSet, prmForwardKinematicsRequest, prmForwardKinematicsResponse, prmImageFrame, prmIMUSensors, prmInputData, prmInverseKinematicsRequest, prmInverseKinematicsResponse, prmOperatingState, prmPositionCartesianArrayGet, prmPositionCartesianGet, prmPositionCartesianSet, prmPositionJointGet, prmPositionJointSet, prmServoCartesian, prmServoJoint, prmStateCartesian, prmStateJoint, and prmVelocityCartesianGet.

◆ ScalarNumberIsFixed()

virtual bool cmnGenericObject::ScalarNumberIsFixed ( void ) const

inlinevirtual

Indicates if this object has a fixed number of scalars. This is used for arrays of object in order to optimize random access for a given scalar. When defining an object with a fixed number of scalars, overloading this method to return true allows some optimizations.

Reimplemented in mtsComponentConstructorArg, mtsGenericObject, mtsTaskConstructorArg, mtsTaskContinuousConstructorArg, mtsTaskPeriodicConstructorArg, prmBaseFrame, prmCameraInfo, prmCartesianImpedance, prmConfigurationJoint, prmDepthMap, prmForceTorqueJointSet, prmForwardKinematicsRequest, prmForwardKinematicsResponse, prmImageFrame, prmIMUSensors, prmInputData, prmInverseKinematicsRequest, prmInverseKinematicsResponse, prmOperatingState, prmPositionCartesianArrayGet, prmPositionCartesianGet, prmPositionCartesianSet, prmPositionJointGet, prmPositionJointSet, prmServoCartesian, prmServoJoint, prmStateCartesian, prmStateJoint, and prmVelocityCartesianGet.

◆ SerializeRaw()

virtual void cmnGenericObject::SerializeRaw ( std::ostream & outputStream ) const

virtual

Serialize the content of the object without any extra information, i.e. no class type nor format version. The "receiver" is supposed to already know what to expect.

◆ Services()

virtual const cmnClassServicesBase * cmnGenericObject::Services ( void ) const

pure virtual

Pure virtual method to access the class services. The derived classes should always declare and implement this method using the macros CMN_DECLARE_SERVICES, CMN_DECLARE_SERVICES_INSTANTIATION and CMN_IMPLEMENT_SERVICES. In NO WAY, a user should redefine/overload this method otherwise.

Returns: A pointer on the class services. This points to the unique instance of cmnClassServiceBase for a given class.

See also: cmnClassRegister cmnClassServiceBase

Implemented in DeRefType< _elementType >, mtsGenericObjectProxyBase< _elementType >, mtsGenericObjectProxyBase< T >, RefType< _elementType >, and value_type< _elementType >.

◆ ToStream()

virtual void cmnGenericObject::ToStream ( std::ostream & outputStream ) const

virtual

The default ToStream method returns the name of the class. This method must be overloaded to provide a useful message.

◆ ToStreamRaw()

virtual void cmnGenericObject::ToStreamRaw	(	std::ostream &	outputStream,
		const char	delimiter = ' ',
		bool	headerOnly = false,
		const std::string &	headerPrefix = "" ) const

virtual

Unformatted text output. Delimiter can be used to create CSV data files if the object requires multiple values (e.g. vector, matrix, ). When headerOnly is set to true, the method should create a label for each value (e.g. v1, v2, v3). The prefix can be used to generated a more useful label (e.g. position-v1)

◆ ToString()

std::string cmnGenericObject::ToString ( void ) const

Formatted IO to a string. This method relies on ToStream which should be overloaded for each class.

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

tmp/cisst-saw/cisst/cisstCommon/cmnGenericObject.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~cmnGenericObject()

Member Function Documentation

◆ DeSerializeRaw()

◆ FromStreamRaw()

◆ GetLogMultiplexer()

◆ ReconstructFrom()

◆ Scalar()

◆ ScalarDescription()

◆ ScalarNumber()

◆ ScalarNumberIsFixed()

◆ SerializeRaw()

◆ Services()

◆ ToStream()

◆ ToStreamRaw()

◆ ToString()