mil::tatrc::physiology::datamodel::CompartmentLinkData Class Reference

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

#include <Compartment.hxx>

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

Public Member Functions
virtual	~CompartmentLinkData ()
	Destructor. More...
Public Member Functions inherited from mil::tatrc::physiology::datamodel::ObjectData
virtual	~ObjectData ()
	Destructor. More...
const contentVersion_optional &	contentVersion () const
	Return a read-only (constant) reference to the attribute container. More...
contentVersion_optional &	contentVersion ()
	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...
ObjectData &	operator= (const ObjectData &x)
	Copy assignment operator. More...

Name
Accessor and modifier functions for the Name required element.
typedef ::xml_schema::string	Name_type
	Element type. More...
typedef ::xsd::cxx::tree::traits< Name_type, char >	Name_traits
	Element traits type. More...
const Name_type &	Name () const
	Return a read-only (constant) reference to the element. More...
Name_type &	Name ()
	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...

Path
Accessor and modifier functions for the Path optional element.
typedef ::xml_schema::string	Path_type
	Element type. More...
typedef ::xsd::cxx::tree::optional< Path_type >	Path_optional
	Element optional container type. More...
typedef ::xsd::cxx::tree::traits< Path_type, char >	Path_traits
	Element traits type. More...
const Path_optional &	Path () const
	Return a read-only (constant) reference to the element container. More...
Path_optional &	Path ()
	Return a read-write reference to the element container. More...
void	Path (const Path_type &x)
	Set the element value. More...
void	Path (const Path_optional &x)
	Set the element value. More...
void	Path (::std::unique_ptr< Path_type > p)
	Set the element value without copying. More...

SourceCompartment
Accessor and modifier functions for the SourceCompartment required element.
typedef ::xml_schema::string	SourceCompartment_type
	Element type. More...
typedef ::xsd::cxx::tree::traits< SourceCompartment_type, char >	SourceCompartment_traits
	Element traits type. More...
const SourceCompartment_type &	SourceCompartment () const
	Return a read-only (constant) reference to the element. More...
SourceCompartment_type &	SourceCompartment ()
	Return a read-write reference to the element. More...
void	SourceCompartment (const SourceCompartment_type &x)
	Set the element value. More...
void	SourceCompartment (::std::unique_ptr< SourceCompartment_type > p)
	Set the element value without copying. More...

TargetCompartment
Accessor and modifier functions for the TargetCompartment required element.
typedef ::xml_schema::string	TargetCompartment_type
	Element type. More...
typedef ::xsd::cxx::tree::traits< TargetCompartment_type, char >	TargetCompartment_traits
	Element traits type. More...
const TargetCompartment_type &	TargetCompartment () const
	Return a read-only (constant) reference to the element. More...
TargetCompartment_type &	TargetCompartment ()
	Return a read-write reference to the element. More...
void	TargetCompartment (const TargetCompartment_type &x)
	Set the element value. More...
void	TargetCompartment (::std::unique_ptr< TargetCompartment_type > p)
	Set the element value without copying. More...

Constructors
	CompartmentLinkData ()
	Default constructor. More...
	CompartmentLinkData (const Name_type &, const SourceCompartment_type &, const TargetCompartment_type &)
	Create an instance from the ultimate base and initializers for required elements and attributes. More...
	CompartmentLinkData (::std::unique_ptr< Name_type >,::std::unique_ptr< SourceCompartment_type >,::std::unique_ptr< TargetCompartment_type >)
	Create an instance from the ultimate base and initializers for required elements and attributes (::std::unique_ptr version). More...
	CompartmentLinkData (const ::xercesc::DOMElement &e,::xml_schema::flags f=0,::xml_schema::container *c=0)
	Create an instance from a DOM element. More...
	CompartmentLinkData (const CompartmentLinkData &x,::xml_schema::flags f=0,::xml_schema::container *c=0)
	Copy constructor. More...
virtual CompartmentLinkData *	_clone (::xml_schema::flags f=0,::xml_schema::container *c=0) const
	Copy the instance polymorphically. More...
