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

#include <NeuroML_v2.3.hxx>

Inheritance diagram for neuroml2::FitzHughNagumo1969Cell:

Collaboration diagram for neuroml2::FitzHughNagumo1969Cell:

a
Accessor and modifier functions for the a required attribute.
typedef ::neuroml2::Nml2Quantity_none	a_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< a_type, char >	a_traits
	Attribute traits type.

const a_type &	a () const
	Return a read-only (constant) reference to the attribute. More...

a_type &	a ()
	Return a read-write reference to the attribute. More...

void	a (const a_type &x)
	Set the attribute value. More...

void	a (::std::unique_ptr< a_type > p)
	Set the attribute value without copying. More...

b
Accessor and modifier functions for the b required attribute.
typedef ::neuroml2::Nml2Quantity_none	b_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< b_type, char >	b_traits
	Attribute traits type.

const b_type &	b () const
	Return a read-only (constant) reference to the attribute. More...

b_type &	b ()
	Return a read-write reference to the attribute. More...

void	b (const b_type &x)
	Set the attribute value. More...

void	b (::std::unique_ptr< b_type > p)
	Set the attribute value without copying. More...

I
Accessor and modifier functions for the I required attribute.
typedef ::neuroml2::Nml2Quantity_none	I_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< I_type, char >	I_traits
	Attribute traits type.

const I_type &	I () const
	Return a read-only (constant) reference to the attribute. More...

I_type &	I ()
	Return a read-write reference to the attribute. More...

void	I (const I_type &x)
	Set the attribute value. More...

void	I (::std::unique_ptr< I_type > p)
	Set the attribute value without copying. More...

phi
Accessor and modifier functions for the phi required attribute.
typedef ::neuroml2::Nml2Quantity_none	phi_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< phi_type, char >	phi_traits
	Attribute traits type.

const phi_type &	phi () const
	Return a read-only (constant) reference to the attribute. More...

phi_type &	phi ()
	Return a read-write reference to the attribute. More...

void	phi (const phi_type &x)
	Set the attribute value. More...

void	phi (::std::unique_ptr< phi_type > p)
	Set the attribute value without copying. More...

V0
Accessor and modifier functions for the V0 required attribute.
typedef ::neuroml2::Nml2Quantity_none	V0_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< V0_type, char >	V0_traits
	Attribute traits type.

const V0_type &	V0 () const
	Return a read-only (constant) reference to the attribute. More...

V0_type &	V0 ()
	Return a read-write reference to the attribute. More...

void	V0 (const V0_type &x)
	Set the attribute value. More...

void	V0 (::std::unique_ptr< V0_type > p)
	Set the attribute value without copying. More...

W0
Accessor and modifier functions for the W0 required attribute.
typedef ::neuroml2::Nml2Quantity_none	W0_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< W0_type, char >	W0_traits
	Attribute traits type.

const W0_type &	W0 () const
	Return a read-only (constant) reference to the attribute. More...

W0_type &	W0 ()
	Return a read-write reference to the attribute. More...

void	W0 (const W0_type &x)
	Set the attribute value. More...

void	W0 (::std::unique_ptr< W0_type > p)
	Set the attribute value without copying. More...

