sf::RsaTypes::ParamInfo Struct Reference

Structure to hold parameter information. More...

#include <RsaTypes.h>

Collaboration diagram for sf::RsaTypes::ParamInfo:

Public Member Functions
	ParamInfo ()
	ParamInfo (const ParamInfo &pi)
ParamInfo &	operator= (const ParamInfo &pi)
void	Init ()
ParamInfo &	Copy (const ParamInfo &pi)

Public Attributes
IdType	Id {0}
unsigned	Gate {0}
unsigned	Index {0}
unsigned	Channel {0}
std::string	Name
std::string	Unit
std::string	Description
Value	Round
Value	Default
Value	Minimum
Value	Maximum
ParamStates	States
int	Flags {0}

Detailed Description

Structure to hold parameter information.

Constructor & Destructor Documentation

ParamInfo() [1/2]

sf::RsaTypes::ParamInfo::ParamInfo ( )

inline

ParamInfo() [2/2]

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

inline

Member Function Documentation

Copy()

ParamInfo & sf::RsaTypes::ParamInfo::Copy ( const ParamInfo &  pi )

inline

Init()

void sf::RsaTypes::ParamInfo::Init ( )

inline

operator=()

ParamInfo & sf::RsaTypes::ParamInfo::operator= ( const ParamInfo &  pi )

inline

Member Data Documentation

Channel

unsigned sf::RsaTypes::ParamInfo::Channel {0}

Holds the channel number of this parameter. When channel is UINT_MAX the param is not a gate related param.

Default

Value sf::RsaTypes::ParamInfo::Default

Default or start value.

Description

std::string sf::RsaTypes::ParamInfo::Description

Usage off the parameter of the parameter.

Flags

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

Parameter is readonly.

Gate

unsigned sf::RsaTypes::ParamInfo::Gate {0}

Holds the gate number this param belongs to. When gate is UINT_MAX the param is not a gate related param.

Id

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

Holds a unique id for the current situation.

Index

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

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

Maximum

Value sf::RsaTypes::ParamInfo::Maximum

Maximum allowed value.

Minimum

Value sf::RsaTypes::ParamInfo::Minimum

Minimum allowed value.

Name

std::string sf::RsaTypes::ParamInfo::Name

Name of the parameter.

Round

Value sf::RsaTypes::ParamInfo::Round

Round or step value of the parameter.

States

ParamStates sf::RsaTypes::ParamInfo::States

Number of specified states for this.

Unit

std::string sf::RsaTypes::ParamInfo::Unit

unit of the parameter.

---

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

• RsaTypes.h