This class represents a std::string derived class which is also CSerializable.
Definition at line 25 of file CTypeSelector.h.
#include <mrpt/utils/CTypeSelector.h>
Public Member Functions | |
void * | operator new (size_t size) |
void * | operator new[] (size_t size) |
void | operator delete (void *ptr) throw () |
void | operator delete[] (void *ptr) throw () |
void | operator delete (void *memory, void *ptr) throw () |
void * | operator new (size_t size, const std::nothrow_t &) throw () |
void | operator delete (void *ptr, const std::nothrow_t &) throw () |
CTypeSelector (std::string posibilitiesList="", std::string defaultType="") | |
Default constructor. More... | |
virtual | ~CTypeSelector () |
Destructor. More... | |
void | getTypePosibilities (std::vector< std::string > &outPosibilities) const |
Returns the set of posibilities in the "type" represented by this class. More... | |
std::string | getType () const |
Gets the currently selected type, from the set of posibilities. More... | |
bool | isType (const char *type) const |
Fast check for a given type, returns true if the selection is exactly the specified type name. More... | |
bool | isType (const std::string &type) const |
Fast check for a given type, returns true if the selection is exactly the specified type name. More... | |
void | setType (const std::string &type) |
Sets the currently selected type. More... | |
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. More... | |
virtual mxArray * | writeToMatlab () const |
Introduces a pure virtual method responsible for writing to a mxArray Matlab object, typically a MATLAB struct whose contents are documented in each derived class. More... | |
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). More... | |
CObject * | clone () const |
Cloning interface for smart pointers. More... | |
Static Public Member Functions | |
static void * | operator new (size_t size, void *ptr) |
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. More... | |
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. More... | |
Protected Attributes | |
std::vector< std::string > | possibleTypes |
The possibilities. More... | |
unsigned int | selection |
The selected one: More... | |
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. More... | |
virtual mrpt::utils::CObject * | duplicate () const |
Returns a copy of the object, indepently of its class. More... | |
static mrpt::utils::CObject * | CreateObject () |
static CTypeSelectorPtr | Create () |
typedef CTypeSelectorPtr mrpt::utils::CTypeSelector::SmartPtr |
A typedef for the associated smart pointer
Definition at line 28 of file CTypeSelector.h.
mrpt::utils::CTypeSelector::CTypeSelector | ( | std::string | posibilitiesList = "" , |
std::string | defaultType = "" |
||
) |
Default constructor.
posibilitiesList | The list of options, as a comma-separated-string, for example: "type 1,other type 2,type_3" |
defaultType | Default type value |
|
virtual |
Destructor.
|
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.
|
inlineinherited |
|
static |
|
static |
|
virtual |
Returns a copy of the object, indepently of its class.
Implements mrpt::utils::CObject.
|
inlineinherited |
|
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.
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.
|
inline |
Definition at line 28 of file CTypeSelector.h.
|
inline |
Definition at line 28 of file CTypeSelector.h.
|
inline |
Definition at line 28 of file CTypeSelector.h.
|
inline |
Definition at line 28 of file CTypeSelector.h.
|
inline |
Definition at line 28 of file CTypeSelector.h.
|
inline |
Definition at line 28 of file CTypeSelector.h.
|
inlinestatic |
Definition at line 28 of file CTypeSelector.h.
|
inline |
Definition at line 28 of file CTypeSelector.h.
|
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.
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. |
std::exception | On any error, see CStream::ReadBuffer |
Implements mrpt::utils::CSerializable.
void mrpt::utils::CTypeSelector::setType | ( | const std::string & | type | ) |
Sets the currently selected type.
std::exception | On trying to select a type not in the list of posible values. |
|
inlinevirtualinherited |
Introduces a pure virtual method responsible for writing to a mxArray
Matlab object, typically a MATLAB struct
whose contents are documented in each derived class.
mxArray
(caller is responsible of memory freeing) or NULL is class does not support conversion to MATLAB. Definition at line 79 of file CSerializable.h.
References BASE_IMPEXP, mrpt::utils::CSerializablePtr, DEFINE_MRPT_OBJECT_POST, mrpt::utils::ObjectToOctetVector(), mrpt::utils::ObjectToRawString(), mrpt::utils::ObjectToString(), mrpt::utils::OctetVectorToObject(), mrpt::utils::RawStringToObject(), and mrpt::utils::StringToObject().
|
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.
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. |
std::exception | On any error, see CStream::WriteBuffer |
Implements mrpt::utils::CSerializable.
|
staticprotected |
Definition at line 28 of file CTypeSelector.h.
|
staticinherited |
|
staticinherited |
Definition at line 42 of file CSerializable.h.
|
static |
Definition at line 28 of file CTypeSelector.h.
|
static |
Definition at line 28 of file CTypeSelector.h.
|
protected |
The possibilities.
Definition at line 32 of file CTypeSelector.h.
|
protected |
The selected one:
Definition at line 36 of file CTypeSelector.h.
Page generated by Doxygen 1.8.12 for MRPT 1.3.2 SVN: at Thu Nov 10 13:22:34 UTC 2016 |