CHAI SDK  Version 1.3
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
CPNS::IRemoteDevice_GetParameterInfo_AsyncReturnHandler Class Referenceabstract

Notification handler for RemoteDevice's GetParameterInfo async method. More...

Public Member Functions

virtual void OnRemoteDevice_GetParameterInfo_Modifier_Return (CPNS::IAsync *const pAsync, CPNS::SectionID const &sectionID, CPNS::ParameterID const &paramID, CPNS::char8 const *const utf8Name, CPNS::IListID *const pIndexListID, CPNS::uint16 const wMidPointValue, CPNS::char8 const *const utf8LabelMin, CPNS::char8 const *const utf8LabelMidPoint, CPNS::char8 const *const utf8LabelMax, CPNS::Enums::DataTypes const preferredDataType, CPNS::uint16 const wGroup, CPNS::CombinedModifierInformationProfiles const informationProfiles, CPNS::CombinedControllerTypes const preferredControllerType)=0
 Parameter Modifier information. More...
 
virtual void OnRemoteDevice_GetParameterInfo_Selector_Return (CPNS::IAsync *const pAsync, CPNS::SectionID const &sectionID, CPNS::ParameterID const &paramID, CPNS::char8 const *const utf8Name, CPNS::IListID *const pIndexListID, CPNS::uint16 const wItemIndexMax, CPNS::IListID *const pSelectorItemListID, CPNS::uint16 const wGroup, CPNS::CombinedSelectorInformationProfiles const informationProfiles, CPNS::CombinedControllerTypes const preferredControllerType)=0
 Parameter Selector information. More...
 
virtual void OnRemoteDevice_GetParameterInfo_Text_Return (CPNS::IAsync *const pAsync, CPNS::SectionID const &sectionID, CPNS::ParameterID const &paramID, CPNS::char8 const *const utf8Name, CPNS::IListID *const pIndexListID, CPNS::uint16 const wGroup, CPNS::CombinedTextInformationProfiles const informationProfiles, CPNS::CombinedControllerTypes const preferredControllerType)=0
 Parameter Text information. More...
 
virtual void OnRemoteDevice_GetParameterInfo_NoData_Return (CPNS::IAsync *const pAsync, CPNS::SectionID const &sectionID)=0
 No more data available. More...
 

Detailed Description

Notification handler for RemoteDevice's GetParameterInfo async method.

Member Function Documentation

virtual void CPNS::IRemoteDevice_GetParameterInfo_AsyncReturnHandler::OnRemoteDevice_GetParameterInfo_Modifier_Return ( CPNS::IAsync *const  pAsync,
CPNS::SectionID const &  sectionID,
CPNS::ParameterID const &  paramID,
CPNS::char8 const *const  utf8Name,
CPNS::IListID *const  pIndexListID,
CPNS::uint16 const  wMidPointValue,
CPNS::char8 const *const  utf8LabelMin,
CPNS::char8 const *const  utf8LabelMidPoint,
CPNS::char8 const *const  utf8LabelMax,
CPNS::Enums::DataTypes const  preferredDataType,
CPNS::uint16 const  wGroup,
CPNS::CombinedModifierInformationProfiles const  informationProfiles,
CPNS::CombinedControllerTypes const  preferredControllerType 
)
pure virtual

Parameter Modifier information.

Parameters
[in]pAsyncPointer to the async operation handler. Can be used to match the return notification with the related async operation. This pointer will become invalid just after exiting this method.
[in]sectionIDSection ID
[in]paramIDthe Parameter ID. msgIndex field contains the maximum index for this parameter info.
[in]utf8Namethe parameter's name
[in]pIndexListIDthe Index List ID if paramID.msgIndex != 0. Don't forget to Acquire() it if the application needs to keep it for later use.
[in]wMidPointValuemid-point position raw value
[in]utf8LabelMinLabel for min
[in]utf8LabelMidPointLabel for mid-point
[in]utf8LabelMaxLabel for max
[in]preferredDataTypepreferred data type in case of typed value usage
[in]wGroupParameter's group. Parameters having the same group number (>0) are physically attached.
[in]informationProfilesInformation profile
[in]preferredControllerTypePreferred controller type bitfield
virtual void CPNS::IRemoteDevice_GetParameterInfo_AsyncReturnHandler::OnRemoteDevice_GetParameterInfo_NoData_Return ( CPNS::IAsync *const  pAsync,
CPNS::SectionID const &  sectionID 
)
pure virtual

No more data available.

Parameters
[in]pAsyncPointer to the async operation handler. Can be used to match the return notification with the related async operation. This pointer will become invalid just after exiting this method.
[in]sectionIDSection ID
virtual void CPNS::IRemoteDevice_GetParameterInfo_AsyncReturnHandler::OnRemoteDevice_GetParameterInfo_Selector_Return ( CPNS::IAsync *const  pAsync,
CPNS::SectionID const &  sectionID,
CPNS::ParameterID const &  paramID,
CPNS::char8 const *const  utf8Name,
CPNS::IListID *const  pIndexListID,
CPNS::uint16 const  wItemIndexMax,
CPNS::IListID *const  pSelectorItemListID,
CPNS::uint16 const  wGroup,
CPNS::CombinedSelectorInformationProfiles const  informationProfiles,
CPNS::CombinedControllerTypes const  preferredControllerType 
)
pure virtual

Parameter Selector information.

Parameters
[in]pAsyncPointer to the async operation handler. Can be used to match the return notification with the related async operation. This pointer will become invalid just after exiting this method.
[in]sectionIDSection ID
[in]paramIDthe Parameter ID. msgIndex field contains the maximum index for this parameter info.
[in]utf8Namethe parameter's name
[in]pIndexListIDthe Index List ID if paramID.msgIndex != 0. Don't forget to Acquire() it if the application needs to keep it for later use.
[in]wItemIndexMaxmaximum value for item index
[in]pSelectorItemListIDthe Selector Item List ID. Don't forget to Acquire() it if the application needs to keep it for later use.
[in]wGroupParameter's group. Parameters having the same group number (>0) are physically attached.
[in]informationProfilesInformation profile
[in]preferredControllerTypePreferred controller type bitfield
virtual void CPNS::IRemoteDevice_GetParameterInfo_AsyncReturnHandler::OnRemoteDevice_GetParameterInfo_Text_Return ( CPNS::IAsync *const  pAsync,
CPNS::SectionID const &  sectionID,
CPNS::ParameterID const &  paramID,
CPNS::char8 const *const  utf8Name,
CPNS::IListID *const  pIndexListID,
CPNS::uint16 const  wGroup,
CPNS::CombinedTextInformationProfiles const  informationProfiles,
CPNS::CombinedControllerTypes const  preferredControllerType 
)
pure virtual

Parameter Text information.

Parameters
[in]pAsyncPointer to the async operation handler. Can be used to match the return notification with the related async operation. This pointer will become invalid just after exiting this method.
[in]sectionIDSection ID
[in]paramIDthe Parameter ID. msgIndex field contains the maximum index for this parameter info.
[in]utf8Namethe parameter's name
[in]pIndexListIDthe Index List ID if paramID.msgIndex != 0. Don't forget to Acquire() it if the application needs to keep it for later use.
[in]wGroupParameter's group. Parameters having the same group number (>0) are physically attached.
[in]informationProfilesInformation profile
[in]preferredControllerTypePreferred controller type bitfield