Inheritance diagram for CanEasy::IDatabase:

Detailed Description

Database is root entry of channels, message, signals,...

 
    interface IDatabase : IDatabaseItem
    {
        HRESULT Load([in] BSTR sFilePath);
        HRESULT Save([in] BSTR sFilePath);
        HRESULT FindObject([in] IObjectFilter* filter, [in] IDispatch* iStartObj, [out, retval] IDatabaseItem**);
        HRESULT Busses([out, retval] IBusCol* *pVal);        
        HRESULT GenerateBus([in] BSTR sBusName, [in] BSTR sFile);
 
        HRESULT FindObjects([in] IObjectFilter* pFilter, [out, retval] ISelection**);      
        HRESULT ValueTables([out, retval] IValueTableCol** ppVal);
        HRESULT DBChangedEvents([out, retval] VARIANT_BOOL *pVal);
        HRESULT DBChangedEvents([in] VARIANT_BOOL boVal);
 
        HRESULT BrowseDatabase([in] long hParentWindow, [in] IDatabaseItem *iRootObj, [in] IDatabaseItem *iSelectionObj, [in] enum DatabaseBrowse_Show enKindShow, [in] enum DatabaseBrowse_Select enKindSelect, [in] BSTR sTitle, [out, retval] IDatabaseItem**);
 
        HRESULT BeginDatabaseChange();
        HRESULT EndDatabaseChange();
        HRESULT SetTrsCtrlForMessages([in] BSTR sText);
        HRESULT Variables([out, retval] INamespace **pItem);
        HRESULT CreateTransmissionEvent([out, retval] ITransmissionEvent** pItem);
        HRESULT AttributeChangeEvents([out, retval] VARIANT_BOOL* boVal);
        HRESULT AttributeChangeEvents([in] VARIANT_BOOL boVal);
          HRESULT TransmissionEvent([out, retval] ITransmissionEvent** pItem);
        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 CreateOffsetFactorConversion([out, retval] IOffsetFactorConversion**);
         HRESULT CreateDatabaseItem([in] BSTR sType, [out, retval] IDatabaseItem**);
         HRESULT SetValue([in] BSTR sRef, [in] VARIANT val);
         HRESULT GetValue([in] BSTR sRef, [out, retval] VARIANT*);
         HRESULT GetValueString([in] BSTR sRef, [out, retval] BSTR*);
         HRESULT Execute([in] BSTR sRef);
         HRESULT TransmitRef([in] BSTR sRef);
         HRESULT TransmitRefOn([in] BSTR sRef, [in] enum BusType enBusType, [in] long channel);
         HRESULT IsValueLess([in] BSTR sRef, [in] double dVal, [in] long timeout, [out, retval] VARIANT_BOOL*);
         HRESULT IsValueGreater([in] BSTR sRef, [in] double dVal, [in] long timeout, [out, retval] VARIANT_BOOL*);
         HRESULT IsValueLessOrEqual([in] BSTR sRef, [in] double dVal, [in] long timeout, [out, retval] VARIANT_BOOL*);
         HRESULT IsValueGreaterOrEqual([in] BSTR sRef, [in] double dVal, [in] long timeout, [out, retval] VARIANT_BOOL*);
         HRESULT IsValueEqual([in] BSTR sRef, [in] double dVal, [in] long timeout, [out, retval] VARIANT_BOOL*);
         HRESULT IsValueInRange([in] BSTR sRef, [in] double dMinVal, [in] double dMaxVal, [in] long timeout, [out, retval] VARIANT_BOOL*);
         HRESULT IsTransmitted([in] BSTR sRef, [in] long timeoutMS, [in] enum DirectionFilter enFilter, [out, retval] VARIANT_BOOL*);
         HRESULT ReadData([in] BSTR sRef);
         HRESULT WriteData([in] BSTR sRef);
         HRESULT CopyValue([in] IValue* s, [in] IValue* d);
    };
 

Definition at line 5290 of file cand_tlb.idl.

Member Function Documentation

◆ BeginDatabaseChange()

HRESULT CanEasy::IDatabase::BeginDatabaseChange ( )

Deprecated: Should be called before doing many database changes

◆ BrowseDatabase()

HRESULT CanEasy::IDatabase::BrowseDatabase	(	[in] long	hParentWindow,
		[in] IDatabaseItem *	iRootObj,
		[in] IDatabaseItem *	iSelectionObj,
		[in] enum DatabaseBrowse_Show	enKindShow,
		[in] enum DatabaseBrowse_Select	enKindSelect,
		[in] BSTR	sTitle,
		[out, retval] IDatabaseItem **
	)

Opens the browse dialog to select an item from the database

Parameters

