coral::model::SlaveTypeDescription Class Reference

A description of a slave type. More...

#include "coral/model.hpp"

Public Types
typedef boost::select_second_const_range< VariablesMap >	ConstVariablesRange
	The return type of the Variables() function.

Public Member Functions
CORAL_DEFINE_DEFAULT_MOVE(SlaveTypeDescription, m_name, m_uuid, m_description, m_author, m_version, m_variables) const std const std::string &	UUID () const
	The slave type name. More...
const std::string &	Description () const
	A human-readable description of the slave type.
const std::string &	Author () const
	Author information.
const std::string &	Version () const
	Version information.
ConstVariablesRange	Variables () const
	Information about all variables.
const VariableDescription &	Variable (VariableID id) const
	Information about the variable with the given ID, O(log n) lookup. More...

Detailed Description

A description of a slave type.

Member Function Documentation

CORAL_DEFINE_DEFAULT_MOVE (SlaveTypeDescription, m_name, m_uuid, m_description, m_author, m_version, m_variables) const std const std::string& coral::model::SlaveTypeDescription::UUID

(

)

const

The slave type name.

A universally unique identifier (UUID) for the slave type.

const VariableDescription& coral::model::SlaveTypeDescription::Variable

(

VariableID

id

)

const

Information about the variable with the given ID, O(log n) lookup.

Exceptions

std::out_of_range

If there is no variable with the given ID.

---

The documentation for this class was generated from the following file:

• coral/model.hpp