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

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

#include <NeuroML_v2.3.hxx>

+ Inheritance diagram for neuroml2::EventOut:
+ Collaboration diagram for neuroml2::EventOut:

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

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

Detailed Description

Class corresponding to the EventOut schema type.

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

Constructor & Destructor Documentation

◆ EventOut() [1/2]

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

◆ EventOut() [2/2]

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

Member Function Documentation

◆ _clone()

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

◆ operator=()

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

◆ port() [1/4]

EventOut::port_type & neuroml2::EventOut::port ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ port() [2/4]

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

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

Returns
A constant reference to the attribute.

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

◆ port() [3/4]

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

◆ port() [4/4]

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


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