CanEasy COM-Help
CanEasy Module Reference

Library to automate CanEasy. More...

Classes

interface  _IAttributeEvents
 
interface  _IBusEvents
 
interface  _ICanEasyApplicationEvents
 
interface  _ICanEasyItemComEvents
 
interface  _ICaptureTimerEvents
 
interface  _ICompareTimerEvents
 
interface  _IControlUnitEvents
 
interface  _IDatabaseEvents
 
interface  _IDatabaseItemEvents
 Database change events provided by class DatabaseItem. More...
 
interface  _IDataEntryBaseEvents
 
interface  _IEnvVarDatabaseEvents
 
interface  _IEnvVarEvents
 
interface  _IMessageEvents
 
interface  _IPreCopyEvents
 
interface  _IPreTransmitEvents
 
interface  _IRecordEvents
 
interface  _IServiceEvents
 
interface  _IShortcutEvents
 
interface  _ISignalEvents
 Events provided by a signal. More...
 
interface  _ISimulationEvents
 Definition of the events provided by class Simulation. More...
 
interface  _IStackEvents
 
interface  _ITimerControlEvents
 
interface  _ITransmissionEventEvents
 Defines the event called on transmission of a message. More...
 
interface  _IValueItemEvents
 Events provided by ValueItem. More...
 
interface  _IVstaIntegrationEvents
 
interface  _IWorkspaceModuleEvents
 
class  AppWindow
 The class AppWindow implements the interface IAppWindow. More...
 
class  Attr
 
class  AttrCol
 
class  BoolValue
 
class  Bus
 
class  BusCol
 
class  CanBusErrorRecordEntry
 
class  CanBusStateRecordEntry
 
class  CanEasyApplication
 
class  CanEasyItemCom
 
class  CanEasyItemComCol
 
class  CanEasyMenu
 
class  CanEasyMenuControl
 
class  CanEasyTree
 
class  CanMessageId
 The class CanMessageId implements the interface ICanMessageId. More...
 
class  CanMsgRecordEntry
 
class  CAPL
 
class  CaptureEntry
 
class  CaptureEntryCol
 
class  CaptureTimer
 
class  CaptureTimerArgs
 
class  CompareTimer
 
class  CompareTimerArgs
 
class  ControlUnit
 
class  ControlUnitCol
 
class  DataArray
 
class  Database
 The class Database implements the interface IDatabase and the event _IDatabaseEvents. More...
 
class  DatabaseItem
 The class DatabaseItem implements the interface IDatabaseItemBase and _IDatabaseItemEvents. More...
 
class  DatabaseItemCol
 Class DatabaseItemCol implements interface IDatabaseItemCol. More...
 
class  DataEntryColOfDynamic
 
class  DataEntryColOfStatic
 
class  Device
 
class  DeviceChannel
 
class  DeviceChannelCol
 
class  DeviceCol
 
class  DiagServiceRecordEntry
 
class  DTC
 
class  DTCCol
 
class  DTCContainer
 
class  DynamicDataEntry
 
class  DynamicServiceParam
 
class  EnvVar
 
class  EnvVarCol
 
class  EnvVarDatabase
 
class  EnvVarRecordEntry
 
class  EventArgs
 Implements the IEventArgs interface. More...
 
struct  HandleDB
 Defines an handle to the CAND ANSI-C API. More...
 
class  Hardware
 
class  HardwareConfiguration
 
class  HardwareConfigurationCol
 
interface  IAppWindow
 Gives access to the CanEasy main window. More...
 
interface  IAttrCol
 
interface  IAttribute
 Interface for a database attribute/property
More...
 
interface  IBoolValue
 Provides an event argument used for pre transmit and pre copy events e.g. to deny transmission. More...
 
interface  IBus
 
interface  IBusCol
 
interface  IBusRecordEntry
 
interface  ICanBusErrorRecordEntry
 
interface  ICanBusStateRecordEntry
 
interface  ICanEasyApplication
 Application interface which allows to access CanEasy functions like Database. More...
 
interface  ICanEasyItemCom
 
interface  ICanEasyItemComCol
 
interface  ICanEasyMenuControl
 
interface  ICanEasyTree
 Tree of CanEasy. More...
 
interface  ICanMessageId
 Access to a CAN message identifier. More...
 
interface  ICanMsgRecordEntry
 
interface  ICAPL
 The CAPL interface gives access to the CAPL converter. More...
 
