Main MRPT website > C++ reference
MRPT logo
Public Member Functions | Protected Attributes

mrpt::utils::CTypeSelector Class Reference


Detailed Description

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

See also:
CSerializable

Definition at line 43 of file CTypeSelector.h.

#include <mrpt/utils/CTypeSelector.h>

Inheritance diagram for mrpt::utils::CTypeSelector:
Inheritance graph
[legend]

List of all members.

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.

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::CObjectduplicate () const
 Returns a copy of the object, indepently of its class.
static mrpt::utils::CObjectCreateObject ()
static CTypeSelectorPtr Create ()

Member Typedef Documentation

A typedef for the associated smart pointer

Definition at line 46 of file CTypeSelector.h.


Constructor & Destructor Documentation

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

Default constructor.

Parameters:
posibilitiesListThe list of options, as a comma-separated-string, for example: "type 1,other type 2,type_3"
defaultTypeDefault 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.

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.

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::exceptionIf 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::setType ( const std::string &  type )

Sets the currently selected type.

See also:
getType,getTypePosibilities
Exceptions:
std::exceptionOn trying to select a type not in the list of posible values.

Member Data Documentation

Definition at line 46 of file CTypeSelector.h.

Definition at line 46 of file CTypeSelector.h.

Definition at line 46 of file CTypeSelector.h.

std::vector<std::string> mrpt::utils::CTypeSelector::possibleTypes [protected]

The possibilities.

Definition at line 50 of file CTypeSelector.h.

unsigned int mrpt::utils::CTypeSelector::selection [protected]

The selected one:

Definition at line 54 of file CTypeSelector.h.




Page generated by Doxygen 1.7.2 for MRPT 0.9.4 SVN: at Mon Jan 10 22:30:30 UTC 2011