SPARK::Problem::simulation_parameter< T > Class Template Reference

Class used to specify a simulation parameter. More...

#include <sparkapi.h>

List of all members.

Public Types
typedef T	value_type
	template type for the parameter
Public Member Functions
	simulation_parameter ()
	Default constructor: empty parameter.
	simulation_parameter (T value)
	Explicit constructor: stores value as parameter.
	simulation_parameter (const simulation_parameter &p)
	Copy constructor: deep copy of parameter value.
bool	empty () const
	Returns true if parameter is empty, false otherwise.
value_type	get () const
	Returns a copy of the parameter value.
	operator value_type () const
	Automatic conversion to parameter type.

---

Detailed Description

template<typename T>
class SPARK::Problem::simulation_parameter< T >

Class used to specify a simulation parameter.

Wrapper class around a POD object of type T that keeps track of whether the parameter was initialized in the constructor. Used in the various simulation methods that accept parameters as arguments.

Examples:

multiproblem_example1.cpp.

---

Member Typedef Documentation

template<typename T> typedef T SPARK::Problem::simulation_parameter< T >::value_type

template type for the parameter

---

Constructor & Destructor Documentation

template<typename T> SPARK::Problem::simulation_parameter< T >::simulation_parameter (   )  [inline]

Default constructor: empty parameter.

template<typename T> SPARK::Problem::simulation_parameter< T >::simulation_parameter (  T  value  )  [inline, explicit]

Explicit constructor: stores value as parameter.

template<typename T> SPARK::Problem::simulation_parameter< T >::simulation_parameter (  const simulation_parameter< T > &  p  )  [inline]

Copy constructor: deep copy of parameter value.

---

Member Function Documentation

template<typename T> bool SPARK::Problem::simulation_parameter< T >::empty (   )  const [inline]

Returns true if parameter is empty, false otherwise.

template<typename T> value_type SPARK::Problem::simulation_parameter< T >::get (   )  const [inline]

Returns a copy of the parameter value.

template<typename T> SPARK::Problem::simulation_parameter< T >::operator value_type (   )  const [inline]

Automatic conversion to parameter type.

---

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

• sparkapi.h

---