Member Reference#

This section contains all members tagged with @api.

template<template<class> class T> using score::mw::com::AsProxy = impl::AsProxy<T>#

Interpret an interface that follows our traits as proxy (cf. impl/traits.h).

Feature API:

template<template<class> class T> using score::mw::com::AsSkeleton = impl::AsSkeleton<T>#

Interpret an interface that follows our traits as skeleton (cf. impl/traits.h).

Feature API:

using score::mw::com::ComErrc = score::mw::com::impl::ComErrc #

Error codes for COM API operations as defined by AUTOSAR SWS Communication Management.

Feature API:

using score::mw::com::ComErrorDomain = score::mw::com::impl::ComErrorDomain #

Error domain providing human-readable messages for COM error codes.

Feature API:

using score::mw::com::DataTypeMetaInfo = impl::DataTypeMetaInfo#

Meta information about a data type, used for generic services.

Feature API:

using score::mw::com::EventInfo = impl::EventInfo#

Information required to create a generic event.

Feature API:

using score::mw::com::EventReceiveHandler = impl::EventReceiveHandler#

Callback for event notifications on proxy side. \requirement SWS_CM_00309.

Feature API:

using score::mw::com::FindServiceHandle = ::score::mw::com::impl::FindServiceHandle #

Handle for service discovery operations. See StartFindService() and StopFindService() for more information.

Feature API:

template<typename T> using score::mw::com::FindServiceHandler = ::score::mw::com::impl::FindServiceHandler<T>#

Callback that notifies the callee about service availability changes. See ProxyBase::StartFindService for more information.

Feature API:

using score::mw::com::GenericProxy = impl::GenericProxy #

A type erased proxy that can be used to read the raw data from a skeleton without knowing the SampleType.

Feature API:

using score::mw::com::GenericSkeleton = impl::GenericSkeleton#

A type erased skeleton that can be used to offer a service without knowing the SampleType.

Feature API:

using score::mw::com::GenericSkeletonEvent = impl::GenericSkeletonEvent#

A type erased skeleton event that can be used to send data without knowing the SampleType.

Feature API:

using score::mw::com::GenericSkeletonServiceElementInfo = impl::GenericSkeletonServiceElementInfo#

Parameters for creating a GenericSkeleton.

Feature API:

using score::mw::com::HandleType = ::score::mw::com::impl::HandleType#

Handle to a service instance.

Feature API:

using score::mw::com::InstanceIdentifier = ::score::mw::com::impl::InstanceIdentifier #

Represents a specific instance of a service. \requirement SWS_CM_01019.

Feature API:

using score::mw::com::InstanceIdentifierContainer = std::vector<InstanceIdentifier>#

The container holds a list of instance identifiers and is used as a return value of the ResolveInstanceIDs method. \requirement SWS_CM_00319.

Feature API:

using score::mw::com::InstanceSpecifier = ::score::mw::com::impl::InstanceSpecifier #

Identifier for an application port. Maps design to deployment. \requirement SWS_CM_00350.

Feature API:

template<typename T> using score::mw::com::ServiceHandleContainer = ::score::mw::com::impl::ServiceHandleContainer<T>#

Container with handles representing currently available service instances. See StartFindService() for more information.

Feature API:

using score::mw::com::SubscriptionState = ::score::mw::com::impl::SubscriptionState #

Subscription state of a proxy event. See ProxyEvent::GetSubscriptionStatus for slightly more information.

Feature API:

template<template<class> class T> using score::mw::com::impl::AsProxy = ProxyWrapperClass<T, ProxyTrait>#

Interpret an interface that follows our traits as proxy (see description above).

Feature API:

template<template<class> class T> using score::mw::com::impl::AsSkeleton = SkeletonWrapperClass<T, SkeletonTrait>#

Interpret an interface that follows our traits as skeleton (see description above).

Feature API:

enum class score::mw::com::impl::ComErrc : score::result::ErrorCode#

Error codes for the mw::com API.

