CPNS::Endpoint Class Reference

Endpoint (source or destination) definition class. More...

Collaboration diagram for CPNS::Endpoint:

Public Member Functions
	Endpoint ()
	Constructor. More...
	Endpoint (CPNS::uint16 const wBrandID, CPNS::uint16 const wModelID, CPNS::uint32 const dwDuplicateNumber, CPNS::uint16 const wModuleID, CPNS::uint16 const wInOutID)
	Constructor. More...
	Endpoint (DeviceID const &devID, CPNS::uint16 const wInOutID)
	Constructor. More...
	Endpoint (Endpoint const &data)
	Copy Constructor. More...
CPNS::boolean	operator== (Endpoint const &a) const
	Equality check operator. More...
CPNS::boolean	operator!= (Endpoint const &a) const
	Difference check operator. More...
CPNS::boolean	operator< (Endpoint const &a) const
	Less than check operator. More...
CPNS::boolean	operator> (Endpoint const &a) const
	Greater than check operator. More...
Endpoint const &	operator= (Endpoint const &a)
	Assignment operator. More...
CPNS::boolean	IsEmpty () const
	Empty check. More...
CPNS::UTF8String	ToString () const
	String representation. More...
void	Clear ()
	Clear the endpoint content. More...
CPNS::uint32	GetIdentity () const
	Identity getter. More...
Endpoint const	WithInOutID (CPNS::uint16 const wInOutID) const

Static Public Member Functions
static CPNS::int8	Compare (Endpoint const &endpt1, Endpoint const &endpt2)
	Compare method. More...

Public Attributes
DeviceID	m_DevIDData
	Device ID. More...
CPNS::uint16	m_wInOutID
	Input or Output ID depending on the endpoint side. More...
CPNS::boolean	m_fDisabledDestination
	TRUE if the endpoint correspond to a disabled destination. More...

Static Public Attributes
static Endpoint	NullEndpoint
	Empty endpoint value. More...

Detailed Description

Endpoint (source or destination) definition class.

Constructor & Destructor Documentation

CPNS::Endpoint::Endpoint

(

)

Constructor.

CPNS::Endpoint::Endpoint	(	CPNS::uint16 const	wBrandID,
		CPNS::uint16 const	wModelID,
		CPNS::uint32 const	dwDuplicateNumber,
		CPNS::uint16 const	wModuleID,
		CPNS::uint16 const	wInOutID
	)

Constructor.

Parameters

[in]	wBrandID	Device's Manufacturer ID
[in]	wModelID	Device's Model ID
[in]	dwDuplicateNumber	Device's Duplicate Number
[in]	wModuleID	Device's Module ID
[in]	wInOutID	Input or Output ID depending on the endpoint side.

CPNS::Endpoint::Endpoint	(	DeviceID const &	devID,
		CPNS::uint16 const	wInOutID
	)

Constructor.

Parameters

[in]	devID	Device's ID
[in]	wInOutID	Input or Output ID depending on the endpoint side.

CPNS::Endpoint::Endpoint

(

Endpoint const &

data

)

Copy Constructor.

Member Function Documentation

void CPNS::Endpoint::Clear

(

)

Clear the endpoint content.

static CPNS::int8 CPNS::Endpoint::Compare ( Endpoint const &  endpt1, Endpoint const &  endpt2  )

static

Compare method.

Returns

-1 if endpt1<endpt2 +1 if endpt1>endpt2 0 if endpt1==endpt2

CPNS::uint32 CPNS::Endpoint::GetIdentity

(

)

const

Identity getter.

Returns

Identity (combined BrandID/ModelID value, excluding duplicate and moduleID)

CPNS::boolean CPNS::Endpoint::IsEmpty

(

)

const

Empty check.

Returns

TRUE if all fields are empty

CPNS::boolean CPNS::Endpoint::operator!=

(

Endpoint const &

a

)

const

Difference check operator.

CPNS::boolean CPNS::Endpoint::operator<

(

Endpoint const &

a

)

const

Less than check operator.

Endpoint const& CPNS::Endpoint::operator=

(

Endpoint const &

a

)

Assignment operator.

CPNS::boolean CPNS::Endpoint::operator==

(

Endpoint const &

a

)

const

Equality check operator.

CPNS::boolean CPNS::Endpoint::operator>

(

Endpoint const &

a

)

const

Greater than check operator.

CPNS::UTF8String CPNS::Endpoint::ToString

(

)

const

String representation.

Returns

an hexadecimal view of the endpoint

Member Data Documentation

DeviceID CPNS::Endpoint::m_DevIDData

Device ID.

CPNS::boolean CPNS::Endpoint::m_fDisabledDestination

TRUE if the endpoint correspond to a disabled destination.

A destination is going to disabled status when it is unreachable. This value is set by the CHAI and must be considered as a read-only member of CEndPoint.

CPNS::uint16 CPNS::Endpoint::m_wInOutID

Input or Output ID depending on the endpoint side.

Endpoint CPNS::Endpoint::NullEndpoint

static

Empty endpoint value.