BCP_parameter Class Reference

This parameter indeintifies a single parameter entry. More...

#include <BCP_parameters.hpp>

Public Member Functions
Constructors / Destructor
	BCP_parameter ()
	The default constructor creates a phony parameter. More...
	BCP_parameter (const BCP_parameter_t t, const int i)
	Constructor where members are specified. More...
	~BCP_parameter ()
	The destructor. More...
Query methods
BCP_parameter_t	type () const
	Return the type of the parameter. More...
int	index () const
	Return the index of the parameter within all parameters of the same type. More...

Private Attributes
Data members
BCP_parameter_t	_type
	The type of the parameter (e.g., BCP_IntPar). More...
int	_index
	The index of this parameter within all parameters of the same type. More...

Detailed Description

This parameter indeintifies a single parameter entry.

Definition at line 52 of file BCP_parameters.hpp.

Constructor & Destructor Documentation

BCP_parameter::BCP_parameter ( )

inline

The default constructor creates a phony parameter.

Definition at line 68 of file BCP_parameters.hpp.

BCP_parameter::BCP_parameter ( const BCP_parameter_t  t, const int  i  )

inline

Constructor where members are specified.

Definition at line 70 of file BCP_parameters.hpp.

BCP_parameter::~BCP_parameter ( )

inline

The destructor.

Definition at line 73 of file BCP_parameters.hpp.

Member Function Documentation

BCP_parameter_t BCP_parameter::type ( ) const

inline

Return the type of the parameter.

Definition at line 79 of file BCP_parameters.hpp.

References _type.

Referenced by BCP_parameter_set< BCP_tm_par >::set_entry(), and BCP_parameter_set< BCP_tm_par >::write_to_stream().

int BCP_parameter::index ( ) const

inline

Return the index of the parameter within all parameters of the same type.

Definition at line 82 of file BCP_parameters.hpp.

References _index.

Referenced by BCP_parameter_set< BCP_tm_par >::set_entry(), and BCP_parameter_set< BCP_tm_par >::write_to_stream().

Member Data Documentation

BCP_parameter_t BCP_parameter::_type

private

The type of the parameter (e.g., BCP_IntPar).

Definition at line 58 of file BCP_parameters.hpp.

Referenced by type().

int BCP_parameter::_index

private

The index of this parameter within all parameters of the same type.

Definition at line 60 of file BCP_parameters.hpp.

Referenced by index().

---

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

• /tmp/Bcp-1.4.4/Bcp/src/include/BCP_parameters.hpp