NEST  2.6.0,not_revisioned_source_dir@0
Public Member Functions | Private Attributes | List of all members
nest::ConstantParameter Class Reference

Parameter with constant value. More...

#include <parameter.h>

Inheritance diagram for nest::ConstantParameter:
nest::Parameter

Public Member Functions

 ConstantParameter (double_t value)
 
 ConstantParameter (const DictionaryDatum &d)
 Parameters: value - constant value of this parameter. More...
 
 ~ConstantParameter ()
 
double_t raw_value (const Position< 2 > &, librandom::RngPtr &) const
 
double_t raw_value (const Position< 3 > &, librandom::RngPtr &) const
 Raw value disregarding cutoff. More...
 
Parameterclone () const
 Clone method. More...
 
- Public Member Functions inherited from nest::Parameter
 Parameter ()
 Default constructor. More...
 
 Parameter (double_t cutoff)
 Constructor. More...
 
 Parameter (const DictionaryDatum &d)
 Constructor Parameter that can be set in the Dictionary: cutoff - Values less than the cutoff are set to zero. More...
 
virtual ~Parameter ()
 Virtual destructor. More...
 
double_t value (const Position< 2 > &p, librandom::RngPtr &rng) const
 
double_t value (const Position< 3 > &p, librandom::RngPtr &rng) const
 
double_t value (const std::vector< double_t > &pt, librandom::RngPtr &rng) const
 
virtual Parametermultiply_parameter (const Parameter &other) const
 Create the product of this parameter with another. More...
 
virtual Parameterdivide_parameter (const Parameter &other) const
 Create the quotient of this parameter with another. More...
 
virtual Parameteradd_parameter (const Parameter &other) const
 Create the sum of this parameter with another. More...
 
virtual Parametersubtract_parameter (const Parameter &other) const
 Create the difference of this parameter with another. More...
 

Private Attributes

double_t value_
 

Detailed Description

Parameter with constant value.

Constructor & Destructor Documentation

nest::ConstantParameter::ConstantParameter ( double_t  value)
inline

Referenced by clone().

nest::ConstantParameter::ConstantParameter ( const DictionaryDatum d)
inline

Parameters: value - constant value of this parameter.

References nest::names::d, and value_.

nest::ConstantParameter::~ConstantParameter ( )
inline

Member Function Documentation

Parameter* nest::ConstantParameter::clone ( ) const
inlinevirtual

Clone method.

Returns
dynamically allocated copy of parameter object

Implements nest::Parameter.

References ConstantParameter(), and value_.

double_t nest::ConstantParameter::raw_value ( const Position< 2 > &  ,
librandom::RngPtr  
) const
inlinevirtual
Returns
the constant value of this parameter.

Reimplemented from nest::Parameter.

References value_.

double_t nest::ConstantParameter::raw_value ( const Position< 3 > &  ,
librandom::RngPtr  
) const
inlinevirtual

Raw value disregarding cutoff.

Returns
the value of the parameter at the given point.

Reimplemented from nest::Parameter.

References value_.

Member Data Documentation

double_t nest::ConstantParameter::value_
private

Referenced by clone(), ConstantParameter(), and raw_value().


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