interface  ICaptureEntry
 Capture timer entry which is used by ICaptureTimer. More...
 
interface  ICaptureEntryCol
 
interface  ICaptureTimer
 Capture timer which can be used to record data together with a timestamp. More...
 
interface  ICaptureTimerArgs
 
interface  IChangeArg
 Argument which is passed into value change event. More...
 
interface  ICol
 Base interface for all collections. More...
 
interface  ICompareTimer
 
interface  ICompareTimerArgs
 
interface  IControlUnit
 
interface  IControlUnitCol
 
interface  IConversion
 Interface which is used to convert a raw value into a physical value. More...
 
interface  IDataArray
 Array database item. More...
 
interface  IDatabase
 
interface  IDatabaseItem
 Base interface for all database items. More...
 
interface  IDatabaseItemBase
 Interface for generic database item that can be attached to every entry of the database. More...
 
interface  IDatabaseItemCol
 Collection of database items. More...
 
interface  IDataEntryBase
 Base interface for every database item that is mapping its value to parent or children. More...
 
interface  IDataEntryColBase
 
interface  IDataEntryColOfDynamic
 
interface  IDataEntryColOfStatic
 
interface  IDevice
 
interface  IDeviceChannel
 
interface  IDeviceChannelCol
 
interface  IDeviceCol
 
interface  IDiagServiceRecordEntry
 
interface  IDTC
 Single DTC (diagnostic trouble code) More...
 
interface  IDTCCol
 
interface  IDTCContainer
 
interface  IDynamicDataEntry
 
interface  IDynamicDataEntryBase
 
interface  IDynamicServiceParam
 
interface  IEnvVar
 Environment variable from the database. More...
 
interface  IEnvVarCol
 
interface  IEnvVarDatabase
 Root database entry of global variables. More...
 
interface  IEnvVarRecordEntry
 
interface  IEventArgs
 Base Interface for generic events (e.g. ICaptureTimerArgs) More...
 
interface  IFlexrayMsgRecordEntry
 
interface  IHardware
 
interface  IHardwareConfiguration
 The hardware configuration contains devices. More...
 
interface  IHardwareConfigurationCol
 
interface  IJ1939MessageId
 Access to a J1939 message identifier. More...
 
interface  ILicense
 
interface  ILinBusStateRecordEntry
 
interface  ILinMessageId
 Access to a LIN message identifier. More...
 
interface  ILinMsgRecordEntry
 
interface  IMarkerRecordEntry
 
interface  IMenu
 Allows to create a menu. More...
 
interface  IMessage
 
interface  IMessageCol
 
interface  IMessageId
 The interface IMessageId gives access to a message identifier. More...
 
interface  IMsgData
 
interface  IMsgRecordEntry
 
interface  INamespace
 Namespace containing environment variables. More...
 
interface  INamespaceCol
 Collection of namespaces. More...
 
interface  IObjectFilter
 Filter to search item in the database. More...
 
interface  IOffsetFactorConversion
 Simple conversion by using factor and offset. More...
 
interface  IPreCopy
 Provides PreCopy events which are called before a received message is processed by CanEasy. More...
 
interface  IPreTransmit
 Provides PreTransmit events which are called before a message gets transmitted. More...
 
interface  IReceiverCol
 
interface  IRecord
 
interface  IRecordChannel
 
interface  IRecordEntry
 
interface  IRecordFilter
 Record filter. More...
 
interface  IRecordIterator
 
interface  IReportEntry
 Entry from the report window. More...
 
interface  IReportEntryCol
 Collection of all report window tabs. More...
 
interface  IReportWnd
 Window tab containing reports. More...
 
interface  IReportWndCol
 Collection of all report windows. More...
 
interface  ISchedulerTable
 
interface  ISelection
 
interface  ISerialPort
 
interface  IService
 Service which contains request (IServiceRequest) and response (IServiceResponse) More...
 
interface  IServiceCol
 
interface  IServiceGroup
 
interface  IServiceGroupCol
 
interface  IServiceNamespace
 
interface  IServiceNamespaceCol
 
interface  IServiceParamCol
 
interface  IServiceRequest
 Service request. More...
 
interface  IServiceRequestCol
 Collection of service requests. More...
 
interface  IServiceResponse
 
interface  IServiceResponseCol
 
interface  IShortcut
 
interface  ISignal
 Signal which is child of a message. More...
 
interface  ISignalCol
 
interface  ISignalGroup
 Signal group that contains signals. More...
 