hParentWindow	Handle to window that should be used as parent
iRootObj	Root object to start showing items
iSelectionObj	Object that should be selected
enKindShow	Kind of items that should be shown
enKindSelect	Kind of items that can be selected
sTitle	Title of the window

Returns: Pointer to selected database item

◆ CopyValue()

HRESULT CanEasy::IDatabase::CopyValue	(	[in] IValue *	s,
		[in] IValue *	d
	)

Copys the value, uses different ways dependent on other properties. Float, Double and Converted values use phys. Bigger than 64 bit use copy of tape.

Parameters

s	source value
d	dest value

◆ CreateDatabaseItem()

HRESULT CanEasy::IDatabase::CreateDatabaseItem	(	[in] BSTR	sType,
		[out, retval] IDatabaseItem **
	)

Creates new database item

Parameters

sType String type of the database item (see xml export)

◆ CreateOffsetFactorConversion()

HRESULT CanEasy::IDatabase::CreateOffsetFactorConversion ( [out, retval] IOffsetFactorConversion ** )

Creates new conversion

◆ CreateTransmissionEvent()

HRESULT CanEasy::IDatabase::CreateTransmissionEvent ( [out, retval] ITransmissionEvent ** pItem )

Creates TransmissionEvent which can be registered to a database item to get send/receive events

◆ EndDatabaseChange()

HRESULT CanEasy::IDatabase::EndDatabaseChange ( )

Deprecated: Should be called after doing database changes are done

◆ Execute()

HRESULT CanEasy::IDatabase::Execute ( [in] BSTR sRef )

Executes an executable database item. Can be schedule table or message.

Parameters

sRef	String path to the database item to be executed

◆ FilterPreCopy()

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

◆ FindObject()

HRESULT CanEasy::IDatabase::FindObject	(	[in] IObjectFilter *	filter,
		[in] IDispatch *	iStartObj,
		[out, retval] IDatabaseItem **
	)

Searches for a database item by filter

Parameters

filter	Filter object to identify item
iStartObj	Pointer to database item to start search

Returns: Pointer to found database item or null of nothing matched

◆ FindObjects()

HRESULT CanEasy::IDatabase::FindObjects	(	[in] IObjectFilter *	pFilter,
		[out, retval] ISelection **
	)

Searches for mulitple database items by filter

Parameters

pFilter Filter object to identify items

Returns: Selection containing all found items

◆ GenerateBus()

HRESULT CanEasy::IDatabase::GenerateBus	(	[in] BSTR	sBusName,
		[in] BSTR	sFile
	)

Import a bus from file (DBC, ARXML)

Parameters

sBusName	Bus name to import
sFile	File to import

◆ GetValue()

HRESULT CanEasy::IDatabase::GetValue	(	[in] BSTR	sRef,
		[out, retval] VARIANT *
	)

Returns a value by string path

Parameters

sRef	String path to the database item thas has to read

Returns: Value of the database item (can be string or physical value)

◆ GetValueString()

HRESULT CanEasy::IDatabase::GetValueString	(	[in] BSTR	sRef,
		[out, retval] BSTR *
	)

Returns a string value by string path

Parameters

sRef	String path to the database item thas has to read

Returns: Value of the database item as string

◆ IsTransmitted()

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

Returns true if the message was transmitted in defined time

Parameters

sRef	String path to message to be checked
timeoutMS	Timeout in milliseconds
enFilter	Direction filter (rx, tx)

Returns: True if message was transmitted otherwise False

◆ IsValueEqual()

HRESULT CanEasy::IDatabase::IsValueEqual	(	[in] BSTR	sRef,
		[in] double	dVal,
		[in] long	timeout,
		[out, retval] VARIANT_BOOL *
	)

Returns true if value becomes equal to value in defined time

Parameters

sRef	String path to the database item to be checked
dVal	Expected value to compare
timeout	Timeout in milliseconds

Returns: True if valid otherwise False

◆ IsValueGreater()

HRESULT CanEasy::IDatabase::IsValueGreater	(	[in] BSTR	sRef,
		[in] double	dVal,
		[in] long	timeout,
		[out, retval] VARIANT_BOOL *
	)

Returns true if value becomes greater than value in defined time

Parameters

sRef	String path to the database item to be checked
dVal	Expected value to compare
timeout	Timeout in milliseconds

Returns: True if valid otherwise False

◆ IsValueGreaterOrEqual()

HRESULT CanEasy::IDatabase::IsValueGreaterOrEqual	(	[in] BSTR	sRef,
		[in] double	dVal,
		[in] long	timeout,
		[out, retval] VARIANT_BOOL *
	)

Returns true if value becomes greater or equal to value in defined time

Parameters

