When a Parameter is associated to an Index List, it means that several instances of this parameter are available. More...

Inheritance diagram for CPNS::IIndexList:

Collaboration diagram for CPNS::IIndexList:

Public Member Functions
virtual CPNS::uint16	GetSize ()=0
	Get the number of items in the list. More...

virtual CPNS::boolean	GetItem (CPNS::uint16 const wItemIndex, CPNS::UTF8String &itemLabel)=0
	Get the label related to an item index. More...

virtual CPNS::Enums::Errors	UpdateDynamicContent ()=0
	Send a notification to all Outputs handling a parameter using this list telling that the list content changed. More...

Public Member Functions inherited from CPNS::IObject
virtual CPNS::ICHAI *	GetCHAI ()=0
	Get a pointer to the CHAI hosting this object. More...

virtual void	RegisterObjectNotificationHandler (CPNS::IObject_NotificationHandler *const pHandler)=0
	Register an Object's notification handler. More...

virtual void	UnregisterObjectNotificationHandler (CPNS::IObject_NotificationHandler *const pHandler)=0
	Unregister an Object's notification handler. More...

virtual CPNS::Enums::ObjectTypes	GetObjectType () const =0
	Get the object type. More...

virtual CPNS::uint32	GetHandle () const =0
	Get a unique handle to the object if this object is handled by the trashcan. More...

virtual void	SetUserDataPtr (void const *const pData)=0
	Set a custom user ptr data. More...

virtual void *	GetUserDataPtr () const =0
	Get custom user ptr data. More...

virtual void	SetUserDataUInt32 (const CPNS::uint32 dwData)=0
	Set a custom user uint32 data. More...

virtual CPNS::uint32	GetUserDataUInt32 () const =0
	Get custom user uint32 data. More...

Detailed Description

When a Parameter is associated to an Index List, it means that several instances of this parameter are available.

Member Function Documentation

virtual CPNS::boolean CPNS::IIndexList::GetItem	(	CPNS::uint16 const	wItemIndex,
		CPNS::UTF8String &	itemLabel
	)

pure virtual

Get the label related to an item index.

Warning: CAUTION! the wItemIndex is the item index (0 based), not the message's Index value (1 based)!!!

Parameters

[in]	wItemIndex	the item index
[out]	itemLabel	the item label

virtual CPNS::uint16 CPNS::IIndexList::GetSize ( )

pure virtual

Get the number of items in the list.

virtual CPNS::Enums::Errors CPNS::IIndexList::UpdateDynamicContent ( )

pure virtual

Send a notification to all Outputs handling a parameter using this list telling that the list content changed.

Calling this makes IOutput_NotificationHandler::OnOutput_RefreshIndexList to be called on connected outputs.

Remarks: An Index List content can be updated but the size can't be changed. Any Parameter using this list would also change of ParameterID in case of index size change. It is too dangerous to allow this, and so Index List size is fixed at creation.