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

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

#include <NeuroML_v2.3.hxx>

+ Inheritance diagram for neuroml2::PlasticityMechanism:
+ Collaboration diagram for neuroml2::PlasticityMechanism:

type

Accessor and modifier functions for the type required attribute.

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

initReleaseProb

Accessor and modifier functions for the initReleaseProb required attribute.

typedef ::neuroml2::ZeroToOne initReleaseProb_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< initReleaseProb_type, char > initReleaseProb_traits
 Attribute traits type.
 
const initReleaseProb_typeinitReleaseProb () const
 Return a read-only (constant) reference to the attribute. More...
 
initReleaseProb_typeinitReleaseProb ()
 Return a read-write reference to the attribute. More...
 
void initReleaseProb (const initReleaseProb_type &x)
 Set the attribute value. More...
 
void initReleaseProb (::std::unique_ptr< initReleaseProb_type > p)
 Set the attribute value without copying. More...
 

tauRec

Accessor and modifier functions for the tauRec required attribute.

typedef ::neuroml2::Nml2Quantity_time tauRec_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< tauRec_type, char > tauRec_traits
 Attribute traits type.
 
const tauRec_typetauRec () const
 Return a read-only (constant) reference to the attribute. More...
 
tauRec_typetauRec ()
 Return a read-write reference to the attribute. More...
 
void tauRec (const tauRec_type &x)
 Set the attribute value. More...
 
void tauRec (::std::unique_ptr< tauRec_type > p)
 Set the attribute value without copying. More...
 

tauFac

Accessor and modifier functions for the tauFac optional attribute.

typedef ::neuroml2::Nml2Quantity_time tauFac_type
 Attribute type.
 
typedef ::xsd::cxx::tree::optional< tauFac_typetauFac_optional
 Attribute optional container type.
 
typedef ::xsd::cxx::tree::traits< tauFac_type, char > tauFac_traits
 Attribute traits type.
 
const tauFac_optionaltauFac () const
 Return a read-only (constant) reference to the attribute container. More...
 
tauFac_optionaltauFac ()
 Return a read-write reference to the attribute container. More...
 
void tauFac (const tauFac_type &x)
 Set the attribute value. More...
 
void tauFac (const tauFac_optional &x)
 Set the attribute value. More...
 
void tauFac (::std::unique_ptr< tauFac_type > p)
 Set the attribute value without copying. More...
 

Constructors

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

Additional Inherited Members

- 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 PlasticityMechanism schema type.

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

Constructor & Destructor Documentation

◆ PlasticityMechanism() [1/2]

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

◆ PlasticityMechanism() [2/2]

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

Member Function Documentation

◆ _clone()

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

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

◆ initReleaseProb() [1/4]

PlasticityMechanism::initReleaseProb_type & neuroml2::PlasticityMechanism::initReleaseProb ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ initReleaseProb() [2/4]

const PlasticityMechanism::initReleaseProb_type & neuroml2::PlasticityMechanism::initReleaseProb ( ) const

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

Returns
A constant reference to the attribute.

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

◆ initReleaseProb() [3/4]

void neuroml2::PlasticityMechanism::initReleaseProb ( ::std::unique_ptr< initReleaseProb_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 7225 of file NeuroML_v2.3.cxx.

◆ initReleaseProb() [4/4]

void neuroml2::PlasticityMechanism::initReleaseProb ( const initReleaseProb_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 7219 of file NeuroML_v2.3.cxx.

◆ operator=()

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

◆ tauFac() [1/5]

PlasticityMechanism::tauFac_optional & neuroml2::PlasticityMechanism::tauFac ( )

Return a read-write reference to the attribute container.

Returns
A reference to the optional container.

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

◆ tauFac() [2/5]

const PlasticityMechanism::tauFac_optional & neuroml2::PlasticityMechanism::tauFac ( ) const

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

Returns
A constant reference to the optional container.

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

◆ tauFac() [3/5]

void neuroml2::PlasticityMechanism::tauFac ( ::std::unique_ptr< tauFac_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 7279 of file NeuroML_v2.3.cxx.

◆ tauFac() [4/5]

void neuroml2::PlasticityMechanism::tauFac ( const tauFac_optional x)

Set the attribute 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 attribute. Otherwise the attribute container is set the 'not present' state.

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

◆ tauFac() [5/5]

void neuroml2::PlasticityMechanism::tauFac ( const tauFac_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 7267 of file NeuroML_v2.3.cxx.

◆ tauRec() [1/4]

PlasticityMechanism::tauRec_type & neuroml2::PlasticityMechanism::tauRec ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ tauRec() [2/4]

const PlasticityMechanism::tauRec_type & neuroml2::PlasticityMechanism::tauRec ( ) const

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

Returns
A constant reference to the attribute.

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

◆ tauRec() [3/4]

void neuroml2::PlasticityMechanism::tauRec ( ::std::unique_ptr< tauRec_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 7249 of file NeuroML_v2.3.cxx.

◆ tauRec() [4/4]

void neuroml2::PlasticityMechanism::tauRec ( const tauRec_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 7243 of file NeuroML_v2.3.cxx.

◆ type() [1/4]

PlasticityMechanism::type_type & neuroml2::PlasticityMechanism::type ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ type() [2/4]

const PlasticityMechanism::type_type & neuroml2::PlasticityMechanism::type ( ) const

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

Returns
A constant reference to the attribute.

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

◆ type() [3/4]

void neuroml2::PlasticityMechanism::type ( ::std::unique_ptr< type_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 7201 of file NeuroML_v2.3.cxx.

◆ type() [4/4]

void neuroml2::PlasticityMechanism::type ( const type_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 7195 of file NeuroML_v2.3.cxx.


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