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

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

#include <NeuroML_v2.3.hxx>

+ Inheritance diagram for neuroml2::InitMembPotential:
+ Collaboration diagram for neuroml2::InitMembPotential:

value

Accessor and modifier functions for the value required attribute.

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

segmentGroup

Accessor and modifier functions for the segmentGroup optional attribute with a default value.

typedef ::neuroml2::NmlId segmentGroup_type
 Attribute type.
 
typedef ::xsd::cxx::tree::traits< segmentGroup_type, char > segmentGroup_traits
 Attribute traits type.
 
const segmentGroup_typesegmentGroup () const
 Return a read-only (constant) reference to the attribute. More...
 
segmentGroup_typesegmentGroup ()
 Return a read-write reference to the attribute. More...
 
void segmentGroup (const segmentGroup_type &x)
 Set the attribute value. More...
 
void segmentGroup (::std::unique_ptr< segmentGroup_type > p)
 Set the attribute value without copying. More...
 
static const segmentGroup_typesegmentGroup_default_value ()
 Return the default value for the attribute. More...
 

Constructors

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

Explicitly set initial membrane potential for the cell
:param value: :type value: voltage

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

Constructor & Destructor Documentation

◆ InitMembPotential() [1/2]

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

◆ InitMembPotential() [2/2]

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

Member Function Documentation

◆ _clone()

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

◆ operator=()

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

◆ segmentGroup() [1/4]

InitMembPotential::segmentGroup_type & neuroml2::InitMembPotential::segmentGroup ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ segmentGroup() [2/4]

const InitMembPotential::segmentGroup_type & neuroml2::InitMembPotential::segmentGroup ( ) const

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

Returns
A constant reference to the attribute.

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

◆ segmentGroup() [3/4]

void neuroml2::InitMembPotential::segmentGroup ( ::std::unique_ptr< segmentGroup_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 10900 of file NeuroML_v2.3.cxx.

◆ segmentGroup() [4/4]

void neuroml2::InitMembPotential::segmentGroup ( const segmentGroup_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 10894 of file NeuroML_v2.3.cxx.

◆ segmentGroup_default_value()

const InitMembPotential::segmentGroup_type & neuroml2::InitMembPotential::segmentGroup_default_value ( )
static

Return the default value for the attribute.

Returns
A read-only (constant) reference to the attribute's default value.

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

◆ value() [1/4]

InitMembPotential::value_type & neuroml2::InitMembPotential::value ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ value() [2/4]

const InitMembPotential::value_type & neuroml2::InitMembPotential::value ( ) const

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

Returns
A constant reference to the attribute.

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

◆ value() [3/4]

void neuroml2::InitMembPotential::value ( ::std::unique_ptr< value_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 10876 of file NeuroML_v2.3.cxx.

◆ value() [4/4]

void neuroml2::InitMembPotential::value ( const value_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 10870 of file NeuroML_v2.3.cxx.


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