Text message dedicated class. More...

Inheritance diagram for CPNS::ITextMessage:

Collaboration diagram for CPNS::ITextMessage:

Public Member Functions
virtual void	SetTransaction (CPNS::Enums::TransactionModes const status)=0
	Set the transaction status. More...

virtual CPNS::Enums::TransactionModes	GetTransaction () const =0
	Get the transaction status. More...

virtual CPNS::boolean	IsVoiceIDAvailable () const =0
	Check if VoiceID is available. More...

virtual void	SetVoiceID (CPNS::uint16 const wValue)=0
	Set VoiceID data The Voice ID information can be used to reconcile Events, Modifiers, Selectors and Texts. More...

virtual CPNS::uint16	GetVoiceID () const =0
	Get the VoiceID value The Voice ID information can be used to reconcile Events, Modifiers, Selectors and Texts. More...

virtual CPNS::boolean	IsAutomationAvailable () const =0
	Check if automation settings are available. More...

virtual void	SetAutomationState (CPNS::Enums::PerformanceMessageAutomationStates const eValue)=0
	Set Automation state. More...

virtual CPNS::Enums::PerformanceMessageAutomationStates	GetAutomationState () const =0
	Get Automation state. More...

virtual void	SetAutomationTouch (CPNS::boolean const fValue)=0
	Set Automation touch. More...

virtual CPNS::boolean	GetAutomationTouch () const =0
	Get Automation touch. More...

virtual void	SetAutomationWTE (CPNS::boolean const fValue)=0
	Set Automation Write-to-End/Latch mode. More...

virtual CPNS::boolean	GetAutomationWTE () const =0
	Get Automation Write-to-End/Latch mode. More...

virtual CPNS::boolean	IsIndexAvailable () const =0
	Check if Index is available. More...

virtual void	SetIndex (CPNS::uint16 const wValue)=0
	Set Index value. More...

virtual CPNS::uint16	GetIndex () const =0
	Get Index value. More...

virtual void	SetPreLoad (CPNS::boolean const fValue)=0
	Set the profile's Preload flag If Preload is set, the device should prepare to apply the message's value but do not commit until : More...

virtual CPNS::boolean	GetPreLoad () const =0
	Get the profile's Preload flag If Preload is set, the device should prepare to apply the message's value but do not commit until : More...

virtual void	SetTrigger (CPNS::boolean const fValue)=0
	Set the Trigger flag Apply again the message, even the current value is already the message's value, or activate the pre-loaded settings. More...

virtual CPNS::boolean	GetTrigger () const =0
	Get the Trigger flag Apply again the message, even the current value is already the message's value, or activate the pre-loaded settings. More...

virtual void	SetNumber (CPNS::uint16 const wNumber)=0
	Set the message Number. More...

virtual CPNS::uint16	GetNumber () const =0
	Get the message's number. More...

virtual void	SetValue (CPNS::char8 const *const utf8Text)=0
	Set the Text's value. More...

virtual CPNS::UTF8String	GetValue () const =0
	Get the Text's value. More...

Public Member Functions inherited from CPNS::IBaseMessage
virtual CPNS::IEventMessage *	GetIEventMessage () const =0
	Check message type and return an IEventMessage object pointer if type match. More...

virtual CPNS::IModifierMessage *	GetIModifierMessage () const =0
	Check message type and return an IModifierMessage object pointer if type match. More...

virtual CPNS::ISelectorMessage *	GetISelectorMessage () const =0
	Check message type and return an ISelectorMessage object pointer if type match. More...

virtual CPNS::ITextMessage *	GetITextMessage () const =0
	Check message type and return an ITextMessage object pointer if type match. More...

virtual CPNS::IMIDISysexMessage *	GetIMIDISysexMessage () const =0
	Check message type and return an IMIDISysexMessage object pointer if type match. More...

virtual CPNS::IDataTransferMessage *	GetIDataTransferMessage () const =0
	Check message type and return an IDataTransferMessage object pointer if type match. More...

virtual CPNS::CombinedTimeStampFlags	GetTimeStampFlags () const =0
	Get time stamp flags, informing about time stamp types available and offline mode. More...

virtual CPNS::SongPosition	GetTimeStampSongPosition () const =0
	Get the Song Position time stamp. More...

virtual CPNS::SystemTime	GetTimeStampSystemTime () const =0
	Get the System Time time stamp. More...

virtual CPNS::Endpoint	GetSource () const =0
	Get the message source endpoint. More...

virtual CPNS::uint16	GetDestinationNumber () const =0
	Get the number of destinations This methods is only useful in case of message trapped during recording session. More...

virtual CPNS::Endpoint	GetDestination (CPNS::uint16 const wDestinationIndex)=0
	Get a destination Get the number of destinations This methods is only useful in case of message trapped during recording session. More...

Public Member Functions inherited from CPNS::IHookedObject
virtual void	Acquire ()=0
	Acquire an object. More...

virtual void	Release ()=0
	Release an object. More...

virtual CPNS::uint32	GetHookCounter () const =0
	Get object's hook counter. 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

Text message dedicated class.

Member Function Documentation

virtual CPNS::Enums::PerformanceMessageAutomationStates CPNS::ITextMessage::GetAutomationState ( ) const

pure virtual

Get Automation state.

Returns: the automation state

virtual CPNS::boolean CPNS::ITextMessage::GetAutomationTouch ( ) const

pure virtual

Get Automation touch.

Returns: state of the touch sensor, TRUE if touching.

virtual CPNS::boolean CPNS::ITextMessage::GetAutomationWTE ( ) const

pure virtual

Get Automation Write-to-End/Latch mode.

Returns: TRUE, Write-to-End FALSE, Latch

