Struct InterfaceVersion

• Defined in File osi_version.proto

Struct Documentation

struct InterfaceVersion

The interface version number.

The field denoting the version number. This needs to be set by the sender to the actual OSI version that is to be sent. Code wanting to access the version number of the OSI code base can access a FileOptions, which has the proper values, like this:

auto currentInterfaceVersion =
  InterfaceVersion::descriptor()->file()->options().GetExtension(current_interface_version);

If a message with all components set to the default value 0 is received, this indicates that either that the message was sent by a version 2.2.0 or earlier release, or that the sender did not properly set the version components prior to sending.

Increments will happen as part of changes to the whole interface. The meaning of different InterfaceVersions is defined [1].

References:

[1] Open Simulation Interface: README.md

Public Members

optional uint32 osi3::InterfaceVersion::version_major = 1

Major version number.

optional uint32 osi3::InterfaceVersion::version_minor = 2

Minor version number.

optional uint32 osi3::InterfaceVersion::version_patch = 3

Patch version number.