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

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

#include <NeuroML_v2.3.hxx>

+ Inheritance diagram for neuroml2::OnEvent:
+ Collaboration diagram for neuroml2::OnEvent:

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

port

Accessor and modifier functions for the port required attribute.

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

Constructors

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

Detailed Description

Class corresponding to the OnEvent schema type.

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

Constructor & Destructor Documentation

◆ OnEvent() [1/2]

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

◆ OnEvent() [2/2]

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

Member Function Documentation

◆ _clone()

OnEvent * neuroml2::OnEvent::_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 21638 of file NeuroML_v2.3.cxx.

◆ EventOut() [1/3]

OnEvent::EventOut_sequence & neuroml2::OnEvent::EventOut ( )

Return a read-write reference to the element sequence.

Returns
A reference to the sequence container.

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

◆ EventOut() [2/3]

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

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

Returns
A constant reference to the sequence container.

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

◆ EventOut() [3/3]

void neuroml2::OnEvent::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 1428 of file NeuroML_v2.3.cxx.

◆ operator=()

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

◆ port() [1/4]

OnEvent::port_type & neuroml2::OnEvent::port ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ port() [2/4]

const OnEvent::port_type & neuroml2::OnEvent::port ( ) const

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

Returns
A constant reference to the attribute.

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

◆ port() [3/4]

void neuroml2::OnEvent::port ( ::std::unique_ptr< port_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 1452 of file NeuroML_v2.3.cxx.

◆ port() [4/4]

void neuroml2::OnEvent::port ( const port_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 1446 of file NeuroML_v2.3.cxx.

◆ StateAssignment() [1/3]

OnEvent::StateAssignment_sequence & neuroml2::OnEvent::StateAssignment ( )

Return a read-write reference to the element sequence.

Returns
A reference to the sequence container.

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

◆ StateAssignment() [2/3]

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

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

Returns
A constant reference to the sequence container.

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

◆ StateAssignment() [3/3]

void neuroml2::OnEvent::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 1410 of file NeuroML_v2.3.cxx.


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