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

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

#include <NeuroML_v2.3.hxx>

+ Inheritance diagram for neuroml2::IafCell:
+ Collaboration diagram for neuroml2::IafCell:

leakReversal

Accessor and modifier functions for the leakReversal required attribute.

typedef ::neuroml2::Nml2Quantity_voltage leakReversal_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< leakReversal_type, char > leakReversal_traits
 Attribute traits type.
 
const leakReversal_typeleakReversal () const
 Return a read-only (constant) reference to the attribute. More...
 
leakReversal_typeleakReversal ()
 Return a read-write reference to the attribute. More...
 
void leakReversal (const leakReversal_type &x)
 Set the attribute value. More...
 
void leakReversal (::std::unique_ptr< leakReversal_type > p)
 Set the attribute value without copying. More...
 

thresh

Accessor and modifier functions for the thresh required attribute.

typedef ::neuroml2::Nml2Quantity_voltage thresh_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< thresh_type, char > thresh_traits
 Attribute traits type.
 
const thresh_typethresh () const
 Return a read-only (constant) reference to the attribute. More...
 
thresh_typethresh ()
 Return a read-write reference to the attribute. More...
 
void thresh (const thresh_type &x)
 Set the attribute value. More...
 
void thresh (::std::unique_ptr< thresh_type > p)
 Set the attribute value without copying. More...
 

reset

Accessor and modifier functions for the reset required attribute.

typedef ::neuroml2::Nml2Quantity_voltage reset_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< reset_type, char > reset_traits
 Attribute traits type.
 
const reset_typereset () const
 Return a read-only (constant) reference to the attribute. More...
 
reset_typereset ()
 Return a read-write reference to the attribute. More...
 
void reset (const reset_type &x)
 Set the attribute value. More...
 
void reset (::std::unique_ptr< reset_type > p)
 Set the attribute value without copying. More...
 

C

Accessor and modifier functions for the C required attribute.

typedef ::neuroml2::Nml2Quantity_capacitance C_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< C_type, char > C_traits
 Attribute traits type.
 
const C_typeC () const
 Return a read-only (constant) reference to the attribute. More...
 
C_typeC ()
 Return a read-write reference to the attribute. More...
 
void C (const C_type &x)
 Set the attribute value. More...
 
void C (::std::unique_ptr< C_type > p)
 Set the attribute value without copying. More...
 

leakConductance

Accessor and modifier functions for the leakConductance required attribute.

typedef ::neuroml2::Nml2Quantity_conductance leakConductance_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< leakConductance_type, char > leakConductance_traits
 Attribute traits type.
 
const leakConductance_typeleakConductance () const
 Return a read-only (constant) reference to the attribute. More...
 
leakConductance_typeleakConductance ()
 Return a read-write reference to the attribute. More...
 
void leakConductance (const leakConductance_type &x)
 Set the attribute value. More...
 
void leakConductance (::std::unique_ptr< leakConductance_type > p)
 Set the attribute value without copying. More...
 

