CPNS::ControllerAssignment Class Reference

Controller assignment definition class. More...

Collaboration diagram for CPNS::ControllerAssignment:

Public Member Functions
CPNS::Endpoint	GetTarget () const
	Target endpoint. More...
CPNS::Enums::MessageTypes	GetMessageType () const
	Message type, matching CPNS::Enums::MessageTypes. More...
void	SetMessageType (CPNS::Enums::MessageTypes const msgType)
CPNS::uint16	GetMessageNumber () const
	Message Number. More...
void	SetMessageNumber (CPNS::uint16 const wNumber)
CPNS::uint16	GetMessageIndex () const
	Message Index. More...
void	SetMessageIndex (CPNS::uint16 const wIndex)
CPNS::uint16	GetInformationProfile () const
	Information profile related to the message type. More...
CPNS::Enums::AssignControllerAvailableValues	GetAvailableValues () const
	Available extra values. More...
CPNS::uint16	GetValueDown () const
	Value for Down action. More...
CPNS::uint16	GetValueUp () const
	Value for Up action. More...
	ControllerAssignment ()
	Default constructor. More...
	ControllerAssignment (CPNS::Endpoint const &target, CPNS::Enums::MessageTypes const msgType, CPNS::uint16 const wMsgNum, CPNS::uint16 const wMsgIndex, CPNS::uint16 const wInformationProfile, CPNS::Enums::AssignControllerAvailableValues const availableValues, CPNS::uint16 const wValueDown, CPNS::uint16 const wValueUp)
	Constructor. More...
	ControllerAssignment (ControllerAssignment const &data)
	Constructor. More...
CPNS::boolean	IsEmpty () const
	Empty check. More...
CPNS::UTF8String	ToString () const
	String representation. More...
CPNS::ParameterID	GetTargetParameterID ()

Static Public Attributes
static ControllerAssignment	NullControllerAssignment
	Empty controller id value. More...

Detailed Description

Controller assignment definition class.

Constructor & Destructor Documentation

CPNS::ControllerAssignment::ControllerAssignment ( )

inline

Default constructor.

CPNS::ControllerAssignment::ControllerAssignment ( CPNS::Endpoint const &  target, CPNS::Enums::MessageTypes const  msgType, CPNS::uint16 const  wMsgNum, CPNS::uint16 const  wMsgIndex, CPNS::uint16 const  wInformationProfile, CPNS::Enums::AssignControllerAvailableValues const  availableValues, CPNS::uint16 const  wValueDown, CPNS::uint16 const  wValueUp  )

inline

Constructor.

Parameters

[in]	msgType	The message type
[in]	wMsgNum	The message number
[in]	wMsgIndex	Message index. CAUTION: first item is related to message index 1!
[in]	wInformationProfile	information profile related to the message type.
[in]	availableValues	tells which of the following optional values are valid (if it makes sense for the assigned message).
[in]	wValueDown	The value to be sent on button down event. Usually used with Selectors assigned to PushButton controllers.
[in]	wValueUp	The value to be sent on button up event. Usually used with Selectors assigned to PushButton controllers.

CPNS::ControllerAssignment::ControllerAssignment ( ControllerAssignment const &  data )

inline

Constructor.

Parameters

[in]

data

Controller assignment to copy

Member Function Documentation

CPNS::Enums::AssignControllerAvailableValues CPNS::ControllerAssignment::GetAvailableValues ( ) const

inline

Available extra values.

CPNS::uint16 CPNS::ControllerAssignment::GetInformationProfile ( ) const

inline

Information profile related to the message type.

See Also

CPNS::Enums::ModifierInformationProfile | CPNS::Enums::SelectorInformationProfile | CPNS::Enums::TextInformationProfile

CPNS::uint16 CPNS::ControllerAssignment::GetMessageIndex ( ) const

inline

Message Index.

CPNS::uint16 CPNS::ControllerAssignment::GetMessageNumber ( ) const

inline

Message Number.

CPNS::Enums::MessageTypes CPNS::ControllerAssignment::GetMessageType ( ) const

inline

Message type, matching CPNS::Enums::MessageTypes.

CPNS::Endpoint CPNS::ControllerAssignment::GetTarget ( ) const

inline

Target endpoint.

CPNS::uint16 CPNS::ControllerAssignment::GetValueDown ( ) const

inline

Value for Down action.

CPNS::uint16 CPNS::ControllerAssignment::GetValueUp ( ) const

inline

Value for Up action.

CPNS::boolean CPNS::ControllerAssignment::IsEmpty ( ) const

inline

Empty check.

Returns

TRUE if all fields are empty

CPNS::UTF8String CPNS::ControllerAssignment::ToString

(

)

const

String representation.

Returns

an hexadecimal view of the parameter id

Member Data Documentation

ControllerAssignment CPNS::ControllerAssignment::NullControllerAssignment

static

Empty controller id value.