CompartmentLinkData &	operator= (const CompartmentLinkData &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_type >	contentVersion_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 CompartmentLinkData schema type.

Member Typedef Documentation

typedef ::xsd::cxx::tree::traits< Name_type, char > mil::tatrc::physiology::datamodel::CompartmentLinkData::Name_traits

Element traits type.

typedef ::xml_schema::string mil::tatrc::physiology::datamodel::CompartmentLinkData::Name_type

Element type.

typedef ::xsd::cxx::tree::optional< Path_type > mil::tatrc::physiology::datamodel::CompartmentLinkData::Path_optional

Element optional container type.

typedef ::xsd::cxx::tree::traits< Path_type, char > mil::tatrc::physiology::datamodel::CompartmentLinkData::Path_traits

Element traits type.

typedef ::xml_schema::string mil::tatrc::physiology::datamodel::CompartmentLinkData::Path_type

Element type.

typedef ::xsd::cxx::tree::traits< SourceCompartment_type, char > mil::tatrc::physiology::datamodel::CompartmentLinkData::SourceCompartment_traits

Element traits type.

typedef ::xml_schema::string mil::tatrc::physiology::datamodel::CompartmentLinkData::SourceCompartment_type

Element type.

typedef ::xsd::cxx::tree::traits< TargetCompartment_type, char > mil::tatrc::physiology::datamodel::CompartmentLinkData::TargetCompartment_traits

Element traits type.

typedef ::xml_schema::string mil::tatrc::physiology::datamodel::CompartmentLinkData::TargetCompartment_type

Element type.

Constructor & Destructor Documentation

mil::tatrc::physiology::datamodel::CompartmentLinkData::CompartmentLinkData

(

)

Default constructor.

Note that this constructor leaves required elements and attributes uninitialized.

mil::tatrc::physiology::datamodel::CompartmentLinkData::CompartmentLinkData	(	const Name_type &	Name,
		const SourceCompartment_type &	SourceCompartment,
		const TargetCompartment_type &	TargetCompartment
	)

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

mil::tatrc::physiology::datamodel::CompartmentLinkData::CompartmentLinkData	(	::std::unique_ptr< Name_type >	Name,
		::std::unique_ptr< SourceCompartment_type >	SourceCompartment,
		::std::unique_ptr< TargetCompartment_type >	TargetCompartment
	)

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::CompartmentLinkData::CompartmentLinkData	(	const ::xercesc::DOMElement &	e,
		::xml_schema::flags	f = 0,
		::xml_schema::container *	c = 0
	)

Create an instance from a DOM element.

Parameters

e	A DOM element to extract the data from.
f	Flags to create the new instance with.
c	A pointer to the object that will contain the new instance.

mil::tatrc::physiology::datamodel::CompartmentLinkData::CompartmentLinkData	(	const CompartmentLinkData &	x,
		::xml_schema::flags	f = 0,
		::xml_schema::container *	c = 0
	)

Copy constructor.

Parameters

x	An instance to make a copy of.
f	Flags to create the copy with.
c	A pointer to the object that will contain the copy.

For polymorphic object models use the _clone function instead.

mil::tatrc::physiology::datamodel::CompartmentLinkData::~CompartmentLinkData ( )

virtual

Destructor.

Member Function Documentation

CompartmentLinkData * mil::tatrc::physiology::datamodel::CompartmentLinkData::_clone ( ::xml_schema::flags  f = 0, ::xml_schema::container *  c = 0  ) const

virtual

Copy the instance polymorphically.

Parameters

f	Flags to create the copy with.
c	A 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.

Reimplemented in mil::tatrc::physiology::datamodel::ElectricalCompartmentLinkData, mil::tatrc::physiology::datamodel::ThermalCompartmentLinkData, mil::tatrc::physiology::datamodel::LiquidCompartmentLinkData, mil::tatrc::physiology::datamodel::GasCompartmentLinkData, and mil::tatrc::physiology::datamodel::FluidCompartmentLinkData.

const CompartmentLinkData::Name_type & mil::tatrc::physiology::datamodel::CompartmentLinkData::Name

(

)

const

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

Returns

A constant reference to the element.

CompartmentLinkData::Name_type & mil::tatrc::physiology::datamodel::CompartmentLinkData::Name

(

)

Return a read-write reference to the element.

Returns

A reference to the element.

void mil::tatrc::physiology::datamodel::CompartmentLinkData::Name

(

const Name_type &

x

)

Set the element value.

Parameters

x	A 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::CompartmentLinkData::Name

(

::std::unique_ptr< Name_type >

p

)

Set the element value without copying.

Parameters

p	A new value to use.

This function will try to use the passed value directly instead of making a copy.

CompartmentLinkData & mil::tatrc::physiology::datamodel::CompartmentLinkData::operator=

(

const CompartmentLinkData &

x

)

Copy assignment operator.

Parameters

x	An instance to make a copy of.

Returns

A reference to itself.

For polymorphic object models use the _clone function instead.

const CompartmentLinkData::Path_optional & mil::tatrc::physiology::datamodel::CompartmentLinkData::Path

(

)

const

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

Returns

A constant reference to the optional container.

CompartmentLinkData::Path_optional & mil::tatrc::physiology::datamodel::CompartmentLinkData::Path

(

)

Return a read-write reference to the element container.

Returns

A reference to the optional container.

void mil::tatrc::physiology::datamodel::CompartmentLinkData::Path

(

const Path_type &

x

)

Set the element value.

Parameters

x	A 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::CompartmentLinkData::Path

(

const Path_optional &

x

)

Set the element value.

Parameters

x	An 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::CompartmentLinkData::Path

(

::std::unique_ptr< Path_type >

p

)

Set the element value without copying.

Parameters

p	A new value to use.

This function will try to use the passed value directly instead of making a copy.

const CompartmentLinkData::SourceCompartment_type & mil::tatrc::physiology::datamodel::CompartmentLinkData::SourceCompartment

(

)

const

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

Returns

A constant reference to the element.

CompartmentLinkData::SourceCompartment_type & mil::tatrc::physiology::datamodel::CompartmentLinkData::SourceCompartment

(

)

Return a read-write reference to the element.

Returns

A reference to the element.

void mil::tatrc::physiology::datamodel::CompartmentLinkData::SourceCompartment

(

const SourceCompartment_type &

x

)

Set the element value.

Parameters

x	A 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::CompartmentLinkData::SourceCompartment

(

::std::unique_ptr< SourceCompartment_type >

p

)

Set the element value without copying.

Parameters

p	A new value to use.

This function will try to use the passed value directly instead of making a copy.

const CompartmentLinkData::TargetCompartment_type & mil::tatrc::physiology::datamodel::CompartmentLinkData::TargetCompartment

(

)

const

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

Returns

A constant reference to the element.

CompartmentLinkData::TargetCompartment_type & mil::tatrc::physiology::datamodel::CompartmentLinkData::TargetCompartment

(

)

Return a read-write reference to the element.

Returns

A reference to the element.

void mil::tatrc::physiology::datamodel::CompartmentLinkData::TargetCompartment

(

const TargetCompartment_type &

x

)

Set the element value.

Parameters

x	A 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::CompartmentLinkData::TargetCompartment

(

::std::unique_ptr< TargetCompartment_type >

p

)

Set the element value without copying.

Parameters

p	A new value to use.

This function will try to use the passed value directly instead of making a copy.