DUNE::Tasks::Parameter Class Reference

Classes
struct	ValuesIf

Public Types

Public Member Functions
	Parameter (const std::string &param_name, const std::string &type_name)
	~Parameter (void)
void	reader (AbstractParameterParser *r)
void	read (const std::string &val)
bool	commit (void)
std::string	name (void) const
std::string	value (void) const
std::string	defaultValue (void) const
Parameter &	defaultValue (const std::string &val)
Parameter &	valuesIf (const std::string &if_param, const std::string &if_value, const std::string &a_values)
Units::Types	units (void) const
Parameter &	units (Units::Types val)
std::string	description (void) const
Parameter &	description (const std::string &val)
Parameter &	minimumValue (const std::string &min_value)
Parameter &	maximumValue (const std::string &max_value)
Parameter &	size (int size_value)
Parameter &	minimumSize (unsigned min_size)
Parameter &	maximumSize (unsigned max_size)
Parameter &	values (const std::string &list)
Parameter &	visibility (Visibility a_visibility)
Parameter &	visibility (const std::string &a_visibility)
Parameter &	scope (Scope a_scope)
Parameter &	scope (const std::string a_scope)
void	writeXML (std::ostream &os) const
bool	changed (void)
void	setChanged (bool enabled=true)
Visibility	getVisibility (void) const
Scope	getScope (void) const

Static Public Member Functions
static Visibility	visibilityFromString (const std::string &v)
static const char *	visibilityToString (Visibility v)
static Scope	scopeFromString (const std::string &s)
static const char *	scopeToString (Scope s)

Protected Attributes
std::string	m_name
std::string	m_type_name
std::string	m_desc
std::string	m_default
Units::Types	m_units
std::string	m_value
std::string	m_values
unsigned	m_min_size
unsigned	m_max_size
std::string	m_min_value
std::string	m_max_value
std::vector< ValuesIf * >	m_values_if
AbstractParameterParser *	m_reader
bool	m_changed
Visibility	m_visibility
Scope	m_scope

Member Enumeration Documentation

enum DUNE::Tasks::Parameter::Scope

Parameter scope.

Enumerator
SCOPE_GLOBAL	Parameter can be changed in all system states.
SCOPE_IDLE	Parameter can only be changed when the system is not performing plans/maneuvers.
SCOPE_PLAN	Parameter can be changed on a per plan basis.
SCOPE_MANEUVER	Parameter can be changed on a per maneuver basis.

enum DUNE::Tasks::Parameter::Visibility

Parameter visibility.

Enumerator
VISIBILITY_USER	Parameter is visible to the user.
VISIBILITY_DEVELOPER	Parameter is visible only to developers.

Constructor & Destructor Documentation

DUNE::Tasks::Parameter::Parameter	(	const std::string &	param_name,
		const std::string &	type_name
	)

Constructor.

DUNE::Tasks::Parameter::~Parameter

(

void

)

Destructor.

References m_reader, and m_values_if.

Member Function Documentation

bool DUNE::Tasks::Parameter::changed ( void  )

inline

References m_changed.

bool DUNE::Tasks::Parameter::commit ( void  )

inline

References DUNE::Tasks::AbstractParameterParser::commit(), and m_reader.

Referenced by DUNE::Tasks::ParameterTable::set().

std::string DUNE::Tasks::Parameter::defaultValue ( void  ) const

inline

References m_default.

Referenced by DUNE::Control::BasicAutopilot::BasicAutopilot(), DUNE::Navigation::BasicNavigation::BasicNavigation(), DUNE::Control::BasicRemoteOperation::BasicRemoteOperation(), DUNE::Tasks::Task::paramActive(), DUNE::Control::PathController::PathController(), DUNE::Control::ProxyPathController::ProxyPathController(), DUNE::Tasks::ParameterTable::set(), DUNE::Tasks::SimpleTransport::SimpleTransport(), Autonomy::TextActions::Task::Task(), Actuators::PWM::Task::Task(), Navigation::General::ROV::Task::Task(), and DUNE::Tasks::Task::Task().

