NEURON
neuron::container::Node::owning_handle Struct Reference

Owning handle to a Node. More...

#include <node_data.hpp>

Inheritance diagram for neuron::container::Node::owning_handle:
neuron::container::Node::handle_interface< owning_identifier< storage > > neuron::container::handle_base< Identifier >

Public Types

using base_type = handle_interface< owning_identifier< storage > >
 
- Public Types inherited from neuron::container::Node::handle_interface< owning_identifier< storage > >
using base_type = handle_base< owning_identifier< storage > >
 

Public Member Functions

handle non_owning_handle ()
 Get a non-owning handle from an owning handle. More...
 
- Public Member Functions inherited from neuron::container::Node::handle_interface< owning_identifier< storage > >
field::AboveDiagonal::typea ()
 Return the above-diagonal element. More...
 
field::AboveDiagonal::type const & a () const
 Return the above-diagonal element. More...
 
field::Area::typearea ()
 Return the area. More...
 
field::Area::type const & area () const
 Return the area. More...
 
field::Area::typearea_hack ()
 This is a workaround for area sometimes being a macro. More...
 
field::Area::type const & area_hack () const
 This is a workaround for area sometimes being a macro. More...
 
data_handle< field::Area::typearea_handle ()
 Return a data_handle to the area. More...
 
field::BelowDiagonal::typeb ()
 Return the below-diagonal element. More...
 
field::BelowDiagonal::type const & b () const
 Return the below-diagonal element. More...
 
field::Diagonal::typed ()
 Return the diagonal element. More...
 
field::Diagonal::type const & d () const
 Return the diagonal element. More...
 
field::Voltage::typev ()
 Return the membrane potential. More...
 
field::Voltage::type const & v () const
 Return the membrane potential. More...
 
data_handle< field::Voltage::typev_handle ()
 Return a handle to the membrane potential. More...
 
field::Voltage::typev_hack ()
 This is a workaround for v sometimes being a macro. More...
 
field::Voltage::type const & v_hack () const
 This is a workaround for v sometimes being a macro. More...
 
field::RHS::typerhs ()
 Return the right hand side of the Hines solver. More...
 
field::RHS::type const & rhs () const
 Return the right hand side of the Hines solver. More...
 
data_handle< field::RHS::typerhs_handle ()
 Return a handle to the right hand side of the Hines solver. More...
 
field::FastIMemSavRHS::typesav_d ()
 
field::FastIMemSavRHS::type const & sav_d () const
 
field::FastIMemSavRHS::typesav_rhs ()
 
field::FastIMemSavRHS::type const & sav_rhs () const
 
data_handle< field::FastIMemSavRHS::typesav_rhs_handle ()
 
- Public Member Functions inherited from neuron::container::handle_base< Identifier >
 handle_base (Identifier identifier)
 Construct a handle from an identifier. More...
 
std::size_t current_row () const
 Return current offset in the underlying storage where this object lives. More...
 
non_owning_identifier_without_container id () const
 Obtain a lightweight identifier of the current entry. More...
 
auto id_hack () const
 This is a workaround for id sometimes being a macro. More...
 
auto & underlying_storage ()
 Obtain a reference to the storage this handle refers to. More...
 
auto const & underlying_storage () const
 Obtain a const reference to the storage this handle refers to. More...
 

Additional Inherited Members

- Protected Member Functions inherited from neuron::container::handle_base< Identifier >
template<typename Tag >
auto get_handle ()
 Get a data_handle<T> referring to the given field inside this handle. More...
 
template<typename Tag >
auto get_handle (int field_index, int array_offset=0)
 Get a data_handle<T> referring to the (runtime) field_index-th copy of a given (static) field. More...
 
template<typename Tag >
auto & get ()
 
template<typename Tag >
auto const & get () const
 
template<typename Tag >
constexpr Tag const & get_tag () const
 Get the instance of the given tag type from underlying storage. More...
 
template<typename Tag >
auto & get (int field_index, int array_offset=0)
 
template<typename Tag >
auto const & get (int field_index, int array_offset=0) const
 

Detailed Description

Owning handle to a Node.

Definition at line 31 of file node_data.hpp.

Member Typedef Documentation

◆ base_type

Member Function Documentation

◆ non_owning_handle()

handle neuron::container::Node::owning_handle::non_owning_handle ( )
inline

Get a non-owning handle from an owning handle.

Definition at line 37 of file node_data.hpp.


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