mil::tatrc::physiology::datamodel::SubstancePhysicochemicalData Class Reference

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

#include <Substance.hxx>

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

Public Member Functions

virtual ~SubstancePhysicochemicalData ()
 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...
 

AcidDissociationConstant

Accessor and modifier functions for the AcidDissociationConstant sequence element.

typedef ::mil::tatrc::physiology::datamodel::ScalarData AcidDissociationConstant_type
 Element type. More...
 
typedef ::xsd::cxx::tree::sequence< AcidDissociationConstant_typeAcidDissociationConstant_sequence
 Element sequence container type. More...
 
typedef AcidDissociationConstant_sequence::iterator AcidDissociationConstant_iterator
 Element iterator type. More...
 
typedef AcidDissociationConstant_sequence::const_iterator AcidDissociationConstant_const_iterator
 Element constant iterator type. More...
 
typedef ::xsd::cxx::tree::traits< AcidDissociationConstant_type, char > AcidDissociationConstant_traits
 Element traits type. More...
 
const AcidDissociationConstant_sequenceAcidDissociationConstant () const
 Return a read-only (constant) reference to the element sequence. More...
 
AcidDissociationConstant_sequenceAcidDissociationConstant ()
 Return a read-write reference to the element sequence. More...
 
void AcidDissociationConstant (const AcidDissociationConstant_sequence &s)
 Copy elements from a given sequence. More...
 

BindingProtein

Accessor and modifier functions for the BindingProtein required element.

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

BloodPlasmaRatio

Accessor and modifier functions for the BloodPlasmaRatio required element.

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

FractionUnboundInPlasma

Accessor and modifier functions for the FractionUnboundInPlasma required element.

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

IonicState

Accessor and modifier functions for the IonicState required element.

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

LogP

Accessor and modifier functions for the LogP required element.

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

HydrogenBondCount

Accessor and modifier functions for the HydrogenBondCount optional element.

typedef ::mil::tatrc::physiology::datamodel::ScalarData HydrogenBondCount_type
 Element type. More...
 
typedef ::xsd::cxx::tree::optional< HydrogenBondCount_typeHydrogenBondCount_optional
 Element optional container type. More...
 
typedef ::xsd::cxx::tree::traits< HydrogenBondCount_type, char > HydrogenBondCount_traits
 Element traits type. More...
 
const HydrogenBondCount_optionalHydrogenBondCount () const
 Return a read-only (constant) reference to the element container. More...
 
HydrogenBondCount_optionalHydrogenBondCount ()
 Return a read-write reference to the element container. More...
 
void HydrogenBondCount (const HydrogenBondCount_type &x)
 Set the element value. More...
 
void HydrogenBondCount (const HydrogenBondCount_optional &x)
 Set the element value. More...
 
void HydrogenBondCount (::std::unique_ptr< HydrogenBondCount_type > p)
 Set the element value without copying. More...
 

PolarSurfaceArea

Accessor and modifier functions for the PolarSurfaceArea optional element.

typedef ::mil::tatrc::physiology::datamodel::ScalarData PolarSurfaceArea_type
 Element type. More...
 
typedef ::xsd::cxx::tree::optional< PolarSurfaceArea_typePolarSurfaceArea_optional
 Element optional container type. More...
 
typedef ::xsd::cxx::tree::traits< PolarSurfaceArea_type, char > PolarSurfaceArea_traits
 Element traits type. More...
 
const PolarSurfaceArea_optionalPolarSurfaceArea () const
 Return a read-only (constant) reference to the element container. More...
 
PolarSurfaceArea_optionalPolarSurfaceArea ()
 Return a read-write reference to the element container. More...
 
void PolarSurfaceArea (const PolarSurfaceArea_type &x)
 Set the element value. More...
 
void PolarSurfaceArea (const PolarSurfaceArea_optional &x)
 Set the element value. More...
 
void PolarSurfaceArea (::std::unique_ptr< PolarSurfaceArea_type > p)
 Set the element value without copying. More...
 

