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

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

#include <NeuroML_v2.3.hxx>

+ Inheritance diagram for neuroml2::HHTime:
+ Collaboration diagram for neuroml2::HHTime:

type

Accessor and modifier functions for the type required attribute.

typedef ::neuroml2::NmlId 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...
 

rate

Accessor and modifier functions for the rate optional attribute.

typedef ::neuroml2::Nml2Quantity_time rate_type
 Attribute type.
 
typedef ::xsd::cxx::tree::optional< rate_typerate_optional
 Attribute optional container type.
 
typedef ::xsd::cxx::tree::traits< rate_type, char > rate_traits
 Attribute traits type.
 
const rate_optionalrate () const
 Return a read-only (constant) reference to the attribute container. More...
 
rate_optionalrate ()
 Return a read-write reference to the attribute container. More...
 
void rate (const rate_type &x)
 Set the attribute value. More...
 
void rate (const rate_optional &x)
 Set the attribute value. More...
 
void rate (::std::unique_ptr< rate_type > p)
 Set the attribute value without copying. More...
 

midpoint

Accessor and modifier functions for the midpoint optional attribute.

typedef ::neuroml2::Nml2Quantity_voltage midpoint_type
 Attribute type.
 
typedef ::xsd::cxx::tree::optional< midpoint_typemidpoint_optional
 Attribute optional container type.
 
typedef ::xsd::cxx::tree::traits< midpoint_type, char > midpoint_traits
 Attribute traits type.
 
const midpoint_optionalmidpoint () const
 Return a read-only (constant) reference to the attribute container. More...
 
midpoint_optionalmidpoint ()
 Return a read-write reference to the attribute container. More...
 
void midpoint (const midpoint_type &x)
 Set the attribute value. More...
 
void midpoint (const midpoint_optional &x)
 Set the attribute value. More...
 
void midpoint (::std::unique_ptr< midpoint_type > p)
 Set the attribute value without copying. More...
 

scale

Accessor and modifier functions for the scale optional attribute.

typedef ::neuroml2::Nml2Quantity_voltage scale_type
 Attribute type.
 
typedef ::xsd::cxx::tree::optional< scale_typescale_optional
 Attribute optional container type.
 
typedef ::xsd::cxx::tree::traits< scale_type, char > scale_traits
 Attribute traits type.
 
const scale_optionalscale () const
 Return a read-only (constant) reference to the attribute container. More...
 
scale_optionalscale ()
 Return a read-write reference to the attribute container. More...
 
void scale (const scale_type &x)
 Set the attribute value. More...
 
void scale (const scale_optional &x)
 Set the attribute value. More...
 
void scale (::std::unique_ptr< scale_type > p)
 Set the attribute value without copying. More...
 

tau

Accessor and modifier functions for the tau optional attribute.

typedef ::neuroml2::Nml2Quantity_time tau_type
 Attribute type.
 
typedef ::xsd::cxx::tree::optional< tau_typetau_optional
 Attribute optional container type.
 
typedef ::xsd::cxx::tree::traits< tau_type, char > tau_traits
 Attribute traits type.
 
const tau_optionaltau () const
 Return a read-only (constant) reference to the attribute container. More...
 
tau_optionaltau ()
 Return a read-write reference to the attribute container. More...
 
void tau (const tau_type &x)
 Set the attribute value. More...
 
void tau (const tau_optional &x)
 Set the attribute value. More...
 
void tau (::std::unique_ptr< tau_type > p)
 Set the attribute value without copying. More...
 

Constructors

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

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

Constructor & Destructor Documentation

◆ HHTime() [1/2]

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

◆ HHTime() [2/2]

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

Member Function Documentation

◆ _clone()

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

◆ midpoint() [1/5]

HHTime::midpoint_optional & neuroml2::HHTime::midpoint ( )

Return a read-write reference to the attribute container.

Returns
A reference to the optional container.

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

◆ midpoint() [2/5]

const HHTime::midpoint_optional & neuroml2::HHTime::midpoint ( ) const

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

Returns
A constant reference to the optional container.

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

◆ midpoint() [3/5]

void neuroml2::HHTime::midpoint ( ::std::unique_ptr< midpoint_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 5945 of file NeuroML_v2.3.cxx.

◆ midpoint() [4/5]

void neuroml2::HHTime::midpoint ( const midpoint_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 5939 of file NeuroML_v2.3.cxx.

◆ midpoint() [5/5]

void neuroml2::HHTime::midpoint ( const midpoint_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 5933 of file NeuroML_v2.3.cxx.

◆ operator=()

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

◆ rate() [1/5]

HHTime::rate_optional & neuroml2::HHTime::rate ( )

Return a read-write reference to the attribute container.

Returns
A reference to the optional container.

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

◆ rate() [2/5]

const HHTime::rate_optional & neuroml2::HHTime::rate ( ) const

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

Returns
A constant reference to the optional container.

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

◆ rate() [3/5]

void neuroml2::HHTime::rate ( ::std::unique_ptr< rate_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 5915 of file NeuroML_v2.3.cxx.

◆ rate() [4/5]

void neuroml2::HHTime::rate ( const rate_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 5909 of file NeuroML_v2.3.cxx.

◆ rate() [5/5]

void neuroml2::HHTime::rate ( const rate_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 5903 of file NeuroML_v2.3.cxx.

◆ scale() [1/5]

HHTime::scale_optional & neuroml2::HHTime::scale ( )

Return a read-write reference to the attribute container.

Returns
A reference to the optional container.

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

◆ scale() [2/5]

const HHTime::scale_optional & neuroml2::HHTime::scale ( ) const

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

Returns
A constant reference to the optional container.

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

◆ scale() [3/5]

void neuroml2::HHTime::scale ( ::std::unique_ptr< scale_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 5975 of file NeuroML_v2.3.cxx.

◆ scale() [4/5]

void neuroml2::HHTime::scale ( const scale_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 5969 of file NeuroML_v2.3.cxx.

◆ scale() [5/5]

void neuroml2::HHTime::scale ( const scale_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 5963 of file NeuroML_v2.3.cxx.

◆ tau() [1/5]

HHTime::tau_optional & neuroml2::HHTime::tau ( )

Return a read-write reference to the attribute container.

Returns
A reference to the optional container.

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

◆ tau() [2/5]

const HHTime::tau_optional & neuroml2::HHTime::tau ( ) const

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

Returns
A constant reference to the optional container.

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

◆ tau() [3/5]

void neuroml2::HHTime::tau ( ::std::unique_ptr< tau_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 6005 of file NeuroML_v2.3.cxx.

◆ tau() [4/5]

void neuroml2::HHTime::tau ( const tau_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 5999 of file NeuroML_v2.3.cxx.

◆ tau() [5/5]

void neuroml2::HHTime::tau ( const tau_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 5993 of file NeuroML_v2.3.cxx.

◆ type() [1/4]

HHTime::type_type & neuroml2::HHTime::type ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.

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

◆ type() [2/4]

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

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

Returns
A constant reference to the attribute.

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

◆ type() [3/4]

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

◆ type() [4/4]

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


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