Provides information about the loaded components More...

Inheritance diagram for Arp::Base::Acf::Services::ISystemInfoService:

Public Types
using	Ptr = std::shared_ptr< ISystemInfoService >

Public Types inherited from Arp::Base::Rsc::Commons::IRscService
using	Ptr = std::shared_ptr< IRscService >
	The shared_ptr type of IRscService.

Public Member Functions
	ISystemInfoService (void)=default
	Constructs an ISystemInfoService instance.

virtual ComponentInfo	GetComponentInfo (const RscString< 512 > &componentName)=0
	Returns information about a loaded component More...

virtual std::vector< ComponentInfo >	GetComponentInfos ()=0
	Returns information about all loaded component More...

virtual RscString< 512 >	GetLibraryInfoItem (const RscString< 512 > &libraryName, LibraryInfoKind kind)=0
	Returns additional information about a library More...

virtual RscString< 512 >	GetComponentInfoItem (const RscString< 512 > &componentName, ComponentInfoKind kind)=0
	Returns additional information about a component More...

Public Member Functions inherited from Arp::Base::Rsc::Commons::IRscService
	IRscService (void)=default
	The default constructor.

	IRscService (const IRscService &arg)=delete
	The deleted copy constructor. More...

	IRscService (IRscService &&arg) noexcept=default
	The default move constructor. More...

IRscService &	operator= (const IRscService &arg)=delete
	The deleted assignment operator. More...

IRscService &	operator= (IRscService &&arg) noexcept=default
	The default move-assignment operator. More...

virtual	~IRscService (void)=default
	Destructs this instance and frees all resources.

Static Public Member Functions
static IRscServiceProxyFactory &	GetProxyFactory (void)

Static Public Member Functions inherited from Arp::Base::Rsc::Commons::IRscService
static IRscServiceProxyFactory &	GetProxyFactory (void)
	Returns a reference to service proxy factory to create a proxy instance of this service. More...

Detailed Description

Provides information about the loaded components

This service is defined in library Arp.Base.Acf.

Realtime Usage: This API call does not have to be deterministic in runtime behaviour, so an asynchronous execution should be considered.

Member Function Documentation

virtual ComponentInfo Arp::Base::Acf::Services::ISystemInfoService::GetComponentInfo ( const RscString< 512 > & componentName )

pure virtual

Returns information about a loaded component

Parameters

componentName instance name of the component

Returns: Arp.Base.Acf.Services.ComponentInfo structure with information about the component

Returns an empty object (all members are empty string) if the component could not be found.

virtual RscString< 512 > Arp::Base::Acf::Services::ISystemInfoService::GetComponentInfoItem	(	const RscString< 512 > &	componentName,
		ComponentInfoKind	kind
	)

pure virtual

Returns additional information about a component

Parameters

componentName	Name of the component to query information about
kind	Kind of information to query

Returns: Requested information as string. Empty string if the component is not found or no information is available.

virtual std::vector< ComponentInfo > Arp::Base::Acf::Services::ISystemInfoService::GetComponentInfos ( )

pure virtual

Returns information about all loaded component

Returns: Collection of Arp.Base.Acf.Services.ComponentInfo structures with information about the components

virtual RscString< 512 > Arp::Base::Acf::Services::ISystemInfoService::GetLibraryInfoItem	(	const RscString< 512 > &	libraryName,
		LibraryInfoKind	kind
	)

pure virtual

Returns additional information about a library

Parameters

libraryName	Name of the library to query information about
kind	Kind of information to query

Returns: Requested information as string. Empty string if the library is not found or no information is available.

The documentation for this class was generated from the following file: