neuroml2::Base Class Reference

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

#include <NeuroML_v2.3.hxx>

Inheritance diagram for neuroml2::Base:

Collaboration diagram for neuroml2::Base:

id
Accessor and modifier functions for the id required attribute.
typedef ::neuroml2::NmlId	id_type
	Attribute type.
typedef ::xsd::cxx::tree::traits< id_type, char >	id_traits
	Attribute traits type.
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...

Constructors
	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...
virtual Base *	_clone (::xml_schema::flags f=0, ::xml_schema::container *c=0) const
	Copy the instance polymorphically. More...
Base &	operator= (const Base &x)
	Copy assignment operator. More...
virtual	~Base ()
	Destructor.

Additional Inherited Members
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 Base schema type.

Anything which can have a unique (within its parent) id of the form NmlId (spaceless combination of letters, numbers and underscore).

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

Constructor & Destructor Documentation

Base() [1/2]

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

Base() [2/2]

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

Member Function Documentation

_clone()

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

Reimplemented in neuroml2::Morphology, neuroml2::NeuroMLDocument, neuroml2::SpikeSourcePoisson, neuroml2::AlphaCurrSynapse, neuroml2::ExpCurrSynapse, neuroml2::AlphaCondSynapse, neuroml2::ExpCondSynapse, neuroml2::BasePynnSynapse, 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, neuroml2::basePyNNIaFCell, neuroml2::basePyNNCell, neuroml2::InputList, neuroml2::ContinuousProjection, neuroml2::ElectricalProjection, neuroml2::Projection, neuroml2::BaseProjection, neuroml2::CellSet, neuroml2::Population, neuroml2::Region, neuroml2::Space, neuroml2::Network, neuroml2::TransientPoissonFiringSynapse, neuroml2::PoissonFiringSynapse, neuroml2::SpikeGeneratorRefPoisson, neuroml2::SpikeGeneratorPoisson, neuroml2::SpikeGeneratorRandom, neuroml2::SpikeGenerator, neuroml2::TimedSynapticInput, neuroml2::SpikeArray, neuroml2::VoltageClampTriple, neuroml2::VoltageClamp, neuroml2::CompoundInputDL, neuroml2::CompoundInput, neuroml2::RampGeneratorDL, neuroml2::RampGenerator, neuroml2::SineGeneratorDL, neuroml2::SineGenerator, neuroml2::PulseGeneratorDL, neuroml2::PulseGenerator, neuroml2::ReactionScheme, neuroml2::ExtracellularPropertiesLocal, neuroml2::ExtracellularProperties, neuroml2::ConcentrationModel_D, neuroml2::Species, neuroml2::ChannelDensityGHK2, neuroml2::ChannelDensityGHK, neuroml2::ChannelDensityNernstCa2, neuroml2::ChannelDensityNernst, neuroml2::ChannelDensityVShift, neuroml2::ChannelDensity, neuroml2::ChannelDensityNonUniformGHK, neuroml2::ChannelDensityNonUniformNernst, neuroml2::ChannelDensityNonUniform, neuroml2::ChannelPopulation, neuroml2::BiophysicalProperties2CaPools, neuroml2::BiophysicalProperties, neuroml2::InhomogeneousParameter, neuroml2::SegmentGroup, neuroml2::Morphology_base, neuroml2::Cell2CaPools, neuroml2::Cell, neuroml2::HindmarshRose1984Cell, neuroml2::PinskyRinzelCA3Cell, neuroml2::FitzHughNagumo1969Cell, neuroml2::FitzHughNagumoCell, neuroml2::AdExIaFCell, neuroml2::Izhikevich2007Cell, neuroml2::BaseCellMembPotCap, neuroml2::IzhikevichCell, neuroml2::IafRefCell, neuroml2::IafCell, neuroml2::IafTauRefCell, neuroml2::IafTauCell, neuroml2::BaseCell, neuroml2::BlockingPlasticSynapse, neuroml2::DoubleSynapse, neuroml2::ExpThreeSynapse, neuroml2::ExpTwoSynapse, neuroml2::ExpOneSynapse, neuroml2::AlphaSynapse, neuroml2::AlphaCurrentSynapse, neuroml2::GradedSynapse, neuroml2::LinearGradedSynapse, neuroml2::SilentSynapse, neuroml2::GapJunction, neuroml2::BaseConductanceBasedSynapseTwo, neuroml2::BaseConductanceBasedSynapse, neuroml2::BaseCurrentBasedSynapse, neuroml2::BaseVoltageDepSynapse, neuroml2::BaseSynapse, neuroml2::FixedFactorConcentrationModel, neuroml2::DecayingPoolConcentrationModel, neuroml2::GateFractionalSubgate, neuroml2::GateFractional, neuroml2::GateHHInstantaneous, neuroml2::GateHHRatesInf, neuroml2::GateHHRatesTau, neuroml2::GateHHRatesTauInf, neuroml2::GateHHTauInf, neuroml2::GateHHRates, neuroml2::GateHHUndetermined, neuroml2::GateKS, neuroml2::TauInfTransition, neuroml2::ReverseTransition, neuroml2::ForwardTransition, neuroml2::OpenState, neuroml2::ClosedState, neuroml2::IonChannelVShift, neuroml2::IonChannelHH, neuroml2::IonChannel, neuroml2::IonChannelKS, neuroml2::IonChannelScalable, neuroml2::NeuroMLDocument_base, and neuroml2::Standalone.

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

id() [1/4]

Base::id_type & neuroml2::Base::id

(

)

Return a read-write reference to the attribute.

Returns

A reference to the attribute.

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

id() [2/4]

const Base::id_type & neuroml2::Base::id

(

)

const

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

Returns

A constant reference to the attribute.

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

id() [3/4]

void neuroml2::Base::id

(

::std::unique_ptr< id_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 1825 of file NeuroML_v2.3.cxx.

id() [4/4]

void neuroml2::Base::id

(

const id_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 1819 of file NeuroML_v2.3.cxx.

operator=()

Base & neuroml2::Base::operator=

(

const Base &

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 22504 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