Header Files

The header files are organized hierarchically starting with the silkit directory. The subdirectory structure resembles the layered architecture of the SIL Kit. As a rule of thumb, each component has a subdirectory with its own namespace:

Table 1 Include Directories

Path

Namespace

Description

silkit/

silkit

Main header, version and macros.

silkit/services/orchestration

SilKit::Services::Orchestration

Synchronization mechanisms.

silkit/services

SilKit::Services

Simulation and Service specific definitions.

silkit/util

SilKit::Util

Generic programming utilities

silkit/config

SilKit::Config

Data structures representing the SIL Kit Configuration.
The subdirectory layout follows mostly a uniform scheme for substantial SIL Kit components:

  • silkit/<component>/all.hpp is sufficient to use the component.

  • silkit/<component>/fwd_decl.hpp contains forward declarations.

  • Data types are declared in silkit/<component>/<Component>Datatypes.hpp.

Using the SIL Kit Headers

The main header file is silkit/SilKit.hpp which defines the CreateParticipant() function. Version information can be retrieved using the silkit/SilKitVersion.hpp header and its functions, e.g., by using the Version::String() function.

Further Reading

Refer to the API overview for a description of the available services and interfaces.