Arcane  4.1.12.0
Developer documentation
Loading...
Searching...
No Matches
Arcane::IServiceInfo Class Referenceabstract
Service

Interface for service or module information. More...

#include <arcane/core/IServiceInfo.h>

Inheritance diagram for Arcane::IServiceInfo:
Collaboration diagram for Arcane::IServiceInfo:

Public Member Functions

virtual ~IServiceInfo ()=default
 Frees resources.
virtual String localName () const =0
 Local part of the service name.
virtual String namespaceURI () const =0
 Service name namespace.
virtual VersionInfo version () const =0
 Service version.
virtual Real axlVersion () const =0
 Version of the axl file describing this service.
virtual bool allowDimension (Integer n) const =0
 Indicates if the service is usable in dimension n.
virtual void addImplementedInterface (const String &name)=0
 Adds the name interface name to the interfaces implemented by this service.
virtual StringCollection implementedInterfaces () const =0
 List of names of classes implemented by this service.
virtual const String & caseOptionsFileName () const =0
 Name of the file containing the dataset (null if none).
virtual ServiceFactory2Collection factories () const =0
 List of service factories.
virtual Internal::ISingletonServiceFactory * singletonFactory () const =0
 Factory for singleton services (nullptr if not supported).
virtual String tagName (const String &lang) const =0
 Name of the service XML element for the language lang. If lang is null, returns the default name.
virtual IServiceFactoryInfo * factoryInfo () const =0
 Information on factories available for this service.
virtual int usageType () const =0
 Indicates where the service can be used.
virtual const FileContent & axlContent () const =0
 Content of the AXL file associated with this service or module.

Static Public Attributes

static const Integer Dim1 = 1
static const Integer Dim2 = 2
static const Integer Dim3 = 4

Detailed Description

Interface for service or module information.

Definition at line 32 of file IServiceInfo.h.

Member Function Documentation

◆ addImplementedInterface()

virtual void Arcane::IServiceInfo::addImplementedInterface ( const String & name)
pure virtual

Adds the name interface name to the interfaces implemented by this service.

Implemented in Arcane::Internal::ServiceInfo, and Arcane::ServiceInfo.

◆ allowDimension()

virtual bool Arcane::IServiceInfo::allowDimension ( Integer n) const
pure virtual

Indicates if the service is usable in dimension n.

Implemented in Arcane::Internal::ServiceInfo, and Arcane::ServiceInfo.

◆ axlContent()

virtual const FileContent & Arcane::IServiceInfo::axlContent ( ) const
pure virtual

Content of the AXL file associated with this service or module.

Implemented in Arcane::Internal::ServiceInfo, and Arcane::ServiceInfo.

◆ axlVersion()

virtual Real Arcane::IServiceInfo::axlVersion ( ) const
pure virtual

Version of the axl file describing this service.

Implemented in Arcane::Internal::ServiceInfo, and Arcane::ServiceInfo.

◆ caseOptionsFileName()

virtual const String & Arcane::IServiceInfo::caseOptionsFileName ( ) const
pure virtual

Name of the file containing the dataset (null if none).

Implemented in Arcane::Internal::ServiceInfo, and Arcane::ServiceInfo.

Referenced by Arcane::InternalInfosDumper::dumpArcaneDatabase().

Here is the caller graph for this function:

◆ factories()

virtual ServiceFactory2Collection Arcane::IServiceInfo::factories ( ) const
pure virtual

List of service factories.

Implemented in Arcane::Internal::ServiceInfo, and Arcane::ServiceInfo.

◆ factoryInfo()

virtual IServiceFactoryInfo * Arcane::IServiceInfo::factoryInfo ( ) const
pure virtual

Information on factories available for this service.

Implemented in Arcane::Internal::ServiceInfo, and Arcane::ServiceInfo.

Referenced by Arcane::ServiceAndModuleFactoryMng::_addFactoryFromServiceRegisterer(), Arcane::ServiceLoader::_loadServices(), and Arcane::ServiceLoader::loadSingletonService().

Here is the caller graph for this function:

◆ implementedInterfaces()

virtual StringCollection Arcane::IServiceInfo::implementedInterfaces ( ) const
pure virtual

List of names of classes implemented by this service.

Implemented in Arcane::Internal::ServiceInfo, and Arcane::ServiceInfo.

◆ localName()

virtual String Arcane::IServiceInfo::localName ( ) const
pure virtual

Local part of the service name.

Implemented in Arcane::Internal::ServiceInfo, and Arcane::ServiceInfo.

Referenced by Arcane::ServiceAndModuleFactoryMng::addGlobalFactory(), Arcane::InternalInfosDumper::dumpArcaneDatabase(), Arcane::ServiceLoader::loadSingletonService(), Arcane::CaseOptionList::printChildren(), and Arcane::ServiceMng::singletonServiceReference().

Here is the caller graph for this function:

◆ namespaceURI()

virtual String Arcane::IServiceInfo::namespaceURI ( ) const
pure virtual

Service name namespace.

Implemented in Arcane::Internal::ServiceInfo, and Arcane::ServiceInfo.

◆ singletonFactory()

virtual Internal::ISingletonServiceFactory * Arcane::IServiceInfo::singletonFactory ( ) const
pure virtual

Factory for singleton services (nullptr if not supported).

Implemented in Arcane::Internal::ServiceInfo, and Arcane::ServiceInfo.

◆ tagName()

virtual String Arcane::IServiceInfo::tagName ( const String & lang) const
pure virtual

Name of the service XML element for the language lang. If lang is null, returns the default name.

Implemented in Arcane::Internal::ServiceInfo, and Arcane::ServiceInfo.

Referenced by Arcane::TimeLoopMng::_fillModuleFactoryMap().

Here is the caller graph for this function:

◆ usageType()

virtual int Arcane::IServiceInfo::usageType ( ) const
pure virtual

Indicates where the service can be used.

It is a combination of eServiceType values.

Implemented in Arcane::Internal::ServiceInfo, and Arcane::ServiceInfo.

◆ version()

virtual VersionInfo Arcane::IServiceInfo::version ( ) const
pure virtual

Service version.

Implemented in Arcane::Internal::ServiceInfo, and Arcane::ServiceInfo.

Member Data Documentation

◆ Dim1

const Integer Arcane::IServiceInfo::Dim1 = 1
static

Definition at line 36 of file IServiceInfo.h.

◆ Dim2

const Integer Arcane::IServiceInfo::Dim2 = 2
static

Definition at line 37 of file IServiceInfo.h.

◆ Dim3

const Integer Arcane::IServiceInfo::Dim3 = 4
static

Definition at line 38 of file IServiceInfo.h.

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