jevois::ParameterSummary Class Reference

#include <jevois/Component/Parameter.H>

ParameterSummary provides a summary about a parameter.

This is used mainly for graphical interfaces.

Definition at line 84 of file Parameter.H.

Collaboration diagram for jevois::ParameterSummary:

Public Attributes
std::string	descriptor
	Descriptor. This is the name of the parameter, qualified by a chain of component names.
std::string	name
	Plain name of the parameter.
std::string	description
	Description of the parameter.
std::string	valuetype
	Parameter value type, as a string.
std::string	defaultvalue
	Default value of the parameter, as a string.
std::string	value
	Current value of the parameter, as a string.
std::string	validvalues
	Description of the parameter's valid values specification, as a string.
std::string	category
	Category of the parameter, as a string.
std::string	categorydescription
	Category description.
bool	frozen
	Flag that indicates whether parameter is frozen.
bool	hidden
	Flag that indicates whether parameter is hidden.

Member Data Documentation

category

std::string jevois::ParameterSummary::category

Category of the parameter, as a string.

Definition at line 109 of file Parameter.H.

Referenced by jevois::GUIhelper::drawParameters(), and jevois::Component::paramInfo().

categorydescription

std::string jevois::ParameterSummary::categorydescription

Category description.

Definition at line 112 of file Parameter.H.

Referenced by jevois::Component::paramInfo().

defaultvalue

std::string jevois::ParameterSummary::defaultvalue

Default value of the parameter, as a string.

Definition at line 100 of file Parameter.H.

Referenced by jevois::Component::paramInfo().

description

std::string jevois::ParameterSummary::description

Description of the parameter.

Definition at line 94 of file Parameter.H.

Referenced by jevois::Component::paramInfo().

descriptor

std::string jevois::ParameterSummary::descriptor

Descriptor. This is the name of the parameter, qualified by a chain of component names.

Definition at line 88 of file Parameter.H.

frozen

bool jevois::ParameterSummary::frozen

Flag that indicates whether parameter is frozen.

Definition at line 115 of file Parameter.H.

Referenced by jevois::Component::paramInfo().

hidden

bool jevois::ParameterSummary::hidden

Flag that indicates whether parameter is hidden.

Definition at line 118 of file Parameter.H.

Referenced by jevois::Component::paramInfo().

name

std::string jevois::ParameterSummary::name

Plain name of the parameter.

Definition at line 91 of file Parameter.H.

Referenced by jevois::GUIhelper::drawParameters(), and jevois::Component::paramInfo().

validvalues

std::string jevois::ParameterSummary::validvalues

Description of the parameter's valid values specification, as a string.

Definition at line 106 of file Parameter.H.

Referenced by jevois::Component::paramInfo().

value

std::string jevois::ParameterSummary::value

Current value of the parameter, as a string.

Definition at line 103 of file Parameter.H.

Referenced by jevois::Component::paramInfo().

valuetype

std::string jevois::ParameterSummary::valuetype

Parameter value type, as a string.

Definition at line 97 of file Parameter.H.

Referenced by jevois::Component::paramInfo().

---

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

• include/jevois/Component/Parameter.H