Arcane::ServiceProperty Class Reference

Service creation properties. More...

#include <arcane/core/ServiceProperty.h>

Collaboration diagram for Arcane::ServiceProperty:

Public Member Functions
	ServiceProperty (const char *aname, int atype, eServiceFactoryProperties aproperties) ARCANE_NOEXCEPT
	Constructs an instance for a service named aname and of type atype with properties properties.
	ServiceProperty (const char *aname, int atype) ARCANE_NOEXCEPT
	Constructs an instance for a service named aname and of type atype.
	ServiceProperty (const char *aname, eServiceType atype) ARCANE_NOEXCEPT
	Constructs an instance for a service named aname and of type atype.
const char *	name () const
	Service name.
int	type () const
	Service type (combination of eServiceType).
eServiceFactoryProperties	properties () const
	Service properties (combination of eServiceFactoryProperties).

Private Attributes
const char *	m_name
int	m_type
eServiceFactoryProperties	m_properties

Detailed Description

Service creation properties.

This class is used in service registration macros and can therefore be instantiated as a global variable before entering the code's main(). It should therefore only contain Plain Object Data (POD) fields.

Generally, instances of this class are used when registering a service via the ARCANE_REGISTER_SERVICE() macro.

In the constructor, the type and properties parameters can use a combination of enumerated values. For example, to specify a service that can be used both in the dataset and at the subdomain level, you can do the following:

ServiceProperty("ServiceName",ST_SubDomain|ST_CaseOption);

Definition at line 97 of file ServiceProperty.h.

Constructor & Destructor Documentation

ServiceProperty() [1/3]

Arcane::ServiceProperty::ServiceProperty ( const char * aname, int atype, eServiceFactoryProperties aproperties )

inline

Constructs an instance for a service named aname and of type atype with properties properties.

Definition at line 105 of file ServiceProperty.h.

ServiceProperty() [2/3]

Arcane::ServiceProperty::ServiceProperty ( const char * aname, int atype )

inline

Constructs an instance for a service named aname and of type atype.

Definition at line 113 of file ServiceProperty.h.

References Arcane::SFP_None.

ServiceProperty() [3/3]

Arcane::ServiceProperty::ServiceProperty ( const char * aname, eServiceType atype )

inline

Constructs an instance for a service named aname and of type atype.

Definition at line 121 of file ServiceProperty.h.

References Arcane::SFP_None.

Member Function Documentation

name()

const char * Arcane::ServiceProperty::name ( ) const

inline

Service name.

Definition at line 131 of file ServiceProperty.h.

properties()

eServiceFactoryProperties Arcane::ServiceProperty::properties ( ) const

inline

Service properties (combination of eServiceFactoryProperties).

Definition at line 137 of file ServiceProperty.h.

type()

int Arcane::ServiceProperty::type ( ) const

inline

Service type (combination of eServiceType).

Definition at line 134 of file ServiceProperty.h.

Member Data Documentation

m_name

const char* Arcane::ServiceProperty::m_name

private

Definition at line 141 of file ServiceProperty.h.

m_properties

eServiceFactoryProperties Arcane::ServiceProperty::m_properties

private

Definition at line 143 of file ServiceProperty.h.

m_type

int Arcane::ServiceProperty::m_type

private

Definition at line 142 of file ServiceProperty.h.

---

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

• ServiceProperty.h