neuroml2::BlockingPlasticSynapse Class Reference

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

#include <NeuroML_v2.3.hxx>

Inheritance diagram for neuroml2::BlockingPlasticSynapse:

Collaboration diagram for neuroml2::BlockingPlasticSynapse:

plasticityMechanism
Accessor and modifier functions for the plasticityMechanism optional element.
typedef ::neuroml2::PlasticityMechanism	plasticityMechanism_type
	Element type.
typedef ::xsd::cxx::tree::optional< plasticityMechanism_type >	plasticityMechanism_optional
	Element optional container type.
typedef ::xsd::cxx::tree::traits< plasticityMechanism_type, char >	plasticityMechanism_traits
	Element traits type.
const plasticityMechanism_optional &	plasticityMechanism () const
	Return a read-only (constant) reference to the element container. More...
plasticityMechanism_optional &	plasticityMechanism ()
	Return a read-write reference to the element container. More...
void	plasticityMechanism (const plasticityMechanism_type &x)
	Set the element value. More...
void	plasticityMechanism (const plasticityMechanism_optional &x)
	Set the element value. More...
void	plasticityMechanism (::std::unique_ptr< plasticityMechanism_type > p)
	Set the element value without copying. More...

blockMechanism
Accessor and modifier functions for the blockMechanism optional element.
typedef ::neuroml2::BlockMechanism	blockMechanism_type
	Element type.
typedef ::xsd::cxx::tree::optional< blockMechanism_type >	blockMechanism_optional
	Element optional container type.
typedef ::xsd::cxx::tree::traits< blockMechanism_type, char >	blockMechanism_traits
	Element traits type.
const blockMechanism_optional &	blockMechanism () const
	Return a read-only (constant) reference to the element container. More...
blockMechanism_optional &	blockMechanism ()
	Return a read-write reference to the element container. More...
void	blockMechanism (const blockMechanism_type &x)
	Set the element value. More...
void	blockMechanism (const blockMechanism_optional &x)
	Set the element value. More...
void	blockMechanism (::std::unique_ptr< blockMechanism_type > p)
	Set the element value without copying. More...

