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

Single double value. More...

#include <conn_parameter.h>

Inheritance diagram for nest::ScalarDoubleParameter:
nest::ConnParameter

Public Member Functions

 ScalarDoubleParameter (double value)
 
double value_double (index, index, librandom::RngPtr &) const
 Return parameter value. More...
 
long_t value_int (index, index, librandom::RngPtr &) const
 
- Public Member Functions inherited from nest::ConnParameter
 ConnParameter ()
 
virtual ~ConnParameter ()
 
virtual size_t number_of_values () const
 Returns number of values available. More...
 

Private Attributes

double value_
 

Additional Inherited Members

- Static Public Member Functions inherited from nest::ConnParameter
static ConnParametercreate (const Token &)
 

Detailed Description

Single double value.

On each request, it returns the same value.

Constructor & Destructor Documentation

nest::ScalarDoubleParameter::ScalarDoubleParameter ( double  value)
inline

Member Function Documentation

double nest::ScalarDoubleParameter::value_double ( index  ,
index  ,
librandom::RngPtr  
) const
inlinevirtual

Return parameter value.

The parameter value may depend on source and target GIDs (when using callback functions, not yet implemented) and random numbers. All three must be supplied, even if a concrete parameter type does not use them.

Parameters
sgidsource gid
tgidtarget gid
rngrandom number generator pointer will be ignored except for random parameters.

Implements nest::ConnParameter.

References value_.

long_t nest::ScalarDoubleParameter::value_int ( index  ,
index  ,
librandom::RngPtr  
) const
inlinevirtual

Implements nest::ConnParameter.

Member Data Documentation

double nest::ScalarDoubleParameter::value_
private

Referenced by value_double().


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