Arcane  v4.1.4.0
Documentation développeur
Chargement...
Recherche...
Aucune correspondance
Classes | Types publics | Fonctions membres publiques | Attributs privés | Amis | Liste de tous les membres
Référence du modèle de la classe Arcane::properties::PropertySetting< T, DataType >
+ Graphe d'héritage de Arcane::properties::PropertySetting< T, DataType >:
+ Graphe de collaboration de Arcane::properties::PropertySetting< T, DataType >:

Classes

class  GetterArg
 
class  SetterArg
 

Types publics

typedef PropertySetting< T, DataType > ThatClass
 
typedef PropertySettingTraits< DataType > SettingsTraits
 
typedef SettingsTraits::InputType InputType
 
typedef SettingsTraits::OutputType OutputType
 
typedef std::function< void(SetterArg a)> SetterType
 
typedef std::function< OutputType(GetterArg a)> GetterType
 

Fonctions membres publiques

 PropertySetting (StringView name, GetterType getter, SetterType setter)
 
 PropertySetting (StringView name)
 
IPropertySetting * setting () final
 
const IPropertySetting * setting () const final
 
String name () const final
 Nom de la propriété
 
String commandLineArgument () const final
 Nom de l'argument de la ligne de commande (nul si aucun)
 
String description () const final
 Description de la propriété
 
String typeName () const final
 Type de la propriété
 
ThatClass & addSetter (const SetterType &setter)
 
ThatClass & addGetter (const GetterType &getter)
 
ThatClass & addCommandLineArgument (const String &arg)
 
ThatClass & addDescription (const String &arg)
 
void setInstanceValue (T &instance, InputType value) const
 
void setFromJSON (const JSONValue &v, T &instance) const override
 
void setFromString (const String &v, T &instance) const override
 
void print (std::ostream &o, const T &instance) const override
 

Attributs privés

String m_name
 
GetterType m_getter
 
SetterType m_setter
 
String m_command_line_argument
 
String m_description
 

Amis

PropertyVisitor< T > & operator<< (PropertyVisitor< T > &o, const ThatClass &me)
 

Description détaillée

template<typename T, typename DataType>
class Arcane::properties::PropertySetting< T, DataType >

Définition à la ligne 243 du fichier Property.h.

Documentation des définitions de type membres

◆ GetterType

template<typename T, typename DataType>
typedef std::function<OutputType(GetterArg a)> Arcane::properties::PropertySetting< T, DataType >::GetterType

Définition à la ligne 280 du fichier Property.h.

◆ InputType

template<typename T, typename DataType>
typedef SettingsTraits::InputType Arcane::properties::PropertySetting< T, DataType >::InputType

Définition à la ligne 251 du fichier Property.h.

◆ OutputType

template<typename T, typename DataType>
typedef SettingsTraits::OutputType Arcane::properties::PropertySetting< T, DataType >::OutputType

Définition à la ligne 252 du fichier Property.h.

◆ SetterType

template<typename T, typename DataType>
typedef std::function<void(SetterArg a)> Arcane::properties::PropertySetting< T, DataType >::SetterType

Définition à la ligne 279 du fichier Property.h.

◆ SettingsTraits

template<typename T, typename DataType>
typedef PropertySettingTraits<DataType> Arcane::properties::PropertySetting< T, DataType >::SettingsTraits

Définition à la ligne 250 du fichier Property.h.

◆ ThatClass

template<typename T, typename DataType>
typedef PropertySetting<T, DataType> Arcane::properties::PropertySetting< T, DataType >::ThatClass

Définition à la ligne 249 du fichier Property.h.

Documentation des constructeurs et destructeur

◆ PropertySetting() [1/2]

template<typename T, typename DataType>
Arcane::properties::PropertySetting< T, DataType >::PropertySetting ( StringView name,
GetterType getter,
SetterType setter )
inline

Définition à la ligne 284 du fichier Property.h.

◆ PropertySetting() [2/2]

template<typename T, typename DataType>
Arcane::properties::PropertySetting< T, DataType >::PropertySetting ( StringView name)
inline

Définition à la ligne 289 du fichier Property.h.

Documentation des fonctions membres

◆ addCommandLineArgument()

template<typename T, typename DataType>
ThatClass & Arcane::properties::PropertySetting< T, DataType >::addCommandLineArgument ( const String & arg)
inline

Définition à la ligne 331 du fichier Property.h.

◆ addDescription()

template<typename T, typename DataType>
ThatClass & Arcane::properties::PropertySetting< T, DataType >::addDescription ( const String & arg)
inline

Définition à la ligne 336 du fichier Property.h.

◆ addGetter()

