CanEasy::ISignal Interface Reference

Inheritance diagram for CanEasy::ISignal:

Detailed Description

Signal which is child of a message.

Used to interpret the raw message payload into a physical value. Changing the message payload the signal gets updated. Changing the signal value the message payload gets updated.

 
    interface ISignal : IStaticDataEntryBase
    {
        HRESULT Min([out, retval] double *pVal);
        HRESULT Min([in] double dNewVal);
        HRESULT Max([out, retval] double *pVal);
        HRESULT Max([in] double dNewVal);
        HRESULT Send();
        HRESULT GetEntry([in] long idx, [out] long* pVal, [out] BSTR* pEntryText);
        HRESULT Receivers([out, retval] IReceiverCol**);
        HRESULT Extension([in] BSTR sID, [out, retval] IDispatch**);
        HRESULT Default([out, retval] double *pVal);
        HRESULT Default([in] double dNewVal);
        HRESULT SigType([out, retval] enum SigType* pVal);
        HRESULT SigType([in] enum SigType enNewVal);
        HRESULT SigValType([out, retval] enum SigValType* pVal);
        HRESULT SigValType([in] enum SigValType enNewVal);  
        HRESULT IsMultiplexerSignal([out, retval] VARIANT_BOOL* pVal);
          HRESULT TransmissionEvent([out, retval] ITransmissionEvent** pEvent);
        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);
    };
 

Definition at line 3509 of file cand_tlb.idl.

Member Function Documentation

FilterPreCopy()

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

Activated PreCopy events. 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::ISignal::FilterPreTransmit	(	[in] BSTR	sFilter,
		[in] BSTR	sId,
		[in] enum CallbackPosition	enPosition
	)

Activated PreTransmit events. 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::ISignal::FilterRxConfirm	(	[in] BSTR	sFilter,
		[in] BSTR	sId,
		[in] enum CallbackPosition	enPosition,
		VARIANT_BOOL	boAsynch
	)

Deprecated: Activated RxConfirm events. 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::ISignal::FilterTxConfirm	(	[in] BSTR	sFilter,
		[in] BSTR	sId,
		[in] enum CallbackPosition	enPosition,
		VARIANT_BOOL	boAsynch
	)

Deprecated: Activated TxConfirm events. 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.

GetEntry()

HRESULT CanEasy::ISignal::GetEntry	(	[in] long	idx,
		[out] long *	pVal,
		[out] BSTR *	pEntryText
	)

Deprecated: Returns a value table text by index.

If a value table is assigned you can get the raw value and description by index

Parameters

	idx	Index of the value table entry
[out]	pVal	Pointer to long getting the raw value
[out]	pEntryText	Pointer BSTR getting description

Send()

HRESULT CanEasy::ISignal::Send

(

)

Transmits the message that contains this signal

Property Documentation

Default

double CanEasy::ISignal::Default

getset

Physical default/start value. If activated in setting CanEasy will write this value into the signal.

Extension

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

get

Returns generic extension that can be registered for signals

IsMultiplexerSignal

VARIANT_BOOL CanEasy::ISignal::IsMultiplexerSignal

get

Returns true if this signal is a multiplexer

Max

double CanEasy::ISignal::Max

getset

Physical maximum of the signal

Min

double CanEasy::ISignal::Min

getset

Physical minimum of the signal

PreCopyEvents

VARIANT_BOOL CanEasy::ISignal::PreCopyEvents

getset

Activates/Deactivates PreCopy events

PreTransmitEvents

VARIANT_BOOL CanEasy::ISignal::PreTransmitEvents

getset

Activates/Deactivates PreTransmit events

Receivers

IReceiverCol CanEasy::ISignal::Receivers

get

Returns the collection of ECUs receiving this signal

RxConfirmEvents

VARIANT_BOOL CanEasy::ISignal::RxConfirmEvents

getset

Deprecated: Activates/Deactivates RxConfirm events. Use TransmissionEvent instead.

SigType

SigType CanEasy::ISignal::SigType

getset

Display type used in CanPanels (Slider, Edit, Checkbox, Combobox)

SigValType

SigValType CanEasy::ISignal::SigValType

getset

Deprecated: Value type of the signal. Use ValueTable instead.

TransmissionEvent

ITransmissionEvent CanEasy::ISignal::TransmissionEvent

get

Returns the class to get transmission events.

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

TxConfirmEvents

VARIANT_BOOL CanEasy::ISignal::TxConfirmEvents

getset

Deprecated: Activates/Deactivates TxConfirm events. Use TransmissionEvent instead.