CPNS::SectionID Class Reference

Section ID definition class. More...

Collaboration diagram for CPNS::SectionID:

Public Member Functions
CPNS::Enums::SectionTypes	GetSectionTypes () const
	Section type, combination of CPNS::Enums::SectionTypes flags. More...
CPNS::uint16	GetInstance () const
	Section instance. More...
	SectionID ()
	Default constructor. More...
	SectionID (CPNS::Enums::SectionTypes const sectionTypes, CPNS::uint16 const wInstance)
	Constructor. More...
	SectionID (SectionID const &data)
	Constructor. More...
CPNS::boolean	operator== (SectionID const &a) const
	Equality check operator. More...
CPNS::boolean	operator!= (SectionID const &a) const
	Difference check operator. More...
SectionID &	operator= (SectionID const &a)
	Assignment operator. More...
CPNS::boolean	operator< (SectionID const &a) const
	Less than check operator. More...
CPNS::boolean	operator> (SectionID const &a) const
	Greater than check operator. More...
CPNS::boolean	IsEmpty () const
	Empty check. More...
CPNS::UTF8String	ToString () const
	String representation. More...
CPNS::boolean	IsMatching (SectionID const &secID)
	Check if the section id is matching another one (taking care of type and instance wildcard) More...
SectionID	WithInstance (CPNS::uint16 wInstance) const
	Get a copy of the ParameterID replacing the instance. More...

Static Public Member Functions
static SectionID	AnyInstanceOf (CPNS::Enums::SectionTypes const sectionTypes)
	Create a SectionID with a 'any' instance wildcard. More...

Static Public Attributes
static SectionID	NullSectionID
	Empty section id value. More...
static SectionID	AnySectionID
	"Any" wildcard More...

Detailed Description

Section ID definition class.

Each Input is associated to a SectionID giving information about its role. A set of Outputs owned y a single Device can be associated to a SectionID, allowing to group multiple Controller Outputs into a single Section.

Constructor & Destructor Documentation

CPNS::SectionID::SectionID ( )

inline

Default constructor.

No section type, null instance.

CPNS::SectionID::SectionID ( CPNS::Enums::SectionTypes const  sectionTypes, CPNS::uint16 const  wInstance  )

inline

Constructor.

Parameters

[in]	sectionTypes	Section type bit field, see CPNS::Enums::SectionTypes
[in]	wInstance	Section instance

CPNS::SectionID::SectionID ( SectionID const &  data )

inline

Constructor.

Parameters

[in]

data

SectionID to copy

Member Function Documentation

static SectionID CPNS::SectionID::AnyInstanceOf ( CPNS::Enums::SectionTypes const  sectionTypes )

inlinestatic

Create a SectionID with a 'any' instance wildcard.

Parameters

[in]

sectionTypes

to be used in the new SectionID

Returns

the new SectionID with instance wildcard.

CPNS::uint16 CPNS::SectionID::GetInstance ( ) const

inline

Section instance.

The value 0xFFFF is a 'any' wildcard for section searching.

CPNS::Enums::SectionTypes CPNS::SectionID::GetSectionTypes ( ) const

inline

Section type, combination of CPNS::Enums::SectionTypes flags.

CPNS::boolean CPNS::SectionID::IsEmpty ( ) const

inline

Empty check.

Returns

TRUE if all fields are empty

CPNS::boolean CPNS::SectionID::IsMatching

(

SectionID const &

secID

)

Check if the section id is matching another one (taking care of type and instance wildcard)

Parameters

[in]

secID

The sectionID to be compared

Returns

TRUE if secID is matching the current section ID

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

inline

Difference check operator.

Parameters

[in]

a

compared value

CPNS::boolean CPNS::SectionID::operator<

(

SectionID const &

a

)

const

Less than check operator.

Parameters

[in]

a

compared value

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

inline

Assignment operator.

Parameters

[in]

a

source value

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

inline

Equality check operator.

Parameters

[in]

a

compared value

CPNS::boolean CPNS::SectionID::operator>

(

SectionID const &

a

)

const

Greater than check operator.

Parameters

[in]

a

compared value

CPNS::UTF8String CPNS::SectionID::ToString

(

)

const

String representation.

Returns

an hexadecimal view of the section id

SectionID CPNS::SectionID::WithInstance ( CPNS::uint16  wInstance ) const

inline

Get a copy of the ParameterID replacing the instance.

Member Data Documentation

SectionID CPNS::SectionID::AnySectionID

static

"Any" wildcard

SectionID CPNS::SectionID::NullSectionID

static

Empty section id value.