Paramètres de configuration. Plus de détails...

#include <Parameter.hpp>

Graphe d'héritage de castor3d::ParametersT< KeyT >:

Fonctions membres publiques
	ParametersT ()=default
	Constructeur.

void	parse (castor::String const &text)
	Analyse le texte donné en une liste de paramètres.

template<typename ValueT >
bool	add (KeyT const &name, ValueT *values, uint32_t count)
	Ajoute un paramètre.

void	add (ParametersT const &parameters)
	Ajoute une liste de paramètres.

template<typename ValueT , uint32_t N>
bool	add (KeyT const &name, ValueT const(&values)[N])
	Ajoute un paramètre.

template<typename ValueT >
bool	add (KeyT const &name, ValueT const &value)
	Ajoute un paramètre.

bool	add (KeyT const &name, castor::String const &value)
	Ajoute un paramètre chaîne de caractères.

bool	add (KeyT const &name, castor::Path const &value)
	Ajoute un paramètre chaîne de caractères.

template<typename ValueT >
bool	set (KeyT const &name, ValueT const &value)
	Définit la valeur d'un paramètre.

template<typename ValueT >
bool	get (KeyT const &name, ValueT *values, uint32_t count) const
	Récupère la valeur d'un paramètre.

template<typename ValueT >
bool	get (KeyT const &name, ValueT &value) const
	Récupère la valeur d'un paramètre.

template<typename ValueT , uint32_t N>
bool	get (KeyT const &name, ValueT(&values)[N]) const
	Récupère la valeur d'un paramètre.

bool	get (KeyT const &name, castor::String &value) const
	Récupère la valeur d'un paramètre.

bool	get (KeyT const &name, castor::Path &value) const
	Récupère la valeur d'un paramètre.

template<typename ValueT >
ValueT	get (KeyT const &name) const
	Récupère la valeur d'un paramètre.

size_t	size () const

auto	begin () const noexcept

auto	end () const noexcept

Description détaillée

template<typename KeyT>
class castor3d::ParametersT< KeyT >

Paramètres de configuration.

Remarques: Couple nom/données binaires.

Documentation des constructeurs et destructeur

◆ ParametersT()

template<typename KeyT >

castor3d::ParametersT< KeyT >::ParametersT ( )

default

Constructeur.

Documentation des fonctions membres

◆ add() [1/6]

template<typename KeyT >

bool castor3d::ParametersT< KeyT >::add	(	KeyT const &	name,
		castor::Path const &	value )

inline

Ajoute un paramètre chaîne de caractères.

Remarques: Si un paramètre avec le nom donné existe déjà, rien n'est fait

Paramètres

[in]	name	Le nom du paramètre
[in]	value	La valeur du paramètre

Renvoie: false si un paramètre avec le nom donné existe déjà

Références castor3d::ParametersT< KeyT >::add().

Voici le graphe d'appel pour cette fonction :

◆ add() [2/6]

template<typename KeyT >

bool castor3d::ParametersT< KeyT >::add	(	KeyT const &	name,
		castor::String const &	value )

inline

Ajoute un paramètre chaîne de caractères.

Remarques: Si un paramètre avec le nom donné existe déjà, rien n'est fait

Paramètres

[in]	name	Le nom du paramètre
[in]	value	La valeur du paramètre

Renvoie: false si un paramètre avec le nom donné existe déjà

Références castor3d::ParametersT< KeyT >::size().

Voici le graphe d'appel pour cette fonction :

◆ add() [3/6]

template<typename KeyT >

template<typename ValueT >

bool castor3d::ParametersT< KeyT >::add	(	KeyT const &	name,
		ValueT *	values,
		uint32_t	count )

inline

Ajoute un paramètre.

Remarques: Si un paramètre avec le nom donné existe déjà, rien n'est fait

Paramètres

[in]	name	Le nom du paramètre
[in]	values	Les valeurs du paramètre
[in]	count	Le compte des valeurs

Renvoie: false si un paramètre avec le nom donné existe déjà

Référencé par castor3d::ParametersT< KeyT >::add(), castor3d::ParametersT< KeyT >::add(), castor3d::ParametersT< KeyT >::add(), et castor3d::ParametersT< KeyT >::parse().

Voici le graphe des appelants de cette fonction :

◆ add() [4/6]

template<typename KeyT >

template<typename ValueT >

bool castor3d::ParametersT< KeyT >::add	(	KeyT const &	name,
		ValueT const &	value )

inline

Ajoute un paramètre.

Remarques: Si un paramètre avec le nom donné existe déjà, rien n'est fait

Paramètres

[in]	name	Le nom du paramètre
[in]	value	La valeur du paramètre

Renvoie: false si un paramètre avec le nom donné existe déjà

Références castor3d::ParametersT< KeyT >::add().

Voici le graphe d'appel pour cette fonction :

◆ add() [5/6]

template<typename KeyT >

template<typename ValueT , uint32_t N>

bool castor3d::ParametersT< KeyT >::add	(	KeyT const &	name,
		ValueT const(&)	values[N] )

inline

Ajoute un paramètre.

Remarques: Si un paramètre avec le nom donné existe déjà, rien n'est fait

Paramètres

[in]	name	Le nom du paramètre
[in]	values	Les valeurs du paramètre

Renvoie: false si un paramètre avec le nom donné existe déjà

Références castor3d::ParametersT< KeyT >::add().

Voici le graphe d'appel pour cette fonction :

