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

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

#include <NeuroML_v2.3.hxx>

+ Inheritance diagram for neuroml2::InputList:
+ Collaboration diagram for neuroml2::InputList:

input

Accessor and modifier functions for the input sequence element.

typedef ::neuroml2::Input input_type
 Element type.
 
typedef ::xsd::cxx::tree::sequence< input_typeinput_sequence
 Element sequence container type.
 
typedef input_sequence::iterator input_iterator
 Element iterator type.
 
typedef input_sequence::const_iterator input_const_iterator
 Element constant iterator type.
 
typedef ::xsd::cxx::tree::traits< input_type, char > input_traits
 Element traits type.
 
const input_sequenceinput () const
 Return a read-only (constant) reference to the element sequence. More...
 
input_sequenceinput ()
 Return a read-write reference to the element sequence. More...
 
void input (const input_sequence &s)
 Copy elements from a given sequence. More...
 

inputW

Accessor and modifier functions for the inputW sequence element.

typedef ::neuroml2::InputW inputW_type
 Element type.
 
typedef ::xsd::cxx::tree::sequence< inputW_typeinputW_sequence
 Element sequence container type.
 
typedef inputW_sequence::iterator inputW_iterator
 Element iterator type.
 
typedef inputW_sequence::const_iterator inputW_const_iterator
 Element constant iterator type.
 
typedef ::xsd::cxx::tree::traits< inputW_type, char > inputW_traits
 Element traits type.
 
const inputW_sequenceinputW () const
 Return a read-only (constant) reference to the element sequence. More...
 
inputW_sequenceinputW ()
 Return a read-write reference to the element sequence. More...
 
void inputW (const inputW_sequence &s)
 Copy elements from a given sequence. More...
 

population

Accessor and modifier functions for the population required attribute.

typedef ::neuroml2::NmlId population_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< population_type, char > population_traits
 Attribute traits type.
 
const population_typepopulation () const
 Return a read-only (constant) reference to the attribute. More...
 
population_typepopulation ()
 Return a read-write reference to the attribute. More...
 
void population (const population_type &x)
 Set the attribute value. More...
 
void population (::std::unique_ptr< population_type > p)
 Set the attribute value without copying. More...
 

component

Accessor and modifier functions for the component required attribute.

typedef ::neuroml2::NmlId component_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< component_type, char > component_traits
 Attribute traits type.
 
const component_typecomponent () const
 Return a read-only (constant) reference to the attribute. More...
 
component_typecomponent ()
 Return a read-write reference to the attribute. More...
 
void component (const component_type &x)
 Set the attribute value. More...
 
void component (::std::unique_ptr< component_type > p)
 Set the attribute value without copying. More...
 

Constructors

 InputList (const id_type &, const population_type &, const component_type &)
 Create an instance from the ultimate base and initializers for required elements and attributes.
 
 InputList (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Create an instance from a DOM element. More...
 
 InputList (const InputList &x, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Copy constructor. More...
 
virtual InputList_clone (::xml_schema::flags f=0, ::xml_schema::container *c=0) const
 Copy the instance polymorphically. More...
 
InputListoperator= (const InputList &x)
 Copy assignment operator. More...
 
virtual ~InputList ()
 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 InputList schema type.

An explicit list of input s to a population.

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

Constructor & Destructor Documentation

◆ InputList() [1/2]

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

◆ InputList() [2/2]

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

Member Function Documentation

◆ _clone()

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

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

◆ component() [1/4]

InputList::component_type & neuroml2::InputList::component ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ component() [2/4]

const InputList::component_type & neuroml2::InputList::component ( ) const

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

Returns
A constant reference to the attribute.

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

◆ component() [3/4]

void neuroml2::InputList::component ( ::std::unique_ptr< component_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 16411 of file NeuroML_v2.3.cxx.

◆ component() [4/4]

void neuroml2::InputList::component ( const component_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 16405 of file NeuroML_v2.3.cxx.

◆ input() [1/3]

InputList::input_sequence & neuroml2::InputList::input ( )

Return a read-write reference to the element sequence.

Returns
A reference to the sequence container.

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

◆ input() [2/3]

const InputList::input_sequence & neuroml2::InputList::input ( ) const

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

Returns
A constant reference to the sequence container.

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

◆ input() [3/3]

void neuroml2::InputList::input ( const input_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 16345 of file NeuroML_v2.3.cxx.

◆ inputW() [1/3]

InputList::inputW_sequence & neuroml2::InputList::inputW ( )

Return a read-write reference to the element sequence.

Returns
A reference to the sequence container.

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

◆ inputW() [2/3]

const InputList::inputW_sequence & neuroml2::InputList::inputW ( ) const

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

Returns
A constant reference to the sequence container.

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

◆ inputW() [3/3]

void neuroml2::InputList::inputW ( const inputW_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 16363 of file NeuroML_v2.3.cxx.

◆ operator=()

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

◆ population() [1/4]

InputList::population_type & neuroml2::InputList::population ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ population() [2/4]

const InputList::population_type & neuroml2::InputList::population ( ) const

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

Returns
A constant reference to the attribute.

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

◆ population() [3/4]

void neuroml2::InputList::population ( ::std::unique_ptr< population_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 16387 of file NeuroML_v2.3.cxx.

◆ population() [4/4]

void neuroml2::InputList::population ( const population_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 16381 of file NeuroML_v2.3.cxx.


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