Main MRPT website > C++ reference for MRPT 1.4.0
List of all members | 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 25 of file CTypeSelector.h.

#include <mrpt/utils/CTypeSelector.h>

Inheritance diagram for mrpt::utils::CTypeSelector:
Inheritance graph

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 Member Functions

CSerializable virtual methods
void writeToStream (mrpt::utils::CStream &out, int *getVersion) const MRPT_OVERRIDE
 
void readFromStream (mrpt::utils::CStream &in, int version) MRPT_OVERRIDE
 

Protected Attributes

std::vector< std::string > possibleTypes
 The possibilities.
 
unsigned int selection
 The selected one:
 

RTTI stuff <br>

typedef CTypeSelectorPtr SmartPtr
 
static mrpt::utils::CLASSINIT _init_CTypeSelector
 
static mrpt::utils::TRuntimeClassId classCTypeSelector
 
static const mrpt::utils::TRuntimeClassIdclassinfo
 
static const mrpt::utils::TRuntimeClassId_GetBaseClass ()
 
virtual const mrpt::utils::TRuntimeClassIdGetRuntimeClass () const MRPT_OVERRIDE
 
virtual mrpt::utils::CObjectduplicate () const MRPT_OVERRIDE
 
static mrpt::utils::CObjectCreateObject ()
 
static CTypeSelectorPtr Create ()
 

Member Typedef Documentation

◆ SmartPtr

A typedef for the associated smart pointer

Definition at line 28 of file CTypeSelector.h.

Constructor & Destructor Documentation

◆ CTypeSelector()

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

◆ ~CTypeSelector()

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

Destructor.

Member Function Documentation

◆ _GetBaseClass()

static const mrpt::utils::TRuntimeClassId * mrpt::utils::CTypeSelector::_GetBaseClass ( )
staticprotected

◆ checkTypeIndex()

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.

◆ Create()

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

◆ CreateObject()

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

◆ duplicate()

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

◆ GetRuntimeClass()

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

◆ getType()

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.

◆ getTypePosibilities()

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

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

◆ isType() [1/2]

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.

◆ isType() [2/2]

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.

◆ readFromStream()

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

◆ setType()

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.

◆ writeToStream()

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

Member Data Documentation

◆ _init_CTypeSelector

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

Definition at line 28 of file CTypeSelector.h.

◆ classCTypeSelector

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

Definition at line 28 of file CTypeSelector.h.

◆ classinfo

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

Definition at line 28 of file CTypeSelector.h.

◆ possibleTypes

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

The possibilities.

Definition at line 32 of file CTypeSelector.h.

◆ selection

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

The selected one:

Definition at line 36 of file CTypeSelector.h.




Page generated by Doxygen 1.9.6 for MRPT 1.4.0 SVN: at Fri Jan 20 02:28:26 UTC 2023