NEST main@caf0ae8
 
Loading...
Searching...
No Matches
nest::ConnectorModel Class Referenceabstract

#include <connector_model.h>

Inheritance diagram for nest::ConnectorModel:
[legend]

Public Member Functions

 ConnectorModel (const std::string, const ConnectionModelProperties &properties)
 
 ConnectorModel (const ConnectorModel &, const std::string)
 
virtual ~ConnectorModel ()
 
virtual void add_connection (Node &src, Node &tgt, std::vector< ConnectorBase * > &hetconn, const synindex syn_id, const Dictionary &d, const double delay=NAN, const double weight=NAN)=0
 Adds a connection.
 
virtual ConnectorModel * clone (std::string, synindex syn_id) const =0
 
virtual void calibrate (const TimeConverter &tc)=0
 
virtual void get_status (Dictionary &) const =0
 
virtual void set_status (const Dictionary &)=0
 
virtual const CommonSynapseProperties & get_common_properties () const =0
 
virtual void check_synapse_params (const Dictionary &) const =0
 Checks to see if illegal parameters are given in syn_spec.
 
virtual std::unique_ptr< SecondaryEvent > get_secondary_event ()=0
 
virtual size_t get_syn_id () const =0
 
virtual void set_syn_id (synindex syn_id)=0
 
std::string get_name () const
 
bool has_property (const ConnectionModelProperties &property) const
 
ConnectionModelProperties get_properties () const
 

Protected Attributes

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

◆ ConnectorModel() [1/2]

nest::ConnectorModel::ConnectorModel ( const std::string  name,
const ConnectionModelProperties &  properties 
)

◆ ConnectorModel() [2/2]

nest::ConnectorModel::ConnectorModel ( const ConnectorModel &  cm,
const std::string  name 
)

◆ ~ConnectorModel()

virtual nest::ConnectorModel::~ConnectorModel ( )
inlinevirtual

Member Function Documentation

◆ add_connection()

virtual void nest::ConnectorModel::add_connection ( Node &  src,
Node &  tgt,
std::vector< ConnectorBase * > &  hetconn,
const synindex  syn_id,
const Dictionary &  d,
const double  delay = NAN,
const double  weight = NAN 
)
pure virtual

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.

Implemented in nest::GenericConnectorModel< ConnectionT >.

Referenced by nest::TargetTableDevices::add_connection_from_device(), nest::TargetTableDevices::add_connection_to_device(), and nest::ConnectionManager::connect_().

Here is the caller graph for this function:

◆ calibrate()

virtual void nest::ConnectorModel::calibrate ( const TimeConverter &  tc)
pure virtual

Implemented in nest::GenericConnectorModel< ConnectionT >.

Referenced by nest::GenericConnectorModel< ConnectionT >::calibrate().

Here is the caller graph for this function:

◆ check_synapse_params()

virtual void nest::ConnectorModel::check_synapse_params ( const Dictionary &  ) const
pure virtual

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().

Implemented in nest::GenericConnectorModel< ConnectionT >.

◆ clone()

virtual ConnectorModel * nest::ConnectorModel::clone ( std::string  ,
synindex  syn_id 
) const
pure virtual

◆ get_common_properties()

virtual const CommonSynapseProperties & nest::ConnectorModel::get_common_properties ( ) const
pure virtual

◆ get_name()

std::string nest::ConnectorModel::get_name ( ) const
inline

References name_.

Referenced by nest::SPManager::get_status(), and nest::ConnectionManager::get_synapse_status().

Here is the caller graph for this function:

◆ get_properties()

ConnectionModelProperties nest::ConnectorModel::get_properties ( ) const
inline

References properties_.

◆ get_secondary_event()

virtual std::unique_ptr< SecondaryEvent > nest::ConnectorModel::get_secondary_event ( )
pure virtual

Implemented in nest::GenericConnectorModel< ConnectionT >.

Referenced by nest::GenericConnectorModel< ConnectionT >::clone(), nest::ModelManager::get_secondary_event_prototype(), and nest::ModelManager::register_specific_connection_model_().

Here is the caller graph for this function:

◆ get_status()

virtual void nest::ConnectorModel::get_status ( Dictionary &  ) const
pure virtual

◆ get_syn_id()

virtual size_t nest::ConnectorModel::get_syn_id ( ) const
pure virtual

Implemented in nest::GenericConnectorModel< ConnectionT >.

Referenced by nest::EpropSynapseCommonProperties::set_status(), and nest::EpropSynapseBSSHSLM2020CommonProperties::set_status().

Here is the caller graph for this function:

◆ has_property()

bool nest::ConnectorModel::has_property ( const ConnectionModelProperties &  property) const
inline

References nest::flag_is_set(), and properties_.

Referenced by nest::GenericConnectorModel< ConnectionT >::clone(), nest::SourceTable::compute_buffer_pos_for_unique_secondary_sources(), nest::ConnectionManager::compute_compressed_secondary_recv_buffer_positions(), nest::ConnectionManager::connect_(), nest::ConnectionManager::deliver_secondary_events(), nest::ConnectionManager::fill_target_buffer(), nest::ModelManager::register_connection_model(), and nest::ModelManager::register_specific_connection_model_().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ set_status()

virtual void nest::ConnectorModel::set_status ( const Dictionary &  )
pure virtual

◆ set_syn_id()

virtual void nest::ConnectorModel::set_syn_id ( synindex  syn_id)
pure virtual

Implemented in nest::GenericConnectorModel< ConnectionT >.

Referenced by nest::GenericConnectorModel< ConnectionT >::clone(), and nest::ModelManager::register_specific_connection_model_().

Here is the caller graph for this function:

Member Data Documentation

◆ default_delay_needs_check_

bool nest::ConnectorModel::default_delay_needs_check_
protected

indicates whether the default delay must be checked

◆ name_

std::string nest::ConnectorModel::name_
protected

name of the ConnectorModel

Referenced by get_name().

◆ properties_

ConnectionModelProperties nest::ConnectorModel::properties_
protected

connection properties

Referenced by get_properties(), and has_property().


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