mil::tatrc::physiology::datamodel::ElectricalCompartmentData Class Reference

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

#include <Compartment.hxx>

Inheritance diagram for mil::tatrc::physiology::datamodel::ElectricalCompartmentData:

Public Member Functions

virtual ~ElectricalCompartmentData ()
 Destructor. More...
 
- Public Member Functions inherited from mil::tatrc::physiology::datamodel::ObjectData
virtual ~ObjectData ()
 Destructor. More...
 
const contentVersion_optionalcontentVersion () const
 Return a read-only (constant) reference to the attribute container. More...
 
contentVersion_optionalcontentVersion ()
 Return a read-write reference to the attribute container. More...
 
void contentVersion (const contentVersion_type &x)
 Set the attribute value. More...
 
void contentVersion (const contentVersion_optional &x)
 Set the attribute value. More...
 
void contentVersion (::std::unique_ptr< contentVersion_type > p)
 Set the attribute value without copying. More...
 
 ObjectData ()
 Create an instance from the ultimate base and initializers for required elements and attributes. More...
 
 ObjectData (const ::xercesc::DOMElement &e,::xml_schema::flags f=0,::xml_schema::container *c=0)
 Create an instance from a DOM element. More...
 
 ObjectData (const ObjectData &x,::xml_schema::flags f=0,::xml_schema::container *c=0)
 Copy constructor. More...
 
ObjectDataoperator= (const ObjectData &x)
 Copy assignment operator. More...
 

CurrentIn

Accessor and modifier functions for the CurrentIn optional element.

typedef ::mil::tatrc::physiology::datamodel::ScalarElectricCurrentData CurrentIn_type
 Element type. More...
 
typedef ::xsd::cxx::tree::optional< CurrentIn_typeCurrentIn_optional
 Element optional container type. More...
 
typedef ::xsd::cxx::tree::traits< CurrentIn_type, char > CurrentIn_traits
 Element traits type. More...
 
const CurrentIn_optionalCurrentIn () const
 Return a read-only (constant) reference to the element container. More...
 
CurrentIn_optionalCurrentIn ()
 Return a read-write reference to the element container. More...
 
void CurrentIn (const CurrentIn_type &x)
 Set the element value. More...
 
void CurrentIn (const CurrentIn_optional &x)
 Set the element value. More...
 
void CurrentIn (::std::unique_ptr< CurrentIn_type > p)
 Set the element value without copying. More...
 

CurrentOut

Accessor and modifier functions for the CurrentOut optional element.

typedef ::mil::tatrc::physiology::datamodel::ScalarElectricCurrentData CurrentOut_type
 Element type. More...
 
typedef ::xsd::cxx::tree::optional< CurrentOut_typeCurrentOut_optional
 Element optional container type. More...
 
typedef ::xsd::cxx::tree::traits< CurrentOut_type, char > CurrentOut_traits
 Element traits type. More...
 
const CurrentOut_optionalCurrentOut () const
 Return a read-only (constant) reference to the element container. More...
 
CurrentOut_optionalCurrentOut ()
 Return a read-write reference to the element container. More...
 
void CurrentOut (const CurrentOut_type &x)
 Set the element value. More...
 
void CurrentOut (const CurrentOut_optional &x)
 Set the element value. More...
 
void CurrentOut (::std::unique_ptr< CurrentOut_type > p)
 Set the element value without copying. More...
 

Voltage

Accessor and modifier functions for the Voltage optional element.

typedef ::mil::tatrc::physiology::datamodel::ScalarElectricPotentialData Voltage_type
 Element type. More...
 
typedef ::xsd::cxx::tree::optional< Voltage_typeVoltage_optional
 Element optional container type. More...
 
typedef ::xsd::cxx::tree::traits< Voltage_type, char > Voltage_traits
 Element traits type. More...
 
const Voltage_optionalVoltage () const
 Return a read-only (constant) reference to the element container. More...
 
Voltage_optionalVoltage ()
 Return a read-write reference to the element container. More...
 
void Voltage (const Voltage_type &x)
 Set the element value. More...
 
void Voltage (const Voltage_optional &x)
 Set the element value. More...
 
void Voltage (::std::unique_ptr< Voltage_type > p)
 Set the element value without copying. More...
 

Charge

Accessor and modifier functions for the Charge optional element.

typedef ::mil::tatrc::physiology::datamodel::ScalarElectricChargeData Charge_type
 Element type. More...
 
typedef ::xsd::cxx::tree::optional< Charge_typeCharge_optional
 Element optional container type. More...
 
typedef ::xsd::cxx::tree::traits< Charge_type, char > Charge_traits
 Element traits type. More...
 
const Charge_optionalCharge () const
 Return a read-only (constant) reference to the element container. More...
 
Charge_optionalCharge ()
 Return a read-write reference to the element container. More...
 
void Charge (const Charge_type &x)
 Set the element value. More...
 
void Charge (const Charge_optional &x)
 Set the element value. More...
 
void Charge (::std::unique_ptr< Charge_type > p)
 Set the element value without copying. More...
 

Constructors

 ElectricalCompartmentData ()
 Create an instance from the ultimate base and initializers for required elements and attributes. More...
 
 ElectricalCompartmentData (const ::xercesc::DOMElement &e,::xml_schema::flags f=0,::xml_schema::container *c=0)
 Create an instance from a DOM element. More...
 
 ElectricalCompartmentData (const ElectricalCompartmentData &x,::xml_schema::flags f=0,::xml_schema::container *c=0)
 Copy constructor. More...
 