interface  ISignalGroupCol
 
interface  ISimulation
 Allows starting and stopping of the simulation. More...
 
interface  IStack
 Stack/Diag config that can be used to setup diagnosis parameter. More...
 
interface  IStackCol
 
interface  IStaticDataEntry
 
interface  IStaticDataEntryBase
 Base interface for database items with bit mask. More...
 
interface  IStaticServiceParam
 
interface  ITestReport
 
interface  ITimer
 
interface  ITimerControl
 
interface  ITransmissionData
 
interface  ITransmissionEvent
 Interface configure transmission events which are called when a message is received or transmitted. More...
 
interface  IValue
 Base interface for everything what is a kind of value object. More...
 
interface  IValueItem
 Interface for database items that represent a value. More...
 
interface  IValueTable
 Value table to map raw value to readable text. More...
 
interface  IValueTableCol
 Collection which provides access to all value tables. More...
 
interface  IValueTableEntry
 Entry of a value table. More...
 
interface  IValueTableEntryCol
 Collection of value table entries. Represents a value table. More...
 
interface  IVirtualChannel
 
interface  IVirtualChannelCol
 
interface  IVstaIntegration
 
interface  IWorkspaceModule
 
class  J1939MessageId
 
class  License
 
class  LinBusStateRecordEntry
 
class  LinMessageId
 The class LinMessageId implements the interface ILinMessageId. More...
 
class  LinMsgRecordEntry
 
class  MarkerRecordEntry
 
class  Message
 
class  MessageCol
 
class  MsgData
 
class  MsgRecordEntry
 
class  Namespace
 
class  NamespaceCol
 
class  ObjectFilter
 
class  OffsetFactorConversion
 The class OffsetFactorConversion implements the interface IOffsetFactorConversion. More...
 
class  PreCopy
 
class  PreTransmit
 
class  ReceiverCol
 
class  Record
 
class  RecordChannel
 
class  RecordFilter
 
class  RecordIterator
 
class  ReportEntry
 Class ReportEntry implement interface IReportEntry. More...
 
class  ReportEntryCol
 Class ReportEntryCol implements interface IReportEntryCol. More...
 
class  ReportWnd
 Class ReportWnd implements interface IReportWnd. More...
 
class  ReportWndCol
 Class ReportWndCol implements the interface IReportWndCol. More...
 
class  SchedulerTable
 
class  Selection
 
class  SerialPort
 
class  Service
 
class  ServiceCol
 
class  ServiceGroup
 
class  ServiceGroupCol
 
class  ServiceNamespace
 
class  ServiceNamespaceCol
 
class  ServiceParamCol
 
class  ServiceRequest
 
class  ServiceRequestCol
 
class  ServiceResponse
 
class  ServiceResponseCol
 
class  Shortcut
 
class  Signal
 
class  SignalCol
 
class  SignalGroup
 
class  SignalGroupCol
 
class  Simulation
 The class Simulation implements the interfaces ISimulation and the events _ISimulationEvents. More...
 
class  Stack
 
class  StackCol
 
class  StaticDataEntry
 
class  StaticServiceParam
 
class  TestReport
 
class  TimerControl
 
class  TransmissionData
 
class  TransmissionEvent
 The class TransmissionEvent implements the interface ITransmissionEvent and the event _ITransmissionEventEvents. More...
 
struct  ValueEntry
 Deprecated: Defines the entry of a value table. More...
 
class  ValueItem
 Class ValueItem implements the interface IValueItem. More...
 
struct  ValueRangeEntry
 Deprecated: Defines the entry of a value table with value range. More...
 
class  ValueTable
 
class  ValueTableCol
 
class  ValueTableEntry
 The class ValueTableEntry implements the interface IValueTableEntry. More...
 
class  ValueTableEntryCol
 The class ValueTableEntryCol implements the interface IValueTableEntryCol. More...
 
class  VirtualChannel
 
class  VirtualChannelCol
 
class  WorkspaceModule
 

Enumerations

enum  BusType { BUSTYPE_CAN, BUSTYPE_LIN, BUSTYPE_ETH, BUSTYPE_UNKNOWN }
 The BusType enumeration defines all the supported bus types. More...
 
enum  CanBusEvent { CANEVENT_BUSOFF, CANEVENT_PASSIVE, CANEVENT_WARNING, CANEVENT_ACTIVE }
 The CanBusEvent enumeration defines chip states from the CAN transceiver. More...
 