Constructors

 SubstancePhysicochemicalData ()
 Default constructor. More...
 
 SubstancePhysicochemicalData (const BindingProtein_type &, const BloodPlasmaRatio_type &, const FractionUnboundInPlasma_type &, const IonicState_type &, const LogP_type &)
 Create an instance from the ultimate base and initializers for required elements and attributes. More...
 
 SubstancePhysicochemicalData (const BindingProtein_type &,::std::unique_ptr< BloodPlasmaRatio_type >,::std::unique_ptr< FractionUnboundInPlasma_type >, const IonicState_type &,::std::unique_ptr< LogP_type >)
 Create an instance from the ultimate base and initializers for required elements and attributes (::std::unique_ptr version). More...
 
 SubstancePhysicochemicalData (::std::unique_ptr< BindingProtein_type >,::std::unique_ptr< BloodPlasmaRatio_type >,::std::unique_ptr< FractionUnboundInPlasma_type >,::std::unique_ptr< IonicState_type >,::std::unique_ptr< LogP_type >)
 Create an instance from the ultimate base and initializers for required elements and attributes (::std::unique_ptr version). More...
 
 SubstancePhysicochemicalData (const ::xercesc::DOMElement &e,::xml_schema::flags f=0,::xml_schema::container *c=0)
 Create an instance from a DOM element. More...
 
 SubstancePhysicochemicalData (const SubstancePhysicochemicalData &x,::xml_schema::flags f=0,::xml_schema::container *c=0)
 Copy constructor. More...
 
virtual SubstancePhysicochemicalData_clone (::xml_schema::flags f=0,::xml_schema::container *c=0) const
 Copy the instance polymorphically. More...
 
