mil::tatrc::physiology::datamodel::SubstanceBolusStateData Class Reference

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

#include <PatientActions.hxx>

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

Public Member Functions

virtual ~SubstanceBolusStateData ()
 Destructor. More...
 

ElapsedTime

Accessor and modifier functions for the ElapsedTime required element.

typedef ::mil::tatrc::physiology::datamodel::ScalarTimeData ElapsedTime_type
 Element type. More...
 
typedef ::xsd::cxx::tree::traits< ElapsedTime_type, char > ElapsedTime_traits
 Element traits type. More...
 
const ElapsedTime_typeElapsedTime () const
 Return a read-only (constant) reference to the element. More...
 
ElapsedTime_typeElapsedTime ()
 Return a read-write reference to the element. More...
 
void ElapsedTime (const ElapsedTime_type &x)
 Set the element value. More...
 
void ElapsedTime (::std::unique_ptr< ElapsedTime_type > p)
 Set the element value without copying. More...
 

AdministeredDose

Accessor and modifier functions for the AdministeredDose required element.

typedef ::mil::tatrc::physiology::datamodel::ScalarVolumeData AdministeredDose_type
 Element type. More...
 
typedef ::xsd::cxx::tree::traits< AdministeredDose_type, char > AdministeredDose_traits
 Element traits type. More...
 
const AdministeredDose_typeAdministeredDose () const
 Return a read-only (constant) reference to the element. More...
 
AdministeredDose_typeAdministeredDose ()
 Return a read-write reference to the element. More...
 
void AdministeredDose (const AdministeredDose_type &x)
 Set the element value. More...
 
void AdministeredDose (::std::unique_ptr< AdministeredDose_type > p)
 Set the element value without copying. More...
 

Substance

Accessor and modifier functions for the Substance required attribute.

typedef ::xml_schema::string Substance_type
 Attribute type. More...
 
typedef ::xsd::cxx::tree::traits< Substance_type, char > Substance_traits
 Attribute traits type. More...
 
const Substance_typeSubstance () const
 Return a read-only (constant) reference to the attribute. More...
 
Substance_typeSubstance ()
 Return a read-write reference to the attribute. More...
 
void Substance (const Substance_type &x)
 Set the attribute value. More...
 
void Substance (::std::unique_ptr< Substance_type > p)
 Set the attribute value without copying. More...
 

Constructors

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

Detailed Description

Class corresponding to the SubstanceBolusStateData schema type.

Member Typedef Documentation

Element traits type.

Attribute traits type.

Constructor & Destructor Documentation

mil::tatrc::physiology::datamodel::SubstanceBolusStateData::SubstanceBolusStateData ( )

Default constructor.

Note that this constructor leaves required elements and attributes uninitialized.

mil::tatrc::physiology::datamodel::SubstanceBolusStateData::SubstanceBolusStateData ( const ElapsedTime_type ElapsedTime,
const AdministeredDose_type AdministeredDose,
const Substance_type Substance 
)

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

mil::tatrc::physiology::datamodel::SubstanceBolusStateData::SubstanceBolusStateData ( ::std::unique_ptr< ElapsedTime_type ElapsedTime,
::std::unique_ptr< AdministeredDose_type AdministeredDose,
const Substance_type Substance 
)

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::SubstanceBolusStateData::SubstanceBolusStateData ( 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::SubstanceBolusStateData::SubstanceBolusStateData ( const SubstanceBolusStateData 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::SubstanceBolusStateData::~SubstanceBolusStateData ( )
virtual

Destructor.

Member Function Documentation

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

const SubstanceBolusStateData::AdministeredDose_type & mil::tatrc::physiology::datamodel::SubstanceBolusStateData::AdministeredDose ( ) const

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

Returns
A constant reference to the element.
SubstanceBolusStateData::AdministeredDose_type & mil::tatrc::physiology::datamodel::SubstanceBolusStateData::AdministeredDose ( )

Return a read-write reference to the element.

Returns
A reference to the element.
void mil::tatrc::physiology::datamodel::SubstanceBolusStateData::AdministeredDose ( const AdministeredDose_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::SubstanceBolusStateData::AdministeredDose ( ::std::unique_ptr< AdministeredDose_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 SubstanceBolusStateData::ElapsedTime_type & mil::tatrc::physiology::datamodel::SubstanceBolusStateData::ElapsedTime ( ) const

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

Returns
A constant reference to the element.
SubstanceBolusStateData::ElapsedTime_type & mil::tatrc::physiology::datamodel::SubstanceBolusStateData::ElapsedTime ( )

Return a read-write reference to the element.

Returns
A reference to the element.
void mil::tatrc::physiology::datamodel::SubstanceBolusStateData::ElapsedTime ( const ElapsedTime_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::SubstanceBolusStateData::ElapsedTime ( ::std::unique_ptr< ElapsedTime_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.

SubstanceBolusStateData & mil::tatrc::physiology::datamodel::SubstanceBolusStateData::operator= ( const SubstanceBolusStateData 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 SubstanceBolusStateData::Substance_type & mil::tatrc::physiology::datamodel::SubstanceBolusStateData::Substance ( ) const

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

Returns
A constant reference to the attribute.
SubstanceBolusStateData::Substance_type & mil::tatrc::physiology::datamodel::SubstanceBolusStateData::Substance ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.
void mil::tatrc::physiology::datamodel::SubstanceBolusStateData::Substance ( const Substance_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::SubstanceBolusStateData::Substance ( ::std::unique_ptr< Substance_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.