NEST  2.6.0,not_revisioned_source_dir@0
Public Member Functions | Static Public Member Functions | List of all members
nest::ConnParameter Class Referenceabstract

#include <conn_parameter.h>

Inheritance diagram for nest::ConnParameter:
nest::ArrayParameter nest::RandomParameter nest::ScalarDoubleParameter nest::ScalarIntegerParameter

Public Member Functions

 ConnParameter ()
 
virtual ~ConnParameter ()
 
virtual double value_double (index, index, librandom::RngPtr &) const =0
 Return parameter value. More...
 
virtual long_t value_int (index, index, librandom::RngPtr &) const =0
 
virtual size_t number_of_values () const
 Returns number of values available. More...
 

Static Public Member Functions

static ConnParametercreate (const Token &)
 

Constructor & Destructor Documentation

nest::ConnParameter::ConnParameter ( )
inline
virtual nest::ConnParameter::~ConnParameter ( )
inlinevirtual

Member Function Documentation

nest::ConnParameter * nest::ConnParameter::create ( const Token t)
static
virtual size_t nest::ConnParameter::number_of_values ( ) const
inlinevirtual

Returns number of values available.

0 indicates scalar/unlimited supply.

Reimplemented in nest::ArrayParameter.

virtual double nest::ConnParameter::value_double ( index  ,
index  ,
librandom::RngPtr  
) const
pure virtual

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.

Implemented in nest::RandomParameter, nest::ArrayParameter, nest::ScalarIntegerParameter, and nest::ScalarDoubleParameter.

virtual long_t nest::ConnParameter::value_int ( index  ,
index  ,
librandom::RngPtr  
) const
pure virtual

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