mil::tatrc::physiology::datamodel::ScalarData Class Reference

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

#include <Properties.hxx>

Inherits mil::tatrc::physiology::datamodel::PropertyData.

Inherited by mil::tatrc::physiology::datamodel::Scalar0To1Data, mil::tatrc::physiology::datamodel::ScalarAmountData, mil::tatrc::physiology::datamodel::ScalarAmountPerMassData, mil::tatrc::physiology::datamodel::ScalarAmountPerTimeData, mil::tatrc::physiology::datamodel::ScalarAmountPerVolumeData, mil::tatrc::physiology::datamodel::ScalarAreaData, mil::tatrc::physiology::datamodel::ScalarAreaPerTimePressureData, mil::tatrc::physiology::datamodel::ScalarElectricCapacitanceData, mil::tatrc::physiology::datamodel::ScalarElectricChargeData, mil::tatrc::physiology::datamodel::ScalarElectricCurrentData, mil::tatrc::physiology::datamodel::ScalarElectricInductanceData, mil::tatrc::physiology::datamodel::ScalarElectricPotentialData, mil::tatrc::physiology::datamodel::ScalarElectricResistanceData, mil::tatrc::physiology::datamodel::ScalarEnergyData, mil::tatrc::physiology::datamodel::ScalarEnergyPerAmountData, mil::tatrc::physiology::datamodel::ScalarEnergyPerMassData, mil::tatrc::physiology::datamodel::ScalarFlowComplianceData, mil::tatrc::physiology::datamodel::ScalarFlowElastanceData, mil::tatrc::physiology::datamodel::ScalarFlowInertanceData, mil::tatrc::physiology::datamodel::ScalarFlowResistanceData, mil::tatrc::physiology::datamodel::ScalarForceData, mil::tatrc::physiology::datamodel::ScalarFractionData, mil::tatrc::physiology::datamodel::ScalarFrequencyData, mil::tatrc::physiology::datamodel::ScalarHeatCapacitanceData, mil::tatrc::physiology::datamodel::ScalarHeatCapacitancePerAmountData, mil::tatrc::physiology::datamodel::ScalarHeatCapacitancePerMassData, mil::tatrc::physiology::datamodel::ScalarHeatConductanceData, mil::tatrc::physiology::datamodel::ScalarHeatConductancePerAreaData, mil::tatrc::physiology::datamodel::ScalarHeatInductanceData, mil::tatrc::physiology::datamodel::ScalarHeatResistanceAreaData, mil::tatrc::physiology::datamodel::ScalarHeatResistanceData, mil::tatrc::physiology::datamodel::ScalarInversePressureData, mil::tatrc::physiology::datamodel::ScalarInverseVolumeData, mil::tatrc::physiology::datamodel::ScalarLengthData, mil::tatrc::physiology::datamodel::ScalarLengthPerTimeData, mil::tatrc::physiology::datamodel::ScalarLengthPerTimePressureData, mil::tatrc::physiology::datamodel::ScalarMassData, mil::tatrc::physiology::datamodel::ScalarMassPerAmountData, mil::tatrc::physiology::datamodel::ScalarMassPerAreaTimeData, mil::tatrc::physiology::datamodel::ScalarMassPerMassData, mil::tatrc::physiology::datamodel::ScalarMassPerTimeData, mil::tatrc::physiology::datamodel::ScalarMassPerVolumeData, mil::tatrc::physiology::datamodel::ScalarNeg1To1Data, mil::tatrc::physiology::datamodel::ScalarOsmolalityData, mil::tatrc::physiology::datamodel::ScalarOsmolarityData, mil::tatrc::physiology::datamodel::ScalarPowerData, mil::tatrc::physiology::datamodel::ScalarPowerPerAreaTemperatureToTheFourthData, mil::tatrc::physiology::datamodel::ScalarPressureData, mil::tatrc::physiology::datamodel::ScalarPressurePerVolumeData, mil::tatrc::physiology::datamodel::ScalarPressureTimePerAreaData, mil::tatrc::physiology::datamodel::ScalarPressureTimePerVolumeAreaData, mil::tatrc::physiology::datamodel::ScalarTemperatureData, mil::tatrc::physiology::datamodel::ScalarTimeData, mil::tatrc::physiology::datamodel::ScalarTimeMassPerVolumeData, mil::tatrc::physiology::datamodel::ScalarVolumeData, mil::tatrc::physiology::datamodel::ScalarVolumePerPressureData, mil::tatrc::physiology::datamodel::ScalarVolumePerTimeAreaData, mil::tatrc::physiology::datamodel::ScalarVolumePerTimeData, mil::tatrc::physiology::datamodel::ScalarVolumePerTimeMassData, mil::tatrc::physiology::datamodel::ScalarVolumePerTimePressureAreaData, and mil::tatrc::physiology::datamodel::ScalarVolumePerTimePressureData.

