Inheritance diagram for CanEasy::IMessage:

Detailed Description

Message can be transmitted on a bus. Contains signal for the physical interpretation of its payload.

 
    interface IMessage : IDatabaseItem
    {
        HRESULT MsgID([out, retval] ICanMessageId** ppVal);
        HRESULT DataChangeEvents([out, retval] VARIANT_BOOL *pVal);
        HRESULT DataChangeEvents([in] VARIANT_BOOL boNewVal);
        HRESULT Data([out, retval] IMsgData** ppData);
        HRESULT Send();
        HRESULT Signals([out, retval] ISignalCol** ppVal);       
        HRESULT TxEnabled([in] VARIANT_BOOL boNewVal);
        HRESULT Extension([in] BSTR sID, [out, retval] IDispatch** ppVal);
        HRESULT IsMultiplexMessage([out, retval] VARIANT_BOOL* pVal);
        HRESULT Messages([out, retval] IMessageCol** ppItem);
        HRESULT MuxSignal([out, retval] ISignal** ppItem);
        HRESULT MuxSignal([in] ISignal* pSig);
        HRESULT ActiveOnLin([out, retval] VARIANT_BOOL *pVal);
        HRESULT ActiveOnLin([in] VARIANT_BOOL boNewVal);        
        HRESULT DLC([out, retval] long* pDlc);        
        HRESULT DLC([in] long lDlc);
        HRESULT DataChangeEventAsynchron([out, retval] VARIANT_BOOL* pVal);
        HRESULT DataChangeEventAsynchron([in] VARIANT_BOOL boVal);
        HRESULT Bus([out, retval] IBus** ppBus);
        HRESULT Bus([in] IBus* pBus);
        HRESULT Assign([in] IMessage* pMsg);
        HRESULT AssignTransmissionData([in] ITransmissionData* pTransmission);
        HRESULT UseTempData([out, retval] VARIANT_BOOL* pVal);
        HRESULT UseTempData([in] VARIANT_BOOL val);   
 
        HRESULT TrsCtrl1([out, retval] ITrsCtrl1MessageExtension** pItem);
        HRESULT SetTrsCtrl([in] BSTR sText);
          HRESULT TransmissionEvent([out, retval] ITransmissionEvent** ppItem);
        HRESULT FilterPreTransmit([in] BSTR sFilter, [in] BSTR sId, [in] enum CallbackPosition enPosition);
        HRESULT FilterPreCopy([in] BSTR sFilter, [in] BSTR sId, [in] enum CallbackPosition enPosition);
        HRESULT FilterTxConfirm([in] BSTR sFilter, [in] BSTR sId, [in] enum CallbackPosition enPosition, VARIANT_BOOL boAsynch);
        HRESULT FilterRxConfirm([in] BSTR sFilter, [in] BSTR sId, [in] enum CallbackPosition enPosition, VARIANT_BOOL boAsynch);
 
        HRESULT PreTransmitEvents([out, retval] VARIANT_BOOL* pVal);
        HRESULT PreTransmitEvents([in] VARIANT_BOOL boVal);
 
        HRESULT PreCopyEvents([out, retval] VARIANT_BOOL* pVal);
        HRESULT PreCopyEvents([in] VARIANT_BOOL boVal);
 
        HRESULT TxConfirmEvents([out, retval] VARIANT_BOOL* pVal);
        HRESULT TxConfirmEvents([in] VARIANT_BOOL boVal);
 
        HRESULT RxConfirmEvents([out, retval] VARIANT_BOOL* pVal);
        HRESULT RxConfirmEvents([in] VARIANT_BOOL boVal);
 
        HRESULT SignalGroups([out, retval] ISignalGroupCol** ppVal);
 
        HRESULT IsTransmitted([in] long timeoutMS, [in] enum DirectionFilter enFilter, [out, retval] VARIANT_BOOL*);
    };
 

Definition at line 3998 of file cand_tlb.idl.

Member Function Documentation

◆ Assign()

HRESULT CanEasy::IMessage::Assign ( [in] IMessage * pMsg )

Assigns the passed message (id, payload) into this message.

◆ AssignTransmissionData()

HRESULT CanEasy::IMessage::AssignTransmissionData ( [in] ITransmissionData * pTransmission )

Assigns the transmission data (id, payload) into this message.

◆ FilterPreCopy()

HRESULT CanEasy::IMessage::FilterPreCopy	(	[in] BSTR	sFilter,
		[in] BSTR	sId,
		[in] enum CallbackPosition	enPosition
	)

Activated PreCopy events for this message. See ITransmissionEvent for more help.

Parameters

sFilter	String filter to reduce the number of events
sId	Unique identifier name
enPosition	Deprecated: Priority when event has to be called

◆ FilterPreTransmit()

HRESULT CanEasy::IMessage::FilterPreTransmit	(	[in] BSTR	sFilter,
		[in] BSTR	sId,
		[in] enum CallbackPosition	enPosition
	)

Activated PreTransmit events for this message. See ITransmissionEvent for more help.

Parameters

sFilter	String filter to reduce the number of events
sId	Unique identifier name
enPosition	Deprecated: Priority when event has to be called

