mil::tatrc::physiology::datamodel::FluidCompartmentData Class Reference

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

#include <Compartment.hxx>

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

Public Member Functions

virtual ~FluidCompartmentData ()
 Destructor. More...
 
- Public Member Functions inherited from mil::tatrc::physiology::datamodel::CompartmentData
virtual ~CompartmentData ()
 Destructor. More...
 
const Name_typeName () const
 Return a read-only (constant) reference to the element. More...
 
Name_typeName ()
 Return a read-write reference to the element. More...
 
void Name (const Name_type &x)
 Set the element value. More...
 
void Name (::std::unique_ptr< Name_type > p)
 Set the element value without copying. More...
 
const Node_sequenceNode () const
 Return a read-only (constant) reference to the element sequence. More...
 
Node_sequenceNode ()
 Return a read-write reference to the element sequence. More...
 
void Node (const Node_sequence &s)
 Copy elements from a given sequence. More...
 
const Child_sequenceChild () const
 Return a read-only (constant) reference to the element sequence. More...
 
Child_sequenceChild ()
 Return a read-write reference to the element sequence. More...
 
void Child (const Child_sequence &s)
 Copy elements from a given sequence. More...
 
 CompartmentData ()
 Default constructor. More...
 
 CompartmentData (const Name_type &)
 Create an instance from the ultimate base and initializers for required elements and attributes. More...
 
 CompartmentData (::std::unique_ptr< Name_type >)
 Create an instance from the ultimate base and initializers for required elements and attributes (::std::unique_ptr version). More...
 
 CompartmentData (const ::xercesc::DOMElement &e,::xml_schema::flags f=0,::xml_schema::container *c=0)
 Create an instance from a DOM element. More...
 
 CompartmentData (const CompartmentData &x,::xml_schema::flags f=0,::xml_schema::container *c=0)
 Copy constructor. More...
 
CompartmentDataoperator= (const CompartmentData &x)
 Copy assignment operator. 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...
 

InFlow

Accessor and modifier functions for the InFlow optional element.

typedef ::mil::tatrc::physiology::datamodel::ScalarVolumePerTimeData InFlow_type
 Element type. More...
 
typedef ::xsd::cxx::tree::optional< InFlow_typeInFlow_optional
 Element optional container type. More...
 
typedef ::xsd::cxx::tree::traits< InFlow_type, char > InFlow_traits
 Element traits type. More...
 
const InFlow_optionalInFlow () const
 Return a read-only (constant) reference to the element container. More...
 
InFlow_optionalInFlow ()
 Return a read-write reference to the element container. More...
 
void InFlow (const InFlow_type &x)
 Set the element value. More...
 
void InFlow (const InFlow_optional &x)
 Set the element value. More...
 
void InFlow (::std::unique_ptr< InFlow_type > p)
 Set the element value without copying. More...
 

OutFlow

Accessor and modifier functions for the OutFlow optional element.

typedef ::mil::tatrc::physiology::datamodel::ScalarVolumePerTimeData OutFlow_type
 Element type. More...
 
typedef ::xsd::cxx::tree::optional< OutFlow_typeOutFlow_optional
 Element optional container type. More...
 
typedef ::xsd::cxx::tree::traits< OutFlow_type, char > OutFlow_traits
 Element traits type. More...
 
const OutFlow_optionalOutFlow () const
 Return a read-only (constant) reference to the element container. More...
 
OutFlow_optionalOutFlow ()
 Return a read-write reference to the element container. More...
 
void OutFlow (const OutFlow_type &x)
 Set the element value. More...
 
void OutFlow (const OutFlow_optional &x)
 Set the element value. More...
 
void OutFlow (::std::unique_ptr< OutFlow_type > p)
 Set the element value without copying. More...
 

Pressure

Accessor and modifier functions for the Pressure optional element.

typedef ::mil::tatrc::physiology::datamodel::ScalarPressureData Pressure_type
 Element type. More...
 
typedef ::xsd::cxx::tree::optional< Pressure_typePressure_optional
 Element optional container type. More...
 
typedef ::xsd::cxx::tree::traits< Pressure_type, char > Pressure_traits
 Element traits type. More...
 
const Pressure_optionalPressure () const
 Return a read-only (constant) reference to the element container. More...
 
Pressure_optionalPressure ()
 Return a read-write reference to the element container. More...
 
void Pressure (const Pressure_type &x)
 Set the element value. More...
 
void Pressure (const Pressure_optional &x)
 Set the element value. More...
 
void Pressure (::std::unique_ptr< Pressure_type > p)
 Set the element value without copying. More...
 

Volume

Accessor and modifier functions for the Volume optional element.

typedef ::mil::tatrc::physiology::datamodel::ScalarVolumeData Volume_type
 Element type. More...
 
typedef ::xsd::cxx::tree::optional< Volume_typeVolume_optional
 Element optional container type. More...
 
typedef ::xsd::cxx::tree::traits< Volume_type, char > Volume_traits
 Element traits type. More...
 
const Volume_optionalVolume () const
 Return a read-only (constant) reference to the element container. More...
 
Volume_optionalVolume ()
 Return a read-write reference to the element container. More...
 
void Volume (const Volume_type &x)
 Set the element value. More...
 
void Volume (const Volume_optional &x)
 Set the element value. More...
 
void Volume (::std::unique_ptr< Volume_type > p)
 Set the element value without copying. More...
 

