mil::tatrc::physiology::datamodel::SubstanceBolusData Class Reference

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

#include <PatientActions.hxx>

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

Public Member Functions

virtual ~SubstanceBolusData ()
 Destructor. More...
 
- Public Member Functions inherited from mil::tatrc::physiology::datamodel::SubstanceAdministrationData
virtual ~SubstanceAdministrationData ()
 Destructor. More...
 
 SubstanceAdministrationData ()
 Create an instance from the ultimate base and initializers for required elements and attributes. More...
 
 SubstanceAdministrationData (const ::xercesc::DOMElement &e,::xml_schema::flags f=0,::xml_schema::container *c=0)
 Create an instance from a DOM element. More...
 
 SubstanceAdministrationData (const SubstanceAdministrationData &x,::xml_schema::flags f=0,::xml_schema::container *c=0)
 Copy constructor. More...
 
- Public Member Functions inherited from mil::tatrc::physiology::datamodel::PatientActionData
virtual ~PatientActionData ()
 Destructor. More...
 
 PatientActionData ()
 Create an instance from the ultimate base and initializers for required elements and attributes. More...
 
 PatientActionData (const ::xercesc::DOMElement &e,::xml_schema::flags f=0,::xml_schema::container *c=0)
 Create an instance from a DOM element. More...
 
 PatientActionData (const PatientActionData &x,::xml_schema::flags f=0,::xml_schema::container *c=0)
 Copy constructor. More...
 
- Public Member Functions inherited from mil::tatrc::physiology::datamodel::ActionData
virtual ~ActionData ()
 Destructor. More...
 
const Comment_optionalComment () const
 Return a read-only (constant) reference to the element container. More...
 
Comment_optionalComment ()
 Return a read-write reference to the element container. More...
 
void Comment (const Comment_type &x)
 Set the element value. More...
 
void Comment (const Comment_optional &x)
 Set the element value. More...
 
void Comment (::std::unique_ptr< Comment_type > p)
 Set the element value without copying. More...
 
const Occurs_optionalOccurs () const
 Return a read-only (constant) reference to the element container. More...
 
Occurs_optionalOccurs ()
 Return a read-write reference to the element container. More...
 
void Occurs (const Occurs_type &x)
 Set the element value. More...
 
void Occurs (const Occurs_optional &x)
 Set the element value. More...
 
const Duration_optionalDuration () const
 Return a read-only (constant) reference to the element container. More...
 
Duration_optionalDuration ()
 Return a read-write reference to the element container. More...
 
void Duration (const Duration_type &x)
 Set the element value. More...
 
void Duration (const Duration_optional &x)
 Set the element value. More...
 
 ActionData ()
 Create an instance from the ultimate base and initializers for required elements and attributes. More...
 
 ActionData (const ::xercesc::DOMElement &e,::xml_schema::flags f=0,::xml_schema::container *c=0)
 Create an instance from a DOM element. More...
 
 ActionData (const ActionData &x,::xml_schema::flags f=0,::xml_schema::container *c=0)
 Copy constructor. More...
 
ActionDataoperator= (const ActionData &x)
 Copy assignment operator. More...
 

Substance

Accessor and modifier functions for the Substance required element.

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

Concentration

Accessor and modifier functions for the Concentration required element.

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

Dose

Accessor and modifier functions for the Dose required element.

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

AdminTime

Accessor and modifier functions for the AdminTime optional element.

typedef ::mil::tatrc::physiology::datamodel::ScalarTimeData AdminTime_type
 Element type. More...
 
typedef ::xsd::cxx::tree::optional< AdminTime_typeAdminTime_optional
 Element optional container type. More...
 
typedef ::xsd::cxx::tree::traits< AdminTime_type, char > AdminTime_traits
 Element traits type. More...
 
const AdminTime_optionalAdminTime () const
 Return a read-only (constant) reference to the element container. More...
 
AdminTime_optionalAdminTime ()
 Return a read-write reference to the element container. More...
 
void AdminTime (const AdminTime_type &x)
 Set the element value. More...
 
void AdminTime (const AdminTime_optional &x)
 Set the element value. More...
 
void AdminTime (::std::unique_ptr< AdminTime_type > p)
 Set the element value without copying. More...
 

AdminRoute

Accessor and modifier functions for the AdminRoute required attribute.

typedef ::mil::tatrc::physiology::datamodel::enumBolusAdministration AdminRoute_type
 Attribute type. More...
 
typedef ::xsd::cxx::tree::traits< AdminRoute_type, char > AdminRoute_traits
 Attribute traits type. More...
 
const AdminRoute_typeAdminRoute () const
 Return a read-only (constant) reference to the attribute. More...
 
AdminRoute_typeAdminRoute ()
 Return a read-write reference to the attribute. More...
 
