Référence de la classe castor3d::Parameters

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

Fonctions membres publiques
C3D_API	Parameters ()
	Constructeur. Plus de détails...
C3D_API	~Parameters ()
	Destructeur. Plus de détails...
C3D_API void	parse (castor::String const &p_text)
	Analyse le texte donné en une liste de paramètres. Plus de détails...
template<typename T >
bool	add (castor::String const &p_name, T *p_values, uint32_t p_count)
	Ajoute un paramètre. Plus de détails...
void	add (Parameters const &p_parameters)
	Ajoute une liste de paramètres. Plus de détails...
template<typename T , uint32_t N>
bool	add (castor::String const &p_name, T const(&p_values)[N])
	Ajoute un paramètre. Plus de détails...
template<typename T >
bool	add (castor::String const &p_name, T const &p_value)
	Ajoute un paramètre. Plus de détails...
bool	add (castor::String const &p_name, castor::String const &p_value)
	Ajoute un paramètre chaîne de caractères. Plus de détails...
template<typename T >
bool	set (castor::String const &p_name, T const &p_value)
	Définit la valeur d'un paramètre. Plus de détails...
template<typename T >
bool	get (castor::String const &p_name, T *p_values, uint32_t p_count) const
	Récupère la valeur d'un paramètre. Plus de détails...
template<typename T >
bool	get (castor::String const &p_name, T &p_value) const
	Récupère la valeur d'un paramètre. Plus de détails...
template<typename T , uint32_t N>
bool	get (castor::String const &p_name, T(&p_values)[N]) const
	Récupère la valeur d'un paramètre. Plus de détails...
bool	get (castor::String const &p_name, castor::String &p_value) const
	Récupère la valeur d'un paramètre. Plus de détails...

Description détaillée

Paramètres de configuration.

Auteur

Sylvain DOREMUS

Version

0.7.0.0

Date

12/11/2012

Remarques

Couple nom/données binaires

Documentation des constructeurs et destructeur

Parameters()

C3D_API castor3d::Parameters::Parameters ( )

inline

Constructeur.

~Parameters()

C3D_API castor3d::Parameters::~Parameters ( )

inline

Destructeur.

Documentation des fonctions membres

add() [1/5]

template<typename T >

bool castor3d::Parameters::add ( castor::String const &  p_name, T *  p_values, uint32_t  p_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]	p_name	Le nom du paramètre
[in]	p_values	Les valeurs du paramètre
[in]	p_count	Le compte des valeurs

Renvoie

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

Référencé par add(), et parse().

Voici le graphe des appelants de cette fonction :

add() [2/5]

void castor3d::Parameters::add ( Parameters const &  p_parameters )

inline

Ajoute une liste de paramètres.

Paramètres

[in]

p_parameters

La liste de paramètres.

add() [3/5]

template<typename T , uint32_t N>

bool castor3d::Parameters::add ( castor::String const &  p_name, T const(&)  p_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]	p_name	Le nom du paramètre
[in]	p_values	Les valeurs du paramètre

Renvoie

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

Références add().

Voici le graphe d'appel pour cette fonction :

add() [4/5]

template<typename T >

bool castor3d::Parameters::add ( castor::String const &  p_name, T const &  p_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]	p_name	Le nom du paramètre
[in]	p_value	La valeur du paramètre

Renvoie

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

Références add().

Voici le graphe d'appel pour cette fonction :

add() [5/5]

bool castor3d::Parameters::add ( castor::String const &  p_name, castor::String const &  p_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]	p_name	Le nom du paramètre
[in]	p_value	La valeur du paramètre

Renvoie

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

get() [1/4]

template<typename T >

bool castor3d::Parameters::get ( castor::String const &  p_name, T *  p_values, uint32_t  p_count  ) const

inline

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

Paramètres

[in]	p_name	Le nom du paramètre
[out]	p_values	Ls valeurs du paramètre
[in]	p_count	La nombre disponible de valeurs

Renvoie

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

get() [2/4]

template<typename T >

bool castor3d::Parameters::get ( castor::String const &  p_name, T &  p_value  ) const

inline

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

Paramètres

[in]	p_name	Le nom du paramètre
[out]	p_value	La valeur du paramètre

Renvoie

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

get() [3/4]

template<typename T , uint32_t N>

bool castor3d::Parameters::get ( castor::String const &  p_name, T(&)  p_values[N]  ) const

inline

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

Paramètres

[in]	p_name	Le nom du paramètre
[out]	p_values	Les valeurs du paramètre

Renvoie

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

get() [4/4]

bool castor3d::Parameters::get ( castor::String const &  p_name, castor::String &  p_value  ) const

inline

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

Paramètres

[in]	p_name	Le nom du paramètre
[out]	p_value	La valeur du paramètre

Renvoie

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

parse()

C3D_API void castor3d::Parameters::parse ( castor::String const &  p_text )

inline

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

Paramètres

[in]

p_text

Le texte source.

Références add().

Voici le graphe d'appel pour cette fonction :

set()

template<typename T >

bool castor3d::Parameters::set ( castor::String const &  p_name, T const &  p_value  )

inline

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

Paramètres

[in]	p_name	Le nom du paramètre
[in]	p_value	La valeur du paramètre

Renvoie

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

---

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

• Z:/Projets/C++/Castor3D/source/Core/Castor3D/Src/Miscellaneous/Parameter.hpp