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

#include <NeuroML_v2.3.hxx>

Inheritance diagram for neuroml2::basePyNNCell:

Collaboration diagram for neuroml2::basePyNNCell:

cm
Accessor and modifier functions for the cm required attribute.
typedef ::xml_schema::float_	cm_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< cm_type, char >	cm_traits
	Attribute traits type.

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

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

void	cm (const cm_type &x)
	Set the attribute value. More...

i_offset
Accessor and modifier functions for the i_offset required attribute.
typedef ::xml_schema::float_	i_offset_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< i_offset_type, char >	i_offset_traits
	Attribute traits type.

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

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

void	i_offset (const i_offset_type &x)
	Set the attribute value. More...

tau_syn_E
Accessor and modifier functions for the tau_syn_E required attribute.
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.

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

tau_syn_E_type &	tau_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...

tau_syn_I
Accessor and modifier functions for the tau_syn_I required attribute.
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.

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

tau_syn_I_type &	tau_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...

v_init
Accessor and modifier functions for the v_init required attribute.
typedef ::xml_schema::float_	v_init_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< v_init_type, char >	v_init_traits
	Attribute traits type.

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

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

void	v_init (const v_init_type &x)
	Set the attribute value. More...

Constructors
	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...

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

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

virtual	~basePyNNCell ()
	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 basePyNNCell schema type.

Base type of any PyNN standard cell model. Note: membrane potential v has dimensions voltage, but all other parameters are dimensionless. This is to facilitate translation to and from PyNN scripts in Python, where these parameters have implicit units, see http://neuralensemble.org/trac/PyNN/wiki/StandardModels
: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 66351 of file NeuroML_v2.3.hxx.

Constructor & Destructor Documentation

◆ basePyNNCell() [1/2]

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

◆ basePyNNCell() [2/2]

neuroml2::basePyNNCell::basePyNNCell	(	const basePyNNCell &	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 47514 of file NeuroML_v2.3.cxx.

Member Function Documentation

◆ _clone()

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

Reimplemented in neuroml2::HH_cond_exp, 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, neuroml2::basePyNNIaFCondCell, and neuroml2::basePyNNIaFCell.

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

◆ cm() [1/3]

basePyNNCell::cm_type & neuroml2::basePyNNCell::cm ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ cm() [2/3]

const basePyNNCell::cm_type & neuroml2::basePyNNCell::cm ( ) const

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

Returns: A constant reference to the attribute.

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

◆ cm() [3/3]

void neuroml2::basePyNNCell::cm ( const cm_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 16567 of file NeuroML_v2.3.cxx.

◆ i_offset() [1/3]

basePyNNCell::i_offset_type & neuroml2::basePyNNCell::i_offset ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ i_offset() [2/3]

const basePyNNCell::i_offset_type & neuroml2::basePyNNCell::i_offset ( ) const

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

Returns: A constant reference to the attribute.

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

◆ i_offset() [3/3]

void neuroml2::basePyNNCell::i_offset ( const i_offset_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 16585 of file NeuroML_v2.3.cxx.

◆ operator=()

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

◆ tau_syn_E() [1/3]

basePyNNCell::tau_syn_E_type & neuroml2::basePyNNCell::tau_syn_E ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ tau_syn_E() [2/3]

const basePyNNCell::tau_syn_E_type & neuroml2::basePyNNCell::tau_syn_E ( ) const

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

Returns: A constant reference to the attribute.

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

◆ tau_syn_E() [3/3]

void neuroml2::basePyNNCell::tau_syn_E ( const tau_syn_E_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 16603 of file NeuroML_v2.3.cxx.

◆ tau_syn_I() [1/3]

basePyNNCell::tau_syn_I_type & neuroml2::basePyNNCell::tau_syn_I ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ tau_syn_I() [2/3]

const basePyNNCell::tau_syn_I_type & neuroml2::basePyNNCell::tau_syn_I ( ) const

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

Returns: A constant reference to the attribute.

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

◆ tau_syn_I() [3/3]

void neuroml2::basePyNNCell::tau_syn_I ( const tau_syn_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 16621 of file NeuroML_v2.3.cxx.

◆ v_init() [1/3]

basePyNNCell::v_init_type & neuroml2::basePyNNCell::v_init ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ v_init() [2/3]

const basePyNNCell::v_init_type & neuroml2::basePyNNCell::v_init ( ) const

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

Returns: A constant reference to the attribute.

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

◆ v_init() [3/3]

void neuroml2::basePyNNCell::v_init ( const v_init_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 16639 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

cm

i_offset

tau_syn_E

tau_syn_I

v_init

Constructors

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ basePyNNCell() [1/2]

◆ basePyNNCell() [2/2]

Member Function Documentation

◆ _clone()

◆ cm() [1/3]

◆ cm() [2/3]

◆ cm() [3/3]

◆ i_offset() [1/3]

◆ i_offset() [2/3]

◆ i_offset() [3/3]

◆ operator=()

◆ tau_syn_E() [1/3]

◆ tau_syn_E() [2/3]

◆ tau_syn_E() [3/3]

◆ tau_syn_I() [1/3]

◆ tau_syn_I() [2/3]

◆ tau_syn_I() [3/3]

◆ v_init() [1/3]

◆ v_init() [2/3]

◆ v_init() [3/3]