◆ add() [6/6]

template<typename KeyT >

void castor3d::ParametersT< KeyT >::add ( ParametersT< KeyT > const & parameters )

inline

Ajoute une liste de paramètres.

Paramètres

[in] parameters La liste de paramètres.

◆ begin()

template<typename KeyT >

auto castor3d::ParametersT< KeyT >::begin ( ) const

inlinenoexcept

Référencé par castor3d::ParametersT< KeyT >::get().

Voici le graphe des appelants de cette fonction :

◆ end()

template<typename KeyT >

auto castor3d::ParametersT< KeyT >::end ( ) const

inlinenoexcept

◆ get() [1/6]

template<typename KeyT >

template<typename ValueT >

ValueT castor3d::ParametersT< KeyT >::get ( KeyT const & name ) const

inline

Récupère la valeur d'un paramètre.

Paramètres

[in] name Le nom du paramètre

Références castor3d::ParametersT< KeyT >::get().

Voici le graphe d'appel pour cette fonction :

◆ get() [2/6]

template<typename KeyT >

bool castor3d::ParametersT< KeyT >::get	(	KeyT const &	name,
		castor::Path &	value ) const

inline

Récupère la valeur d'un paramètre.

Paramètres

[in]	name	Le nom du paramètre
[out]	value	La valeur du paramètre

Renvoie: false s'il n'y a pas de paramètre avec le nom donné

Références castor3d::ParametersT< KeyT >::get().

Voici le graphe d'appel pour cette fonction :

◆ get() [3/6]

template<typename KeyT >

bool castor3d::ParametersT< KeyT >::get	(	KeyT const &	name,
		castor::String &	value ) const

inline

Récupère la valeur d'un paramètre.

Paramètres

[in]	name	Le nom du paramètre
[out]	value	La valeur du paramètre

Renvoie: false s'il n'y a pas de paramètre avec le nom donné

◆ get() [4/6]

template<typename KeyT >

template<typename ValueT >

bool castor3d::ParametersT< KeyT >::get	(	KeyT const &	name,
		ValueT &	value ) const

inline

Récupère la valeur d'un paramètre.

Paramètres

[in]	name	Le nom du paramètre
[out]	value	La valeur du paramètre

Renvoie: false s'il n'y a pas de paramètre avec le nom donné

Références castor3d::ParametersT< KeyT >::get().

Voici le graphe d'appel pour cette fonction :

◆ get() [5/6]

template<typename KeyT >

template<typename ValueT >

bool castor3d::ParametersT< KeyT >::get	(	KeyT const &	name,
		ValueT *	values,
		uint32_t	count ) const

inline

Récupère la valeur d'un paramètre.

Paramètres

[in]	name	Le nom du paramètre
[out]	values	Les valeurs du paramètre
[in]	count	La nombre disponible de valeurs

Renvoie: false s'il n'y a pas de paramètre avec le nom donné

Références castor3d::ParametersT< KeyT >::begin().

Référencé par castor3d::ParametersT< KeyT >::get(), castor3d::ParametersT< KeyT >::get(), castor3d::ParametersT< KeyT >::get(), et castor3d::ParametersT< KeyT >::get().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

◆ get() [6/6]

template<typename KeyT >

template<typename ValueT , uint32_t N>

bool castor3d::ParametersT< KeyT >::get	(	KeyT const &	name,
		ValueT(&)	values[N] ) const

inline

Récupère la valeur d'un paramètre.

Paramètres

[in]	name	Le nom du paramètre
[out]	values	Les valeurs du paramètre

Renvoie: false s'il n'y a pas de paramètre avec le nom donné

Références castor3d::ParametersT< KeyT >::get().

Voici le graphe d'appel pour cette fonction :

◆ parse()

template<typename KeyT >

void castor3d::ParametersT< KeyT >::parse ( castor::String const & text )

inline

Analyse le texte donné en une liste de paramètres.

Paramètres

[in] text Le texte source.

Références castor3d::ParametersT< KeyT >::add(), cuT, et castor::string::split().

Voici le graphe d'appel pour cette fonction :

◆ set()

template<typename KeyT >

template<typename ValueT >

bool castor3d::ParametersT< KeyT >::set	(	KeyT const &	name,
		ValueT const &	value )

inline

Définit la valeur d'un paramètre.

Paramètres

[in]	name	Le nom du paramètre
[in]	value	La valeur du paramètre

Renvoie: false s'il n'y a pas de paramètre avec le nom donné

◆ size()

template<typename KeyT >

size_t castor3d::ParametersT< KeyT >::size ( ) const

inline

Référencé par castor3d::ParametersT< KeyT >::add().

Voici le graphe des appelants de cette fonction :

La documentation de cette classe a été générée à partir des fichiers suivants :

Castor3D/Miscellaneous/MiscellaneousModule.hpp
Castor3D/Miscellaneous/Parameter.hpp

Fonctions membres publiques

Description détaillée

Documentation des constructeurs et destructeur

◆ ParametersT()

Documentation des fonctions membres

◆ add() [1/6]

◆ add() [2/6]

◆ add() [3/6]

◆ add() [4/6]

◆ add() [5/6]

◆ add() [6/6]

◆ begin()

◆ end()

◆ get() [1/6]

◆ get() [2/6]

◆ get() [3/6]

◆ get() [4/6]

◆ get() [5/6]

◆ get() [6/6]

◆ parse()

◆ set()

◆ size()