Parameter& DUNE::Tasks::Parameter::defaultValue ( const std::string &  val )

inline

References m_default.

std::string DUNE::Tasks::Parameter::description ( void  ) const

inline

References m_desc.

Referenced by DUNE::Navigation::BasicNavigation::BasicNavigation(), and DUNE::Tasks::SimpleTransport::SimpleTransport().

Parameter& DUNE::Tasks::Parameter::description ( const std::string &  val )

inline

References m_desc.

Scope DUNE::Tasks::Parameter::getScope ( void  ) const

inline

References m_scope.

Visibility DUNE::Tasks::Parameter::getVisibility ( void  ) const

inline

References m_visibility.

Parameter& DUNE::Tasks::Parameter::maximumSize ( unsigned  max_size )

inline

References m_max_size, m_reader, and DUNE::Tasks::AbstractParameterParser::maximumSize().

Referenced by size().

Parameter& DUNE::Tasks::Parameter::maximumValue ( const std::string &  max_value )

inline

References m_max_value, m_reader, and DUNE::Tasks::AbstractParameterParser::maximumValue().

Parameter& DUNE::Tasks::Parameter::minimumSize ( unsigned  min_size )

inline

References m_min_size, m_reader, and DUNE::Tasks::AbstractParameterParser::minimumSize().

Referenced by size().

Parameter& DUNE::Tasks::Parameter::minimumValue ( const std::string &  min_value )

inline

References m_min_value, m_reader, and DUNE::Tasks::AbstractParameterParser::minimumValue().

std::string DUNE::Tasks::Parameter::name ( void  ) const

inline

References m_name.

Referenced by writeXML().

void DUNE::Tasks::Parameter::read

(

const std::string &

val

)

References m_name, m_reader, m_value, DUNE::Tasks::AbstractParameterParser::read(), DUNE::Utils::String::str(), and DUNE::Tasks::AbstractParameterParser::validate().

Referenced by DUNE::Tasks::ParameterTable::set().

void DUNE::Tasks::Parameter::reader

(

AbstractParameterParser *

r

)

References m_reader.

Referenced by DUNE::Tasks::ParameterTable::add().

Parameter& DUNE::Tasks::Parameter::scope ( Scope  a_scope )

inline

References m_scope, and writeXML().

Referenced by DUNE::Tasks::Task::paramActive().

Parameter & DUNE::Tasks::Parameter::scope

(

const std::string

a_scope

)

References m_scope, and scopeFromString().

Parameter::Scope DUNE::Tasks::Parameter::scopeFromString ( const std::string &  s )

static

Referenced by DUNE::Tasks::Task::deactivationFailed(), and scope().

const char * DUNE::Tasks::Parameter::scopeToString ( Scope  s )

static

Referenced by DUNE::Tasks::Task::paramActive(), and writeXML().

void DUNE::Tasks::Parameter::setChanged ( bool  enabled = true )

inline

References m_changed.

Referenced by DUNE::Tasks::ParameterTable::set().

Parameter& DUNE::Tasks::Parameter::size ( int  size_value )

inline

References maximumSize(), and minimumSize().

Units::Types DUNE::Tasks::Parameter::units ( void  ) const

inline

References m_units.

Referenced by DUNE::Navigation::BasicNavigation::BasicNavigation(), and DUNE::Tasks::Periodic::Periodic().

Parameter& DUNE::Tasks::Parameter::units ( Units::Types  val )

inline

References m_units.

std::string DUNE::Tasks::Parameter::value ( void  ) const

inline

References m_value.

Parameter& DUNE::Tasks::Parameter::values ( const std::string &  list )

inline

References m_reader, m_values, and DUNE::Tasks::AbstractParameterParser::values().

Referenced by writeXML().

Parameter& DUNE::Tasks::Parameter::valuesIf ( const std::string &  if_param, const std::string &  if_value, const std::string &  a_values  )