◆ FilterRxConfirm()

HRESULT CanEasy::IMessage::FilterRxConfirm	(	[in] BSTR	sFilter,
		[in] BSTR	sId,
		[in] enum CallbackPosition	enPosition,
		VARIANT_BOOL	boAsynch
	)

Deprecated: Activated RxConfirm events for this message. Use TransmissionEvent instead. See ITransmissionEvent for more help.

Parameters

sFilter	String filter to reduce the number of events
sId	Unique identifier name
enPosition	Deprecated: Priority when event has to be called
boAsynch	Should be set to true. If set to false the event is called from high prio transmission thread.

◆ FilterTxConfirm()

HRESULT CanEasy::IMessage::FilterTxConfirm	(	[in] BSTR	sFilter,
		[in] BSTR	sId,
		[in] enum CallbackPosition	enPosition,
		VARIANT_BOOL	boAsynch
	)

Deprecated: Activated TxConfirm events for this message. Use TransmissionEvent instead. See ITransmissionEvent for more help.

Parameters

sFilter	String filter to reduce the number of events
sId	Unique identifier name
enPosition	Deprecated: Priority when event has to be called
boAsynch	Should be set to true. If set to false the event is called from high prio transmission thread.

◆ IsTransmitted()

HRESULT CanEasy::IMessage::IsTransmitted	(	[in] long	timeoutMS,
		[in] enum DirectionFilter	enFilter,
		[out, retval] VARIANT_BOOL *
	)

Waits for the transmission of the message

Parameters

timeoutMS	Timeout in milliseconds to wait
enFilter	Filter for rx or tx direction

Returns: Returns true if message was transmitted within the passed time

◆ Send()

HRESULT CanEasy::IMessage::Send ( )

Sends this message

◆ SetTrsCtrl()

HRESULT CanEasy::IMessage::SetTrsCtrl ( [in] BSTR sText )

Sets the name of the transmission control responsible for sending this message.

Property Documentation

◆ ActiveOnLin

VARIANT_BOOL CanEasy::IMessage::ActiveOnLin

getset

True if LIN signal is simulated. If False CanEasy will just send header-frame.

◆ Bus

IBus CanEasy::IMessage::Bus

getset

Reference to the bus/channel containing this message

◆ Data

IMsgData CanEasy::IMessage::Data

get

Returns on object to get access to the message payload

◆ DataChangeEventAsynchron

VARIANT_BOOL CanEasy::IMessage::DataChangeEventAsynchron

getset

Activates data change events called asynchrony

◆ DataChangeEvents

VARIANT_BOOL CanEasy::IMessage::DataChangeEvents

getset

Activates events on value change

◆ DLC

long CanEasy::IMessage::DLC

getset

Byte length of this message.

◆ Extension

IDispatch CanEasy::IMessage::Extension([in] BSTR sID)

get

Returns a generic extension by name

Parameters

sID	Name of the extension

Returns: Interface to the extension

◆ IsMultiplexMessage

VARIANT_BOOL CanEasy::IMessage::IsMultiplexMessage

get

Returns true if the message is a multiplex message contained by another message.

◆ Messages

IMessageCol CanEasy::IMessage::Messages

get

Returns the collection for contained multiplex messages

◆ MsgID

ICanMessageId CanEasy::IMessage::MsgID

get

Returns an object to get access to the message identifier

◆ MuxSignal

ISignal CanEasy::IMessage::MuxSignal

getset

Signal that is used as multiplexer

◆ PreCopyEvents

VARIANT_BOOL CanEasy::IMessage::PreCopyEvents

getset

Activates/Deactivates PreCopy events for this message

◆ PreTransmitEvents

VARIANT_BOOL CanEasy::IMessage::PreTransmitEvents

getset

Activates/Deactivates PreTransmit events for this message

◆ RxConfirmEvents

VARIANT_BOOL CanEasy::IMessage::RxConfirmEvents

getset

Deprecated: Activates/Deactivates RxConfirm events for this message. Use TransmissionEvent instead.

◆ SignalGroups

ISignalGroupCol CanEasy::IMessage::SignalGroups

get

Returns collection of contained signal groups

◆ Signals

ISignalCol CanEasy::IMessage::Signals

get

Returns a collection to access all contained signals

◆ TransmissionEvent

ITransmissionEvent CanEasy::IMessage::TransmissionEvent

get

Returns the class to get transmission events.

Example: Use item.TransmissionEvent.Active = true to activate the events.

◆ TrsCtrl1

ITrsCtrl1MessageExtension CanEasy::IMessage::TrsCtrl1

get

Returns interface to the transmission control.

: Allows to changing transmission parameters at runtime without changing the database.

◆ TxConfirmEvents

VARIANT_BOOL CanEasy::IMessage::TxConfirmEvents

getset

Deprecated: Activates/Deactivates TxConfirm events for this message. Use TransmissionEvent instead.

◆ TxEnabled

VARIANT_BOOL CanEasy::IMessage::TxEnabled

set

Activates/Deactivates the transmission of all messages

◆ UseTempData

VARIANT_BOOL CanEasy::IMessage::UseTempData

getset

If True, changes are not written into the database