Inheritance diagram for CanEasy::IBus:

Detailed Description

Bus/Channel, gets connected to hardware channel and allows transmission of messages

 
    interface IBus : IDatabaseItem
    {
        HRESULT Baudrate([out, retval] long *pVal);
        HRESULT Baudrate([in] long lVal);
        HRESULT BTR0([out, retval] short *pVal);
        HRESULT BTR0([in] short iNewVal);
        HRESULT BTR1([out, retval] short *pVal);
        HRESULT BTR1([in] short iNewVal);
        HRESULT TxEnabled([out, retval] VARIANT_BOOL *pVal);
        HRESULT TxEnabled([in] VARIANT_BOOL boNewVal);
        HRESULT RxEnabled([out, retval] VARIANT_BOOL *pVal);
        HRESULT RxEnabled([in] VARIANT_BOOL boNewVal);
        HRESULT SendFreeMsg([in] long nMsgID, [in] VARIANT vData, [in] short nDLC);
        HRESULT GetMsgByID([in] long nMsgID, [out, retval] IMessage** iMsg);
        HRESULT GetMsgByName([in] BSTR sName, [out, retval] IMessage** iMsg);
        HRESULT ControlUnits([out, retval] IControlUnitCol* *pVal);
        HRESULT SelectHardware([in] BSTR sHardwareName, [in] VARIANT vHwId, [in] byte bHwChannel);
        HRESULT Extension([in] BSTR sID, [out, retval] IDispatch* *pVal);
        HRESULT LinMaster([out, retval] IControlUnit** iEcu);
        HRESULT LinMaster([in] IControlUnit* iEcu);
        HRESULT Type([out, retval] enum BusType* pType);        
        HRESULT Export([in] BSTR sFilename);
        HRESULT BusStateEvents([out, retval] VARIANT_BOOL *pVal);
        HRESULT BusStateEvents([in] VARIANT_BOOL boVal);
        HRESULT BusErrorEvents([out, retval] VARIANT_BOOL *val);
        HRESULT BusErrorEvents([in] VARIANT_BOOL boVal);
        HRESULT GenerateControlUnit ([in] BSTR sFile);
        HRESULT SendFreeCanMsg([in] long nMsgID, [in] VARIANT vData, [in] short nDLC);
        HRESULT SendFreeLinMsg([in] long nMsgID, [in] VARIANT vData, [in] short nDLC, [in] enum LinChecksumVersion enChecksumVersion);
        HRESULT Channel([out, retval] byte* pChannel);
        HRESULT Channel([in] byte bChannel);
        HRESULT ResetChannel();
        HRESULT SetTrsCtrlForMessages([in] BSTR sText);
        HRESULT NMHigh([out, retval] INMHighBusExt** ppItem);
        HRESULT OsekNM([out, retval] INMBusExt** ppItem);
        HRESULT VirtualChannel([out, retval] IVirtualChannel** ppItem);
        HRESULT Variables([out, retval] INamespace **pItem);
         HRESULT InitErrorEvents([out, retval] VARIANT_BOOL* pActive);
         HRESULT InitErrorEvents([in] VARIANT_BOOL boActive);
 
        HRESULT TransmitMsg([in] long nMsgID, [in] VARIANT vData, [in] short nDLC, [in] enum TransmissionFlags enFlags);
          HRESULT TransmissionEvent([out, retval] ITransmissionEvent** ppTransmission);
        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 4753 of file cand_tlb.idl.

Member Function Documentation

◆ Export()

HRESULT CanEasy::IBus::Export ( [in] BSTR sFilename )

Exports the bus to DBC or LDF file

◆ FilterPreCopy()

HRESULT CanEasy::IBus::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::IBus::FilterPreTransmit	(	[in] BSTR	sFilter,
		[in] BSTR	sId,
		[in] enum CallbackPosition	enPosition
	)

Activated PreTransmit event. See ITransmissionEvent for more help.

Parameters

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

◆ FilterRxConfirm()

HRESULT CanEasy::IBus::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::IBus::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.

◆ GenerateControlUnit()

HRESULT CanEasy::IBus::GenerateControlUnit ( [in] BSTR sFile )

Imports an LIN ECU from NCF file

◆ GetMsgByID()

HRESULT CanEasy::IBus::GetMsgByID	(	[in] long	nMsgID,
		[out, retval] IMessage **	iMsg
	)

Returns a message by its identifier

◆ GetMsgByName()

HRESULT CanEasy::IBus::GetMsgByName	(	[in] BSTR	sName,
		[out, retval] IMessage **	iMsg
	)

Returns a message by its name

◆ ResetChannel()

HRESULT CanEasy::IBus::ResetChannel ( )

Resets the channel, required on bus off

◆ SelectHardware()

HRESULT CanEasy::IBus::SelectHardware	(	[in] BSTR	sHardwareName,
		[in] VARIANT	vHwId,
		[in] byte	bHwChannel
	)

Connects this channel to some hardware channel.

Parameters

sHardwareName	Name of the hardware adapter
vHwId	Index or serial number, depends on the adapter
bHwChannel	Channel index of the adapter

◆ SendFreeCanMsg()

HRESULT CanEasy::IBus::SendFreeCanMsg	(	[in] long	nMsgID,
		[in] VARIANT	vData,
		[in] short	nDLC
	)

Sends a free CAN message

Parameters

nMsgID	Message identifier
vData	Byte array (payload)
nDLC	Byte length of payload

◆ SendFreeLinMsg()

HRESULT CanEasy::IBus::SendFreeLinMsg	(	[in] long	nMsgID,
		[in] VARIANT	vData,
		[in] short	nDLC,
		[in] enum LinChecksumVersion	enChecksumVersion
	)

Sends a free LIN message

Parameters

nMsgID	Message identifier
vData	Byte array (payload)
nDLC	Byte length of payload
enChecksumVersion	Checksum (Classic, Enhanced)

◆ SendFreeMsg()

HRESULT CanEasy::IBus::SendFreeMsg	(	[in] long	nMsgID,
		[in] VARIANT	vData,
		[in] short	nDLC
	)

Deprecated: Sends a message. Use TransmitMsg instead.

◆ SetTrsCtrlForMessages()

HRESULT CanEasy::IBus::SetTrsCtrlForMessages ( [in] BSTR sText )

Set the transmission control for all messages in this channel

Parameters

sText Name of the transmission control

◆ TransmitMsg()

HRESULT CanEasy::IBus::TransmitMsg	(	[in] long	nMsgID,
		[in] VARIANT	vData,
		[in] short	nDLC,
		[in] enum TransmissionFlags	enFlags
	)

Transmits a message

Parameters

nMsgID	Message identifier
vData	Byte array (payload)
nDLC	Byte length of payload
enFlags	Flags like Baudrate switch for CANFD

Property Documentation

◆ Baudrate

long CanEasy::IBus::Baudrate

getset

Baudrate used to initialized the adapter

◆ BTR0

short CanEasy::IBus::BTR0

getset

CAN BTR0 register

◆ BTR1

short CanEasy::IBus::BTR1

getset

CAN BTR1 register

◆ BusErrorEvents

VARIANT_BOOL CanEasy::IBus::BusErrorEvents

getset

Activates/Deactivates bus error events

◆ BusStateEvents

VARIANT_BOOL CanEasy::IBus::BusStateEvents

getset

Activates/Deactivates bus state (chipstate) events

◆ Channel

byte CanEasy::IBus::Channel

getset

Returns the channel identifier (see attribute ChannelId)

◆ ControlUnits

IControlUnitCol CanEasy::IBus::ControlUnits

get

Returns a collection of contained ECUs

◆ Extension

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

get

Returns a generic extension for this channel by name

◆ InitErrorEvents

VARIANT_BOOL CanEasy::IBus::InitErrorEvents

getset

Activated/Deactivates events on hardware init error

◆ LinMaster

IControlUnit CanEasy::IBus::LinMaster

getset

ECU which is configured as LIN master

◆ NMHigh

INMHighBusExt CanEasy::IBus::NMHigh

get

Returns the AutoSAR network management interface

◆ OsekNM

INMBusExt CanEasy::IBus::OsekNM

get

Returns the OSEK network management interface

◆ PreCopyEvents

VARIANT_BOOL CanEasy::IBus::PreCopyEvents

getset

Activates/Deactivates PreCopy events

◆ PreTransmitEvents

VARIANT_BOOL CanEasy::IBus::PreTransmitEvents

getset

Activates/Deactivates PreTransmit events

◆ RxConfirmEvents

VARIANT_BOOL CanEasy::IBus::RxConfirmEvents

getset

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

◆ RxEnabled

VARIANT_BOOL CanEasy::IBus::RxEnabled

getset

Activates/Deactivates the reception of all messages

◆ TransmissionEvent

ITransmissionEvent CanEasy::IBus::TransmissionEvent

get

Returns the class to get transmission events.

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

◆ TxConfirmEvents

VARIANT_BOOL CanEasy::IBus::TxConfirmEvents

getset

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

◆ TxEnabled

VARIANT_BOOL CanEasy::IBus::TxEnabled

getset

Activates/Deactivates the transmission of all messages

◆ Type

BusType CanEasy::IBus::Type

get

Returns the bus type (CAN, LIN, ETH)

◆ Variables

INamespace CanEasy::IBus::Variables

get

Returns namespace with variables created under the channel.

◆ VirtualChannel

IVirtualChannel CanEasy::IBus::VirtualChannel

get

Returns interface to get the virtual channel (see attribute VirtualChannel)