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

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

#include <NeuroML_v2.3.hxx>

+ Inheritance diagram for neuroml2::OnCondition:
+ Collaboration diagram for neuroml2::OnCondition:

StateAssignment

Accessor and modifier functions for the StateAssignment sequence element.

typedef ::neuroml2::StateAssignment StateAssignment_type
 Element type.
 
typedef ::xsd::cxx::tree::sequence< StateAssignment_typeStateAssignment_sequence
 Element sequence container type.
 
typedef StateAssignment_sequence::iterator StateAssignment_iterator
 Element iterator type.
 
typedef StateAssignment_sequence::const_iterator StateAssignment_const_iterator
 Element constant iterator type.
 
typedef ::xsd::cxx::tree::traits< StateAssignment_type, char > StateAssignment_traits
 Element traits type.
 
const StateAssignment_sequenceStateAssignment () const
 Return a read-only (constant) reference to the element sequence. More...
 
StateAssignment_sequenceStateAssignment ()
 Return a read-write reference to the element sequence. More...
 
void StateAssignment (const StateAssignment_sequence &s)
 Copy elements from a given sequence. More...
 

EventOut

Accessor and modifier functions for the EventOut sequence element.

typedef ::neuroml2::EventOut EventOut_type
 Element type.
 
typedef ::xsd::cxx::tree::sequence< EventOut_typeEventOut_sequence
 Element sequence container type.
 
typedef EventOut_sequence::iterator EventOut_iterator
 Element iterator type.
 
typedef EventOut_sequence::const_iterator EventOut_const_iterator
 Element constant iterator type.
 
typedef ::xsd::cxx::tree::traits< EventOut_type, char > EventOut_traits
 Element traits type.
 
const EventOut_sequenceEventOut () const
 Return a read-only (constant) reference to the element sequence. More...
 
EventOut_sequenceEventOut ()
 Return a read-write reference to the element sequence. More...
 
void EventOut (const EventOut_sequence &s)
 Copy elements from a given sequence. More...
 

Transition

Accessor and modifier functions for the Transition optional element.

typedef ::neuroml2::Transition Transition_type
 Element type.
 
typedef ::xsd::cxx::tree::optional< Transition_typeTransition_optional
 Element optional container type.
 
typedef ::xsd::cxx::tree::traits< Transition_type, char > Transition_traits
 Element traits type.
 
const Transition_optionalTransition () const
 Return a read-only (constant) reference to the element container. More...
 
Transition_optionalTransition ()
 Return a read-write reference to the element container. More...
 
void Transition (const Transition_type &x)
 Set the element value. More...
 
void Transition (const Transition_optional &x)
 Set the element value. More...
 
void Transition (::std::unique_ptr< Transition_type > p)
 Set the element value without copying. More...
 

test

Accessor and modifier functions for the test required attribute.

typedef ::xml_schema::string test_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< test_type, char > test_traits
 Attribute traits type.
 
const test_typetest () const
 Return a read-only (constant) reference to the attribute. More...
 
test_typetest ()
 Return a read-write reference to the attribute. More...
 
void test (const test_type &x)
 Set the attribute value. More...
 
void test (::std::unique_ptr< test_type > p)
 Set the attribute value without copying. More...
 

Constructors

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

Detailed Description

Class corresponding to the OnCondition schema type.

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

Constructor & Destructor Documentation

◆ OnCondition() [1/2]

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

◆ OnCondition() [2/2]

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

Member Function Documentation

◆ _clone()

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

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

◆ EventOut() [1/3]

OnCondition::EventOut_sequence & neuroml2::OnCondition::EventOut ( )

Return a read-write reference to the element sequence.

Returns
A reference to the sequence container.

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

◆ EventOut() [2/3]

const OnCondition::EventOut_sequence & neuroml2::OnCondition::EventOut ( ) const

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

Returns
A constant reference to the sequence container.

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

◆ EventOut() [3/3]

void neuroml2::OnCondition::EventOut ( const EventOut_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 1520 of file NeuroML_v2.3.cxx.

◆ operator=()

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

◆ StateAssignment() [1/3]

OnCondition::StateAssignment_sequence & neuroml2::OnCondition::StateAssignment ( )

Return a read-write reference to the element sequence.

Returns
A reference to the sequence container.

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

◆ StateAssignment() [2/3]

const OnCondition::StateAssignment_sequence & neuroml2::OnCondition::StateAssignment ( ) const

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

Returns
A constant reference to the sequence container.

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

◆ StateAssignment() [3/3]

void neuroml2::OnCondition::StateAssignment ( const StateAssignment_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 1502 of file NeuroML_v2.3.cxx.

◆ test() [1/4]

OnCondition::test_type & neuroml2::OnCondition::test ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ test() [2/4]

const OnCondition::test_type & neuroml2::OnCondition::test ( ) const

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

Returns
A constant reference to the attribute.

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

◆ test() [3/4]

void neuroml2::OnCondition::test ( ::std::unique_ptr< test_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 1574 of file NeuroML_v2.3.cxx.

◆ test() [4/4]

void neuroml2::OnCondition::test ( const test_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 1568 of file NeuroML_v2.3.cxx.

◆ Transition() [1/5]

OnCondition::Transition_optional & neuroml2::OnCondition::Transition ( )

Return a read-write reference to the element container.

Returns
A reference to the optional container.

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

◆ Transition() [2/5]

const OnCondition::Transition_optional & neuroml2::OnCondition::Transition ( ) const

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

Returns
A constant reference to the optional container.

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

◆ Transition() [3/5]

void neuroml2::OnCondition::Transition ( ::std::unique_ptr< Transition_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 1550 of file NeuroML_v2.3.cxx.

◆ Transition() [4/5]

void neuroml2::OnCondition::Transition ( const Transition_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 1544 of file NeuroML_v2.3.cxx.

◆ Transition() [5/5]

void neuroml2::OnCondition::Transition ( const Transition_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 1538 of file NeuroML_v2.3.cxx.


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