nest::ScalarIntegerParameter Class Reference

Single integer value. More...

#include <conn_parameter.h>

Inheritance diagram for nest::ScalarIntegerParameter:

Collaboration diagram for nest::ScalarIntegerParameter:

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

Private Attributes
long	value_

Additional Inherited Members
Static Public Member Functions inherited from nest::ConnParameter
static ConnParameter *	create (const any_type &, const size_t)

Detailed Description

Single integer value.

On each request, it returns the same value.

Constructor & Destructor Documentation

ScalarIntegerParameter()

nest::ScalarIntegerParameter::ScalarIntegerParameter ( long  value, const size_t    )

inline

Member Function Documentation

is_array()

bool nest::ScalarIntegerParameter::is_array ( ) const

inlineoverridevirtual

Implements nest::ConnParameter.

is_scalar()

bool nest::ScalarIntegerParameter::is_scalar ( ) const

inlineoverridevirtual

Reimplemented from nest::ConnParameter.

provides_long()

bool nest::ScalarIntegerParameter::provides_long ( ) const

inlineoverridevirtual

Reimplemented from nest::ConnParameter.

reset()

void nest::ScalarIntegerParameter::reset ( ) const

inlineoverridevirtual

Reimplemented from nest::ConnParameter.

value_double()

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

inlineoverridevirtual

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.

Implements nest::ConnParameter.

References value_.

value_int()

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

inlineoverridevirtual

Implements nest::ConnParameter.

References value_.

Member Data Documentation

value_

long nest::ScalarIntegerParameter::value_

private

Referenced by value_double(), and value_int().

---

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

• conn_parameter.h