Param Struct Reference

#include <Connectivity_SessionDefs.h>

Inheritance diagram for Param:

Public Member Functions
	Param ()
	Param (const std::string &paramName, const std::string &type, const std::string &defaultVal, std::list< std::string > &allowedVals, const std::string &description, bool required, bool referenceOnly)
const std::string	toString ()
map_t	getCP (const std::string &eventType) const

Public Attributes
std::string	m_name
std::string	m_type
std::string	m_defaultVal
std::list< std::string >	m_allowedVals
std::string	m_description
bool	m_required
bool	m_referenceOnly

Detailed Description

Param structure to hold all the information of a session. This is base class for SessionParam and CapabilityParam.

Constructor & Destructor Documentation

Param::Param ( )

inline

Param constructor

Param::Param ( const std::string &  paramName, const std::string &  type, const std::string &  defaultVal, std::list< std::string > &  allowedVals, const std::string &  description, bool  required, bool  referenceOnly  )

inline

Parameterized Param constructor

Member Function Documentation

map_t Param::getCP

(

const std::string &

eventType

)

const

getCP method

Parameters

eventType

Type of event for which control param is required.

Returns

control param schema in form of map_t

const std::string Param::toString ( )

inline

toString method for Param class

Member Data Documentation

std::list<std::string> Param::m_allowedVals

Allowed values

std::string Param::m_defaultVal

Default Value

std::string Param::m_description

Param description

std::string Param::m_name

Param Name

bool Param::m_referenceOnly

Parameter referenceOnly

bool Param::m_required

Parameter required or not

std::string Param::m_type

Param Type

---

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

• Connectivity_SessionDefs.h