<< Click to Display Table of Contents >> Navigation: Protocols > SOME/IP > API |
The structure of the COM-API corresponds to the tree structure of objects in CanEasy.
Main classes:
Name |
Description |
SomeIPConfig |
The root COM-API element, through which any child element can be accessed. |
SomeIPService |
Provides information about a service. It can be a client or server service. |
SomeIPField |
Provides information about a service field. |
SomeIPEvent |
Events connected to fields, to inform about field changes. There is possibility to fire event from VBA with method Fire during simulation. |
SomeIPEventGroup |
All events can be grouped into event groups. Event groups can contain several references to events. Event groups can be fired with VBA during simulation as well. |
SomeIPMethod |
Methods allows to describe input/output arguments (request/response). Input/Output arguments can have as difficult/deep structure as fields. |
Helper classes/structs:
Name |
Description |
SomeIPRequest |
Event parameter: Contains service information and result of request. |
SomieIPResponse |
Event parameter: Contains service information and result of response. |
SomeIPServiceInfo |
The structure contains information about the service. |
SomeIPEndpoint |
The structure provides IP address and port of endpoint for current service. |
SomeIPProtocolType |
Enumerated type of protocol (UDP, TCP). |
SomeIPMethodParam |
Contains the tree structure of method parameters. |
SomeIPMethodRequest |
Contains the tree structure of method requests. |
SomieIPMethodResponse |
Contains the tree structure of method response. |
Collections:
Name |
Description |
SomeIPServicesCollection |
Contains a collection of services for this configuration. |
SomeIPEventGroupsCollection |
Contains a collection of service event groups. |
SomeIPFieldsCollection |
Contains a collection of service fields. |
SomeIPMethodsCollection |
Contains a collection of service methods. |