virtual CPNS::uint16 CPNS::ITextMessage::GetIndex ( ) const

pure virtual

Get Index value.

Returns: Index value

virtual CPNS::uint16 CPNS::ITextMessage::GetNumber ( ) const

pure virtual

Get the message's number.

Returns: the message's number

virtual CPNS::boolean CPNS::ITextMessage::GetPreLoad ( ) const

pure virtual

Get the profile's Preload flag If Preload is set, the device should prepare to apply the message's value but do not commit until :

the same message arrives with Trigger profile set and Preload flag clear.
a SIG_PreloadCommit or SIG_PreloadCancel signal is received
Returns
Preload status

virtual CPNS::Enums::TransactionModes CPNS::ITextMessage::GetTransaction ( ) const

pure virtual

Get the transaction status.

Returns: one of the TransactionModes values

virtual CPNS::boolean CPNS::ITextMessage::GetTrigger ( ) const

pure virtual

Get the Trigger flag Apply again the message, even the current value is already the message's value, or activate the pre-loaded settings.

Returns: Trigger value

virtual CPNS::UTF8String CPNS::ITextMessage::GetValue ( ) const

pure virtual

Get the Text's value.

Returns: the message's value

virtual CPNS::uint16 CPNS::ITextMessage::GetVoiceID ( ) const

pure virtual

Get the VoiceID value The Voice ID information can be used to reconcile Events, Modifiers, Selectors and Texts.

The range 0xFF00 to 0xFF7F is reserved for MIDI backward compatibility. A MIDI to CopperLan translator automatically set the VoiceID to the value 0xFF00 + MIDI note. Value 0xFFFE is reserved and means "Voice ID unavailable". Value 0xFFFF is reserved and means "All Voice IDs".

Warning: If no VoiceID is present in the message, and if the application needs a VoiceID, it is recommended to use the tone information in place of the missing VoiceID.

Returns: the VoiceID value

virtual CPNS::boolean CPNS::ITextMessage::IsAutomationAvailable ( ) const

pure virtual

Check if automation settings are available.

Returns: TRUE if profile bit TP_Automation is set

virtual CPNS::boolean CPNS::ITextMessage::IsIndexAvailable ( ) const

pure virtual

Check if Index is available.

Returns: TRUE if TP_IndexAvailable profile bit set

virtual CPNS::boolean CPNS::ITextMessage::IsVoiceIDAvailable ( ) const

pure virtual

Check if VoiceID is available.

Returns: TRUE if VoiceID data is available (EP_VoiceID is set)

virtual void CPNS::ITextMessage::SetAutomationState ( CPNS::Enums::PerformanceMessageAutomationStates const eValue )

pure virtual

Set Automation state.

Remarks: Automatically set the TP_Automation profile bit

Parameters

[in] eValue the automation state

virtual void CPNS::ITextMessage::SetAutomationTouch ( CPNS::boolean const fValue )

pure virtual

Set Automation touch.

Remarks: Automatically set the TP_Automation profile bit

Parameters

[in] fValue state of the touch sensor, TRUE if touching.

virtual void CPNS::ITextMessage::SetAutomationWTE ( CPNS::boolean const fValue )

pure virtual

Set Automation Write-to-End/Latch mode.

Remarks: Automatically set the TP_Automation profile bit

Parameters

[in] fValue TRUE, Write-to-End FALSE, Latch

virtual void CPNS::ITextMessage::SetIndex ( CPNS::uint16 const wValue )

pure virtual

Set Index value.

Remarks: Automatically set the TP_IndexAvailable profile bit

Parameters

[in] wValue Index value

virtual void CPNS::ITextMessage::SetNumber ( CPNS::uint16 const wNumber )

pure virtual

Set the message Number.

Remarks: Standard Text numbers are available from CPNS::Enums::Texts

Parameters

[in] wNumber the message's number

virtual void CPNS::ITextMessage::SetPreLoad ( CPNS::boolean const fValue )

pure virtual

Set the profile's Preload flag If Preload is set, the device should prepare to apply the message's value but do not commit until :

the same message arrives with Trigger profile set and Preload flag clear.
a SIG_PreloadCommit or SIG_PreloadCancel signal is received
Parameters

[in] fValue Preload status

virtual void CPNS::ITextMessage::SetTransaction ( CPNS::Enums::TransactionModes const status )

pure virtual

Set the transaction status.

Parameters

[in] status The current transaction status

virtual void CPNS::ITextMessage::SetTrigger ( CPNS::boolean const fValue )

pure virtual

Set the Trigger flag Apply again the message, even the current value is already the message's value, or activate the pre-loaded settings.

Parameters

[in] fValue Trigger value

virtual void CPNS::ITextMessage::SetValue ( CPNS::char8 const *const utf8Text )

pure virtual

Set the Text's value.

Parameters

[in] utf8Text the message's value

virtual void CPNS::ITextMessage::SetVoiceID ( CPNS::uint16 const wValue )

pure virtual

Set VoiceID data The Voice ID information can be used to reconcile Events, Modifiers, Selectors and Texts.

The range 0xFF00 to 0xFF7F is reserved for MIDI backward compatibility. A MIDI to CopperLan translator automatically set the VoiceID to the value 0xFF00 + MIDI note. Value 0xFFFE is reserved and means "Voice ID unavailable". Value 0xFFFF is reserved and means "All Voice IDs".

Remarks: Automatically set the EP_VoiceID profile bit

Warning: If no VoiceID is present in the message, and if the application needs a VoiceID, it is recommended to use the tone information in place of the missing VoiceID.

Parameters

[in] wValue the VoiceID

Public Member Functions

Detailed Description

Member Function Documentation