Constructors

 IafCell (const id_type &, const leakReversal_type &, const thresh_type &, const reset_type &, const C_type &, const leakConductance_type &)
 Create an instance from the ultimate base and initializers for required elements and attributes.
 
 IafCell (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Create an instance from a DOM element. More...
 
 IafCell (const IafCell &x, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Copy constructor. More...
 
virtual IafCell_clone (::xml_schema::flags f=0, ::xml_schema::container *c=0) const
 Copy the instance polymorphically. More...
 
IafCelloperator= (const IafCell &x)
 Copy assignment operator. More...
 
virtual ~IafCell ()
 Destructor.
 

Additional Inherited Members

- 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::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 IafCell schema type.

Integrate and fire cell with capacitance C, leakConductance and leakReversal
:param leakConductance: :type leakConductance: conductance :param leakReversal: :type leakReversal: voltage :param thresh: :type thresh: voltage :param reset: :type reset: voltage :param C: Total capacitance of the cell membrane :type C: capacitance

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

Constructor & Destructor Documentation

◆ IafCell() [1/2]

neuroml2::IafCell::IafCell ( 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 31606 of file NeuroML_v2.3.cxx.

◆ IafCell() [2/2]

neuroml2::IafCell::IafCell ( const IafCell 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 31593 of file NeuroML_v2.3.cxx.

Member Function Documentation

◆ _clone()

IafCell * neuroml2::IafCell::_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::BaseCell.

Reimplemented in neuroml2::IafRefCell.

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

◆ C() [1/4]

IafCell::C_type & neuroml2::IafCell::C ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ C() [2/4]

const IafCell::C_type & neuroml2::IafCell::C ( ) const

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

Returns
A constant reference to the attribute.

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

◆ C() [3/4]

void neuroml2::IafCell::C ( ::std::unique_ptr< C_type p)

Set the attribute value without copying.

Parameters
pA new value to use.

This function will try to use the passed value directly instead of making a copy.

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

◆ C() [4/4]

void neuroml2::IafCell::C ( const C_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 7535 of file NeuroML_v2.3.cxx.

◆ leakConductance() [1/4]

IafCell::leakConductance_type & neuroml2::IafCell::leakConductance ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ leakConductance() [2/4]

const IafCell::leakConductance_type & neuroml2::IafCell::leakConductance ( ) const

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

Returns
A constant reference to the attribute.

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

◆ leakConductance() [3/4]

void neuroml2::IafCell::leakConductance ( ::std::unique_ptr< leakConductance_type p)

Set the attribute value without copying.

Parameters
pA new value to use.

This function will try to use the passed value directly instead of making a copy.

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

◆ leakConductance() [4/4]

void neuroml2::IafCell::leakConductance ( const leakConductance_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 7559 of file NeuroML_v2.3.cxx.

◆ leakReversal() [1/4]

IafCell::leakReversal_type & neuroml2::IafCell::leakReversal ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ leakReversal() [2/4]

const IafCell::leakReversal_type & neuroml2::IafCell::leakReversal ( ) const

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

Returns
A constant reference to the attribute.

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

◆ leakReversal() [3/4]

void neuroml2::IafCell::leakReversal ( ::std::unique_ptr< leakReversal_type p)

Set the attribute value without copying.

Parameters
pA new value to use.

This function will try to use the passed value directly instead of making a copy.

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

◆ leakReversal() [4/4]

void neuroml2::IafCell::leakReversal ( const leakReversal_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 7463 of file NeuroML_v2.3.cxx.

◆ operator=()

IafCell & neuroml2::IafCell::operator= ( const IafCell 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 31712 of file NeuroML_v2.3.cxx.

◆ reset() [1/4]

IafCell::reset_type & neuroml2::IafCell::reset ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ reset() [2/4]

const IafCell::reset_type & neuroml2::IafCell::reset ( ) const

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

Returns
A constant reference to the attribute.

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

◆ reset() [3/4]

void neuroml2::IafCell::reset ( ::std::unique_ptr< reset_type p)

Set the attribute value without copying.

Parameters
pA new value to use.

This function will try to use the passed value directly instead of making a copy.

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

◆ reset() [4/4]

void neuroml2::IafCell::reset ( const 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 7511 of file NeuroML_v2.3.cxx.

◆ thresh() [1/4]

IafCell::thresh_type & neuroml2::IafCell::thresh ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ thresh() [2/4]

const IafCell::thresh_type & neuroml2::IafCell::thresh ( ) const

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

Returns
A constant reference to the attribute.

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

◆ thresh() [3/4]

void neuroml2::IafCell::thresh ( ::std::unique_ptr< thresh_type p)

Set the attribute value without copying.

Parameters
pA new value to use.

This function will try to use the passed value directly instead of making a copy.

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

◆ thresh() [4/4]

void neuroml2::IafCell::thresh ( const 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 7487 of file NeuroML_v2.3.cxx.


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