nest::ConnParameter Class Reference

#include <conn_parameter.h>

Inheritance diagram for nest::ConnParameter:

Public Member Functions
	ConnParameter ()
virtual	~ConnParameter ()
virtual double	value_double (size_t, RngPtr, size_t, Node *) const =0
	Return parameter value.
virtual long	value_int (size_t, RngPtr, size_t, Node *) const =0
virtual void	skip (size_t, size_t) const
virtual bool	is_array () const =0
virtual bool	is_scalar () const
virtual bool	provides_long () const
virtual void	reset () const
virtual size_t	number_of_values () const
	Returns number of values available.

Static Public Member Functions
static ConnParameter *	create (const any_type &, const size_t)

Constructor & Destructor Documentation

ConnParameter()

nest::ConnParameter::ConnParameter ( )

inline

~ConnParameter()

virtual nest::ConnParameter::~ConnParameter ( )

inlinevirtual

Member Function Documentation

create()

ConnParameter * nest::ConnParameter::create ( const any_type &  value, const size_t  nthreads  )

static

Parameters

t	parameter type is established by casts to all acceptedpossibilities
nthread	number of threads required to fix number pointers to the iterator (one for each thread)

References get_typename().

Referenced by nest::BipartiteConnBuilder::set_default_weight_or_delay_(), and nest::BipartiteConnBuilder::set_synapse_params().

Here is the call graph for this function:

Here is the caller graph for this function:

is_array()

virtual bool nest::ConnParameter::is_array ( ) const

pure virtual

Implemented in nest::ScalarDoubleParameter, nest::ScalarIntegerParameter, nest::ArrayDoubleParameter, nest::ArrayLongParameter, and nest::ParameterConnParameterWrapper.

Referenced by nest::BipartiteConnBuilder::register_parameters_requiring_skipping_().

Here is the caller graph for this function:

is_scalar()

virtual bool nest::ConnParameter::is_scalar ( ) const

inlinevirtual

Reimplemented in nest::ScalarDoubleParameter, and nest::ScalarIntegerParameter.

number_of_values()

virtual size_t nest::ConnParameter::number_of_values ( ) const

inlinevirtual

Returns number of values available.

0 indicates scalar/unlimited supply.

Reimplemented in nest::ArrayDoubleParameter, and nest::ArrayLongParameter.

provides_long()

virtual bool nest::ConnParameter::provides_long ( ) const

inlinevirtual

Reimplemented in nest::ScalarIntegerParameter, nest::ArrayLongParameter, and nest::ParameterConnParameterWrapper.

reset()

virtual void nest::ConnParameter::reset ( ) const

inlinevirtual

Reimplemented in nest::ScalarDoubleParameter, nest::ScalarIntegerParameter, nest::ArrayDoubleParameter, and nest::ArrayLongParameter.

skip()

virtual void nest::ConnParameter::skip ( size_t  , size_t    ) const

inlinevirtual

Reimplemented in nest::ArrayDoubleParameter, and nest::ArrayLongParameter.

value_double()

virtual double nest::ConnParameter::value_double ( size_t  , RngPtr  , size_t  , Node *    ) const

pure virtual

Return parameter value.

The parameter value may depend on target threads and random numbers. Both must be supplied, even if a concrete parameter type does not use them.

Parameters

target_thread	will be ignored except for array parameters.
rng	random number generator pointer will be ignored except for random parameters.

Implemented in nest::ParameterConnParameterWrapper, nest::ArrayDoubleParameter, nest::ArrayLongParameter, nest::ScalarDoubleParameter, and nest::ScalarIntegerParameter.

value_int()

virtual long nest::ConnParameter::value_int ( size_t  , RngPtr  , size_t  , Node *    ) const

pure virtual

Implemented in nest::ParameterConnParameterWrapper, nest::ArrayLongParameter, nest::ScalarDoubleParameter, nest::ScalarIntegerParameter, and nest::ArrayDoubleParameter.

---

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

• conn_parameter.h
• conn_parameter.cpp