Feature API:

Enum values map 1:1 to the Communication Management error codes. \requirement SWS_CM_10432 \threadsafe

Values:

enumerator kInvalid#

enumerator kServiceNotAvailable#

enumerator kMaxSamplesReached#

enumerator kBindingFailure#

enumerator kGrantEnforcementError#

enumerator kPeerIsUnreachable#

enumerator kFieldValueIsNotValid#

enumerator kSetHandlerNotSet#

enumerator kUnsetFailure#

enumerator kSampleAllocationFailure#

enumerator kIllegalUseOfAllocate#

enumerator kServiceNotOffered#

enumerator kCommunicationLinkError#

enumerator kNoClients#

enumerator kCommunicationStackError#

enumerator kMaxSampleCountNotRealizable#

enumerator kMaxSubscribersExceeded#

enumerator kErroneousFileHandle#

enumerator kCouldNotExecute#

enumerator kInvalidInstanceIdentifierString#

enumerator kInvalidBindingInformation#

enumerator kEventNotExisting#

enumerator kNotSubscribed#

enumerator kInvalidConfiguration#

enumerator kInvalidMetaModelShortname#

enumerator kServiceInstanceAlreadyOffered#

enumerator kCouldNotRestartProxy#

enumerator kNotOffered#

enumerator kInstanceIDCouldNotBeResolved#

enumerator kFindServiceHandlerFailure#

enumerator kInvalidHandle#

enumerator kCallQueueFull#

enumerator kServiceElementAlreadyExists#

enumerator kNumEnumElements#

inline std::string_view score::mw::com::impl::ComErrorDomain::MessageFor(const score::result::ErrorCode &code) const noexcept final override

Translates an error code into a human readable message.