virtual ElectricalCompartmentData_clone (::xml_schema::flags f=0,::xml_schema::container *c=0) const
 Copy the instance polymorphically. More...
 
ElectricalCompartmentDataoperator= (const ElectricalCompartmentData &x)
 Copy assignment operator. More...
 

Additional Inherited Members

- Public Types inherited from mil::tatrc::physiology::datamodel::ObjectData
typedef ::xml_schema::string contentVersion_type
 Attribute type. More...
 
typedef ::xsd::cxx::tree::optional< contentVersion_typecontentVersion_optional
 Attribute optional container type. More...
 
typedef ::xsd::cxx::tree::traits< contentVersion_type, char > contentVersion_traits
 Attribute traits type. More...
 

Detailed Description

Class corresponding to the ElectricalCompartmentData schema type.

Member Typedef Documentation

Element optional container type.

Element traits type.

Element optional container type.

Element traits type.

Element optional container type.

Element traits type.

Element optional container type.

Element traits type.

Constructor & Destructor Documentation

mil::tatrc::physiology::datamodel::ElectricalCompartmentData::ElectricalCompartmentData ( )

Create an instance from the ultimate base and initializers for required elements and attributes.

mil::tatrc::physiology::datamodel::ElectricalCompartmentData::ElectricalCompartmentData ( 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.
mil::tatrc::physiology::datamodel::ElectricalCompartmentData::ElectricalCompartmentData ( const ElectricalCompartmentData 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.

mil::tatrc::physiology::datamodel::ElectricalCompartmentData::~ElectricalCompartmentData ( )
virtual

Destructor.

Member Function Documentation

ElectricalCompartmentData * mil::tatrc::physiology::datamodel::ElectricalCompartmentData::_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 mil::tatrc::physiology::datamodel::ObjectData.

const ElectricalCompartmentData::Charge_optional & mil::tatrc::physiology::datamodel::ElectricalCompartmentData::Charge ( ) const

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

Returns
A constant reference to the optional container.
ElectricalCompartmentData::Charge_optional & mil::tatrc::physiology::datamodel::ElectricalCompartmentData::Charge ( )

Return a read-write reference to the element container.

Returns
A reference to the optional container.
void mil::tatrc::physiology::datamodel::ElectricalCompartmentData::Charge ( const Charge_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.

void mil::tatrc::physiology::datamodel::ElectricalCompartmentData::Charge ( const Charge_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.

void mil::tatrc::physiology::datamodel::ElectricalCompartmentData::Charge ( ::std::unique_ptr< Charge_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.

const ElectricalCompartmentData::CurrentIn_optional & mil::tatrc::physiology::datamodel::ElectricalCompartmentData::CurrentIn ( ) const

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

Returns
A constant reference to the optional container.
ElectricalCompartmentData::CurrentIn_optional & mil::tatrc::physiology::datamodel::ElectricalCompartmentData::CurrentIn ( )

Return a read-write reference to the element container.

Returns
A reference to the optional container.
void mil::tatrc::physiology::datamodel::ElectricalCompartmentData::CurrentIn ( const CurrentIn_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.

void mil::tatrc::physiology::datamodel::ElectricalCompartmentData::CurrentIn ( const CurrentIn_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.

void mil::tatrc::physiology::datamodel::ElectricalCompartmentData::CurrentIn ( ::std::unique_ptr< CurrentIn_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.

const ElectricalCompartmentData::CurrentOut_optional & mil::tatrc::physiology::datamodel::ElectricalCompartmentData::CurrentOut ( ) const

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

Returns
A constant reference to the optional container.
ElectricalCompartmentData::CurrentOut_optional & mil::tatrc::physiology::datamodel::ElectricalCompartmentData::CurrentOut ( )

Return a read-write reference to the element container.

Returns
A reference to the optional container.
void mil::tatrc::physiology::datamodel::ElectricalCompartmentData::CurrentOut ( const CurrentOut_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.

void mil::tatrc::physiology::datamodel::ElectricalCompartmentData::CurrentOut ( const CurrentOut_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.

void mil::tatrc::physiology::datamodel::ElectricalCompartmentData::CurrentOut ( ::std::unique_ptr< CurrentOut_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.

ElectricalCompartmentData & mil::tatrc::physiology::datamodel::ElectricalCompartmentData::operator= ( const ElectricalCompartmentData 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.

const ElectricalCompartmentData::Voltage_optional & mil::tatrc::physiology::datamodel::ElectricalCompartmentData::Voltage ( ) const

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

Returns
A constant reference to the optional container.
ElectricalCompartmentData::Voltage_optional & mil::tatrc::physiology::datamodel::ElectricalCompartmentData::Voltage ( )

Return a read-write reference to the element container.

Returns
A reference to the optional container.
void mil::tatrc::physiology::datamodel::ElectricalCompartmentData::Voltage ( const Voltage_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.

void mil::tatrc::physiology::datamodel::ElectricalCompartmentData::Voltage ( const Voltage_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.

void mil::tatrc::physiology::datamodel::ElectricalCompartmentData::Voltage ( ::std::unique_ptr< Voltage_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.