Constructors

 FluidCompartmentData ()
 Default constructor. More...
 
 FluidCompartmentData (const Name_type &)
 Create an instance from the ultimate base and initializers for required elements and attributes. More...
 
 FluidCompartmentData (::std::unique_ptr< Name_type >)
 Create an instance from the ultimate base and initializers for required elements and attributes (::std::unique_ptr version). More...
 
 FluidCompartmentData (const ::xercesc::DOMElement &e,::xml_schema::flags f=0,::xml_schema::container *c=0)
 Create an instance from a DOM element. More...
 
 FluidCompartmentData (const FluidCompartmentData &x,::xml_schema::flags f=0,::xml_schema::container *c=0)
 Copy constructor. More...
 
virtual FluidCompartmentData_clone (::xml_schema::flags f=0,::xml_schema::container *c=0) const
 Copy the instance polymorphically. More...
 
FluidCompartmentDataoperator= (const FluidCompartmentData &x)
 Copy assignment operator. More...
 

Additional Inherited Members

- Public Types inherited from mil::tatrc::physiology::datamodel::CompartmentData
typedef ::xml_schema::string Name_type
 Element type. More...
 
typedef ::xsd::cxx::tree::traits< Name_type, char > Name_traits
 Element traits type. More...
 
typedef ::xml_schema::string Node_type
 Element type. More...
 
typedef ::xsd::cxx::tree::sequence< Node_typeNode_sequence
 Element sequence container type. More...
 
typedef Node_sequence::iterator Node_iterator
 Element iterator type. More...
 
typedef Node_sequence::const_iterator Node_const_iterator
 Element constant iterator type. More...
 
typedef ::xsd::cxx::tree::traits< Node_type, char > Node_traits
 Element traits type. More...
 
typedef ::xml_schema::string Child_type
 Element type. More...
 
typedef ::xsd::cxx::tree::sequence< Child_typeChild_sequence
 Element sequence container type. More...
 
typedef Child_sequence::iterator Child_iterator
 Element iterator type. More...
 
typedef Child_sequence::const_iterator Child_const_iterator
 Element constant iterator type. More...
 
typedef ::xsd::cxx::tree::traits< Child_type, char > Child_traits
 Element traits type. More...
 
- 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 FluidCompartmentData 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::FluidCompartmentData::FluidCompartmentData ( )

Default constructor.

Note that this constructor leaves required elements and attributes uninitialized.

mil::tatrc::physiology::datamodel::FluidCompartmentData::FluidCompartmentData ( const Name_type Name)

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

mil::tatrc::physiology::datamodel::FluidCompartmentData::FluidCompartmentData ( ::std::unique_ptr< Name_type Name)

Create an instance from the ultimate base and initializers for required elements and attributes (::std::unique_ptr version).

This constructor will try to use the passed values directly instead of making copies.

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

Destructor.

Member Function Documentation

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

Reimplemented in mil::tatrc::physiology::datamodel::LiquidCompartmentData, and mil::tatrc::physiology::datamodel::GasCompartmentData.

const FluidCompartmentData::InFlow_optional & mil::tatrc::physiology::datamodel::FluidCompartmentData::InFlow ( ) const

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

Returns
A constant reference to the optional container.
FluidCompartmentData::InFlow_optional & mil::tatrc::physiology::datamodel::FluidCompartmentData::InFlow ( )

Return a read-write reference to the element container.

Returns
A reference to the optional container.
void mil::tatrc::physiology::datamodel::FluidCompartmentData::InFlow ( const InFlow_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::FluidCompartmentData::InFlow ( const InFlow_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::FluidCompartmentData::InFlow ( ::std::unique_ptr< InFlow_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.

FluidCompartmentData & mil::tatrc::physiology::datamodel::FluidCompartmentData::operator= ( const FluidCompartmentData 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 FluidCompartmentData::OutFlow_optional & mil::tatrc::physiology::datamodel::FluidCompartmentData::OutFlow ( ) const

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

Returns
A constant reference to the optional container.
FluidCompartmentData::OutFlow_optional & mil::tatrc::physiology::datamodel::FluidCompartmentData::OutFlow ( )

Return a read-write reference to the element container.

Returns
A reference to the optional container.
void mil::tatrc::physiology::datamodel::FluidCompartmentData::OutFlow ( const OutFlow_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::FluidCompartmentData::OutFlow ( const OutFlow_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::FluidCompartmentData::OutFlow ( ::std::unique_ptr< OutFlow_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 FluidCompartmentData::Pressure_optional & mil::tatrc::physiology::datamodel::FluidCompartmentData::Pressure ( ) const

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

Returns
A constant reference to the optional container.
FluidCompartmentData::Pressure_optional & mil::tatrc::physiology::datamodel::FluidCompartmentData::Pressure ( )

Return a read-write reference to the element container.

Returns
A reference to the optional container.
void mil::tatrc::physiology::datamodel::FluidCompartmentData::Pressure ( const Pressure_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::FluidCompartmentData::Pressure ( const Pressure_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::FluidCompartmentData::Pressure ( ::std::unique_ptr< Pressure_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 FluidCompartmentData::Volume_optional & mil::tatrc::physiology::datamodel::FluidCompartmentData::Volume ( ) const

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

Returns
A constant reference to the optional container.
FluidCompartmentData::Volume_optional & mil::tatrc::physiology::datamodel::FluidCompartmentData::Volume ( )

Return a read-write reference to the element container.

Returns
A reference to the optional container.
void mil::tatrc::physiology::datamodel::FluidCompartmentData::Volume ( const Volume_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::FluidCompartmentData::Volume ( const Volume_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::FluidCompartmentData::Volume ( ::std::unique_ptr< Volume_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.