Constructors
	BlockingPlasticSynapse (const id_type &, const gbase_type &, const erev_type &, const tauDecay_type &, const tauRise_type &)
	Create an instance from the ultimate base and initializers for required elements and attributes.
	BlockingPlasticSynapse (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
	Create an instance from a DOM element. More...
	BlockingPlasticSynapse (const BlockingPlasticSynapse &x, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
	Copy constructor. More...
virtual BlockingPlasticSynapse *	_clone (::xml_schema::flags f=0, ::xml_schema::container *c=0) const
	Copy the instance polymorphically. More...
BlockingPlasticSynapse &	operator= (const BlockingPlasticSynapse &x)
	Copy assignment operator. More...
virtual	~BlockingPlasticSynapse ()
	Destructor.

Additional Inherited Members
Public Types inherited from neuroml2::ExpTwoSynapse
typedef ::neuroml2::Nml2Quantity_time	tauDecay_type
	Attribute type.
typedef ::xsd::cxx::tree::traits< tauDecay_type, char >	tauDecay_traits
	Attribute traits type.
typedef ::neuroml2::Nml2Quantity_time	tauRise_type
	Attribute type.
typedef ::xsd::cxx::tree::traits< tauRise_type, char >	tauRise_traits
	Attribute traits type.
Public Types inherited from neuroml2::BaseConductanceBasedSynapse
typedef ::neuroml2::Nml2Quantity_conductance	gbase_type
	Attribute type.
typedef ::xsd::cxx::tree::traits< gbase_type, char >	gbase_traits
	Attribute traits type.
typedef ::neuroml2::Nml2Quantity_voltage	erev_type
	Attribute type.
typedef ::xsd::cxx::tree::traits< erev_type, char >	erev_traits
	Attribute traits type.
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::ExpTwoSynapse
const tauDecay_type &	tauDecay () const
	Return a read-only (constant) reference to the attribute. More...
tauDecay_type &	tauDecay ()
	Return a read-write reference to the attribute. More...
void	tauDecay (const tauDecay_type &x)
	Set the attribute value. More...
void	tauDecay (::std::unique_ptr< tauDecay_type > p)
	Set the attribute value without copying. More...
const tauRise_type &	tauRise () const
	Return a read-only (constant) reference to the attribute. More...
tauRise_type &	tauRise ()
	Return a read-write reference to the attribute. More...
void	tauRise (const tauRise_type &x)
	Set the attribute value. More...
void	tauRise (::std::unique_ptr< tauRise_type > p)
	Set the attribute value without copying. More...
	ExpTwoSynapse (const id_type &, const gbase_type &, const erev_type &, const tauDecay_type &, const tauRise_type &)
	Create an instance from the ultimate base and initializers for required elements and attributes.
	ExpTwoSynapse (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
	Create an instance from a DOM element. More...
	ExpTwoSynapse (const ExpTwoSynapse &x, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
	Copy constructor. More...
ExpTwoSynapse &	operator= (const ExpTwoSynapse &x)
	Copy assignment operator. More...
virtual	~ExpTwoSynapse ()
	Destructor.
Public Member Functions inherited from neuroml2::BaseConductanceBasedSynapse
const gbase_type &	gbase () const
	Return a read-only (constant) reference to the attribute. More...
gbase_type &	gbase ()
	Return a read-write reference to the attribute. More...
void	gbase (const gbase_type &x)
	Set the attribute value. More...
void	gbase (::std::unique_ptr< gbase_type > p)
	Set the attribute value without copying. More...
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...
	BaseConductanceBasedSynapse (const id_type &, const gbase_type &, const erev_type &)
	Create an instance from the ultimate base and initializers for required elements and attributes.
	BaseConductanceBasedSynapse (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
	Create an instance from a DOM element. More...
	BaseConductanceBasedSynapse (const BaseConductanceBasedSynapse &x, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
	Copy constructor. More...
BaseConductanceBasedSynapse &	operator= (const BaseConductanceBasedSynapse &x)
	Copy assignment operator. More...
virtual	~BaseConductanceBasedSynapse ()
	Destructor.
Public Member Functions inherited from neuroml2::BaseVoltageDepSynapse
	BaseVoltageDepSynapse (const id_type &)
	Create an instance from the ultimate base and initializers for required elements and attributes.
	BaseVoltageDepSynapse (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
	Create an instance from a DOM element. More...
	BaseVoltageDepSynapse (const BaseVoltageDepSynapse &x, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
	Copy constructor. More...
virtual	~BaseVoltageDepSynapse ()
	Destructor.
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 BlockingPlasticSynapse schema type.

Biexponential synapse that allows for optional block and plasticity mechanisms, which can be expressed as child elements.
:param tauRise: :type tauRise: time :param tauDecay: :type tauDecay: time :param gbase: Baseline conductance, generally the maximum conductance following a single spike :type gbase: conductance :param erev: Reversal potential of the synapse :type erev: voltage

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

Constructor & Destructor Documentation

BlockingPlasticSynapse() [1/2]

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

BlockingPlasticSynapse() [2/2]

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

Member Function Documentation

_clone()

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

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

blockMechanism() [1/5]

BlockingPlasticSynapse::blockMechanism_optional & neuroml2::BlockingPlasticSynapse::blockMechanism

(

)

Return a read-write reference to the element container.

Returns

A reference to the optional container.

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

blockMechanism() [2/5]

const BlockingPlasticSynapse::blockMechanism_optional & neuroml2::BlockingPlasticSynapse::blockMechanism

(

)

const

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

Returns

A constant reference to the optional container.

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

blockMechanism() [3/5]

void neuroml2::BlockingPlasticSynapse::blockMechanism

(

::std::unique_ptr< blockMechanism_type >

p

)

Set the element 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 6959 of file NeuroML_v2.3.cxx.

blockMechanism() [4/5]

void neuroml2::BlockingPlasticSynapse::blockMechanism

(

const blockMechanism_optional &

x

)

Set the element value.

Parameters

x	An optional container with the new value to set.

If the value is present in x then this function makes a copy of this value and sets it as the new value of the element. Otherwise the element container is set the 'not present' state.

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

blockMechanism() [5/5]

void neuroml2::BlockingPlasticSynapse::blockMechanism

(

const blockMechanism_type &

x

)

Set the element 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 element.

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

operator=()

BlockingPlasticSynapse & neuroml2::BlockingPlasticSynapse::operator=

(

const BlockingPlasticSynapse &

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 30682 of file NeuroML_v2.3.cxx.

plasticityMechanism() [1/5]

BlockingPlasticSynapse::plasticityMechanism_optional & neuroml2::BlockingPlasticSynapse::plasticityMechanism

(

)

Return a read-write reference to the element container.

Returns

A reference to the optional container.

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

plasticityMechanism() [2/5]

const BlockingPlasticSynapse::plasticityMechanism_optional & neuroml2::BlockingPlasticSynapse::plasticityMechanism

(

)

const

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

Returns

A constant reference to the optional container.

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

plasticityMechanism() [3/5]

void neuroml2::BlockingPlasticSynapse::plasticityMechanism

(

::std::unique_ptr< plasticityMechanism_type >

p

)

Set the element 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 6929 of file NeuroML_v2.3.cxx.

plasticityMechanism() [4/5]

void neuroml2::BlockingPlasticSynapse::plasticityMechanism

(

const plasticityMechanism_optional &

x

)

Set the element value.

Parameters

x	An optional container with the new value to set.

If the value is present in x then this function makes a copy of this value and sets it as the new value of the element. Otherwise the element container is set the 'not present' state.

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

plasticityMechanism() [5/5]

void neuroml2::BlockingPlasticSynapse::plasticityMechanism

(

const plasticityMechanism_type &

x

)

Set the element 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 element.

Definition at line 6917 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