Detailed Description

This class represents a std::string derived class which is also CSerializable.

See also:: CSerializable

#include <mrpt/utils/CTypeSelector.h>

Inheritance diagram for mrpt::utils::CTypeSelector:

Public Member Functions
	CTypeSelector (std::string posibilitiesList="", std::string defaultType="")
	Default constructor.
virtual	~CTypeSelector ()
	Destructor.
void	getTypePosibilities (std::vector< std::string > &outPosibilities) const
	Returns the set of posibilities in the "type" represented by this class.
std::string	getType () const
	Gets the currently selected type, from the set of posibilities.
bool	isType (const char *type) const
	Fast check for a given type, returns true if the selection is exactly the specified type name.
bool	isType (const std::string &type) const
	Fast check for a given type, returns true if the selection is exactly the specified type name.
void	setType (const std::string &type)
	Sets the currently selected type.
int	checkTypeIndex (const std::string &type) const
	Returns the index of a given type within the list of all possible types, or -1 if the given string is not a valid type.
mrpt::utils::CObjectPtr	duplicateGetSmartPtr () const
	Returns a copy of the object, indepently of its class, as a smart pointer (the newly created object will exist as long as any copy of this smart pointer).
CObject *	clone () const
	Cloning interface for smart pointers.
Static Public Attributes
static const mrpt::utils::TRuntimeClassId	classCObject
Protected Member Functions
virtual void	writeToStream (mrpt::utils::CStream &out, int *getVersion) const =0
	Introduces a pure virtual method responsible for writing to a CStream.
virtual void	readFromStream (mrpt::utils::CStream &in, int version)=0
	Introduces a pure virtual method responsible for loading from a CStream This can not be used directly be users, instead use "stream >> object;" for reading it from a stream or "stream >> object_ptr;" if the class is unknown apriori.
Protected Attributes
std::vector< std::string >	possibleTypes
	The possibilities.
unsigned int	selection
	The selected one:
RTTI stuff
static const mrpt::utils::TRuntimeClassId	classCSerializable
class	mrpt::utils::CStream
RTTI stuff
typedef CTypeSelectorPtr	SmartPtr
static mrpt::utils::CLASSINIT	_init_CTypeSelector
static mrpt::utils::TRuntimeClassId	classCTypeSelector
static const mrpt::utils::TRuntimeClassId *	classinfo
static const mrpt::utils::TRuntimeClassId *	_GetBaseClass ()
virtual const mrpt::utils::TRuntimeClassId *	GetRuntimeClass () const
	Returns information about the class of an object in runtime.
virtual mrpt::utils::CObject *	duplicate () const
	Returns a copy of the object, indepently of its class.
static mrpt::utils::CObject *	CreateObject ()
static CTypeSelectorPtr	Create ()

Member Typedef Documentation

typedef CTypeSelectorPtr mrpt::utils::CTypeSelector::SmartPtr

A typedef for the associated smart pointer

Definition at line 47 of file CTypeSelector.h.

Constructor & Destructor Documentation

mrpt::utils::CTypeSelector::CTypeSelector	(	std::string	posibilitiesList = `""`,
		std::string	defaultType = `""`
	)

Default constructor.

Parameters:

posibilitiesList	The list of options, as a comma-separated-string, for example: "type 1,other type 2,type_3"
defaultType	Default type value

virtual mrpt::utils::CTypeSelector::~CTypeSelector ( ) [virtual]

Destructor.

Member Function Documentation

static const mrpt::utils::TRuntimeClassId* mrpt::utils::CTypeSelector::_GetBaseClass ( ) [static, protected]

Reimplemented from mrpt::utils::CSerializable.

int mrpt::utils::CTypeSelector::checkTypeIndex ( const std::string & type ) const

Returns the index of a given type within the list of all possible types, or -1 if the given string is not a valid type.

CObject* mrpt::utils::CObject::clone ( ) const [inline, inherited]

Cloning interface for smart pointers.

Reimplemented in mrpt::opengl::CRenderizable, and mrpt::opengl::CRenderizableDisplayList.

Definition at line 154 of file CObject.h.

static CTypeSelectorPtr mrpt::utils::CTypeSelector::Create ( ) [static]

static mrpt::utils::CObject* mrpt::utils::CTypeSelector::CreateObject ( ) [static]

virtual mrpt::utils::CObject* mrpt::utils::CTypeSelector::duplicate ( ) const [virtual]

Returns a copy of the object, indepently of its class.

Implements mrpt::utils::CObject.

mrpt::utils::CObjectPtr mrpt::utils::CObject::duplicateGetSmartPtr ( ) const [inline, inherited]

Returns a copy of the object, indepently of its class, as a smart pointer (the newly created object will exist as long as any copy of this smart pointer).

Definition at line 151 of file CObject.h.

virtual const mrpt::utils::TRuntimeClassId* mrpt::utils::CTypeSelector::GetRuntimeClass ( ) const [virtual]

Returns information about the class of an object in runtime.

Reimplemented from mrpt::utils::CSerializable.

std::string mrpt::utils::CTypeSelector::getType ( ) const

Gets the currently selected type, from the set of posibilities.

See also:: setType,getTypePosibilities

Exceptions:

std::exception If currently there is not a valid selection.

void mrpt::utils::CTypeSelector::getTypePosibilities ( std::vector< std::string > & outPosibilities ) const

Returns the set of posibilities in the "type" represented by this class.

bool mrpt::utils::CTypeSelector::isType ( const char * type ) const

Fast check for a given type, returns true if the selection is exactly the specified type name.

bool mrpt::utils::CTypeSelector::isType ( const std::string & type ) const

Fast check for a given type, returns true if the selection is exactly the specified type name.

virtual void mrpt::utils::CSerializable::readFromStream	(	mrpt::utils::CStream &	in,
		int	version
	)		`[protected, pure virtual, inherited]`

Introduces a pure virtual method responsible for loading from a CStream This can not be used directly be users, instead use "stream >> object;" for reading it from a stream or "stream >> object_ptr;" if the class is unknown apriori.

Parameters:

in	The input binary stream where the object data must read from.
version	The version of the object stored in the stream: use this version number in your code to know how to read the incoming data.

Exceptions:

std::exception On any error, see CStream::ReadBuffer

See also:: CStream

Implemented in mrpt::math::CMatrixD, and mrpt::math::CMatrix.

void mrpt::utils::CTypeSelector::setType ( const std::string & type )

Sets the currently selected type.

See also:: getType,getTypePosibilities

Exceptions:

std::exception On trying to select a type not in the list of posible values.

virtual void mrpt::utils::CSerializable::writeToStream	(	mrpt::utils::CStream &	out,
		int *	getVersion
	)		const `[protected, pure virtual, inherited]`

Introduces a pure virtual method responsible for writing to a CStream.

This can not be used directly be users, instead use "stream << object;" for writing it to a stream.

Parameters:

out	The output binary stream where object must be dumped.
getVersion	If NULL, the object must be dumped. If not, only the version of the object dump must be returned in this pointer. This enables the versioning of objects dumping and backward compatibility with previously stored data.

Exceptions:

std::exception On any error, see CStream::WriteBuffer