enum  LinBusEvent {
  LINEVENT_NOANSWER, LINEVENT_WAKEUP, LINEVENT_SLEEP, LINEVENT_SYNCERROR,
  LINEVENT_ERRORMSG, LINEVENT_CRCERROR
}
 The LinBusEvent enumeration defines events from the LIN transceiver written into the record. More...
 
enum  LinBusState { LINSTATE_WAKEUP, LINSTATE_SLEEP }
 The LinBusState enumeration defines wakeup and sleep state for a LIN bus. More...
 
enum  LinBusError { LINERROR_NOANSWER, LINERROR_SYNCERROR, LINERROR_ERRORMSG, LINERROR_CRCERROR }
 The LinBusError enumeration defines events from the LIN transceiver used by events. More...
 
enum  AttrType {
  ATTRTYPE_STRING = 0, ATTRTYPE_INT = 1, ATTRTYPE_FLOAT = 2, ATTRTYPE_HEX = 4,
  ATTRTYPE_QWORD = 5, ATTRTYPE_BOOL = 6, ATTRTYPE_ENUM = 7
}
 Deprecated: The AttrType enumeration defines value types of attributes. More...
 
enum  ValueType {
  VALUETYPE_EMPTY = 0 , VALUETYPE_CHAR_VECTOR , VALUETYPE_UCHAR_VECTOR , VALUETYPE_INT_VECTOR ,
  VALUETYPE_UINT_VECTOR , VALUETYPE_INT64_VECTOR , VALUETYPE_UINT64_VECTOR , VALUETYPE_DOUBLE_VECTOR ,
  VALUETYPE_STRING_VECTOR , VALUETYPE_POINTER_VECTOR , VALUETYPE_SHORT_VECTOR , VALUETYPE_USHORT_VECTOR ,
  VALUETYPE_FLOAT_VECTOR
}
 The ValueType enumeration defines value types of the database. More...
 
enum  EnvVarType {
  ENVVAR_BYTE = 0, ENVVAR_WORD, ENVVAR_DWORD, ENVVAR_QWORD,
  ENVVAR_BOOL, ENVVAR_INTEGER, ENVVAR_DOUBLE, ENVVAR_STRING,
  ENVVAR_INVALID
}
 Deprecated: The EnvVarType enumeration defines value types of environment variables. More...
 
enum  GenMsgMode { MSGMODE_OFF, MSGMODE_ADAPT, MSGMODE_FULL }
 The GenMsgMode enumeration defines the transmission mode for messages. More...
 
enum  SigType {
  SigTypeBool, SigTypeEdit1, SigTypeEdit2, SigTypeCombo,
  SigTypeInvalid = 0xFF
}
 Deprecated: The SigType enumeration defines the type of control to show a signal value. More...
 
enum  ValueDisplayType { DisplayType_Check, DisplayType_Slider, DisplayType_Edit, DisplayType_Combo }
 The ValueDisplayType enumeration defines the type of control to show a database value. More...
 
enum  ByteOrder { BYTEORDER_INTEL, BYTEORDER_MOTOROLA }
 The ByteOrder enumeration defines the byte order of a signal. More...
 
enum  SigValType { SigValTypeSigned, SigValTypeUnsigned, SigValTypeFloat, SigValTypeDouble }
 The SigValType enumeration defines the data type of a signal. More...
 
enum  DisplayValueType { DisplayValueType_Decimal, DisplayValueType_Hex }
 The DisplayValueType enumeration defines whether the value is shown as decimal or hexadecimal. More...
 
enum  ValueConversionType { ValueType_NoMath, ValueType_Signed, ValueType_Unsigned }
 The ValueConversionType enumeration defines the data type of a value. More...
 
enum  CallbackPosition { PositionFirst, PositionNeutral, PositionLast }
 Deprecated: The CallbackPosition enumeration defines the position when a transmission callback has to be called. More...
 
enum  ReportType { ReportTypeInformation, ReportTypeWarning, ReportTypeError }
 The ReportType enumeration defines the type/icon of a report in the report window. More...
 
enum  ReportTypeFilter {
  ReportTypeFilterNone, ReportTypeFilterInformation, ReportTypeFilterWarning, ReportTypeFilterInformationAndWarning,
  ReportTypeFilterError, ReportTypeFilterInformationAndError, ReportTypeFilterWarningAndError, ReportTypeFilterAll
}
 The ReportTypeFilter enumeration defines the filter types for the report window. More...
 