inline

References DUNE::Tasks::Parameter::ValuesIf::equals, m_values_if, DUNE::Tasks::Parameter::ValuesIf::name, and DUNE::Tasks::Parameter::ValuesIf::values.

Parameter& DUNE::Tasks::Parameter::visibility ( Visibility  a_visibility )

inline

Set parameter's visibility.

Parameters

[in]

a_visibility

desired visibility.

Returns

parameter reference.

References m_visibility.

Referenced by DUNE::Navigation::BasicNavigation::BasicNavigation(), and DUNE::Tasks::Task::paramActive().

Parameter & DUNE::Tasks::Parameter::visibility

(

const std::string &

a_visibility

)

Set parameter's visibility.

Parameters

[in]

a_visibility

desired visibility.

Returns

parameter reference.

References m_visibility, and visibilityFromString().

Parameter::Visibility DUNE::Tasks::Parameter::visibilityFromString ( const std::string &  v )

static

Referenced by visibility().

const char * DUNE::Tasks::Parameter::visibilityToString ( Visibility  v )

static

Referenced by DUNE::Tasks::Task::paramActive(), and writeXML().

void DUNE::Tasks::Parameter::writeXML

(

std::ostream &

os

)

const

References DUNE::Units::getAbbrev(), m_default, m_desc, m_max_size, m_max_value, m_min_size, m_min_value, m_name, m_scope, m_type_name, m_units, m_value, m_values, m_values_if, m_visibility, name(), scopeToString(), DUNE::uncastLexical(), values(), and visibilityToString().

Referenced by scope().

Member Data Documentation

bool DUNE::Tasks::Parameter::m_changed

protected

True if the value of this parameter changed.

Referenced by changed(), and setChanged().

std::string DUNE::Tasks::Parameter::m_default

protected

Default value.

Referenced by defaultValue(), and writeXML().

std::string DUNE::Tasks::Parameter::m_desc

protected

Description.

Referenced by description(), and writeXML().

unsigned DUNE::Tasks::Parameter::m_max_size

protected

Maximum size.

Referenced by maximumSize(), and writeXML().

std::string DUNE::Tasks::Parameter::m_max_value

protected

Maximum value.

Referenced by maximumValue(), and writeXML().

unsigned DUNE::Tasks::Parameter::m_min_size

protected

Minimum size.

Referenced by minimumSize(), and writeXML().

std::string DUNE::Tasks::Parameter::m_min_value

protected

Minimum value.

Referenced by minimumValue(), and writeXML().

std::string DUNE::Tasks::Parameter::m_name

protected

Name.

Referenced by name(), read(), and writeXML().

AbstractParameterParser* DUNE::Tasks::Parameter::m_reader

protected

String reader.

Referenced by commit(), maximumSize(), maximumValue(), minimumSize(), minimumValue(), read(), reader(), values(), and ~Parameter().

Scope DUNE::Tasks::Parameter::m_scope

protected

Parameter scope.

Referenced by getScope(), scope(), and writeXML().

std::string DUNE::Tasks::Parameter::m_type_name

protected

Type name.

Referenced by writeXML().

Units::Types DUNE::Tasks::Parameter::m_units

protected

Units.

Referenced by units(), and writeXML().

std::string DUNE::Tasks::Parameter::m_value

protected

Current value.

Referenced by read(), value(), and writeXML().

std::string DUNE::Tasks::Parameter::m_values

protected

Comma separated list of valid values.

Referenced by values(), and writeXML().

std::vector<ValuesIf*> DUNE::Tasks::Parameter::m_values_if

protected

Conditional comma separated list of valid values.

Referenced by valuesIf(), writeXML(), and ~Parameter().

Visibility DUNE::Tasks::Parameter::m_visibility

protected

Parameter visibility.

Referenced by getVisibility(), visibility(), and writeXML().

Collaboration diagram for DUNE::Tasks::Parameter: