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...
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...
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/4]

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().

Voici le graphe des appelants de cette fonction :

Add() [2/4]

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() [3/4]

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() [4/4]

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é

Référencé par Get().

Voici le graphe des appelants de cette fonction :

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é

Références Get().

Voici le graphe d'appel pour cette fonction :

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é

Références Get().

Voici le graphe d'appel pour cette fonction :

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é

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 :

• Y:/software/perso/Castor3D/source/Core/Castor3D/Src/Miscellaneous/Parameter.hpp