NeuroML C++ API  2.3.0
C++ API for NeuroML 2
List of all members
neuroml2::Standalone Class Reference

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

#include <NeuroML_v2.3.hxx>

+ Inheritance diagram for neuroml2::Standalone:
+ Collaboration diagram for neuroml2::Standalone:

notes

Accessor and modifier functions for the notes optional element.

typedef ::neuroml2::Notes notes_type
 Element type.
 
typedef ::xsd::cxx::tree::optional< notes_typenotes_optional
 Element optional container type.
 
typedef ::xsd::cxx::tree::traits< notes_type, char > notes_traits
 Element traits type.
 
const notes_optionalnotes () const
 Return a read-only (constant) reference to the element container. More...
 
notes_optionalnotes ()
 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...
 

property

Accessor and modifier functions for the property sequence element.

typedef ::neuroml2::Property property_type
 Element type.
 
typedef ::xsd::cxx::tree::sequence< property_typeproperty_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.
 
const property_sequenceproperty () const
 Return a read-only (constant) reference to the element sequence. More...
 
property_sequenceproperty ()
 Return a read-write reference to the element sequence. More...
 
void property (const property_sequence &s)
 Copy elements from a given sequence. More...
 

annotation

Accessor and modifier functions for the annotation optional element.

typedef ::neuroml2::Annotation annotation_type
 Element type.
 
typedef ::xsd::cxx::tree::optional< annotation_typeannotation_optional
 Element optional container type.
 
typedef ::xsd::cxx::tree::traits< annotation_type, char > annotation_traits
 Element traits type.
 
const annotation_optionalannotation () const
 Return a read-only (constant) reference to the element container. More...
 
annotation_optionalannotation ()
 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...
 

metaid

Accessor and modifier functions for the metaid optional attribute.

typedef ::neuroml2::MetaId metaid_type
 Attribute type.
 
typedef ::xsd::cxx::tree::optional< metaid_typemetaid_optional
 Attribute optional container type.
 
typedef ::xsd::cxx::tree::traits< metaid_type, char > metaid_traits
 Attribute traits type.
 
const metaid_optionalmetaid () const
 Return a read-only (constant) reference to the attribute container. More...
 
metaid_optionalmetaid ()
 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...
 

Constructors

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

Additional Inherited Members

- 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::Base
const id_typeid () const
 Return a read-only (constant) reference to the attribute. More...
 
id_typeid ()
 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...
 
Baseoperator= (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 Standalone schema type.

Elements which can stand alone and be referenced by id, e.g. cell, morphology.

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

Constructor & Destructor Documentation

◆ Standalone() [1/2]

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

Create an instance from a DOM element.

Parameters
eA DOM element to extract the data from.
fFlags to create the new instance with.
cA pointer to the object that will contain the new instance.

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

◆ Standalone() [2/2]

neuroml2::Standalone::Standalone ( const Standalone x,
::xml_schema::flags  f = 0,
::xml_schema::container c = 0 
)

Copy constructor.

Parameters
xAn instance to make a copy of.
fFlags to create the copy with.
cA pointer to the object that will contain the copy.

For polymorphic object models use the _clone function instead.

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

Member Function Documentation

◆ _clone()

Standalone * neuroml2::Standalone::_clone ( ::xml_schema::flags  f = 0,
::xml_schema::container c = 0 
) const
virtual

Copy the instance polymorphically.

Parameters
fFlags to create the copy with.
cA 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::Base.

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::Population, 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::ConcentrationModel_D, neuroml2::BiophysicalProperties2CaPools, neuroml2::BiophysicalProperties, 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::IonChannelVShift, neuroml2::IonChannelHH, neuroml2::IonChannel, neuroml2::IonChannelKS, neuroml2::IonChannelScalable, and neuroml2::NeuroMLDocument_base.

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

◆ annotation() [1/5]

Standalone::annotation_optional & neuroml2::Standalone::annotation ( )

Return a read-write reference to the element container.

Returns
A reference to the optional container.

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

◆ annotation() [2/5]

const Standalone::annotation_optional & neuroml2::Standalone::annotation ( ) const

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

Returns
A constant reference to the optional container.

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

◆ annotation() [3/5]

void neuroml2::Standalone::annotation ( ::std::unique_ptr< annotation_type p)

Set the element value without copying.

Parameters
pA new value to use.

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

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

◆ annotation() [4/5]

void neuroml2::Standalone::annotation ( const annotation_optional x)

Set the element value.

Parameters
xAn 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 1901 of file NeuroML_v2.3.cxx.

◆ annotation() [5/5]

void neuroml2::Standalone::annotation ( const annotation_type x)

Set the element value.

Parameters
xA 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 1895 of file NeuroML_v2.3.cxx.

◆ metaid() [1/5]

Standalone::metaid_optional & neuroml2::Standalone::metaid ( )

Return a read-write reference to the attribute container.

Returns
A reference to the optional container.

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

◆ metaid() [2/5]

const Standalone::metaid_optional & neuroml2::Standalone::metaid ( ) const

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

Returns
A constant reference to the optional container.

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

◆ metaid() [3/5]

void neuroml2::Standalone::metaid ( ::std::unique_ptr< metaid_type p)

Set the attribute value without copying.

Parameters
pA new value to use.

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

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

◆ metaid() [4/5]

void neuroml2::Standalone::metaid ( const metaid_optional x)

Set the attribute value.

Parameters
xAn 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 attribute. Otherwise the attribute container is set the 'not present' state.

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

◆ metaid() [5/5]

void neuroml2::Standalone::metaid ( const metaid_type x)

Set the attribute value.

Parameters
xA 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 1925 of file NeuroML_v2.3.cxx.

◆ notes() [1/5]

Standalone::notes_optional & neuroml2::Standalone::notes ( )

Return a read-write reference to the element container.

Returns
A reference to the optional container.

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

◆ notes() [2/5]

const Standalone::notes_optional & neuroml2::Standalone::notes ( ) const

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

Returns
A constant reference to the optional container.

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

◆ notes() [3/5]

void neuroml2::Standalone::notes ( ::std::unique_ptr< notes_type p)

Set the element value without copying.

Parameters
pA new value to use.

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

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

◆ notes() [4/5]

void neuroml2::Standalone::notes ( const notes_optional x)

Set the element value.

Parameters
xAn 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 1853 of file NeuroML_v2.3.cxx.

◆ notes() [5/5]

void neuroml2::Standalone::notes ( const notes_type x)

Set the element value.

Parameters
xA 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 1847 of file NeuroML_v2.3.cxx.

◆ operator=()

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

Copy assignment operator.

Parameters
xAn instance to make a copy of.
Returns
A reference to itself.

For polymorphic object models use the _clone function instead.

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

◆ property() [1/3]

Standalone::property_sequence & neuroml2::Standalone::property ( )

Return a read-write reference to the element sequence.

Returns
A reference to the sequence container.

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

◆ property() [2/3]

const Standalone::property_sequence & neuroml2::Standalone::property ( ) const

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

Returns
A constant reference to the sequence container.

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

◆ property() [3/3]

void neuroml2::Standalone::property ( const property_sequence s)

Copy elements from a given sequence.

Parameters
sA sequence to copy elements from.

For each element in s this function makes a copy and adds it to the sequence. Note that this operation completely changes the sequence and all old elements will be lost.

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


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