template<typename T, typename DataType>
ThatClass & Arcane::properties::PropertySetting< T, DataType >::addGetter ( const GetterType & getter)
inline

Définition à la ligne 326 du fichier Property.h.

◆ addSetter()

template<typename T, typename DataType>
ThatClass & Arcane::properties::PropertySetting< T, DataType >::addSetter ( const SetterType & setter)
inline

Définition à la ligne 321 du fichier Property.h.

◆ commandLineArgument()

template<typename T, typename DataType>
String Arcane::properties::PropertySetting< T, DataType >::commandLineArgument ( ) const
inlinefinalvirtual

Nom de l'argument de la ligne de commande (nul si aucun)

Implémente Arcane::properties::IPropertySetting.

Définition à la ligne 309 du fichier Property.h.

◆ description()

template<typename T, typename DataType>
String Arcane::properties::PropertySetting< T, DataType >::description ( ) const
inlinefinalvirtual

Description de la propriété

Implémente Arcane::properties::IPropertySetting.

Définition à la ligne 313 du fichier Property.h.

◆ name()

template<typename T, typename DataType>
String Arcane::properties::PropertySetting< T, DataType >::name ( ) const
inlinefinalvirtual

Nom de la propriété

Implémente Arcane::properties::IPropertySetting.

Définition à la ligne 305 du fichier Property.h.

◆ print()

template<typename T, typename DataType>
void Arcane::properties::PropertySetting< T, DataType >::print ( std::ostream & o,
const T & instance ) const
inlineoverridevirtual

Implémente Arcane::properties::PropertySettingBase< T >.

Définition à la ligne 355 du fichier Property.h.

◆ setFromJSON()

template<typename T, typename DataType>
void Arcane::properties::PropertySetting< T, DataType >::setFromJSON ( const JSONValue & v,
T & instance ) const
inlineoverridevirtual

Implémente Arcane::properties::PropertySettingBase< T >.

Définition à la ligne 345 du fichier Property.h.

◆ setFromString()

template<typename T, typename DataType>
void Arcane::properties::PropertySetting< T, DataType >::setFromString ( const String & v,
T & instance ) const
inlineoverridevirtual

Implémente Arcane::properties::PropertySettingBase< T >.

Définition à la ligne 350 du fichier Property.h.

◆ setInstanceValue()

template<typename T, typename DataType>
void Arcane::properties::PropertySetting< T, DataType >::setInstanceValue ( T & instance,
InputType value ) const
inline

Définition à la ligne 341 du fichier Property.h.

◆ setting() [1/2]

template<typename T, typename DataType>
const IPropertySetting * Arcane::properties::PropertySetting< T, DataType >::setting ( ) const
inlinefinalvirtual

Implémente Arcane::properties::PropertySettingBase< T >.

Définition à la ligne 301 du fichier Property.h.

◆ setting() [2/2]

template<typename T, typename DataType>
IPropertySetting * Arcane::properties::PropertySetting< T, DataType >::setting ( )
inlinefinalvirtual

Implémente Arcane::properties::PropertySettingBase< T >.

Définition à la ligne 297 du fichier Property.h.

◆ typeName()

template<typename T, typename DataType>
String Arcane::properties::PropertySetting< T, DataType >::typeName ( ) const
inlinefinalvirtual

Type de la propriété

Implémente Arcane::properties::IPropertySetting.

Définition à la ligne 317 du fichier Property.h.

Documentation des fonctions amies et associées

◆ operator<<

template<typename T, typename DataType>
PropertyVisitor< T > & operator<< ( PropertyVisitor< T > & o,
const ThatClass & me )
friend

Définition à la ligne 364 du fichier Property.h.

Documentation des données membres

◆ m_command_line_argument

template<typename T, typename DataType>
String Arcane::properties::PropertySetting< T, DataType >::m_command_line_argument
private

Définition à la ligne 375 du fichier Property.h.

◆ m_description

template<typename T, typename DataType>
String Arcane::properties::PropertySetting< T, DataType >::m_description
private

Définition à la ligne 376 du fichier Property.h.

◆ m_getter

template<typename T, typename DataType>
GetterType Arcane::properties::PropertySetting< T, DataType >::m_getter
private

Définition à la ligne 373 du fichier Property.h.

◆ m_name

template<typename T, typename DataType>
String Arcane::properties::PropertySetting< T, DataType >::m_name
private

Définition à la ligne 372 du fichier Property.h.

◆ m_setter

template<typename T, typename DataType>
SetterType Arcane::properties::PropertySetting< T, DataType >::m_setter
private

Définition à la ligne 374 du fichier Property.h.

La documentation de cette classe a été générée à partir du fichier suivant :