NEST main@caf0ae8
 
Loading...
Searching...
No Matches
nest::GenericConnectorModel< ConnectionT > Class Template Reference

#include <connector_model.h>

Inheritance diagram for nest::GenericConnectorModel< ConnectionT >:
[legend]
Collaboration diagram for nest::GenericConnectorModel< ConnectionT >:
[legend]

Public Member Functions

 GenericConnectorModel (const std::string name)
 
 GenericConnectorModel (const GenericConnectorModel &cm, const std::string name)
 
void add_connection (Node &src, Node &tgt, std::vector< ConnectorBase * > &hetconn, const synindex syn_id, const Dictionary &d, const double delay, const double weight) override
 Adds a connection.
 
ConnectorModel * clone (std::string, synindex) const override
 
void calibrate (const TimeConverter &tc) override
 
void get_status (Dictionary &) const override
 
void set_status (const Dictionary &) override
 
ConnectionT::CommonPropertiesType const & get_common_properties () const override
 
size_t get_syn_id () const override
 
void set_syn_id (synindex syn_id) override
 
void check_synapse_params (const Dictionary &syn_spec) const override
 Checks to see if illegal parameters are given in syn_spec.
 
std::unique_ptr< SecondaryEvent > get_secondary_event () override
 
ConnectionT const & get_default_connection () const
 
- Public Member Functions inherited from nest::ConnectorModel
 ConnectorModel (const std::string, const ConnectionModelProperties &properties)
 
 ConnectorModel (const ConnectorModel &, const std::string)
 
virtual ~ConnectorModel ()
 
std::string get_name () const
 
bool has_property (const ConnectionModelProperties &property) const
 
ConnectionModelProperties get_properties () const
 

Private Member Functions

void used_default_delay ()
 
void add_connection_ (Node &src, Node &tgt, std::vector< ConnectorBase * > &hetconn, const synindex syn_id, ConnectionT &c, const size_t receptor_type)
 

Private Attributes

ConnectionT::CommonPropertiesType cp_
 
ConnectionT default_connection_
 
size_t receptor_type_
 

Additional Inherited Members

- Protected Attributes inherited from nest::ConnectorModel
std::string name_
 name of the ConnectorModel
 
bool default_delay_needs_check_
 indicates whether the default delay must be checked
 
ConnectionModelProperties properties_
 connection properties
 

Constructor & Destructor Documentation

◆ GenericConnectorModel() [1/2]

template<typename ConnectionT >
nest::GenericConnectorModel< ConnectionT >::GenericConnectorModel ( const std::string  name)
inline

◆ GenericConnectorModel() [2/2]

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

Member Function Documentation

◆ add_connection()

template<typename ConnectionT >
void nest::GenericConnectorModel< ConnectionT >::add_connection ( Node &  src,
Node &  tgt,
std::vector< ConnectorBase * > &  hetconn,
const synindex  syn_id,
const Dictionary &  d,
const double  delay,
const double  weight 
)
overridevirtual

Adds a connection.

Parameters
srcSource node
tgtTarget node
hetconnConnector vector
syn_idSynapse id
dParameter dictionary to configure the synapse
delayDelay of the connection
weightWeight of the connection

Delay and weight have the default value NAN, a special value, which describes double values that are not a number. If delay or weight is omitted, NAN indicates this and weight/delay are set only if they are valid.

Implements nest::ConnectorModel.

References nest::DelayChecker::assert_valid_delay_ms(), nest::KernelManager::connection_manager, nest::names::delay(), nest::ConnectionManager::get_delay_checker(), nest::HAS_DELAY, numerics::is_nan(), nest::kernel(), nest::names::music_channel(), and nest::names::receptor_type().

Here is the call graph for this function:

◆ add_connection_()

template<typename ConnectionT >
void nest::GenericConnectorModel< ConnectionT >::add_connection_ ( Node &  src,
Node &  tgt,
std::vector< ConnectorBase * > &  hetconn,
const synindex  syn_id,
ConnectionT &  c,
const size_t  receptor_type 
)
private

References nest::invalid_synindex, and nest::Connector< ConnectionT >::push_back().

Here is the call graph for this function:

◆ calibrate()

template<typename ConnectionT >
void nest::GenericConnectorModel< ConnectionT >::calibrate ( const TimeConverter &  tc)
overridevirtual

Implements nest::ConnectorModel.

References nest::ConnectorModel::calibrate().

Here is the call graph for this function:

◆ check_synapse_params()

template<typename ConnectionT >
void nest::GenericConnectorModel< ConnectionT >::check_synapse_params ( const Dictionary &  ) const
overridevirtual

Checks to see if illegal parameters are given in syn_spec.

Checks against setting CommonSynapseProperties upon Connect() are implemented in GenericConnectorModel. Any further checks need to be implemented by the connection model class by overriding Connection::check_synapse_params().

Implements nest::ConnectorModel.

References Dictionary::known().

Here is the call graph for this function:

◆ clone()

template<typename ConnectionT >
ConnectorModel * nest::GenericConnectorModel< ConnectionT >::clone ( std::string  name,
synindex  syn_id 
) const
overridevirtual

Implements nest::ConnectorModel.

References nest::ConnectorModel::get_secondary_event(), nest::ConnectorModel::has_property(), nest::IS_PRIMARY, and nest::ConnectorModel::set_syn_id().

Here is the call graph for this function:

◆ get_common_properties()

template<typename ConnectionT >
ConnectionT::CommonPropertiesType const & nest::GenericConnectorModel< ConnectionT >::get_common_properties ( ) const
inlineoverridevirtual

◆ get_default_connection()

template<typename ConnectionT >
ConnectionT const & nest::GenericConnectorModel< ConnectionT >::get_default_connection ( ) const
inline

◆ get_secondary_event()

template<typename ConnectionT >
std::unique_ptr< SecondaryEvent > nest::GenericConnectorModel< ConnectionT >::get_secondary_event ( )
inlineoverridevirtual

◆ get_status()

template<typename ConnectionT >
void nest::GenericConnectorModel< ConnectionT >::get_status ( Dictionary &  d) const
overridevirtual

◆ get_syn_id()

template<typename ConnectionT >
size_t nest::GenericConnectorModel< ConnectionT >::get_syn_id ( ) const
overridevirtual

Implements nest::ConnectorModel.

◆ set_status()

template<typename ConnectionT >
void nest::GenericConnectorModel< ConnectionT >::set_status ( const Dictionary &  d)
overridevirtual

Implements nest::ConnectorModel.

References nest::KernelManager::connection_manager, nest::DelayChecker::enable_delay_update(), nest::DelayChecker::freeze_delay_update(), nest::ConnectionManager::get_delay_checker(), nest::kernel(), nest::names::music_channel(), and nest::names::receptor_type().

Here is the call graph for this function:

◆ set_syn_id()

template<typename ConnectionT >
void nest::GenericConnectorModel< ConnectionT >::set_syn_id ( synindex  syn_id)
overridevirtual

Implements nest::ConnectorModel.

◆ used_default_delay()

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

Member Data Documentation

◆ cp_

template<typename ConnectionT >
ConnectionT::CommonPropertiesType nest::GenericConnectorModel< ConnectionT >::cp_
private

◆ default_connection_

template<typename ConnectionT >
ConnectionT nest::GenericConnectorModel< ConnectionT >::default_connection_
private

◆ receptor_type_

template<typename ConnectionT >
size_t nest::GenericConnectorModel< ConnectionT >::receptor_type_
private

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