CPNS::ParameterID Class Reference

Parameter ID definition class. More...

Collaboration diagram for CPNS::ParameterID:

Public Member Functions
CPNS::Enums::MessageTypes	GetMessageType () const
	Message type, matching CPNS::Enums::MessageTypes. More...
CPNS::uint16	GetInputID () const
	Related input ID. More...
CPNS::uint16	GetMessageNumber () const
	Message Number. More...
CPNS::uint16	GetMessageIndex () const
	Message Index. More...
	ParameterID ()
	Default constructor. More...
	ParameterID (CPNS::uint16 const wInputID, CPNS::Enums::MessageTypes const msgType, CPNS::uint16 const wMsgNum, CPNS::uint16 const wMsgIndex)
	Constructor. More...
	ParameterID (ParameterID const &data)
	Constructor. More...
CPNS::boolean	operator== (ParameterID const &a) const
	Equality check operator. More...
CPNS::boolean	operator!= (ParameterID const &a) const
	Difference check operator. More...
ParameterID &	operator= (ParameterID const &a)
	Assignment operator. More...
CPNS::boolean	IsEmpty () const
	Empty check. More...
CPNS::UTF8String	ToString () const
	String representation. More...
ParameterID	WithMessageNumber (CPNS::uint16 wMsgNum) const
	Get a copy of the ParameterID replacing the Message Number. More...
ParameterID	WithMessageIndex (CPNS::uint16 wMsgIndex) const
	Get a copy of the ParameterID replacing the Message Index. More...
CPNS::boolean	IsCompatibleWithConrollerType (CPNS::CombinedControllerTypes const ctrlType)

Static Public Attributes
static ParameterID	NullParameterID
	Empty section id value. More...
static ParameterID	AnyParameterID
	"Any" wildcard More...

Detailed Description

Parameter ID definition class.

This class contains a strong parameter identity related to a Device. Knowing a ParameterID and its owning Device gives enough information to build the related message and to know where to send it in order to update the Parameter.

Constructor & Destructor Documentation

CPNS::ParameterID::ParameterID ( )

inline

Default constructor.

CPNS::ParameterID::ParameterID ( CPNS::uint16 const  wInputID, CPNS::Enums::MessageTypes const  msgType, CPNS::uint16 const  wMsgNum, CPNS::uint16 const  wMsgIndex  )

inline

Constructor.

Parameters

[in]	wInputID	Related input ID
[in]	msgType	Message type, matching CPNS::Enums::MessageTypes
[in]	wMsgNum	Message Number
[in]	wMsgIndex	Message Index

CPNS::ParameterID::ParameterID ( ParameterID const &  data )

inline

Constructor.

Parameters

[in]

data

ParameterID to copy

Member Function Documentation

CPNS::uint16 CPNS::ParameterID::GetInputID ( ) const

inline

Related input ID.

CPNS::uint16 CPNS::ParameterID::GetMessageIndex ( ) const

inline

Message Index.

CPNS::uint16 CPNS::ParameterID::GetMessageNumber ( ) const

inline

Message Number.

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

inline

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

CPNS::boolean CPNS::ParameterID::IsEmpty ( ) const

inline

Empty check.

Returns

TRUE if all fields are empty

CPNS::boolean CPNS::ParameterID::operator!= ( ParameterID const &  a ) const

inline

Difference check operator.

ParameterID& CPNS::ParameterID::operator= ( ParameterID const &  a )

inline

Assignment operator.

CPNS::boolean CPNS::ParameterID::operator== ( ParameterID const &  a ) const

inline

Equality check operator.

CPNS::UTF8String CPNS::ParameterID::ToString

(

)

const

String representation.

Returns

an hexadecimal view of the parameter id

ParameterID CPNS::ParameterID::WithMessageIndex ( CPNS::uint16  wMsgIndex ) const

inline

Get a copy of the ParameterID replacing the Message Index.

ParameterID CPNS::ParameterID::WithMessageNumber ( CPNS::uint16  wMsgNum ) const

inline

Get a copy of the ParameterID replacing the Message Number.

Member Data Documentation

ParameterID CPNS::ParameterID::AnyParameterID

static

"Any" wildcard

ParameterID CPNS::ParameterID::NullParameterID

static

Empty section id value.