Public Member Functions | Static Public Member Functions | Protected Attributes | Static Protected Attributes
constrained_ik::constraint_types::ConstraintType Struct Reference

A structure for ConstraintTypes enum providing addition functionality like enumToString and stringToEnum. More...

#include <enum_types.h>

List of all members.

Public Member Functions

 ConstraintType (ConstraintTypes constraint_type)
 ConstraintType constructor.
ConstraintTypes getType () const
 Gets the enumerator.
void setType (ConstraintTypes constraint_type)
 Sets the enumerator type.
void setType (std::string constraint_type_name)
 Sets the enumerator type given the string representation.
std::string toString () const
 A string representation of the enumerator.

Static Public Member Functions

static std::string enumToString (ConstraintTypes constraint_type)
 Coverts ConstraintTypes value to its string representation.
static ConstraintTypes stringToEnum (std::string constraint_type_name)
 Converts string to ConstraintTypes value.

Protected Attributes

ConstraintTypes type_

Static Protected Attributes

static const std::map
< std::string, ConstraintTypes > 
name_to_enum_map_ = boost::assign::map_list_of ("primary", Primary) ("auxiliary", Auxiliary) ("inactive", Inactive)
static const std::string names_ [] = {"Primary", "Auxiliary", "Inactive"}

Detailed Description

A structure for ConstraintTypes enum providing addition functionality like enumToString and stringToEnum.

Definition at line 51 of file enum_types.h.


Constructor & Destructor Documentation

constrained_ik::constraint_types::ConstraintType::ConstraintType ( ConstraintTypes  constraint_type) [inline]

ConstraintType constructor.

Parameters:
constraint_typeenumerator value (Primary, Auxiliary, Inactive)

Definition at line 57 of file enum_types.h.


Member Function Documentation

static std::string constrained_ik::constraint_types::ConstraintType::enumToString ( ConstraintTypes  constraint_type) [inline, static]

Coverts ConstraintTypes value to its string representation.

Parameters:
constraint_typetype enumerator value (Primary, Auxiliary, Inactive)
Returns:
std::string

Definition at line 89 of file enum_types.h.

Gets the enumerator.

Returns:
ConstraintTypes

Definition at line 70 of file enum_types.h.

void constrained_ik::constraint_types::ConstraintType::setType ( ConstraintTypes  constraint_type) [inline]

Sets the enumerator type.

Parameters:
constraint_typeenumerator value (Primary, Auxiliary, Inactive)

Definition at line 76 of file enum_types.h.

void constrained_ik::constraint_types::ConstraintType::setType ( std::string  constraint_type_name) [inline]

Sets the enumerator type given the string representation.

Parameters:
constraint_type_nameenumerator string value (Primary, Auxiliary, Inactive)

Definition at line 82 of file enum_types.h.

ConstraintTypes ConstraintType::stringToEnum ( std::string  constraint_type_name) [static]

Converts string to ConstraintTypes value.

Parameters:
constraint_type_nameenumerator string value (Primary, Auxiliary, Inactive)
Returns:
ConstraintTypes

Definition at line 38 of file enum_types.cpp.

A string representation of the enumerator.

Returns:
std::string

Definition at line 64 of file enum_types.h.


Member Data Documentation

const std::map< std::string, ConstraintTypes > ConstraintType::name_to_enum_map_ = boost::assign::map_list_of ("primary", Primary) ("auxiliary", Auxiliary) ("inactive", Inactive) [static, protected]

Map of ConstraintTypes string name to ConstraintType

Definition at line 101 of file enum_types.h.

const std::string ConstraintType::names_ = {"Primary", "Auxiliary", "Inactive"} [static, protected]

list of string names for ConstraintTypes

Definition at line 100 of file enum_types.h.

constraint type

Definition at line 99 of file enum_types.h.


The documentation for this struct was generated from the following files:


constrained_ik
Author(s): Chris Lewis , Jeremy Zoss , Dan Solomon
autogenerated on Sat Jun 8 2019 19:23:46