sRef	String path to the database item to be checked
dVal	Expected value to compare
timeout	Timeout in milliseconds

Returns: True if valid otherwise False

◆ IsValueInRange()

HRESULT CanEasy::IDatabase::IsValueInRange	(	[in] BSTR	sRef,
		[in] double	dMinVal,
		[in] double	dMaxVal,
		[in] long	timeout,
		[out, retval] VARIANT_BOOL *
	)

Returns true if value becomes in defined range in defined time

Parameters

sRef	String path to the database item to be checked
dMinVal	Expected minimum value to compare
dMaxVal	Expected maximum value to compare
timeout	Timeout in milliseconds

Returns: True if valid otherwise False

◆ IsValueLess()

HRESULT CanEasy::IDatabase::IsValueLess	(	[in] BSTR	sRef,
		[in] double	dVal,
		[in] long	timeout,
		[out, retval] VARIANT_BOOL *
	)

Returns true if value becomes less than value in defined time

Parameters

sRef	String path to the database item to be checked
dVal	Expected value to compare
timeout	Timeout in milliseconds

Returns: True if valid otherwise False

◆ IsValueLessOrEqual()

HRESULT CanEasy::IDatabase::IsValueLessOrEqual	(	[in] BSTR	sRef,
		[in] double	dVal,
		[in] long	timeout,
		[out, retval] VARIANT_BOOL *
	)

Returns true if value becomes less or equal to value in defined time

Parameters

sRef	String path to the database item to be checked
dVal	Expected value to compare
timeout	Timeout in milliseconds

Returns: True if valid otherwise False

◆ Load()

HRESULT CanEasy::IDatabase::Load ( [in] BSTR sFilePath )

Loads a database from file (dbc, xml, arxml)

◆ ReadData()

HRESULT CanEasy::IDatabase::ReadData ( [in] BSTR sRef )

Reads data via UDS or XCP protocol

Parameters

sRef	String path to variable

◆ Save()

HRESULT CanEasy::IDatabase::Save ( [in] BSTR sFilePath )

Saves the database to a file

◆ SetTrsCtrlForMessages()

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

Sets the passed transmission control name for all messages of this database.

◆ SetValue()

HRESULT CanEasy::IDatabase::SetValue	(	[in] BSTR	sRef,
		[in] VARIANT	val
	)

Sets a value by string path

Parameters

sRef	String path to the database item thas has to be changed
val	Value to set (can be string or physical value)

◆ TransmitRef()

HRESULT CanEasy::IDatabase::TransmitRef ( [in] BSTR sRef )

Transmits a database item

Parameters

sRef	String path to the database item to be transmitted

◆ TransmitRefOn()

HRESULT CanEasy::IDatabase::TransmitRefOn	(	[in] BSTR	sRef,
		[in] enum BusType	enBusType,
		[in] long	channel
	)

Transmits a database item on a bus/channel

Parameters

sRef	String path to the database item to be transmitted
enBusType	Bus type to send on (CAN)
channel	Virtual channel to send on (1)

◆ WriteData()

HRESULT CanEasy::IDatabase::WriteData ( [in] BSTR sRef )

Writes data via UDS or XCP protocol

Parameters

sRef	String path to variable

Property Documentation

◆ AttributeChangeEvents

VARIANT_BOOL CanEasy::IDatabase::AttributeChangeEvents

getset

Deprecated: Activates/Deactivates attribute changes events. Use _DatabaseItemEvents instead.

◆ Busses

IBusCol CanEasy::IDatabase::Busses

get

Returns collection containing all channels/busses

◆ DBChangedEvents

VARIANT_BOOL CanEasy::IDatabase::DBChangedEvents

getset

Deprecated: Activate database change events. Use _DatabaseItemEvents instead.

◆ PreCopyEvents

VARIANT_BOOL CanEasy::IDatabase::PreCopyEvents

getset

Activates/Deactivates PreCopy events

◆ PreTransmitEvents

VARIANT_BOOL CanEasy::IDatabase::PreTransmitEvents

getset

Activates/Deactivates PreTransmit events

◆ RxConfirmEvents

VARIANT_BOOL CanEasy::IDatabase::RxConfirmEvents

getset

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

◆ TransmissionEvent

ITransmissionEvent CanEasy::IDatabase::TransmissionEvent

get

Returns the class to get transmission events.

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

◆ TxConfirmEvents

VARIANT_BOOL CanEasy::IDatabase::TxConfirmEvents

getset

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

◆ ValueTables

IValueTableCol CanEasy::IDatabase::ValueTables

get

Returns collection containing all value tables

◆ Variables

INamespace CanEasy::IDatabase::Variables

get

Returns namespace containing variables of the database