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

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

#include <NeuroML_v2.3.hxx>

+ Inheritance diagram for neuroml2::CompoundInputDL:
+ Collaboration diagram for neuroml2::CompoundInputDL:

pulseGeneratorDL

Accessor and modifier functions for the pulseGeneratorDL sequence element.

typedef ::neuroml2::PulseGeneratorDL pulseGeneratorDL_type
 Element type.
 
typedef ::xsd::cxx::tree::sequence< pulseGeneratorDL_typepulseGeneratorDL_sequence
 Element sequence container type.
 
typedef pulseGeneratorDL_sequence::iterator pulseGeneratorDL_iterator
 Element iterator type.
 
typedef pulseGeneratorDL_sequence::const_iterator pulseGeneratorDL_const_iterator
 Element constant iterator type.
 
typedef ::xsd::cxx::tree::traits< pulseGeneratorDL_type, char > pulseGeneratorDL_traits
 Element traits type.
 
const pulseGeneratorDL_sequencepulseGeneratorDL () const
 Return a read-only (constant) reference to the element sequence. More...
 
pulseGeneratorDL_sequencepulseGeneratorDL ()
 Return a read-write reference to the element sequence. More...
 
void pulseGeneratorDL (const pulseGeneratorDL_sequence &s)
 Copy elements from a given sequence. More...
 

sineGeneratorDL

Accessor and modifier functions for the sineGeneratorDL sequence element.

typedef ::neuroml2::SineGeneratorDL sineGeneratorDL_type
 Element type.
 
typedef ::xsd::cxx::tree::sequence< sineGeneratorDL_typesineGeneratorDL_sequence
 Element sequence container type.
 
typedef sineGeneratorDL_sequence::iterator sineGeneratorDL_iterator
 Element iterator type.
 
typedef sineGeneratorDL_sequence::const_iterator sineGeneratorDL_const_iterator
 Element constant iterator type.
 
typedef ::xsd::cxx::tree::traits< sineGeneratorDL_type, char > sineGeneratorDL_traits
 Element traits type.
 
const sineGeneratorDL_sequencesineGeneratorDL () const
 Return a read-only (constant) reference to the element sequence. More...
 
sineGeneratorDL_sequencesineGeneratorDL ()
 Return a read-write reference to the element sequence. More...
 
void sineGeneratorDL (const sineGeneratorDL_sequence &s)
 Copy elements from a given sequence. More...
 

rampGeneratorDL

Accessor and modifier functions for the rampGeneratorDL sequence element.

typedef ::neuroml2::RampGeneratorDL rampGeneratorDL_type
 Element type.
 
typedef ::xsd::cxx::tree::sequence< rampGeneratorDL_typerampGeneratorDL_sequence
 Element sequence container type.
 
typedef rampGeneratorDL_sequence::iterator rampGeneratorDL_iterator
 Element iterator type.
 
typedef rampGeneratorDL_sequence::const_iterator rampGeneratorDL_const_iterator
 Element constant iterator type.
 
typedef ::xsd::cxx::tree::traits< rampGeneratorDL_type, char > rampGeneratorDL_traits
 Element traits type.
 
const rampGeneratorDL_sequencerampGeneratorDL () const
 Return a read-only (constant) reference to the element sequence. More...
 
rampGeneratorDL_sequencerampGeneratorDL ()
 Return a read-write reference to the element sequence. More...
 
void rampGeneratorDL (const rampGeneratorDL_sequence &s)
 Copy elements from a given sequence. More...
 

Constructors

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

Additional Inherited Members

- Public Types inherited from neuroml2::Standalone
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.
 
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.
 
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.
 
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.
 
- 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::Standalone
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...
 
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...
 
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...
 
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...
 
 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...
 
Standaloneoperator= (const Standalone &x)
 Copy assignment operator. More...
 
virtual ~Standalone ()
 Destructor.
 
- 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 CompoundInputDL schema type.

Generates a current which is the sum of all its child basePointCurrentDL elements, e. g. can be a combination of pulseGeneratorDL , sineGeneratorDL elements producing a single i. Scaled by weight, if set

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

Constructor & Destructor Documentation

◆ CompoundInputDL() [1/2]

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

◆ CompoundInputDL() [2/2]

neuroml2::CompoundInputDL::CompoundInputDL ( const CompoundInputDL 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 41235 of file NeuroML_v2.3.cxx.

Member Function Documentation

◆ _clone()

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

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

◆ operator=()

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

◆ pulseGeneratorDL() [1/3]

CompoundInputDL::pulseGeneratorDL_sequence & neuroml2::CompoundInputDL::pulseGeneratorDL ( )

Return a read-write reference to the element sequence.

Returns
A reference to the sequence container.

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

◆ pulseGeneratorDL() [2/3]

const CompoundInputDL::pulseGeneratorDL_sequence & neuroml2::CompoundInputDL::pulseGeneratorDL ( ) const

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

Returns
A constant reference to the sequence container.

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

◆ pulseGeneratorDL() [3/3]

void neuroml2::CompoundInputDL::pulseGeneratorDL ( const pulseGeneratorDL_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 13184 of file NeuroML_v2.3.cxx.

◆ rampGeneratorDL() [1/3]

CompoundInputDL::rampGeneratorDL_sequence & neuroml2::CompoundInputDL::rampGeneratorDL ( )

Return a read-write reference to the element sequence.

Returns
A reference to the sequence container.

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

◆ rampGeneratorDL() [2/3]

const CompoundInputDL::rampGeneratorDL_sequence & neuroml2::CompoundInputDL::rampGeneratorDL ( ) const

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

Returns
A constant reference to the sequence container.

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

◆ rampGeneratorDL() [3/3]

void neuroml2::CompoundInputDL::rampGeneratorDL ( const rampGeneratorDL_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 13220 of file NeuroML_v2.3.cxx.

◆ sineGeneratorDL() [1/3]

CompoundInputDL::sineGeneratorDL_sequence & neuroml2::CompoundInputDL::sineGeneratorDL ( )

Return a read-write reference to the element sequence.

Returns
A reference to the sequence container.

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

◆ sineGeneratorDL() [2/3]

const CompoundInputDL::sineGeneratorDL_sequence & neuroml2::CompoundInputDL::sineGeneratorDL ( ) const

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

Returns
A constant reference to the sequence container.

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

◆ sineGeneratorDL() [3/3]

void neuroml2::CompoundInputDL::sineGeneratorDL ( const sineGeneratorDL_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 13202 of file NeuroML_v2.3.cxx.


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