SubstancePhysicochemicalDataoperator= (const SubstancePhysicochemicalData &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 SubstancePhysicochemicalData schema type.

Member Typedef Documentation

Element constant iterator type.

Element iterator type.

Element traits type.

Element traits type.

Element optional container type.

Constructor & Destructor Documentation

mil::tatrc::physiology::datamodel::SubstancePhysicochemicalData::SubstancePhysicochemicalData ( )

Default constructor.

Note that this constructor leaves required elements and attributes uninitialized.

mil::tatrc::physiology::datamodel::SubstancePhysicochemicalData::SubstancePhysicochemicalData ( const BindingProtein_type BindingProtein,
const BloodPlasmaRatio_type BloodPlasmaRatio,
const FractionUnboundInPlasma_type FractionUnboundInPlasma,
const IonicState_type IonicState,
const LogP_type LogP 
)

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

mil::tatrc::physiology::datamodel::SubstancePhysicochemicalData::SubstancePhysicochemicalData ( const BindingProtein_type BindingProtein,
::std::unique_ptr< BloodPlasmaRatio_type BloodPlasmaRatio,
::std::unique_ptr< FractionUnboundInPlasma_type FractionUnboundInPlasma,
const IonicState_type IonicState,
::std::unique_ptr< LogP_type LogP 
)

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::SubstancePhysicochemicalData::SubstancePhysicochemicalData ( ::std::unique_ptr< BindingProtein_type BindingProtein,
::std::unique_ptr< BloodPlasmaRatio_type BloodPlasmaRatio,
::std::unique_ptr< FractionUnboundInPlasma_type FractionUnboundInPlasma,
::std::unique_ptr< IonicState_type IonicState,
::std::unique_ptr< LogP_type LogP 
)

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

Destructor.

Member Function Documentation

SubstancePhysicochemicalData * mil::tatrc::physiology::datamodel::SubstancePhysicochemicalData::_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 SubstancePhysicochemicalData::AcidDissociationConstant_sequence & mil::tatrc::physiology::datamodel::SubstancePhysicochemicalData::AcidDissociationConstant ( ) const

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

Returns
A constant reference to the sequence container.
SubstancePhysicochemicalData::AcidDissociationConstant_sequence & mil::tatrc::physiology::datamodel::SubstancePhysicochemicalData::AcidDissociationConstant ( )

Return a read-write reference to the element sequence.

Returns
A reference to the sequence container.
void mil::tatrc::physiology::datamodel::SubstancePhysicochemicalData::AcidDissociationConstant ( const AcidDissociationConstant_sequence s)

Copy elements from a given sequence.

Parameters
sA sequence to copy elements from.

For each element in s this function makes a copy and adds it to the sequence. Note that this operation completely changes the sequence and all old elements will be lost.

const SubstancePhysicochemicalData::BindingProtein_type & mil::tatrc::physiology::datamodel::SubstancePhysicochemicalData::BindingProtein ( ) const

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

Returns
A constant reference to the element.
SubstancePhysicochemicalData::BindingProtein_type & mil::tatrc::physiology::datamodel::SubstancePhysicochemicalData::BindingProtein ( )

Return a read-write reference to the element.

Returns
A reference to the element.
void mil::tatrc::physiology::datamodel::SubstancePhysicochemicalData::BindingProtein ( const BindingProtein_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::SubstancePhysicochemicalData::BindingProtein ( ::std::unique_ptr< BindingProtein_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 SubstancePhysicochemicalData::BloodPlasmaRatio_type & mil::tatrc::physiology::datamodel::SubstancePhysicochemicalData::BloodPlasmaRatio ( ) const

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

Returns
A constant reference to the element.
SubstancePhysicochemicalData::BloodPlasmaRatio_type & mil::tatrc::physiology::datamodel::SubstancePhysicochemicalData::BloodPlasmaRatio ( )

Return a read-write reference to the element.

Returns
A reference to the element.
void mil::tatrc::physiology::datamodel::SubstancePhysicochemicalData::BloodPlasmaRatio ( const BloodPlasmaRatio_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::SubstancePhysicochemicalData::BloodPlasmaRatio ( ::std::unique_ptr< BloodPlasmaRatio_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 SubstancePhysicochemicalData::FractionUnboundInPlasma_type & mil::tatrc::physiology::datamodel::SubstancePhysicochemicalData::FractionUnboundInPlasma ( ) const

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

Returns
A constant reference to the element.
SubstancePhysicochemicalData::FractionUnboundInPlasma_type & mil::tatrc::physiology::datamodel::SubstancePhysicochemicalData::FractionUnboundInPlasma ( )

Return a read-write reference to the element.

Returns
A reference to the element.
void mil::tatrc::physiology::datamodel::SubstancePhysicochemicalData::FractionUnboundInPlasma ( const FractionUnboundInPlasma_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::SubstancePhysicochemicalData::FractionUnboundInPlasma ( ::std::unique_ptr< FractionUnboundInPlasma_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 SubstancePhysicochemicalData::HydrogenBondCount_optional & mil::tatrc::physiology::datamodel::SubstancePhysicochemicalData::HydrogenBondCount ( ) const

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

Returns
A constant reference to the optional container.
SubstancePhysicochemicalData::HydrogenBondCount_optional & mil::tatrc::physiology::datamodel::SubstancePhysicochemicalData::HydrogenBondCount ( )

Return a read-write reference to the element container.

Returns
A reference to the optional container.
void mil::tatrc::physiology::datamodel::SubstancePhysicochemicalData::HydrogenBondCount ( const HydrogenBondCount_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::SubstancePhysicochemicalData::HydrogenBondCount ( const HydrogenBondCount_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::SubstancePhysicochemicalData::HydrogenBondCount ( ::std::unique_ptr< HydrogenBondCount_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 SubstancePhysicochemicalData::IonicState_type & mil::tatrc::physiology::datamodel::SubstancePhysicochemicalData::IonicState ( ) const

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

Returns
A constant reference to the element.
SubstancePhysicochemicalData::IonicState_type & mil::tatrc::physiology::datamodel::SubstancePhysicochemicalData::IonicState ( )

Return a read-write reference to the element.

Returns
A reference to the element.
void mil::tatrc::physiology::datamodel::SubstancePhysicochemicalData::IonicState ( const IonicState_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::SubstancePhysicochemicalData::IonicState ( ::std::unique_ptr< IonicState_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 SubstancePhysicochemicalData::LogP_type & mil::tatrc::physiology::datamodel::SubstancePhysicochemicalData::LogP ( ) const

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

Returns
A constant reference to the element.
SubstancePhysicochemicalData::LogP_type & mil::tatrc::physiology::datamodel::SubstancePhysicochemicalData::LogP ( )

Return a read-write reference to the element.

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

SubstancePhysicochemicalData & mil::tatrc::physiology::datamodel::SubstancePhysicochemicalData::operator= ( const SubstancePhysicochemicalData 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 SubstancePhysicochemicalData::PolarSurfaceArea_optional & mil::tatrc::physiology::datamodel::SubstancePhysicochemicalData::PolarSurfaceArea ( ) const

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

Returns
A constant reference to the optional container.
SubstancePhysicochemicalData::PolarSurfaceArea_optional & mil::tatrc::physiology::datamodel::SubstancePhysicochemicalData::PolarSurfaceArea ( )

Return a read-write reference to the element container.

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