mrpt::utils::CTypeSelector Class Reference

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

#include <mrpt/utils/CTypeSelector.h>

Inheritance diagram for mrpt::utils::CTypeSelector:

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:.

---

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.

---

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

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.

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 std::string &

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 char *

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::exception

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

---

Member Data Documentation

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.