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

#include <NeuroML_v2.3.hxx>

Inheritance diagram for neuroml2::GradedSynapse:

Collaboration diagram for neuroml2::GradedSynapse:

conductance
Accessor and modifier functions for the conductance required attribute.
typedef ::neuroml2::Nml2Quantity_conductance	conductance_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< conductance_type, char >	conductance_traits
	Attribute traits type.

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

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

void	conductance (const conductance_type &x)
	Set the attribute value. More...

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

delta
Accessor and modifier functions for the delta required attribute.
typedef ::neuroml2::Nml2Quantity_voltage	delta_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< delta_type, char >	delta_traits
	Attribute traits type.

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

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

void	delta (const delta_type &x)
	Set the attribute value. More...

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

Vth
Accessor and modifier functions for the Vth required attribute.
typedef ::neuroml2::Nml2Quantity_voltage	Vth_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< Vth_type, char >	Vth_traits
	Attribute traits type.

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

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

void	Vth (const Vth_type &x)
	Set the attribute value. More...

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

k
Accessor and modifier functions for the k required attribute.
typedef ::neuroml2::Nml2Quantity_pertime	k_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< k_type, char >	k_traits
	Attribute traits type.

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

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

void	k (const k_type &x)
	Set the attribute value. More...

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

erev
Accessor and modifier functions for the erev required attribute.
typedef ::neuroml2::Nml2Quantity_voltage	erev_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< erev_type, char >	erev_traits
	Attribute traits type.

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

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

void	erev (const erev_type &x)
	Set the attribute value. More...

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

Constructors
	GradedSynapse (const id_type &, const conductance_type &, const delta_type &, const Vth_type &, const k_type &, const erev_type &)
	Create an instance from the ultimate base and initializers for required elements and attributes.

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

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

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

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

virtual	~GradedSynapse ()
	Destructor.

Additional Inherited Members
Public Types inherited from neuroml2::BaseSynapse
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::BaseSynapse
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...

	BaseSynapse (const id_type &)
	Create an instance from the ultimate base and initializers for required elements and attributes.

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

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

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

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

Graded/analog synapse. Based on synapse in Methods of http://www. nature.com/neuro/journal/v7/n12/abs/nn1352.html
:param conductance: :type conductance: conductance :param delta: Slope of the activation curve :type delta: voltage :param k: Rate constant for transmitter-receptor dissociation rate :type k: per_time :param Vth: The half-activation voltage of the synapse :type Vth: voltage :param erev: The reversal potential of the synapse :type erev: voltage

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

Constructor & Destructor Documentation

◆ GradedSynapse() [1/2]

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

◆ GradedSynapse() [2/2]

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

Member Function Documentation

◆ _clone()

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

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

◆ conductance() [1/4]

GradedSynapse::conductance_type & neuroml2::GradedSynapse::conductance ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ conductance() [2/4]

const GradedSynapse::conductance_type & neuroml2::GradedSynapse::conductance ( ) const

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

Returns: A constant reference to the attribute.

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

◆ conductance() [3/4]

void neuroml2::GradedSynapse::conductance ( ::std::unique_ptr< conductance_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 6463 of file NeuroML_v2.3.cxx.

◆ conductance() [4/4]

void neuroml2::GradedSynapse::conductance ( const conductance_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 6457 of file NeuroML_v2.3.cxx.

◆ delta() [1/4]

GradedSynapse::delta_type & neuroml2::GradedSynapse::delta ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ delta() [2/4]

const GradedSynapse::delta_type & neuroml2::GradedSynapse::delta ( ) const

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

Returns: A constant reference to the attribute.

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

◆ delta() [3/4]

void neuroml2::GradedSynapse::delta ( ::std::unique_ptr< delta_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 6487 of file NeuroML_v2.3.cxx.

◆ delta() [4/4]

void neuroml2::GradedSynapse::delta ( const delta_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 6481 of file NeuroML_v2.3.cxx.

◆ erev() [1/4]

GradedSynapse::erev_type & neuroml2::GradedSynapse::erev ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ erev() [2/4]

const GradedSynapse::erev_type & neuroml2::GradedSynapse::erev ( ) const

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

Returns: A constant reference to the attribute.

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

◆ erev() [3/4]

void neuroml2::GradedSynapse::erev ( ::std::unique_ptr< erev_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 6559 of file NeuroML_v2.3.cxx.

◆ erev() [4/4]

void neuroml2::GradedSynapse::erev ( const erev_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 6553 of file NeuroML_v2.3.cxx.

◆ k() [1/4]

GradedSynapse::k_type & neuroml2::GradedSynapse::k ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ k() [2/4]

const GradedSynapse::k_type & neuroml2::GradedSynapse::k ( ) const

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

Returns: A constant reference to the attribute.

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

◆ k() [3/4]

void neuroml2::GradedSynapse::k ( ::std::unique_ptr< k_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 6535 of file NeuroML_v2.3.cxx.

◆ k() [4/4]

void neuroml2::GradedSynapse::k ( const k_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 6529 of file NeuroML_v2.3.cxx.

◆ operator=()

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

◆ Vth() [1/4]

GradedSynapse::Vth_type & neuroml2::GradedSynapse::Vth ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ Vth() [2/4]

const GradedSynapse::Vth_type & neuroml2::GradedSynapse::Vth ( ) const

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

Returns: A constant reference to the attribute.

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

◆ Vth() [3/4]

void neuroml2::GradedSynapse::Vth ( ::std::unique_ptr< Vth_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 6511 of file NeuroML_v2.3.cxx.

◆ Vth() [4/4]

void neuroml2::GradedSynapse::Vth ( const Vth_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 6505 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

conductance

delta

Vth

k

erev

Constructors

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GradedSynapse() [1/2]

◆ GradedSynapse() [2/2]

Member Function Documentation

◆ _clone()

◆ conductance() [1/4]

◆ conductance() [2/4]

◆ conductance() [3/4]

◆ conductance() [4/4]

◆ delta() [1/4]

◆ delta() [2/4]

◆ delta() [3/4]

◆ delta() [4/4]

◆ erev() [1/4]

◆ erev() [2/4]

◆ erev() [3/4]

◆ erev() [4/4]

◆ k() [1/4]

◆ k() [2/4]

◆ k() [3/4]

◆ k() [4/4]

◆ operator=()

◆ Vth() [1/4]

◆ Vth() [2/4]

◆ Vth() [3/4]

◆ Vth() [4/4]