Configuration parameters. More...

Public Member Functions
C3D_API	Parameters ()
	Constructor. More...

C3D_API	~Parameters ()
	Destructor. More...

template<typename T >
bool	Add (Castor::String const &p_name, T *p_values, uint32_t p_count)
	Adds a parameter. More...

template<typename T , uint32_t N>
bool	Add (Castor::String const &p_name, T const(&p_values)[N])
	Adds a parameter. More...

template<typename T >
bool	Add (Castor::String const &p_name, T const &p_value)
	Adds a parameter. More...

bool	Add (Castor::String const &p_name, Castor::String const &p_value)
	Adds a string parameter. More...

template<typename T >
bool	Set (Castor::String const &p_name, T const &p_value)
	Sets a parameter value. More...

template<typename T >
bool	Get (Castor::String const &p_name, T *p_values, uint32_t p_count) const
	Retrieves a parameter value. More...

template<typename T >
bool	Get (Castor::String const &p_name, T &p_value) const
	Retrieves a parameter value. More...

template<typename T , uint32_t N>
bool	Get (Castor::String const &p_name, T(&p_values)[N]) const
	Retrieves a parameter value. More...

bool	Get (Castor::String const &p_name, Castor::String &p_value) const
	Retrieves a parameter value. More...

Detailed Description

Configuration parameters.

Author: Sylvain DOREMUS

Version: 0.7.0.0

Date: 12/11/2012

Remarks: Pair of a name and binary data

Constructor & Destructor Documentation

◆ Parameters()

C3D_API Castor3D::Parameters::Parameters ( )

inline

Constructor.

◆ ~Parameters()

C3D_API Castor3D::Parameters::~Parameters ( )

inline

Destructor.

Member Function Documentation

◆ Add() [1/4]

template<typename T >

bool Castor3D::Parameters::Add	(	Castor::String const &	p_name,
		T *	p_values,
		uint32_t	p_count
	)

inline

Adds a parameter.

Remarks: If a parameter with the given name already exists, nothing is done

Parameters

[in]	p_name	The parameter name
[in]	p_values	The parameter values
[in]	p_count	The values count

Returns: false if a parameter with the given name already exists

Referenced by Add().

Here is the caller graph for this function:

◆ Add() [2/4]

template<typename T , uint32_t N>

bool Castor3D::Parameters::Add	(	Castor::String const &	p_name,
		T const(&)	p_values[N]
	)

inline

Adds a parameter.

Remarks: If a parameter with the given name already exists, nothing is done

Parameters

[in]	p_name	The parameter name
[in]	p_values	The parameter values

Returns: false if a parameter with the given name already exists

References Add().

Here is the call graph for this function:

◆ Add() [3/4]

template<typename T >

bool Castor3D::Parameters::Add	(	Castor::String const &	p_name,
		T const &	p_value
	)

inline

Adds a parameter.

Remarks: If a parameter with the given name already exists, nothing is done

Parameters

[in]	p_name	The parameter name
[in]	p_value	The parameter value

Returns: false if a parameter with the given name already exists

References Add().

Here is the call graph for this function:

◆ Add() [4/4]

bool Castor3D::Parameters::Add	(	Castor::String const &	p_name,
		Castor::String const &	p_value
	)

inline

Adds a string parameter.

Remarks: If a parameter with the given name already exists, nothing is done

Parameters

[in]	p_name	The parameter name
[in]	p_value	The parameter value

Returns: false if a parameter with the given name already exists

◆ Get() [1/4]

template<typename T >

bool Castor3D::Parameters::Get	(	Castor::String const &	p_name,
		T *	p_values,
		uint32_t	p_count
	)		const

inline

Retrieves a parameter value.

Parameters

[in]	p_name	The parameter name
[out]	p_values	The parameter values
[in]	p_count	The values available count

Returns: false if there is no parameter with the given name

Referenced by Get().

Here is the caller graph for this function:

◆ Get() [2/4]

template<typename T >

bool Castor3D::Parameters::Get	(	Castor::String const &	p_name,
		T &	p_value
	)		const

inline

Retrieves a parameter value.

Parameters

[in]	p_name	The parameter name
[out]	p_value	The parameter value

Returns: false if there is no parameter with the given name

References Get().

Here is the call graph for this function:

◆ Get() [3/4]

template<typename T , uint32_t N>

bool Castor3D::Parameters::Get	(	Castor::String const &	p_name,
		T(&)	p_values[N]
	)		const

inline

Retrieves a parameter value.

Parameters

[in]	p_name	The parameter name
[out]	p_values	The parameter values

Returns: false if there is no parameter with the given name

References Get().

Here is the call graph for this function:

◆ Get() [4/4]

bool Castor3D::Parameters::Get	(	Castor::String const &	p_name,
		Castor::String &	p_value
	)		const

inline

Retrieves a parameter value.

Parameters

[in]	p_name	The parameter name
[out]	p_value	The parameter value

Returns: false if there is no parameter with the given name

◆ Set()

template<typename T >

bool Castor3D::Parameters::Set	(	Castor::String const &	p_name,
		T const &	p_value
	)

inline

Sets a parameter value.

Parameters

[in]	p_name	The parameter name
[in]	p_value	The parameter value

Returns: false if there is no parameter with the given name

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

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Parameters()

◆ ~Parameters()

Member Function Documentation

◆ Add() [1/4]

◆ Add() [2/4]

◆ Add() [3/4]

◆ Add() [4/4]

◆ Get() [1/4]

◆ Get() [2/4]

◆ Get() [3/4]

◆ Get() [4/4]

◆ Set()