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

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

#include <NeuroML_v2.3.hxx>

+ Inheritance diagram for neuroml2::GateFractional:
+ Collaboration diagram for neuroml2::GateFractional:

notes

Accessor and modifier functions for the notes optional element.

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

q10Settings

Accessor and modifier functions for the q10Settings optional element.

typedef ::neuroml2::Q10Settings q10Settings_type
 Element type.
 
typedef ::xsd::cxx::tree::optional< q10Settings_typeq10Settings_optional
 Element optional container type.
 
typedef ::xsd::cxx::tree::traits< q10Settings_type, char > q10Settings_traits
 Element traits type.
 
const q10Settings_optionalq10Settings () const
 Return a read-only (constant) reference to the element container. More...
 
q10Settings_optionalq10Settings ()
 Return a read-write reference to the element container. More...
 
void q10Settings (const q10Settings_type &x)
 Set the element value. More...
 
void q10Settings (const q10Settings_optional &x)
 Set the element value. More...
 
void q10Settings (::std::unique_ptr< q10Settings_type > p)
 Set the element value without copying. More...
 

subGate

Accessor and modifier functions for the subGate sequence element.

typedef ::neuroml2::GateFractionalSubgate subGate_type
 Element type.
 
typedef ::xsd::cxx::tree::sequence< subGate_typesubGate_sequence
 Element sequence container type.
 
typedef subGate_sequence::iterator subGate_iterator
 Element iterator type.
 
typedef subGate_sequence::const_iterator subGate_const_iterator
 Element constant iterator type.
 
typedef ::xsd::cxx::tree::traits< subGate_type, char > subGate_traits
 Element traits type.
 
const subGate_sequencesubGate () const
 Return a read-only (constant) reference to the element sequence. More...
 
subGate_sequencesubGate ()
 Return a read-write reference to the element sequence. More...
 
void subGate (const subGate_sequence &s)
 Copy elements from a given sequence. More...
 

instances

Accessor and modifier functions for the instances required attribute.

typedef ::neuroml2::PositiveInteger instances_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< instances_type, char > instances_traits
 Attribute traits type.
 
const instances_typeinstances () const
 Return a read-only (constant) reference to the attribute. More...
 
instances_typeinstances ()
 Return a read-write reference to the attribute. More...
 
void instances (const instances_type &x)
 Set the attribute value. More...
 
void instances (::std::unique_ptr< instances_type > p)
 Set the attribute value without copying. More...
 

Constructors

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

Gate composed of subgates contributing with fractional conductance
:param instances: :type instances: none

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

Constructor & Destructor Documentation

◆ GateFractional() [1/2]

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

◆ GateFractional() [2/2]

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

Member Function Documentation

◆ _clone()

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

◆ instances() [1/4]

GateFractional::instances_type & neuroml2::GateFractional::instances ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ instances() [2/4]

const GateFractional::instances_type & neuroml2::GateFractional::instances ( ) const

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

Returns
A constant reference to the attribute.

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

◆ instances() [3/4]

void neuroml2::GateFractional::instances ( ::std::unique_ptr< instances_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 5373 of file NeuroML_v2.3.cxx.

◆ instances() [4/4]

void neuroml2::GateFractional::instances ( const instances_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 5367 of file NeuroML_v2.3.cxx.

◆ notes() [1/5]

GateFractional::notes_optional & neuroml2::GateFractional::notes ( )

Return a read-write reference to the element container.

Returns
A reference to the optional container.

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

◆ notes() [2/5]

const GateFractional::notes_optional & neuroml2::GateFractional::notes ( ) const

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

Returns
A constant reference to the optional container.

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

◆ notes() [3/5]

void neuroml2::GateFractional::notes ( ::std::unique_ptr< notes_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 5301 of file NeuroML_v2.3.cxx.

◆ notes() [4/5]

void neuroml2::GateFractional::notes ( const notes_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 5295 of file NeuroML_v2.3.cxx.

◆ notes() [5/5]

void neuroml2::GateFractional::notes ( const notes_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 5289 of file NeuroML_v2.3.cxx.

◆ operator=()

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

◆ q10Settings() [1/5]

GateFractional::q10Settings_optional & neuroml2::GateFractional::q10Settings ( )

Return a read-write reference to the element container.

Returns
A reference to the optional container.

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

◆ q10Settings() [2/5]

const GateFractional::q10Settings_optional & neuroml2::GateFractional::q10Settings ( ) const

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

Returns
A constant reference to the optional container.

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

◆ q10Settings() [3/5]

void neuroml2::GateFractional::q10Settings ( ::std::unique_ptr< q10Settings_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 5331 of file NeuroML_v2.3.cxx.

◆ q10Settings() [4/5]

void neuroml2::GateFractional::q10Settings ( const q10Settings_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 5325 of file NeuroML_v2.3.cxx.

◆ q10Settings() [5/5]

void neuroml2::GateFractional::q10Settings ( const q10Settings_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 5319 of file NeuroML_v2.3.cxx.

◆ subGate() [1/3]

GateFractional::subGate_sequence & neuroml2::GateFractional::subGate ( )

Return a read-write reference to the element sequence.

Returns
A reference to the sequence container.

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

◆ subGate() [2/3]

const GateFractional::subGate_sequence & neuroml2::GateFractional::subGate ( ) const

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

Returns
A constant reference to the sequence container.

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

◆ subGate() [3/3]

void neuroml2::GateFractional::subGate ( const subGate_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 5349 of file NeuroML_v2.3.cxx.


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