enum  RecordEntryType {
  MsgRecordEntry, CanBusErrorRecordEntry, CanBusStateRecordEntry, LinBusStateRecordEntry,
  MarkerRecordEntry, EnvVarRecordEntry, XcpRecordEntry, DiagServiceRecordEntry
}
 The RecordEntryType enumeration defines the record entry type. More...
 
enum  RecordChangedEvent { RecordUnload, RecordLoad }
 The RecordChangedEvent enumeration defines whether a record was loaded or unloaded. More...
 
enum  MsgRecordEntryType { CanMsgRecordEntry, LinMsgRecordEntry, FlexrayMsgRecordEntry }
 The MsgRecordEntryType enumeration defines the sub message type of a record entry. More...
 
enum  LinChecksumVersion { LinChecksumVersion1, LinChecksumVersion2 }
 The LinChecksumVersion enumeration defines the checksum version used to send a LIN frame. More...
 
enum  DatabaseType {
  NoneDatabaseType, BusDatabaseType, ControlUnitDatabaseType, MessageDatabaseType,
  SignalDatabaseType
}
 The DatabaseType enumeration defines database type which is refered by a default attribute. More...
 
enum  CanEasyMenuControlType { ControlTypeText, ControlTypeSeparator, ControlTypePopup }
 The CanEasyMenuControlType enumeration defines type of a context menu entry. More...
 
enum  DatabaseBrowse_Show {
  ShowAll, ShowBus, ShowEcu, ShowMessage,
  ShowSignal
}
 The DatabaseBrowse_Show enumeration defines filters for the database browse dialog. More...
 
enum  DatabaseBrowse_Select {
  SelectBus, SelectBusEcu, SelectBusEcuMessage, SelectBusEcuMessageSignal,
  SelectBusEcuSignal, SelectBusMessage, SelectBusMessageSignal, SelectBusSignal,
  SelectEcu, SelectEcuMessage, SelectEcuMessageSignal, SelectEcuSignal,
  SelectMessage, SelectMessageSignal, SelectSignal, SelectAny
}
 The DatabaseBrowse_Select enumeration defines filters for the selection in the database browse dialog. More...
 
enum  StartMode { StartWithSimulation, StartManuel }
 The StartMode enumeration defines when to start a TimerControl. More...
 
enum  TimeMode { TimeModeRelative, TimeModeAbsolute }
 The TimeMode enumeration defines how the CompareTimer must interpret the passed time values. More...
 
enum  TimerMode { TimerModeInterval, TimerModeOneShot }
 The TimerMode enumeration defines whether the TimerControl fires cyclic events. More...
 
enum  TimerStatus { TimerStatusActive, TimerStatusSuspended, TimerStatusStopped }
 The TimerStatus enumeration defines the state of the timer. More...
 
enum  DirectionFilter { FilterRx, FilterTx, FilterRxTx }
 The DirectionFilter enumeration defines filters for the replay. More...
 
enum  TransmissionState {
  Undefined, Pending, Ok, Error,
  Timeout
}
 The TransmissionState enumeration defines the state of a transmission. More...
 
enum  DataEntryType { Static, Dynamic, Array }
 The DataEntryType enumeration defines the kind of database value item. More...
 
enum  TransmissionFlags {
  TransmissionFlags_None = 0, TransmissionFlags_CAN_BaudrateSwitch = 1, TransmissionFlags_CAN_Highvoltage = 2, TransmissionFlags_CAN_Remoteframe = 4,
  TransmissionFlags_LIN_LinChecksumVersion1 = 100, TransmissionFlags_LIN_LinChecksumVersion2 = 300
}
 The TransmissionFlags enumeration defines flags for low-level protocol handling as a bit mask. More...
 
enum  ChangeContext { ChangeContext_Auto, ChangeContext_User }
 The ChangeContext enumeration defines the change context of a database modification. More...
 
enum  AddInStatus { ADDINSTATUS_UNKNOWN, ADDINSTATUS_STOPPED, ADDINSTATUS_RUNNING_RELEASE, ADDINSTATUS_RUNNING_DEBUG }
 
enum  AddInLanguage { VB, CSHARP }
 
enum  KeyModifier {
  NoKeyModifier = 0x00, AltKeyModifier = 0x01, CtrlKeyModifier = 0x02, ShiftKeyModifier = 0x04,
  WinKeyModifier = 0x08
}