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

Notification handler for ClockListener Input. More...

Public Member Functions

virtual void OnInput_ClockDefinition (CPNS::IInput *const pNotifiedObject, CPNS::Endpoint const &source, CPNS::BPM16 const BPM, CPNS::uint8 const bCPQNMultiplier)
 Called if the input receives a clock definition. More...
 
virtual void OnInput_ClockTick (CPNS::IInput *const pNotifiedObject, CPNS::Endpoint const &source, CPNS::BPM16 const BPM, CPNS::uint16 const wResolution, CPNS::uint16 const wTick)=0
 Called if the input receives a clock tick. More...
 
virtual void OnInput_ClockCommand (CPNS::IInput *const pNotifiedObject, CPNS::Endpoint const &source, CPNS::Enums::ClockCommands const command)
 Called if the input receives a clock command. More...
 
virtual void OnInput_ClockSetPosition (CPNS::IInput *const pNotifiedObject, CPNS::Endpoint const &source, CPNS::uint32 const dwPosition, CPNS::boolean const fImmediate)
 Called if the input receives a clock position. More...
 

Detailed Description

Notification handler for ClockListener Input.

Member Function Documentation

virtual void CPNS::IInput_ClockListenerControlNotificationHandler::OnInput_ClockCommand ( CPNS::IInput *const  pNotifiedObject,
CPNS::Endpoint const &  source,
CPNS::Enums::ClockCommands const  command 
)
inlinevirtual

Called if the input receives a clock command.

Parameters
[in]pNotifiedObjectPointer to the input object receiving the message
[in]sourceClock generator source
[in]commandCommand o be executed
virtual void CPNS::IInput_ClockListenerControlNotificationHandler::OnInput_ClockDefinition ( CPNS::IInput *const  pNotifiedObject,
CPNS::Endpoint const &  source,
CPNS::BPM16 const  BPM,
CPNS::uint8 const  bCPQNMultiplier 
)
inlinevirtual

Called if the input receives a clock definition.

Parameters
[in]pNotifiedObjectPointer to the input object receiving the message
[in]sourceClock generator source
[in]BPMOptional BPM value (0xFFFF if not applicable, default value = 0xFFFF)
[in]bCPQNMultiplierClock resolution = 24 * bCPQNMultiplier (default value = 1)
virtual void CPNS::IInput_ClockListenerControlNotificationHandler::OnInput_ClockSetPosition ( CPNS::IInput *const  pNotifiedObject,
CPNS::Endpoint const &  source,
CPNS::uint32 const  dwPosition,
CPNS::boolean const  fImmediate 
)
inlinevirtual

Called if the input receives a clock position.

Parameters
[in]pNotifiedObjectPointer to the input object receiving the message
[in]sourceClock generator source
[in]dwPositionNew clock position
[in]fImmediateTRUE if the position should be commited immediately
virtual void CPNS::IInput_ClockListenerControlNotificationHandler::OnInput_ClockTick ( CPNS::IInput *const  pNotifiedObject,
CPNS::Endpoint const &  source,
CPNS::BPM16 const  BPM,
CPNS::uint16 const  wResolution,
CPNS::uint16 const  wTick 
)
pure virtual

Called if the input receives a clock tick.

Parameters
[in]pNotifiedObjectPointer to the input object receiving the message
[in]sourceClock generator source
[in]BPMOptional BPM value (0xFFFF if not applicable, default value = 0xFFFF)
[in]wResolutionClock resolution (multiple of 24)
[in]wTickOptional Tick count ([0..wResolution-1] or 0xFFFF if not applicable)