NeuroML C++ API  2.3.0
C++ API for NeuroML 2
List of all members
neuroml2::basePyNNIaFCell Class Reference

Class corresponding to the basePyNNIaFCell schema type. More...

#include <NeuroML_v2.3.hxx>

+ Inheritance diagram for neuroml2::basePyNNIaFCell:
+ Collaboration diagram for neuroml2::basePyNNIaFCell:

tau_m

Accessor and modifier functions for the tau_m required attribute.

typedef ::xml_schema::float_ tau_m_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< tau_m_type, char > tau_m_traits
 Attribute traits type.
 
const tau_m_typetau_m () const
 Return a read-only (constant) reference to the attribute. More...
 
tau_m_typetau_m ()
 Return a read-write reference to the attribute. More...
 
void tau_m (const tau_m_type &x)
 Set the attribute value. More...
 

tau_refrac

Accessor and modifier functions for the tau_refrac required attribute.

typedef ::xml_schema::float_ tau_refrac_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< tau_refrac_type, char > tau_refrac_traits
 Attribute traits type.
 
const tau_refrac_typetau_refrac () const
 Return a read-only (constant) reference to the attribute. More...
 
tau_refrac_typetau_refrac ()
 Return a read-write reference to the attribute. More...
 
void tau_refrac (const tau_refrac_type &x)
 Set the attribute value. More...
 

v_reset

Accessor and modifier functions for the v_reset required attribute.

typedef ::xml_schema::float_ v_reset_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< v_reset_type, char > v_reset_traits
 Attribute traits type.
 
const v_reset_typev_reset () const
 Return a read-only (constant) reference to the attribute. More...
 
v_reset_typev_reset ()
 Return a read-write reference to the attribute. More...
 
void v_reset (const v_reset_type &x)
 Set the attribute value. More...
 

v_rest

Accessor and modifier functions for the v_rest required attribute.

typedef ::xml_schema::float_ v_rest_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< v_rest_type, char > v_rest_traits
 Attribute traits type.
 
const v_rest_typev_rest () const
 Return a read-only (constant) reference to the attribute. More...
 
v_rest_typev_rest ()
 Return a read-write reference to the attribute. More...
 
void v_rest (const v_rest_type &x)
 Set the attribute value. More...
 

v_thresh

Accessor and modifier functions for the v_thresh required attribute.

typedef ::xml_schema::float_ v_thresh_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< v_thresh_type, char > v_thresh_traits
 Attribute traits type.
 
const v_thresh_typev_thresh () const
 Return a read-only (constant) reference to the attribute. More...
 
v_thresh_typev_thresh ()
 Return a read-write reference to the attribute. More...
 
void v_thresh (const v_thresh_type &x)
 Set the attribute value. More...
 

