NEST  2.6.0,not_revisioned_source_dir@0
Public Member Functions | Private Member Functions | Private Attributes | List of all members
nest::GenericConnectorModel< ConnectionT > Class Template Reference

#include <connector_model.h>

Inheritance diagram for nest::GenericConnectorModel< ConnectionT >:
nest::ConnectorModel

Public Member Functions

 GenericConnectorModel (Network &net, const std::string name)
 
 GenericConnectorModel (const GenericConnectorModel &cm, const std::string name)
 
ConnectorBaseadd_connection (Node &src, Node &tgt, ConnectorBase *conn, synindex syn_id, double_t weight, double_t delay)
 delay and weight have the default value NAN. More...
 
ConnectorBaseadd_connection (Node &src, Node &tgt, ConnectorBase *conn, synindex syn_id, DictionaryDatum &d, double_t weight, double_t delay)
 delay and weight have the default value NAN. More...
 
ConnectorModelclone (std::string) const
 
void calibrate (const TimeConverter &tc)
 
void get_status (DictionaryDatum &) const
 
void set_status (const DictionaryDatum &)
 
ConnectionT::CommonPropertiesType
const & 
get_common_properties () const
 
void set_syn_id (synindex syn_id)
 
ConnectionT const & get_default_connection () const
 
- Public Member Functions inherited from nest::ConnectorModel
 ConnectorModel (Network &net, const std::string)
 
 ConnectorModel (const ConnectorModel &, const std::string)
 
virtual ~ConnectorModel ()
 
size_t get_num_connections () const
 
const Timeget_min_delay () const
 
const Timeget_max_delay () const
 
void update_delay_extrema (const double_t mindelay_cand, const double_t maxdelay_cand)
 
void assert_valid_delay_ms (double_t)
 Raise exception if delay value in milliseconds is invalid. More...
 
void assert_two_valid_delays_steps (long_t, long_t)
 Raise exception if either of the two delays in steps is invalid. More...
 
std::string get_name () const
 
bool get_user_set_delay_extrema () const
 
Networknetwork () const
 

Private Member Functions

void used_default_delay ()
 
ConnectorBaseadd_connection (Node &src, Node &tgt, ConnectorBase *conn, synindex syn_id, ConnectionT &c, rport receptor_type)
 

Private Attributes

ConnectionT::CommonPropertiesType cp_
 
ConnectionT default_connection_
 
rport receptor_type_
 

Additional Inherited Members

- Protected Attributes inherited from nest::ConnectorModel
Networknet_
 The Network instance. More...
 
Time min_delay_
 Minimal delay of all created synapses. More...
 
Time max_delay_
 Maximal delay of all created synapses. More...
 
size_t num_connections_
 The number of connections registered with this type. More...
 
bool default_delay_needs_check_
 Flag indicating, that the default delay must be checked. More...
 
bool user_set_delay_extrema_
 Flag indicating if the user set the delay extrema. More...
 
bool used_default_delay_
 
std::string name_
 

Constructor & Destructor Documentation

template<typename ConnectionT >
nest::GenericConnectorModel< ConnectionT >::GenericConnectorModel ( Network net,
const std::string  name 
)
inline
template<typename ConnectionT >
nest::GenericConnectorModel< ConnectionT >::GenericConnectorModel ( const GenericConnectorModel< ConnectionT > &  cm,
const std::string  name 
)
inline

Member Function Documentation

template<typename ConnectionT >
ConnectorBase * nest::GenericConnectorModel< ConnectionT >::add_connection ( Node src,
Node tgt,
ConnectorBase conn,
synindex  syn_id,
double_t  delay,
double_t  weight 
)
virtual

delay and weight have the default value NAN.

NAN is a special value in cmath, which describes double values that are not a number. If delay or weight is omitted in an add_connection call, NAN indicates this and weight/delay are set only, if they are valid.

Implements nest::ConnectorModel.

References nest::names::c.

template<typename ConnectionT >
ConnectorBase * nest::GenericConnectorModel< ConnectionT >::add_connection ( Node src,
Node tgt,
ConnectorBase conn,
synindex  syn_id,
DictionaryDatum p,
double_t  delay,
double_t  weight 
)
virtual

delay and weight have the default value NAN.

NAN is a special value in cmath, which describes double values that are not a number. If delay or weight is omitted in an add_connection call, NAN indicates this and weight/delay are set only, if they are valid.

Implements nest::ConnectorModel.

References nest::names::c, nest::names::delay, nest::names::music_channel, nest::names::p, and nest::names::receptor_type.

template<typename ConnectionT >
ConnectorBase * nest::GenericConnectorModel< ConnectionT >::add_connection ( Node src,
Node tgt,
ConnectorBase conn,
synindex  syn_id,
ConnectionT &  c,
rport  receptor_type 
)
private
template<typename ConnectionT >
void nest::GenericConnectorModel< ConnectionT >::calibrate ( const TimeConverter tc)
virtual
template<typename ConnectionT >
ConnectorModel * nest::GenericConnectorModel< ConnectionT >::clone ( std::string  name) const
virtual

Implements nest::ConnectorModel.

template<typename ConnectionT >
ConnectionT::CommonPropertiesType const& nest::GenericConnectorModel< ConnectionT >::get_common_properties ( ) const
inlinevirtual
template<typename ConnectionT >
ConnectionT const& nest::GenericConnectorModel< ConnectionT >::get_default_connection ( ) const
inline
template<typename ConnectionT >
void nest::GenericConnectorModel< ConnectionT >::get_status ( DictionaryDatum d) const
virtual
template<typename ConnectionT >
void nest::GenericConnectorModel< ConnectionT >::set_status ( const DictionaryDatum d)
virtual
template<typename ConnectionT >
void nest::GenericConnectorModel< ConnectionT >::set_syn_id ( synindex  syn_id)
virtual

Implements nest::ConnectorModel.

template<typename ConnectionT >
void nest::GenericConnectorModel< ConnectionT >::used_default_delay ( )
private

Member Data Documentation

template<typename ConnectionT >
ConnectionT::CommonPropertiesType nest::GenericConnectorModel< ConnectionT >::cp_
private
template<typename ConnectionT >
ConnectionT nest::GenericConnectorModel< ConnectionT >::default_connection_
private
template<typename ConnectionT >
rport nest::GenericConnectorModel< ConnectionT >::receptor_type_
private

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