Public Member Functions

virtual ~ScalarData ()
 Destructor. More...
 
- Public Member Functions inherited from mil::tatrc::physiology::datamodel::PropertyData
virtual ~PropertyData ()
 Destructor. More...
 
 PropertyData ()
 Create an instance from the ultimate base and initializers for required elements and attributes. More...
 
 PropertyData (const ::xercesc::DOMElement &e,::xml_schema::flags f=0,::xml_schema::container *c=0)
 Create an instance from a DOM element. More...
 
 PropertyData (const ::xercesc::DOMAttr &a,::xml_schema::flags f=0,::xml_schema::container *c=0)
 Create an instance from a DOM attribute. More...
 
 PropertyData (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...
 
 PropertyData (const PropertyData &x,::xml_schema::flags f=0,::xml_schema::container *c=0)
 Copy constructor. More...
 

value

Accessor and modifier functions for the value required attribute.

typedef ::xml_schema::double_ value_type
 Attribute type. More...
 
typedef ::xsd::cxx::tree::traits< value_type, char,::xsd::cxx::tree::schema_type::double_ > value_traits
 Attribute traits type. More...
 
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...
 

unit

Accessor and modifier functions for the unit optional attribute.

typedef ::xml_schema::string unit_type
 Attribute type. More...
 
typedef ::xsd::cxx::tree::optional< unit_typeunit_optional
 Attribute optional container type. More...
 
typedef ::xsd::cxx::tree::traits< unit_type, char > unit_traits
 Attribute traits type. More...
 
const unit_optionalunit () const
 Return a read-only (constant) reference to the attribute container. More...
 
unit_optionalunit ()
 Return a read-write reference to the attribute container. More...
 
void unit (const unit_type &x)
 Set the attribute value. More...
 
void unit (const unit_optional &x)
 Set the attribute value. More...
 
void unit (::std::unique_ptr< unit_type > p)
 Set the attribute value without copying. More...
 

readOnly

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

typedef ::xml_schema::boolean readOnly_type
 Attribute type. More...
 
typedef ::xsd::cxx::tree::traits< readOnly_type, char > readOnly_traits
 Attribute traits type. More...
 
const readOnly_typereadOnly () const
 Return a read-only (constant) reference to the attribute. More...
 
readOnly_typereadOnly ()
 Return a read-write reference to the attribute. More...
 
void readOnly (const readOnly_type &x)
 Set the attribute value. More...
 
static readOnly_type readOnly_default_value ()
 Return the default value for the attribute. More...
 

Constructors

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

Detailed Description

Class corresponding to the ScalarData schema type.

Member Typedef Documentation

Attribute traits type.

Attribute optional container type.

typedef ::xsd::cxx::tree::traits< unit_type, char > mil::tatrc::physiology::datamodel::ScalarData::unit_traits

Attribute traits type.

typedef ::xsd::cxx::tree::traits< value_type, char, ::xsd::cxx::tree::schema_type::double_ > mil::tatrc::physiology::datamodel::ScalarData::value_traits

Attribute traits type.

Constructor & Destructor Documentation

mil::tatrc::physiology::datamodel::ScalarData::ScalarData ( )

Default constructor.

Note that this constructor leaves required elements and attributes uninitialized.

mil::tatrc::physiology::datamodel::ScalarData::ScalarData ( const value_type value)

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

mil::tatrc::physiology::datamodel::ScalarData::ScalarData ( 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::ScalarData::ScalarData ( const ScalarData 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::ScalarData::~ScalarData ( )
virtual

Destructor.

Member Function Documentation

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

Reimplemented in mil::tatrc::physiology::datamodel::ScalarVolumePerTimePressureAreaData, mil::tatrc::physiology::datamodel::ScalarVolumePerTimePressureData, mil::tatrc::physiology::datamodel::ScalarVolumePerTimeMassData, mil::tatrc::physiology::datamodel::ScalarVolumePerTimeAreaData, mil::tatrc::physiology::datamodel::ScalarVolumePerPressureData, mil::tatrc::physiology::datamodel::ScalarVolumePerTimeData, mil::tatrc::physiology::datamodel::ScalarVolumeData, mil::tatrc::physiology::datamodel::ScalarTemperatureData, mil::tatrc::physiology::datamodel::ScalarTimeData, mil::tatrc::physiology::datamodel::ScalarPressureTimePerAreaData, mil::tatrc::physiology::datamodel::ScalarPressureTimePerVolumeAreaData, mil::tatrc::physiology::datamodel::ScalarPressurePerVolumeData, mil::tatrc::physiology::datamodel::ScalarPressureData, mil::tatrc::physiology::datamodel::ScalarPowerPerAreaTemperatureToTheFourthData, mil::tatrc::physiology::datamodel::ScalarPowerData, mil::tatrc::physiology::datamodel::ScalarOsmolarityData, mil::tatrc::physiology::datamodel::ScalarOsmolalityData, mil::tatrc::physiology::datamodel::ScalarTimeMassPerVolumeData, mil::tatrc::physiology::datamodel::ScalarMassPerVolumeData, mil::tatrc::physiology::datamodel::ScalarMassPerTimeData, mil::tatrc::physiology::datamodel::ScalarMassPerMassData, mil::tatrc::physiology::datamodel::ScalarMassPerAreaTimeData, mil::tatrc::physiology::datamodel::ScalarMassPerAmountData, mil::tatrc::physiology::datamodel::ScalarMassData, mil::tatrc::physiology::datamodel::ScalarLengthPerTimePressureData, mil::tatrc::physiology::datamodel::ScalarLengthPerTimeData, mil::tatrc::physiology::datamodel::ScalarLengthData, mil::tatrc::physiology::datamodel::ScalarInverseVolumeData, mil::tatrc::physiology::datamodel::ScalarInversePressureData, mil::tatrc::physiology::datamodel::ScalarHeatResistanceAreaData, mil::tatrc::physiology::datamodel::ScalarHeatResistanceData, mil::tatrc::physiology::datamodel::ScalarHeatInductanceData, mil::tatrc::physiology::datamodel::ScalarHeatConductancePerAreaData, mil::tatrc::physiology::datamodel::ScalarHeatConductanceData, mil::tatrc::physiology::datamodel::ScalarHeatCapacitancePerMassData, mil::tatrc::physiology::datamodel::ScalarHeatCapacitancePerAmountData, mil::tatrc::physiology::datamodel::ScalarHeatCapacitanceData, mil::tatrc::physiology::datamodel::ScalarFrequencyData, mil::tatrc::physiology::datamodel::ScalarForceData, mil::tatrc::physiology::datamodel::ScalarFlowInertanceData, mil::tatrc::physiology::datamodel::ScalarFlowElastanceData, mil::tatrc::physiology::datamodel::ScalarFlowComplianceData, mil::tatrc::physiology::datamodel::ScalarFlowResistanceData, mil::tatrc::physiology::datamodel::ScalarEnergyPerMassData, mil::tatrc::physiology::datamodel::ScalarEnergyPerAmountData, mil::tatrc::physiology::datamodel::ScalarEnergyData, mil::tatrc::physiology::datamodel::ScalarElectricResistanceData, mil::tatrc::physiology::datamodel::ScalarElectricInductanceData, mil::tatrc::physiology::datamodel::ScalarElectricPotentialData, mil::tatrc::physiology::datamodel::ScalarElectricCurrentData, mil::tatrc::physiology::datamodel::ScalarElectricChargeData, mil::tatrc::physiology::datamodel::ScalarElectricCapacitanceData, mil::tatrc::physiology::datamodel::ScalarAreaPerTimePressureData, mil::tatrc::physiology::datamodel::ScalarAreaData, mil::tatrc::physiology::datamodel::ScalarAmountPerVolumeData, mil::tatrc::physiology::datamodel::ScalarAmountPerTimeData, mil::tatrc::physiology::datamodel::ScalarAmountPerMassData, mil::tatrc::physiology::datamodel::ScalarAmountData, mil::tatrc::physiology::datamodel::ScalarNeg1To1Data, mil::tatrc::physiology::datamodel::Scalar0To1Data, and mil::tatrc::physiology::datamodel::ScalarFractionData.

ScalarData & mil::tatrc::physiology::datamodel::ScalarData::operator= ( const ScalarData 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 ScalarData::readOnly_type & mil::tatrc::physiology::datamodel::ScalarData::readOnly ( ) const

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

Returns
A constant reference to the attribute.
ScalarData::readOnly_type & mil::tatrc::physiology::datamodel::ScalarData::readOnly ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.
void mil::tatrc::physiology::datamodel::ScalarData::readOnly ( const readOnly_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.

ScalarData::readOnly_type mil::tatrc::physiology::datamodel::ScalarData::readOnly_default_value ( )
static

Return the default value for the attribute.

Returns
The attribute's default value.
const ScalarData::unit_optional & mil::tatrc::physiology::datamodel::ScalarData::unit ( ) const

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

Returns
A constant reference to the optional container.
ScalarData::unit_optional & mil::tatrc::physiology::datamodel::ScalarData::unit ( )

Return a read-write reference to the attribute container.

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

void mil::tatrc::physiology::datamodel::ScalarData::unit ( const unit_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.

void mil::tatrc::physiology::datamodel::ScalarData::unit ( ::std::unique_ptr< unit_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.

const ScalarData::value_type & mil::tatrc::physiology::datamodel::ScalarData::value ( ) const

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

Returns
A constant reference to the attribute.
ScalarData::value_type & mil::tatrc::physiology::datamodel::ScalarData::value ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.
void mil::tatrc::physiology::datamodel::ScalarData::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.