void AdminRoute (const AdminRoute_type &x)
 Set the attribute value. More...
 
void AdminRoute (::std::unique_ptr< AdminRoute_type > p)
 Set the attribute value without copying. More...
 

Constructors

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

Additional Inherited Members

- Public Types inherited from mil::tatrc::physiology::datamodel::ActionData
typedef ::xml_schema::string Comment_type
 Element type. More...
 
typedef ::xsd::cxx::tree::optional< Comment_typeComment_optional
 Element optional container type. More...
 
typedef ::xsd::cxx::tree::traits< Comment_type, char > Comment_traits
 Element traits type. More...
 
typedef ::xml_schema::double_ Occurs_type
 Element type. More...
 
typedef ::xsd::cxx::tree::optional< Occurs_typeOccurs_optional
 Element optional container type. More...
 
typedef ::xsd::cxx::tree::traits< Occurs_type, char,::xsd::cxx::tree::schema_type::double_ > Occurs_traits
 Element traits type. More...
 
typedef ::xml_schema::double_ Duration_type
 Element type. More...
 
typedef ::xsd::cxx::tree::optional< Duration_typeDuration_optional
 Element optional container type. More...
 
typedef ::xsd::cxx::tree::traits< Duration_type, char,::xsd::cxx::tree::schema_type::double_ > Duration_traits
 Element traits type. More...
 

Detailed Description

Class corresponding to the SubstanceBolusData schema type.

Member Typedef Documentation

Attribute traits type.

Element optional container type.

Element traits type.

Element traits type.

Element traits type.

Element traits type.

Constructor & Destructor Documentation

mil::tatrc::physiology::datamodel::SubstanceBolusData::SubstanceBolusData ( )

Default constructor.

Note that this constructor leaves required elements and attributes uninitialized.

mil::tatrc::physiology::datamodel::SubstanceBolusData::SubstanceBolusData ( const Substance_type Substance,
const Concentration_type Concentration,
const Dose_type Dose,
const AdminRoute_type AdminRoute 
)

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

mil::tatrc::physiology::datamodel::SubstanceBolusData::SubstanceBolusData ( const Substance_type Substance,
::std::unique_ptr< Concentration_type Concentration,
::std::unique_ptr< Dose_type Dose,
const AdminRoute_type AdminRoute 
)

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::SubstanceBolusData::SubstanceBolusData ( ::std::unique_ptr< Substance_type Substance,
::std::unique_ptr< Concentration_type Concentration,
::std::unique_ptr< Dose_type Dose,
const AdminRoute_type AdminRoute 
)

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

Destructor.

Member Function Documentation

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

const SubstanceBolusData::AdminRoute_type & mil::tatrc::physiology::datamodel::SubstanceBolusData::AdminRoute ( ) const

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

Returns
A constant reference to the attribute.
SubstanceBolusData::AdminRoute_type & mil::tatrc::physiology::datamodel::SubstanceBolusData::AdminRoute ( )

Return a read-write reference to the attribute.

Returns
A reference to the attribute.
void mil::tatrc::physiology::datamodel::SubstanceBolusData::AdminRoute ( const AdminRoute_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::SubstanceBolusData::AdminRoute ( ::std::unique_ptr< AdminRoute_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 SubstanceBolusData::AdminTime_optional & mil::tatrc::physiology::datamodel::SubstanceBolusData::AdminTime ( ) const

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

Returns
A constant reference to the optional container.
SubstanceBolusData::AdminTime_optional & mil::tatrc::physiology::datamodel::SubstanceBolusData::AdminTime ( )

Return a read-write reference to the element container.

Returns
A reference to the optional container.
void mil::tatrc::physiology::datamodel::SubstanceBolusData::AdminTime ( const AdminTime_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::SubstanceBolusData::AdminTime ( const AdminTime_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::SubstanceBolusData::AdminTime ( ::std::unique_ptr< AdminTime_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 SubstanceBolusData::Concentration_type & mil::tatrc::physiology::datamodel::SubstanceBolusData::Concentration ( ) const

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

Returns
A constant reference to the element.
SubstanceBolusData::Concentration_type & mil::tatrc::physiology::datamodel::SubstanceBolusData::Concentration ( )

Return a read-write reference to the element.

Returns
A reference to the element.
void mil::tatrc::physiology::datamodel::SubstanceBolusData::Concentration ( const Concentration_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::SubstanceBolusData::Concentration ( ::std::unique_ptr< Concentration_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 SubstanceBolusData::Dose_type & mil::tatrc::physiology::datamodel::SubstanceBolusData::Dose ( ) const

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

Returns
A constant reference to the element.
SubstanceBolusData::Dose_type & mil::tatrc::physiology::datamodel::SubstanceBolusData::Dose ( )

Return a read-write reference to the element.

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

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

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

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

Return a read-write reference to the element.

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