Constructors

 basePyNNIaFCell (const id_type &, const cm_type &, const i_offset_type &, const tau_syn_E_type &, const tau_syn_I_type &, const v_init_type &, const tau_m_type &, const tau_refrac_type &, const v_reset_type &, const v_rest_type &, const v_thresh_type &)
 Create an instance from the ultimate base and initializers for required elements and attributes.
 
 basePyNNIaFCell (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Create an instance from a DOM element. More...
 
 basePyNNIaFCell (const basePyNNIaFCell &x, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Copy constructor. More...
 
virtual basePyNNIaFCell_clone (::xml_schema::flags f=0, ::xml_schema::container *c=0) const
 Copy the instance polymorphically. More...
 
basePyNNIaFCelloperator= (const basePyNNIaFCell &x)
 Copy assignment operator. More...
 
virtual ~basePyNNIaFCell ()
 Destructor.
 

Additional Inherited Members

- Public Types inherited from neuroml2::basePyNNCell
typedef ::xml_schema::float_ cm_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< cm_type, char > cm_traits
 Attribute traits type.
 
typedef ::xml_schema::float_ i_offset_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< i_offset_type, char > i_offset_traits
 Attribute traits type.
 
typedef ::xml_schema::float_ tau_syn_E_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< tau_syn_E_type, char > tau_syn_E_traits
 Attribute traits type.
 
typedef ::xml_schema::float_ tau_syn_I_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< tau_syn_I_type, char > tau_syn_I_traits
 Attribute traits type.
 
typedef ::xml_schema::float_ v_init_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< v_init_type, char > v_init_traits
 Attribute traits type.
 
- Public Types inherited from neuroml2::BaseCell
typedef ::neuroml2::NeuroLexId neuroLexId_type
 Attribute type.
 
typedef ::xsd::cxx::tree::optional< neuroLexId_typeneuroLexId_optional
 Attribute optional container type.
 
typedef ::xsd::cxx::tree::traits< neuroLexId_type, char > neuroLexId_traits
 Attribute traits type.
 
- Public Types inherited from neuroml2::Standalone
typedef ::neuroml2::Notes notes_type
 Element type.
 
typedef ::xsd::cxx::tree::optional< notes_typenotes_optional
 Element optional container type.
 
typedef ::xsd::cxx::tree::traits< notes_type, char > notes_traits
 Element traits type.
 
typedef ::neuroml2::Property property_type
 Element type.
 
typedef ::xsd::cxx::tree::sequence< property_typeproperty_sequence
 Element sequence container type.
 
typedef property_sequence::iterator property_iterator
 Element iterator type.
 
typedef property_sequence::const_iterator property_const_iterator
 Element constant iterator type.
 
typedef ::xsd::cxx::tree::traits< property_type, char > property_traits
 Element traits type.
 
typedef ::neuroml2::Annotation annotation_type
 Element type.
 
typedef ::xsd::cxx::tree::optional< annotation_typeannotation_optional
 Element optional container type.
 
typedef ::xsd::cxx::tree::traits< annotation_type, char > annotation_traits
 Element traits type.
 
typedef ::neuroml2::MetaId metaid_type
 Attribute type.
 
typedef ::xsd::cxx::tree::optional< metaid_typemetaid_optional
 Attribute optional container type.
 
typedef ::xsd::cxx::tree::traits< metaid_type, char > metaid_traits
 Attribute traits type.
 
- Public Types inherited from neuroml2::Base
typedef ::neuroml2::NmlId id_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< id_type, char > id_traits
 Attribute traits type.
 
- Public Member Functions inherited from neuroml2::basePyNNCell
const cm_typecm () const
 Return a read-only (constant) reference to the attribute. More...
 
cm_typecm ()
 Return a read-write reference to the attribute. More...
 
void cm (const cm_type &x)
 Set the attribute value. More...
 
const i_offset_typei_offset () const
 Return a read-only (constant) reference to the attribute. More...
 
i_offset_typei_offset ()
 Return a read-write reference to the attribute. More...
 
void i_offset (const i_offset_type &x)
 Set the attribute value. More...
 
const tau_syn_E_typetau_syn_E () const
 Return a read-only (constant) reference to the attribute. More...
 
tau_syn_E_typetau_syn_E ()
 Return a read-write reference to the attribute. More...
 
void tau_syn_E (const tau_syn_E_type &x)
 Set the attribute value. More...
 
const tau_syn_I_typetau_syn_I () const
 Return a read-only (constant) reference to the attribute. More...
 
tau_syn_I_typetau_syn_I ()
 Return a read-write reference to the attribute. More...
 
void tau_syn_I (const tau_syn_I_type &x)
 Set the attribute value. More...
 
const v_init_typev_init () const
 Return a read-only (constant) reference to the attribute. More...
 
v_init_typev_init ()
 Return a read-write reference to the attribute. More...
 
void v_init (const v_init_type &x)
 Set the attribute value. More...
 
 basePyNNCell (const id_type &, const cm_type &, const i_offset_type &, const tau_syn_E_type &, const tau_syn_I_type &, const v_init_type &)
 Create an instance from the ultimate base and initializers for required elements and attributes.
 
 basePyNNCell (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Create an instance from a DOM element. More...
 
 basePyNNCell (const basePyNNCell &x, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Copy constructor. More...
 
basePyNNCelloperator= (const basePyNNCell &x)
 Copy assignment operator. More...
 
virtual ~basePyNNCell ()
 Destructor.
 
- Public Member Functions inherited from neuroml2::BaseCell
const neuroLexId_optionalneuroLexId () const
 Return a read-only (constant) reference to the attribute container. More...
 
neuroLexId_optionalneuroLexId ()
 Return a read-write reference to the attribute container. More...
 
void neuroLexId (const neuroLexId_type &x)
 Set the attribute value. More...
 
void neuroLexId (const neuroLexId_optional &x)
 Set the attribute value. More...
 
void neuroLexId (::std::unique_ptr< neuroLexId_type > p)
 Set the attribute value without copying. More...
 
 BaseCell (const id_type &)
 Create an instance from the ultimate base and initializers for required elements and attributes.
 
 BaseCell (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Create an instance from a DOM element. More...
 
 BaseCell (const BaseCell &x, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Copy constructor. More...
 
BaseCelloperator= (const BaseCell &x)
 Copy assignment operator. More...
 
virtual ~BaseCell ()
 Destructor.
 
- Public Member Functions inherited from neuroml2::Standalone
const notes_optionalnotes () const
 Return a read-only (constant) reference to the element container. More...
 
notes_optionalnotes ()
 Return a read-write reference to the element container. More...
 
void notes (const notes_type &x)
 Set the element value. More...
 
void notes (const notes_optional &x)
 Set the element value. More...
 
void notes (::std::unique_ptr< notes_type > p)
 Set the element value without copying. More...
 
const property_sequenceproperty () const
 Return a read-only (constant) reference to the element sequence. More...
 
property_sequenceproperty ()
 Return a read-write reference to the element sequence. More...
 
void property (const property_sequence &s)
 Copy elements from a given sequence. More...
 
const annotation_optionalannotation () const
 Return a read-only (constant) reference to the element container. More...
 
annotation_optionalannotation ()
 Return a read-write reference to the element container. More...
 
void annotation (const annotation_type &x)
 Set the element value. More...
 
void annotation (const annotation_optional &x)
 Set the element value. More...
 
void annotation (::std::unique_ptr< annotation_type > p)
 Set the element value without copying. More...
 
const metaid_optionalmetaid () const
 Return a read-only (constant) reference to the attribute container. More...
 
metaid_optionalmetaid ()
 Return a read-write reference to the attribute container. More...
 
void metaid (const metaid_type &x)
 Set the attribute value. More...
 
void metaid (const metaid_optional &x)
 Set the attribute value. More...
 
void metaid (::std::unique_ptr< metaid_type > p)
 Set the attribute value without copying. More...
 
 Standalone (const id_type &)
 Create an instance from the ultimate base and initializers for required elements and attributes.
 
 Standalone (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Create an instance from a DOM element. More...
 
 Standalone (const Standalone &x, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Copy constructor. More...
 
Standaloneoperator= (const Standalone &x)
 Copy assignment operator. More...
 
virtual ~Standalone ()
 Destructor.
 
- Public Member Functions inherited from neuroml2::Base
const id_typeid () const
 Return a read-only (constant) reference to the attribute. More...
 
id_typeid ()
 Return a read-write reference to the attribute. More...
 
void id (const id_type &x)
 Set the attribute value. More...
 
void id (::std::unique_ptr< id_type > p)
 Set the attribute value without copying. More...
 
 Base (const id_type &)
 Create an instance from the ultimate base and initializers for required elements and attributes.
 
 Base (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Create an instance from a DOM element. More...
 
 Base (const Base &x, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Copy constructor. More...
 
Baseoperator= (const Base &x)
 Copy assignment operator. More...
 
virtual ~Base ()
 Destructor.
 
- Public Member Functions inherited from neuroml2::BaseWithoutId
 BaseWithoutId ()
 Create an instance from the ultimate base and initializers for required elements and attributes.
 
 BaseWithoutId (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Create an instance from a DOM element. More...
 
 BaseWithoutId (const ::xercesc::DOMAttr &a, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Create an instance from a DOM attribute. More...
 
 BaseWithoutId (const ::std::string &s, const ::xercesc::DOMElement *e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Create an instance from a string fragment. More...
 
 BaseWithoutId (const BaseWithoutId &x, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Copy constructor. More...
 
virtual ~BaseWithoutId ()
 Destructor.
 

Detailed Description

Class corresponding to the basePyNNIaFCell schema type.

Base type of any PyNN standard integrate and fire model
:param tau_refrac: :type tau_refrac: none :param v_thresh: :type v_thresh: none :param tau_m: :type tau_m: none :param v_rest: :type v_rest: none :param v_reset: :type v_reset: none :param cm: :type cm: none :param i_offset: :type i_offset: none :param tau_syn_E: This parameter is never used in the NeuroML2 description of this cell! Any synapse producing a current can be placed on this cell :type tau_syn_E: none :param tau_syn_I: This parameter is never used in the NeuroML2 description of this cell! Any synapse producing a current can be placed on this cell :type tau_syn_I: none :param v_init: :type v_init: none

Definition at line 66723 of file NeuroML_v2.3.hxx.

Constructor & Destructor Documentation

◆ basePyNNIaFCell() [1/2]

neuroml2::basePyNNIaFCell::basePyNNIaFCell ( const ::xercesc::DOMElement &  e,
::xml_schema::flags  f = 0,
::xml_schema::container c = 0 
)

Create an instance from a DOM element.

Parameters
eA DOM element to extract the data from.
fFlags to create the new instance with.
cA pointer to the object that will contain the new instance.

Definition at line 47727 of file NeuroML_v2.3.cxx.

◆ basePyNNIaFCell() [2/2]

neuroml2::basePyNNIaFCell::basePyNNIaFCell ( const basePyNNIaFCell x,
::xml_schema::flags  f = 0,
::xml_schema::container c = 0 
)

Copy constructor.

Parameters
xAn instance to make a copy of.
fFlags to create the copy with.
cA pointer to the object that will contain the copy.

For polymorphic object models use the _clone function instead.

Definition at line 47714 of file NeuroML_v2.3.cxx.

Member Function Documentation

◆ _clone()

basePyNNIaFCell * neuroml2::basePyNNIaFCell::_clone ( ::xml_schema::flags  f = 0,
::xml_schema::container c = 0 
) const
virtual

Copy the instance polymorphically.

Parameters
fFlags to create the copy with.
cA pointer to the object that will contain the copy.
Returns
A pointer to the dynamically allocated copy.

This function ensures that the dynamic type of the instance is used for copying and should be used for polymorphic object models instead of the copy constructor.

Reimplemented from neuroml2::basePyNNCell.

Reimplemented in neuroml2::EIF_cond_alpha_isfa_ista, neuroml2::EIF_cond_exp_isfa_ista, neuroml2::IF_cond_exp, neuroml2::IF_cond_alpha, neuroml2::IF_curr_exp, neuroml2::IF_curr_alpha, and neuroml2::basePyNNIaFCondCell.

Definition at line 47826 of file NeuroML_v2.3.cxx.

◆ operator=()

basePyNNIaFCell & neuroml2::basePyNNIaFCell::operator= ( const basePyNNIaFCell x)

Copy assignment operator.

Parameters
xAn instance to make a copy of.
Returns
A reference to itself.

For polymorphic object models use the _clone function instead.

Definition at line 47833 of file NeuroML_v2.3.cxx.

◆ tau_m() [1/3]

basePyNNIaFCell::tau_m_type & neuroml2::basePyNNIaFCell::tau_m ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

Definition at line 16655 of file NeuroML_v2.3.cxx.

◆ tau_m() [2/3]

const basePyNNIaFCell::tau_m_type & neuroml2::basePyNNIaFCell::tau_m ( ) const

Return a read-only (constant) reference to the attribute.

Returns
A constant reference to the attribute.

Definition at line 16649 of file NeuroML_v2.3.cxx.

◆ tau_m() [3/3]

void neuroml2::basePyNNIaFCell::tau_m ( const tau_m_type x)

Set the attribute value.

Parameters
xA new value to set.

This function makes a copy of its argument and sets it as the new value of the attribute.

Definition at line 16661 of file NeuroML_v2.3.cxx.

◆ tau_refrac() [1/3]

basePyNNIaFCell::tau_refrac_type & neuroml2::basePyNNIaFCell::tau_refrac ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

Definition at line 16673 of file NeuroML_v2.3.cxx.

◆ tau_refrac() [2/3]

const basePyNNIaFCell::tau_refrac_type & neuroml2::basePyNNIaFCell::tau_refrac ( ) const

Return a read-only (constant) reference to the attribute.

Returns
A constant reference to the attribute.

Definition at line 16667 of file NeuroML_v2.3.cxx.

◆ tau_refrac() [3/3]

void neuroml2::basePyNNIaFCell::tau_refrac ( const tau_refrac_type x)

Set the attribute value.

Parameters
xA new value to set.

This function makes a copy of its argument and sets it as the new value of the attribute.

Definition at line 16679 of file NeuroML_v2.3.cxx.

◆ v_reset() [1/3]

basePyNNIaFCell::v_reset_type & neuroml2::basePyNNIaFCell::v_reset ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

Definition at line 16691 of file NeuroML_v2.3.cxx.

◆ v_reset() [2/3]

const basePyNNIaFCell::v_reset_type & neuroml2::basePyNNIaFCell::v_reset ( ) const

Return a read-only (constant) reference to the attribute.

Returns
A constant reference to the attribute.

Definition at line 16685 of file NeuroML_v2.3.cxx.

◆ v_reset() [3/3]

void neuroml2::basePyNNIaFCell::v_reset ( const v_reset_type x)

Set the attribute value.

Parameters
xA new value to set.

This function makes a copy of its argument and sets it as the new value of the attribute.

Definition at line 16697 of file NeuroML_v2.3.cxx.

◆ v_rest() [1/3]

basePyNNIaFCell::v_rest_type & neuroml2::basePyNNIaFCell::v_rest ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

Definition at line 16709 of file NeuroML_v2.3.cxx.

◆ v_rest() [2/3]

const basePyNNIaFCell::v_rest_type & neuroml2::basePyNNIaFCell::v_rest ( ) const

Return a read-only (constant) reference to the attribute.

Returns
A constant reference to the attribute.

Definition at line 16703 of file NeuroML_v2.3.cxx.

◆ v_rest() [3/3]

void neuroml2::basePyNNIaFCell::v_rest ( const v_rest_type x)

Set the attribute value.

Parameters
xA new value to set.

This function makes a copy of its argument and sets it as the new value of the attribute.

Definition at line 16715 of file NeuroML_v2.3.cxx.

◆ v_thresh() [1/3]

basePyNNIaFCell::v_thresh_type & neuroml2::basePyNNIaFCell::v_thresh ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

Definition at line 16727 of file NeuroML_v2.3.cxx.

◆ v_thresh() [2/3]

const basePyNNIaFCell::v_thresh_type & neuroml2::basePyNNIaFCell::v_thresh ( ) const

Return a read-only (constant) reference to the attribute.

Returns
A constant reference to the attribute.

Definition at line 16721 of file NeuroML_v2.3.cxx.

◆ v_thresh() [3/3]

void neuroml2::basePyNNIaFCell::v_thresh ( const v_thresh_type x)

Set the attribute value.

Parameters
xA new value to set.

This function makes a copy of its argument and sets it as the new value of the attribute.

Definition at line 16733 of file NeuroML_v2.3.cxx.


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