Detailed Description

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

See Also: CSerializable

Definition at line 44 of file CTypeSelector.h.

#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

RTTI stuff
static const mrpt::utils::TRuntimeClassId	classCSerializable

Protected Member Functions
CSerializable virtual methods
void	writeToStream (mrpt::utils::CStream &out, int *getVersion) const
	Introduces a pure virtual method responsible for writing to a CStream.

void	readFromStream (mrpt::utils::CStream &in, int version)
	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
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 ( )

staticprotected

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

inlineinherited

Cloning interface for smart pointers.

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

inlineinherited

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.

void mrpt::utils::CTypeSelector::readFromStream	(	mrpt::utils::CStream &	in,
		int	version
	)

protectedvirtual

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

Implements mrpt::utils::CSerializable.

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.

void mrpt::utils::CTypeSelector::writeToStream	(	mrpt::utils::CStream &	out,
		int *	getVersion
	)		const

protectedvirtual

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

See Also: CStream

Implements mrpt::utils::CSerializable.

Member Data Documentation

mrpt::utils::CLASSINIT mrpt::utils::CTypeSelector::_init_CTypeSelector

staticprotected

Definition at line 47 of file CTypeSelector.h.

const mrpt::utils::TRuntimeClassId mrpt::utils::CObject::classCObject

staticinherited

Definition at line 139 of file CObject.h.

const mrpt::utils::TRuntimeClassId mrpt::utils::CSerializable::classCSerializable

staticinherited

Definition at line 56 of file CSerializable.h.

mrpt::utils::TRuntimeClassId mrpt::utils::CTypeSelector::classCTypeSelector

static

Definition at line 47 of file CTypeSelector.h.

const mrpt::utils::TRuntimeClassId* mrpt::utils::CTypeSelector::classinfo

static

Definition at line 47 of file CTypeSelector.h.

std::vector<std::string> mrpt::utils::CTypeSelector::possibleTypes

protected

The possibilities.

Definition at line 51 of file CTypeSelector.h.

unsigned int mrpt::utils::CTypeSelector::selection

protected

The selected one:

Definition at line 55 of file CTypeSelector.h.

Detailed Description

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

RTTI stuff

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation