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

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

#include <NeuroML_v2.3.hxx>

+ Inheritance diagram for neuroml2::InputW:
+ Collaboration diagram for neuroml2::InputW:

weight

Accessor and modifier functions for the weight required attribute.

typedef ::xml_schema::float_ weight_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< weight_type, char > weight_traits
 Attribute traits type.
 
const weight_typeweight () const
 Return a read-only (constant) reference to the attribute. More...
 
weight_typeweight ()
 Return a read-write reference to the attribute. More...
 
void weight (const weight_type &x)
 Set the attribute value. More...
 

Constructors

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

Additional Inherited Members

- Public Types inherited from neuroml2::Input
typedef ::neuroml2::Nml2PopulationReferencePath target_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< target_type, char > target_traits
 Attribute traits type.
 
typedef ::neuroml2::NmlId destination_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< destination_type, char > destination_traits
 Attribute traits type.
 
typedef ::neuroml2::NonNegativeInteger segmentId_type
 Attribute type.
 
typedef ::xsd::cxx::tree::optional< segmentId_typesegmentId_optional
 Attribute optional container type.
 
typedef ::xsd::cxx::tree::traits< segmentId_type, char > segmentId_traits
 Attribute traits type.
 
typedef ::neuroml2::ZeroToOne fractionAlong_type
 Attribute type.
 
typedef ::xsd::cxx::tree::optional< fractionAlong_typefractionAlong_optional
 Attribute optional container type.
 
typedef ::xsd::cxx::tree::traits< fractionAlong_type, char > fractionAlong_traits
 Attribute traits type.
 
- Public Types inherited from neuroml2::BaseNonNegativeIntegerId
typedef ::neuroml2::NonNegativeInteger id_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< id_type, char > id_traits
 Attribute traits type.
 
- Public Member Functions inherited from neuroml2::Input
const target_typetarget () const
 Return a read-only (constant) reference to the attribute. More...
 
target_typetarget ()
 Return a read-write reference to the attribute. More...
 
void target (const target_type &x)
 Set the attribute value. More...
 
void target (::std::unique_ptr< target_type > p)
 Set the attribute value without copying. More...
 
const destination_typedestination () const
 Return a read-only (constant) reference to the attribute. More...
 
destination_typedestination ()
 Return a read-write reference to the attribute. More...
 
void destination (const destination_type &x)
 Set the attribute value. More...
 
void destination (::std::unique_ptr< destination_type > p)
 Set the attribute value without copying. More...
 
const segmentId_optionalsegmentId () const
 Return a read-only (constant) reference to the attribute container. More...
 
segmentId_optionalsegmentId ()
 Return a read-write reference to the attribute container. More...
 
void segmentId (const segmentId_type &x)
 Set the attribute value. More...
 
void segmentId (const segmentId_optional &x)
 Set the attribute value. More...
 
void segmentId (::std::unique_ptr< segmentId_type > p)
 Set the attribute value without copying. More...
 
const fractionAlong_optionalfractionAlong () const
 Return a read-only (constant) reference to the attribute container. More...
 
fractionAlong_optionalfractionAlong ()
 Return a read-write reference to the attribute container. More...
 
void fractionAlong (const fractionAlong_type &x)
 Set the attribute value. More...
 
void fractionAlong (const fractionAlong_optional &x)
 Set the attribute value. More...
 
void fractionAlong (::std::unique_ptr< fractionAlong_type > p)
 Set the attribute value without copying. More...
 
 Input (const id_type &, const target_type &, const destination_type &)
 Create an instance from the ultimate base and initializers for required elements and attributes.
 
 Input (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Create an instance from a DOM element. More...
 
 Input (const Input &x, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Copy constructor. More...
 
Inputoperator= (const Input &x)
 Copy assignment operator. More...
 
virtual ~Input ()
 Destructor.
 
- Public Member Functions inherited from neuroml2::BaseNonNegativeIntegerId
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...
 
 BaseNonNegativeIntegerId (const id_type &)
 Create an instance from the ultimate base and initializers for required elements and attributes.
 
 BaseNonNegativeIntegerId (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Create an instance from a DOM element. More...
 
 BaseNonNegativeIntegerId (const BaseNonNegativeIntegerId &x, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Copy constructor. More...
 
BaseNonNegativeIntegerIdoperator= (const BaseNonNegativeIntegerId &x)
 Copy assignment operator. More...
 
virtual ~BaseNonNegativeIntegerId ()
 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 InputW schema type.

Specifies input lists. Can set weight to scale individual inputs.
:param weight: :type weight: none

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

Constructor & Destructor Documentation

◆ InputW() [1/2]

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

◆ InputW() [2/2]

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

Member Function Documentation

◆ _clone()

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

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

◆ operator=()

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

◆ weight() [1/3]

InputW::weight_type & neuroml2::InputW::weight ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ weight() [2/3]

const InputW::weight_type & neuroml2::InputW::weight ( ) const

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

Returns
A constant reference to the attribute.

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

◆ weight() [3/3]

void neuroml2::InputW::weight ( const weight_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 16545 of file NeuroML_v2.3.cxx.


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