Todo:: Gcc compiler bug leads to a compiler warning if override is not added, even if final keyword is there (https://gcc.gnu.org/bugzilla/show_bug.cgi?id=78010). When bug is fixed, remove the override keyword from the MessageFor function signature and the AUTOSAR.MEMB.VIRTUAL.SPEC klocwork suppression.

Feature API:

This function is required by the std::error_domain interface

Parameters:: code – The error code to translates
Returns:: returns a string view to the human readable message \threadsafe

score::mw::com::impl::FindServiceHandle::FindServiceHandle(FindServiceHandle &&other) noexcept = default

MoveAssignment for FindServiceHandle.

Feature API:

Parameters:: other – The FindServiceHandle *this shall be constructed from
Post:: *this == other
Returns:: The FindServiceHandle that was constructed

score::mw::com::impl::FindServiceHandle::FindServiceHandle(const FindServiceHandle &other) = default

CopyConstructor for FindServiceHandle.

Feature API:

Parameters:: other – The FindServiceHandle to copy from
Returns:: The FindServiceHandle that was constructed

friend bool score::mw::com::impl::FindServiceHandle::operator<(const FindServiceHandle &lhs, const FindServiceHandle &rhs) noexcept

LessThanComparable operator.

Feature API:

Parameters:

lhs – The first FindServiceHandle instance to compare
rhs – The second FindServiceHandle instance to compare

Returns:

true if lhs is less then rhs, false otherwise

friend mw::log::LogStream &score::mw::com::impl::FindServiceHandle::operator<<(mw::log::LogStream &log_stream, const FindServiceHandle &find_service_handle)

Stream operator which enables logging of FindServiceHandle via mw::log::LogStream.

Feature API:

Parameters:

log_stream – The log stream to write to
find_service_handle – The FindServiceHandle to log

Returns:

The log stream passed in as parameter

friend std::ostream &score::mw::com::impl::FindServiceHandle::operator<<(std::ostream &ostream_out, const FindServiceHandle &find_service_handle)

Stream operator which enables logging of FindServiceHandle via std::ostream.

Feature API:

Parameters:

ostream_out – The output stream to write to
find_service_handle – The FindServiceHandle to log

Returns:

The output stream passed in as parameter

FindServiceHandle &score::mw::com::impl::FindServiceHandle::operator=(FindServiceHandle &&other) noexcept = default

MoveAssignment for FindServiceHandle.

Feature API:

Parameters:: other – The FindServiceHandle *this shall be constructed from
Post:: *this == other
Returns:: The FindServiceHandle that was constructed

FindServiceHandle &score::mw::com::impl::FindServiceHandle::operator=(const FindServiceHandle &other) = default

CopyAssignment for FindServiceHandle.

Feature API:

Parameters:: other – The FindServiceHandle *this shall be constructed from
Post:: *this == other
Returns:: The FindServiceHandle that was constructed

friend bool score::mw::com::impl::FindServiceHandle::operator==(const FindServiceHandle &lhs, const FindServiceHandle &rhs) noexcept

Compares two instances for equality.

Feature API:

Parameters:

lhs – The first instance to check for equality
rhs – The second instance to check for equality

Returns:

true if lhs and rhs equal, false otherwise

template<typename T> using score::mw::com::impl::FindServiceHandler = score::cpp::callback<void(ServiceHandleContainer<T>, FindServiceHandle)>#

A function wrapper for the handler function that gets called by the Communication Management software in case the service availability changes.

Feature API:

It takes as input parameter a handle container containing handles for all matching service instances and a FindServiceHandle which can be used to invoke StopFindService (see [SWS_CM_00125]) from within the FindServiceHandler.

\requirement SWS_CM_00383

static Result<GenericProxy> score::mw::com::impl::GenericProxy::Create(HandleType instance_handle) noexcept

Exception-less GenericProxy constructor.

Feature API:

Parameters:: instance_handle – Handle to the instance
Returns:: Result containing the created GenericProxy instance or an error code.

EventMap &score::mw::com::impl::GenericProxy::GetEvents() noexcept

Returns a reference to the event map.

Feature API:

Returns:: Reference to the event map.

static score::Result<InstanceIdentifier> score::mw::com::impl::InstanceIdentifier::Create(std::string &&serialized_format) noexcept

Exception-less constructor to create InstanceIdentifier from a serialized InstanceIdentifier created with InstanceIdentifier::ToString().

Feature API:

Parameters:: serialized_format – The serialized format to create the InstanceIdentifier from
Returns:: The created InstanceIdentifier or an error

score::mw::com::impl::InstanceIdentifier::InstanceIdentifier(InstanceIdentifier&&) noexcept = default

Move constructor for InstanceIdentifier.

Feature API:

Parameters:: other – The InstanceIdentifier to move from
Post:: *this == other
Returns:: The moved InstanceIdentifier

score::mw::com::impl::InstanceIdentifier::InstanceIdentifier(const InstanceIdentifier&) = default

Copy constructor for InstanceIdentifier.

Feature API:

Parameters:: other – The InstanceIdentifier to copy from
Returns:: The InstanceIdentifier that was constructed

std::string_view score::mw::com::impl::InstanceIdentifier::ToString() const noexcept

Returns the serialized form of the unknown internals of this class as a meaningful string.

Feature API:

Returns:: A non-owning string representation of the internals of this class

friend bool score::mw::com::impl::InstanceIdentifier::operator<(const InstanceIdentifier &lhs, const InstanceIdentifier &rhs) noexcept

LessThanComparable operator.

Feature API:

Parameters:

lhs – The first InstanceIdentifier instance to compare
rhs – The second InstanceIdentifier instance to compare

Returns:

true if *this is less then other, false otherwise

InstanceIdentifier &score::mw::com::impl::InstanceIdentifier::operator=(InstanceIdentifier &&other) = default

MoveAssignment for InstanceIdentifier.

Feature API:

Parameters:: other – The InstanceIdentifier *this shall be constructed from
Post:: *this == other
Returns:: The InstanceIdentifier that was constructed

InstanceIdentifier &score::mw::com::impl::InstanceIdentifier::operator=(const InstanceIdentifier &other) = default

CopyAssignment for InstanceIdentifier.

ctor from serialized representation.

Constructor is required by adaptive AUTOSAR Standard. But it uses exceptions, thus we will not implement it.

explicit InstanceIdentifier(std::string_view value);

Feature API:

Parameters:: other – The InstanceIdentifier *this shall be constructed from
Post:: *this == other
Returns:: The InstanceIdentifier that was constructed

friend bool score::mw::com::impl::InstanceIdentifier::operator==(const InstanceIdentifier &lhs, const InstanceIdentifier &rhs) noexcept

Compares two instances for equality.

Feature API:

Parameters:

lhs – The first instance to check for equality
rhs – The second instance to check for equality

Returns:

true if other and *this equal, false otherwise

static score::Result<InstanceSpecifier> score::mw::com::impl::InstanceSpecifier::Create(std::string &&shortname_path) noexcept

Create an InstanceSpecifier from a shortname path.

Feature API:

Parameters:: shortname_path – The shortname path to create the InstanceSpecifier from.
Returns:: A Result containing the created InstanceSpecifier or an error.

std::string_view score::mw::com::impl::InstanceSpecifier::ToString() const noexcept

Convert the InstanceSpecifier to a string representation.

Feature API:

Returns:: A string representation of the InstanceSpecifier.

static Result<ServiceHandleContainer<HandleType>> score::mw::com::impl::ProxyBase::FindService(InstanceIdentifier instance_identifier) noexcept#

Tries to find a service that matches the given instance identifier synchronously.

Feature API:

Does a synchronous one-shot lookup/find, which service instance(s) matching the specifier are there.

Parameters:: instance_identifier – The instance_identifier of the service.
Returns:: A result which on success contains a list of found handles that can be used to create a proxy. On failure, returns an error code.

static Result<ServiceHandleContainer<HandleType>> score::mw::com::impl::ProxyBase::FindService(InstanceSpecifier specifier) noexcept#

Tries to find a service that matches the given specifier synchronously.

Feature API:

Does a synchronous one-shot lookup/find, which service instance(s) matching the specifier are there.

Parameters:: specifier – The instance specifier of the service.
Returns:: A result which on success contains a list of found handles that can be used to create a proxy. On failure, returns an error code. \requirement SWS_CM_00622

const HandleType &score::mw::com::impl::ProxyBase::GetHandle() const noexcept#

Returns the handle that was used to instantiate this proxy.

Feature API:

Returns:: Handle identifying the service that this proxy is connected to.

static Result<FindServiceHandle> score::mw::com::impl::ProxyBase::StartFindService(FindServiceHandler<HandleType> handler, InstanceIdentifier instance_identifier) noexcept#

Starts asynchronous service discovery that matches the given instance identifier.

Feature API:

Initiates a continuous service discovery operation. The provided handler will be called whenever matching service instances become available or unavailable.

Parameters:

handler – The callback handler to be invoked when service availability changes.
instance_identifier – The instance identifier of the service to find.

Returns:

A result which on success contains a handle to control the find operation. On failure, returns an error code.

static Result<FindServiceHandle> score::mw::com::impl::ProxyBase::StartFindService(FindServiceHandler<HandleType> handler, InstanceSpecifier instance_specifier) noexcept#

Starts asynchronous service discovery that matches the given instance specifier.

Feature API:

Initiates a continuous service discovery operation. The provided handler will be called whenever matching service instances become available or unavailable.

Parameters:

handler – The callback handler to be invoked when service availability changes.
instance_specifier – The instance specifier of the service to find.

Returns:

A result which on success contains a handle to control the find operation. On failure, returns an error code.

static score::ResultBlank score::mw::com::impl::ProxyBase::StopFindService(const FindServiceHandle handle) noexcept#

Stops an ongoing asynchronous service discovery operation.

Feature API:

Terminates the service discovery initiated by StartFindService. After this call, the associated handler will no longer be invoked.

Parameters:: handle – The handle returned by StartFindService identifying the find operation to stop.
Returns:: A result indicating success or failure of stopping the find operation.

Warning

doxygenfunction: Cannot find function “score::mw::com::impl::ProxyEvent< SampleDataType >::GetNewSamples” in doxygen xml output for project “com” from directory: ../../score/mw/com/design/doxygen_build/xml

std::size_t score::mw::com::impl::ProxyEventBase::GetFreeSampleCount() const noexcept#

Get the number of samples that can still be received by the user of this event.

Feature API:

If this returns 0, the user first has to drop at least one SamplePtr before it is possible to receive data via GetNewSamples again. If there is no subscription for this event, the returned value is unspecified.

Returns:: Number of samples that can still be received.

Result<std::size_t> score::mw::com::impl::ProxyEventBase::GetNumNewSamplesAvailable() const noexcept#

Returns the number of new samples a call to GetNewSamples() would currently provide if the max_sample_count set in the Subscribe call and GetNewSamples call were both infinitely high.

Feature API:

E.g. If there are 10 available / valid samples, but the max_sample_count set in the Subscribe() call was 2, then GetNumNewSamplesAvailable() would return 10 while a call to GetNewSamples(2) would only receive 2 samples. This is a proprietary extension to the official ara::com API. It is useful in resource sensitive setups, where the user wants to work in polling mode only without registered async receive-handlers. For further details see //score/mw/com/design/extensions/README.md.

Returns:: Either 0 if no new samples are available (and GetNewSamples() wouldn’t return any) or N, where 1 <= N <= actual new samples. I.e. an implementation is allowed to report a lower number than actual new samples, which would be provided by a call to GetNewSamples().

SubscriptionState score::mw::com::impl::ProxyEventBase::GetSubscriptionState() const noexcept#

Get the subscription state of this event.

Feature API:

This method can always be called regardless of the state of the event.

Returns:: Subscription state of the event.

inline bool score::mw::com::impl::ProxyEventBase::IsBindingValid() const noexcept#

Checks if the binding is valid.

Feature API:

Returns:: True if the binding is valid, false otherwise.

ResultBlank score::mw::com::impl::ProxyEventBase::SetReceiveHandler(EventReceiveHandler handler) noexcept#

Sets the handler to be called, whenever a new event-sample has been received.

Feature API:

Generally a ReceiveHandler has no restrictions on what mw::com API it is allowed to call. It is especially allowed to call all public APIs of the Event instance on which it had been set/registered as long as it obeys the general requirement, that API calls on a Proxy/Proxy event are thread safe/can’t be called concurrently.

Attention: This function MUST NOT be called from the context of a ReceiveHandler registered for this event! It makes semantically not really sense to register a “new” ReceiveHandler from the context of an already running ReceiveHandler. We also see no use cases for it and won’t support it therefore.

Parameters:: handler – user provided handler to be called

ResultBlank score::mw::com::impl::ProxyEventBase::Subscribe(const std::size_t max_sample_count) noexcept#

Subscribe to the event.

Feature API:

This will initialize the event so that event data can be received once it arrives.

Parameters:: max_sample_count – Specify the maximum number of concurrent samples that this event shall be able to offer to the using application.
Returns:: On failure, returns an error code.

ResultBlank score::mw::com::impl::ProxyEventBase::UnsetReceiveHandler() noexcept#

Removes any ReceiveHandler registered via SetReceiveHandler.

Feature API:

void score::mw::com::impl::ProxyEventBase::Unsubscribe() noexcept#

End subscription to an event and release needed resources.

Feature API:

It is illegal to call this method while data is still held by the application in the form of SamplePtr. Doing so will result in undefined behavior. An eventually currently registered ReceiveHandler will get removed (needs to be set again for a new subscription) and therefore, this method will “synchronize” with a currently running ReceiveHandler and will only finish after any running ReceiveHandler has ended. After a call to this method, the event behaves as if it had just been constructed.

Warning

doxygenfunction: Cannot find function “score::mw::com::impl::ProxyField< SampleDataType, EnableGet, EnableSet, EnableNotifier >::GetNewSamples” in doxygen xml output for project “com” from directory: ../../score/mw/com/design/doxygen_build/xml

inline std::size_t score::mw::com::impl::ProxyFieldBase::GetFreeSampleCount() noexcept#

Get the number of samples that can still be received by the user of this field.

Feature API:

If this returns 0, the user first has to drop at least one SamplePtr before it is possible to receive data via GetNewSamples again. If there is no subscription for this field, the returned value is unspecified.

Returns:: Number of samples that can still be received.

inline Result<std::size_t> score::mw::com::impl::ProxyFieldBase::GetNumNewSamplesAvailable() noexcept#

Returns the number of new samples a call to GetNewSamples() (given parameter max_num_samples doesn’t restrict it) would currently provide.

Feature API:

This is a proprietary extension to the official ara::com API. It is useful in resource sensitive setups, where the user wants to work in polling mode only without registered async receive-handlers. For further details see //score/mw/com/design/extensions/README.md.

Returns:: Either 0 if no new samples are available (and GetNewSamples() wouldn’t return any) or N, where 1 <= N <= actual new samples. I.e. an implementation is allowed to report a lower number than actual new samples, which would be provided by a call to GetNewSamples().

inline SubscriptionState score::mw::com::impl::ProxyFieldBase::GetSubscriptionState() noexcept#

Get the subscription state of this field.

Feature API:

This method can always be called regardless of the state of the field.

Returns:: Subscription state of the field.

inline ResultBlank score::mw::com::impl::ProxyFieldBase::SetReceiveHandler(EventReceiveHandler handler) noexcept#

Sets the handler to be called, whenever a new field value has been received.

Feature API:

Generally a ReceiveHandler has no restrictions on what mw::com API it is allowed to call. It is especially allowed to call all public APIs of the Field instance on which it had been set/registered as long as it obeys the general requirement, that API calls on a Proxy/Proxy field are thread safe/can’t be called concurrently.

Attention: This function MUST NOT be called from the context of a ReceiveHandler registered for this field! It makes semantically not really sense to register a “new” ReceiveHandler from the context of an already running ReceiveHandler. We also see no use cases for it and won’t support it therefore.

Parameters:: handler – user provided handler to be called

inline ResultBlank score::mw::com::impl::ProxyFieldBase::Subscribe(const std::size_t max_sample_count) noexcept#

Subscribe to the field.

Feature API:

Parameters:: max_sample_count – Specify the maximum number of concurrent samples that this event shall be able to offer to the using application.
Returns:: On failure, returns an error code.

inline ResultBlank score::mw::com::impl::ProxyFieldBase::UnsetReceiveHandler() noexcept#

Removes any ReceiveHandler registered via SetReceiveHandler.

Feature API:

inline void score::mw::com::impl::ProxyFieldBase::Unsubscribe() noexcept#

End subscription to a field and release needed resources.

Feature API:

It is illegal to call this method while data is still held by the application in the form of SamplePtr. Doing so will result in undefined behavior. After a call to this method, the field behaves as if it had just been constructed.

Warning

doxygenfunction: Cannot find function “score::mw::com::impl::ProxyWrapperClass< Interface, Trait >::Create” in doxygen xml output for project “com” from directory: ../../score/mw/com/design/doxygen_build/xml

template<typename T> using score::mw::com::impl::ServiceHandleContainer = std::vector<T>#

The container holds a list of service handles and is used as a return value of the FindService methods. \requirement SWS_CM_00304.

Feature API:

ResultBlank score::mw::com::impl::SkeletonBase::OfferService() noexcept#

Offer the respective service to other applications.

Feature API:

Returns:: On failure, returns an error code according to the SW Component Requirements SCR-17434118 and SCR-566325.

void score::mw::com::impl::SkeletonBase::StopOfferService() noexcept#

Stops offering the respective service to other applications \requirement SWS_CM_00111.

Feature API:

Warning

doxygenfunction: Cannot find function “score::mw::com::impl::SkeletonEvent< SampleDataType >::Allocate” in doxygen xml output for project “com” from directory: ../../score/mw/com/design/doxygen_build/xml

Warning

doxygenfunction: Cannot find function “score::mw::com::impl::SkeletonEvent< SampleDataType >::Send” in doxygen xml output for project “com” from directory: ../../score/mw/com/design/doxygen_build/xml

Warning

doxygenfunction: Cannot find function “score::mw::com::impl::SkeletonField< SampleDataType, EnableSet, EnableNotifier >::Allocate” in doxygen xml output for project “com” from directory: ../../score/mw/com/design/doxygen_build/xml

Warning

doxygenfunction: Cannot find function “score::mw::com::impl::SkeletonField< SampleDataType, EnableSet, EnableNotifier >::Update” in doxygen xml output for project “com” from directory: ../../score/mw/com/design/doxygen_build/xml

Warning

doxygenfunction: Cannot find function “score::mw::com::impl::SkeletonWrapperClass< Interface, Trait >::Create” in doxygen xml output for project “com” from directory: ../../score/mw/com/design/doxygen_build/xml

Warning

enum class score::mw::com::impl::SubscriptionState : std::uint8_t#

state of a proxy event. \requirement SWS_CM_00310

Feature API:

Values:

enumerator kSubscribed#: Proxy is subscribed to a particular event and will receive data.

enumerator kNotSubscribed#: Proxy is not subscribed, no data is received.

enumerator kSubscriptionPending#: Subscription is requested but not yet acknowledged by the producer.

void score::mw::com::runtime::InitializeRuntime(const RuntimeConfiguration &runtime_configuration)#

Initializes mw::com subsystem with the given configuration.

Feature API:

This call is optional for a mw::com user. Only if the mw::com configuration (json) is not located in the default manifest path, this function shall be called when the caller already has the configuration path.

Attention: This function shall only be called ONCE per application/process lifetime! A second call may have no effect after an internal runtime singleton has been already created/is in use!

void score::mw::com::runtime::InitializeRuntime(const std::int32_t argc, score::StringLiteral argv[])#

Initializes mw::com subsystem with the given configuration referenced in the command-line options.

Feature API:

This call is optional for a mw::com user. Only if the mw::com configuration (json) is not located in the default manifest path, this function shall be called with the commandline option “-service_instance_manifest” pointing to the json config file to be used.

Attention: This function shall only be called ONCE per application/process lifetime! A second call may have no effect after an internal runtime singleton has been already created/is in use!

score::Result<InstanceIdentifierContainer> score::mw::com::runtime::ResolveInstanceIDs(const InstanceSpecifier model_name)#

Resolves given InstanceSpecifier (port name in the model) to a collection of InstanceIdentifiers via manifest lookup.

Feature API:

Parameters:: modelName – (name of the SWC port)
Returns:: container with InstanceIdentifiers \requirement SWS_CM_00118

const filesystem::Path &score::mw::com::runtime::RuntimeConfiguration::GetConfigurationPath() const

Returns the stored configuration path.

Feature API:

Returns:: The stored configuration path.

score::mw::com::runtime::RuntimeConfiguration::RuntimeConfiguration(const std::int32_t argc, score::StringLiteral argv[])

Constructor which initialiases the stored configuration path from command line arguments.

Feature API:

The constructor parses the command line arguments for a specific key to extract the configuration path. If the key is not found, a default path is used.

Parameters:

argc – The number of command line arguments.
argv – The array of command line arguments.

explicit score::mw::com::runtime::RuntimeConfiguration::RuntimeConfiguration(filesystem::Path configuration_path)

Constructor which initialiases the stored configuration path with the provided path.

Feature API:

Parameters:: configuration_path – The configuration path to be stored.