sf::gmi::ParamInfo Struct Reference

Structure to hold parameter information. More...

#include <GmiInterface.h>

Collaboration diagram for sf::gmi::ParamInfo:

Public Member Functions
	ParamInfo ()=default
	Default constructor.
	ParamInfo (const ParamInfo &pi)
	Copy constructor.
ParamInfo &	operator= (const ParamInfo &pi)
	Assignment operator.
void	init ()
	initialize/reset the instance as when it was constructed.
ParamInfo &	copyFrom (const ParamInfo &pi)
	Sets the e instance as when it was constructed.

Public Attributes
IdType	Id {0}
	Holds a unique id for the current situation.
int	Controller {0}
	Holds the controller instance number.
unsigned	Axis {0}
	Holds the gate number this gate belongs to. When Axis is UINT_MAX the param is not an axis related param.
unsigned	Index {0}
	Param index in the hierarchy of the gate or non gate params.
std::string	Name
	Name of the parameter.
std::string	Unit
	Unit of the parameter.
std::string	Description
	Usage off the parameter of the parameter.
Value	Round {Value::vitUndefined}
	Round or step value of the parameter.
Value	Default {Value::vitUndefined}
	Default or start value.
Value	Minimum {Value::vitUndefined}
	Minimum allowed value.
Value	Maximum {Value::vitUndefined}
	Maximum allowed value.
ParamState::Vector	States
	Number of specified states for this.
int	Flags {0}
	Parameter is readonly.

Detailed Description

Structure to hold parameter information.

Constructor & Destructor Documentation

ParamInfo() [1/2]

sf::gmi::ParamInfo::ParamInfo ( )

default

Default constructor.

ParamInfo() [2/2]

sf::gmi::ParamInfo::ParamInfo ( const ParamInfo &  pi )

inline

Copy constructor.

Parameters

pi

Member Function Documentation

copyFrom()

ParamInfo & sf::gmi::ParamInfo::copyFrom

(

const ParamInfo &

pi

)

Sets the e instance as when it was constructed.

init()

void sf::gmi::ParamInfo::init

(

)

initialize/reset the instance as when it was constructed.

operator=()

ParamInfo & sf::gmi::ParamInfo::operator=

(

const ParamInfo &

pi

)

Assignment operator.

Parameters

pi

Returns

Member Data Documentation

Axis

unsigned sf::gmi::ParamInfo::Axis {0}

Holds the gate number this gate belongs to. When Axis is UINT_MAX the param is not an axis related param.

Controller

int sf::gmi::ParamInfo::Controller {0}

Holds the controller instance number.

Default

Value sf::gmi::ParamInfo::Default {Value::vitUndefined}

Default or start value.

Description

std::string sf::gmi::ParamInfo::Description

Usage off the parameter of the parameter.

Flags

int sf::gmi::ParamInfo::Flags {0}

Parameter is readonly.

Id

IdType sf::gmi::ParamInfo::Id {0}

Holds a unique id for the current situation.

Index

unsigned sf::gmi::ParamInfo::Index {0}

Param index in the hierarchy of the gate or non gate params.

Maximum

Value sf::gmi::ParamInfo::Maximum {Value::vitUndefined}

Maximum allowed value.

Minimum

Value sf::gmi::ParamInfo::Minimum {Value::vitUndefined}

Minimum allowed value.

Name

std::string sf::gmi::ParamInfo::Name

Name of the parameter.

Round

Value sf::gmi::ParamInfo::Round {Value::vitUndefined}

Round or step value of the parameter.

States

ParamState::Vector sf::gmi::ParamInfo::States

Number of specified states for this.

Unit

std::string sf::gmi::ParamInfo::Unit

Unit of the parameter.

---

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

• GmiInterface.h