Constructors
	FitzHughNagumo1969Cell (const id_type &, const a_type &, const b_type &, const I_type &, const phi_type &, const V0_type &, const W0_type &)
	Create an instance from the ultimate base and initializers for required elements and attributes.

	FitzHughNagumo1969Cell (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
	Create an instance from a DOM element. More...

	FitzHughNagumo1969Cell (const FitzHughNagumo1969Cell &x, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
	Copy constructor. More...

virtual FitzHughNagumo1969Cell *	_clone (::xml_schema::flags f=0, ::xml_schema::container *c=0) const
	Copy the instance polymorphically. More...

FitzHughNagumo1969Cell &	operator= (const FitzHughNagumo1969Cell &x)
	Copy assignment operator. More...

virtual	~FitzHughNagumo1969Cell ()
	Destructor.

Additional Inherited Members
Public Types inherited from neuroml2::BaseCell
typedef ::neuroml2::NeuroLexId	neuroLexId_type
	Attribute type.

typedef ::xsd::cxx::tree::optional< neuroLexId_type >	neuroLexId_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_type >	notes_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_type >	property_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_type >	annotation_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_type >	metaid_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_optional &	neuroLexId () const
	Return a read-only (constant) reference to the attribute container. More...

neuroLexId_optional &	neuroLexId ()
	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...

BaseCell &	operator= (const BaseCell &x)
	Copy assignment operator. More...

virtual	~BaseCell ()
	Destructor.

Public Member Functions inherited from neuroml2::Standalone
const notes_optional &	notes () const
	Return a read-only (constant) reference to the element container. More...

notes_optional &	notes ()
	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_sequence &	property () const
	Return a read-only (constant) reference to the element sequence. More...

property_sequence &	property ()
	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_optional &	annotation () const
	Return a read-only (constant) reference to the element container. More...

annotation_optional &	annotation ()
	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_optional &	metaid () const
	Return a read-only (constant) reference to the attribute container. More...

metaid_optional &	metaid ()
	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...

Standalone &	operator= (const Standalone &x)
	Copy assignment operator. More...

virtual	~Standalone ()
	Destructor.

Public Member Functions inherited from neuroml2::Base
const id_type &	id () const
	Return a read-only (constant) reference to the attribute. More...

id_type &	id ()
	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...

Base &	operator= (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 FitzHughNagumo1969Cell schema type.

The Fitzhugh Nagumo model is a two-dimensional simplification of the Hodgkin-Huxley model of spike generation in squid giant axons. This system was suggested by FitzHugh ( FitzHugh R. [1961]: Impulses and physiological states in theoretical models of nerve membrane. Biophysical J. 1:445-466 ), who called it " Bonhoeffer-van der Pol model ", and the equivalent circuit by Nagumo et al. ( Nagumo J. , Arimoto S. , and Yoshizawa S. [1962] An active pulse transmission line simulating nerve axon. Proc IRE. 50:2061-2070. 1962 ). This version corresponds to the one described in FitzHugh R. [1969]: Mathematical models of excitation and propagation in nerve. Chapter 1 ( pp. 1-85 in H. P. Schwan, ed. Biological Engineering, McGraw-Hill Book Co. , N. Y. )
:param a: :type a: none :param b: :type b: none :param I: plays the role of an external injected current :type I: none :param phi: :type phi: none :param V0: :type V0: none :param W0: :type W0: none

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

Constructor & Destructor Documentation

◆ FitzHughNagumo1969Cell() [1/2]

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

Create an instance from a DOM element.

Parameters

e	A DOM element to extract the data from.
f	Flags to create the new instance with.
c	A pointer to the object that will contain the new instance.

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

◆ FitzHughNagumo1969Cell() [2/2]

neuroml2::FitzHughNagumo1969Cell::FitzHughNagumo1969Cell	(	const FitzHughNagumo1969Cell &	x,
		::xml_schema::flags	f = `0`,
		::xml_schema::container *	c = `0`
	)

Copy constructor.

Parameters

x	An instance to make a copy of.
f	Flags to create the copy with.
c	A pointer to the object that will contain the copy.

For polymorphic object models use the _clone function instead.

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

Member Function Documentation

◆ _clone()

FitzHughNagumo1969Cell * neuroml2::FitzHughNagumo1969Cell::_clone	(	::xml_schema::flags	f = `0`,
		::xml_schema::container *	c = `0`
	)		const

virtual

Copy the instance polymorphically.

Parameters

f	Flags to create the copy with.
c	A 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.

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

◆ a() [1/4]

FitzHughNagumo1969Cell::a_type & neuroml2::FitzHughNagumo1969Cell::a ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ a() [2/4]

const FitzHughNagumo1969Cell::a_type & neuroml2::FitzHughNagumo1969Cell::a ( ) const

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

Returns: A constant reference to the attribute.

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

◆ a() [3/4]

void neuroml2::FitzHughNagumo1969Cell::a ( ::std::unique_ptr< a_type > p )

Set the attribute value without copying.

Parameters

p	A new value to use.

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

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

◆ a() [4/4]

void neuroml2::FitzHughNagumo1969Cell::a ( const a_type & x )

Set the attribute value.

Parameters

x	A 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 8283 of file NeuroML_v2.3.cxx.

◆ b() [1/4]

FitzHughNagumo1969Cell::b_type & neuroml2::FitzHughNagumo1969Cell::b ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ b() [2/4]

const FitzHughNagumo1969Cell::b_type & neuroml2::FitzHughNagumo1969Cell::b ( ) const

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

Returns: A constant reference to the attribute.

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

◆ b() [3/4]

void neuroml2::FitzHughNagumo1969Cell::b ( ::std::unique_ptr< b_type > p )

Set the attribute value without copying.

Parameters

p	A new value to use.

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

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

◆ b() [4/4]

void neuroml2::FitzHughNagumo1969Cell::b ( const b_type & x )

Set the attribute value.

Parameters

x	A 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 8307 of file NeuroML_v2.3.cxx.

◆ I() [1/4]

FitzHughNagumo1969Cell::I_type & neuroml2::FitzHughNagumo1969Cell::I ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ I() [2/4]

const FitzHughNagumo1969Cell::I_type & neuroml2::FitzHughNagumo1969Cell::I ( ) const

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

Returns: A constant reference to the attribute.

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

◆ I() [3/4]

void neuroml2::FitzHughNagumo1969Cell::I ( ::std::unique_ptr< I_type > p )

Set the attribute value without copying.

Parameters

p	A new value to use.

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

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

◆ I() [4/4]

void neuroml2::FitzHughNagumo1969Cell::I ( const I_type & x )

Set the attribute value.

Parameters

x	A 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 8331 of file NeuroML_v2.3.cxx.

◆ operator=()

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

Copy assignment operator.

Parameters

x	An instance to make a copy of.

Returns: A reference to itself.

For polymorphic object models use the _clone function instead.

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

◆ phi() [1/4]

FitzHughNagumo1969Cell::phi_type & neuroml2::FitzHughNagumo1969Cell::phi ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ phi() [2/4]

const FitzHughNagumo1969Cell::phi_type & neuroml2::FitzHughNagumo1969Cell::phi ( ) const

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

Returns: A constant reference to the attribute.

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

◆ phi() [3/4]

void neuroml2::FitzHughNagumo1969Cell::phi ( ::std::unique_ptr< phi_type > p )

Set the attribute value without copying.

Parameters

p	A new value to use.

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

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

◆ phi() [4/4]

void neuroml2::FitzHughNagumo1969Cell::phi ( const phi_type & x )

Set the attribute value.

Parameters

x	A 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 8355 of file NeuroML_v2.3.cxx.

◆ V0() [1/4]

FitzHughNagumo1969Cell::V0_type & neuroml2::FitzHughNagumo1969Cell::V0 ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ V0() [2/4]

const FitzHughNagumo1969Cell::V0_type & neuroml2::FitzHughNagumo1969Cell::V0 ( ) const

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

Returns: A constant reference to the attribute.

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

◆ V0() [3/4]

void neuroml2::FitzHughNagumo1969Cell::V0 ( ::std::unique_ptr< V0_type > p )

Set the attribute value without copying.

Parameters

p	A new value to use.

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

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

◆ V0() [4/4]

void neuroml2::FitzHughNagumo1969Cell::V0 ( const V0_type & x )

Set the attribute value.

Parameters

x	A 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 8379 of file NeuroML_v2.3.cxx.

◆ W0() [1/4]

FitzHughNagumo1969Cell::W0_type & neuroml2::FitzHughNagumo1969Cell::W0 ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ W0() [2/4]

const FitzHughNagumo1969Cell::W0_type & neuroml2::FitzHughNagumo1969Cell::W0 ( ) const

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

Returns: A constant reference to the attribute.

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

◆ W0() [3/4]

void neuroml2::FitzHughNagumo1969Cell::W0 ( ::std::unique_ptr< W0_type > p )

Set the attribute value without copying.

Parameters

p	A new value to use.

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

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

◆ W0() [4/4]

void neuroml2::FitzHughNagumo1969Cell::W0 ( const W0_type & x )

Set the attribute value.

Parameters

x	A 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 8403 of file NeuroML_v2.3.cxx.

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

src/NeuroML_v2.3.hxx
src/NeuroML_v2.3.cxx

a

b

I

phi

V0

W0

Constructors

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FitzHughNagumo1969Cell() [1/2]

◆ FitzHughNagumo1969Cell() [2/2]

Member Function Documentation

◆ _clone()

◆ a() [1/4]

◆ a() [2/4]

◆ a() [3/4]

◆ a() [4/4]

◆ b() [1/4]

◆ b() [2/4]

◆ b() [3/4]

◆ b() [4/4]

◆ I() [1/4]

◆ I() [2/4]

◆ I() [3/4]

◆ I() [4/4]

◆ operator=()

◆ phi() [1/4]

◆ phi() [2/4]

◆ phi() [3/4]

◆ phi() [4/4]

◆ V0() [1/4]

◆ V0() [2/4]

◆ V0() [3/4]

◆ V0() [4/4]

◆ W0() [1/4]

◆ W0() [2/4]

◆ W0() [3/4]

◆ W0() [4/4]