mil::tatrc::physiology::datamodel::CircuitPathData Class Reference

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

#include <Circuit.hxx>

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

Public Member Functions

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

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_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...
 

SourceNode

Accessor and modifier functions for the SourceNode required element.

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

TargetNode

Accessor and modifier functions for the TargetNode required element.

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

Switch

Accessor and modifier functions for the Switch optional element.

typedef ::mil::tatrc::physiology::datamodel::enumOpenClosed Switch_type
 Element type. More...
 
typedef ::xsd::cxx::tree::optional< Switch_typeSwitch_optional
 Element optional container type. More...
 
typedef ::xsd::cxx::tree::traits< Switch_type, char > Switch_traits
 Element traits type. More...
 
const Switch_optionalSwitch () const
 Return a read-only (constant) reference to the element container. More...
 
Switch_optionalSwitch ()
 Return a read-write reference to the element container. More...
 
void Switch (const Switch_type &x)
 Set the element value. More...
 
void Switch (const Switch_optional &x)
 Set the element value. More...
 
void Switch (::std::unique_ptr< Switch_type > p)
 Set the element value without copying. More...
 

NextSwitch

Accessor and modifier functions for the NextSwitch optional element.

typedef ::mil::tatrc::physiology::datamodel::enumOpenClosed NextSwitch_type
 Element type. More...
 
typedef ::xsd::cxx::tree::optional< NextSwitch_typeNextSwitch_optional
 Element optional container type. More...
 
typedef ::xsd::cxx::tree::traits< NextSwitch_type, char > NextSwitch_traits
 Element traits type. More...
 
const NextSwitch_optionalNextSwitch () const
 Return a read-only (constant) reference to the element container. More...
 
NextSwitch_optionalNextSwitch ()
 Return a read-write reference to the element container. More...
 
void NextSwitch (const NextSwitch_type &x)
 Set the element value. More...
 
void NextSwitch (const NextSwitch_optional &x)
 Set the element value. More...
 
void NextSwitch (::std::unique_ptr< NextSwitch_type > p)
 Set the element value without copying. More...
 

Valve

Accessor and modifier functions for the Valve optional element.

typedef ::mil::tatrc::physiology::datamodel::enumOpenClosed Valve_type
 Element type. More...
 
typedef ::xsd::cxx::tree::optional< Valve_typeValve_optional
 Element optional container type. More...
 
typedef ::xsd::cxx::tree::traits< Valve_type, char > Valve_traits
 Element traits type. More...
 
const Valve_optionalValve () const
 Return a read-only (constant) reference to the element container. More...
 
Valve_optionalValve ()
 Return a read-write reference to the element container. More...
 
void Valve (const Valve_type &x)
 Set the element value. More...
 
void Valve (const Valve_optional &x)
 Set the element value. More...
 
void Valve (::std::unique_ptr< Valve_type > p)
 Set the element value without copying. More...
 

NextValve

Accessor and modifier functions for the NextValve optional element.

typedef ::mil::tatrc::physiology::datamodel::enumOpenClosed NextValve_type
 Element type. More...
 
typedef ::xsd::cxx::tree::optional< NextValve_typeNextValve_optional
 Element optional container type. More...
 
typedef ::xsd::cxx::tree::traits< NextValve_type, char > NextValve_traits
 Element traits type. More...
 
const NextValve_optionalNextValve () const
 Return a read-only (constant) reference to the element container. More...
 
NextValve_optionalNextValve ()
 Return a read-write reference to the element container. More...
 
void NextValve (const NextValve_type &x)
 Set the element value. More...
 
void NextValve (const NextValve_optional &x)
 Set the element value. More...
 
void NextValve (::std::unique_ptr< NextValve_type > p)
 Set the element value without copying. More...
 

PolarizedState

Accessor and modifier functions for the PolarizedState optional element.

typedef ::mil::tatrc::physiology::datamodel::enumOpenClosed PolarizedState_type
 Element type. More...
 
typedef ::xsd::cxx::tree::optional< PolarizedState_typePolarizedState_optional
 Element optional container type. More...
 
typedef ::xsd::cxx::tree::traits< PolarizedState_type, char > PolarizedState_traits
 Element traits type. More...
 
const PolarizedState_optionalPolarizedState () const
 Return a read-only (constant) reference to the element container. More...
 
PolarizedState_optionalPolarizedState ()
 Return a read-write reference to the element container. More...
 
void PolarizedState (const PolarizedState_type &x)
 Set the element value. More...
 
void PolarizedState (const PolarizedState_optional &x)
 Set the element value. More...
 
void PolarizedState (::std::unique_ptr< PolarizedState_type > p)
 Set the element value without copying. More...
 

NextPolarizedState

Accessor and modifier functions for the NextPolarizedState optional element.

typedef ::mil::tatrc::physiology::datamodel::enumOpenClosed NextPolarizedState_type
 Element type. More...
 
typedef ::xsd::cxx::tree::optional< NextPolarizedState_typeNextPolarizedState_optional
 Element optional container type. More...
 
typedef ::xsd::cxx::tree::traits< NextPolarizedState_type, char > NextPolarizedState_traits
 Element traits type. More...
 
const NextPolarizedState_optionalNextPolarizedState () const
 Return a read-only (constant) reference to the element container. More...
 
NextPolarizedState_optionalNextPolarizedState ()
 Return a read-write reference to the element container. More...
 
void NextPolarizedState (const NextPolarizedState_type &x)
 Set the element value. More...
 
void NextPolarizedState (const NextPolarizedState_optional &x)
 Set the element value. More...
 
void NextPolarizedState (::std::unique_ptr< NextPolarizedState_type > p)
 Set the element value without copying. More...
 

Constructors

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

Member Typedef Documentation

Element traits type.

Element optional container type.

Element optional container type.

Element traits type.

Element optional container type.

Element traits type.

Element optional container type.

Element traits type.

Element traits type.

Element optional container type.

Element traits type.

Element traits type.

Element optional container type.

Element traits type.

Constructor & Destructor Documentation

mil::tatrc::physiology::datamodel::CircuitPathData::CircuitPathData ( )

Default constructor.

Note that this constructor leaves required elements and attributes uninitialized.

mil::tatrc::physiology::datamodel::CircuitPathData::CircuitPathData ( const Name_type Name,
const SourceNode_type SourceNode,
const TargetNode_type TargetNode 
)

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

mil::tatrc::physiology::datamodel::CircuitPathData::CircuitPathData ( ::std::unique_ptr< Name_type Name,
::std::unique_ptr< SourceNode_type SourceNode,
::std::unique_ptr< TargetNode_type TargetNode 
)

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

Destructor.

Member Function Documentation

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

Reimplemented in mil::tatrc::physiology::datamodel::ThermalCircuitPathData, mil::tatrc::physiology::datamodel::FluidCircuitPathData, and mil::tatrc::physiology::datamodel::ElectricalCircuitPathData.

const CircuitPathData::Name_type & mil::tatrc::physiology::datamodel::CircuitPathData::Name ( ) const

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

Returns
A constant reference to the element.
CircuitPathData::Name_type & mil::tatrc::physiology::datamodel::CircuitPathData::Name ( )

Return a read-write reference to the element.

Returns
A reference to the element.
void mil::tatrc::physiology::datamodel::CircuitPathData::Name ( const Name_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::CircuitPathData::Name ( ::std::unique_ptr< Name_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 CircuitPathData::NextPolarizedState_optional & mil::tatrc::physiology::datamodel::CircuitPathData::NextPolarizedState ( ) const

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

Returns
A constant reference to the optional container.
CircuitPathData::NextPolarizedState_optional & mil::tatrc::physiology::datamodel::CircuitPathData::NextPolarizedState ( )

Return a read-write reference to the element container.

Returns
A reference to the optional container.
void mil::tatrc::physiology::datamodel::CircuitPathData::NextPolarizedState ( const NextPolarizedState_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::CircuitPathData::NextPolarizedState ( const NextPolarizedState_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::CircuitPathData::NextPolarizedState ( ::std::unique_ptr< NextPolarizedState_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 CircuitPathData::NextSwitch_optional & mil::tatrc::physiology::datamodel::CircuitPathData::NextSwitch ( ) const

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

Returns
A constant reference to the optional container.
CircuitPathData::NextSwitch_optional & mil::tatrc::physiology::datamodel::CircuitPathData::NextSwitch ( )

Return a read-write reference to the element container.

Returns
A reference to the optional container.
void mil::tatrc::physiology::datamodel::CircuitPathData::NextSwitch ( const NextSwitch_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::CircuitPathData::NextSwitch ( const NextSwitch_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::CircuitPathData::NextSwitch ( ::std::unique_ptr< NextSwitch_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 CircuitPathData::NextValve_optional & mil::tatrc::physiology::datamodel::CircuitPathData::NextValve ( ) const

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

Returns
A constant reference to the optional container.
CircuitPathData::NextValve_optional & mil::tatrc::physiology::datamodel::CircuitPathData::NextValve ( )

Return a read-write reference to the element container.

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

CircuitPathData & mil::tatrc::physiology::datamodel::CircuitPathData::operator= ( const CircuitPathData 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 CircuitPathData::PolarizedState_optional & mil::tatrc::physiology::datamodel::CircuitPathData::PolarizedState ( ) const

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

Returns
A constant reference to the optional container.
CircuitPathData::PolarizedState_optional & mil::tatrc::physiology::datamodel::CircuitPathData::PolarizedState ( )

Return a read-write reference to the element container.

Returns
A reference to the optional container.
void mil::tatrc::physiology::datamodel::CircuitPathData::PolarizedState ( const PolarizedState_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::CircuitPathData::PolarizedState ( const PolarizedState_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::CircuitPathData::PolarizedState ( ::std::unique_ptr< PolarizedState_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 CircuitPathData::SourceNode_type & mil::tatrc::physiology::datamodel::CircuitPathData::SourceNode ( ) const

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

Returns
A constant reference to the element.
CircuitPathData::SourceNode_type & mil::tatrc::physiology::datamodel::CircuitPathData::SourceNode ( )

Return a read-write reference to the element.

Returns
A reference to the element.
void mil::tatrc::physiology::datamodel::CircuitPathData::SourceNode ( const SourceNode_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::CircuitPathData::SourceNode ( ::std::unique_ptr< SourceNode_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 CircuitPathData::Switch_optional & mil::tatrc::physiology::datamodel::CircuitPathData::Switch ( ) const

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

Returns
A constant reference to the optional container.
CircuitPathData::Switch_optional & mil::tatrc::physiology::datamodel::CircuitPathData::Switch ( )

Return a read-write reference to the element container.

Returns
A reference to the optional container.
void mil::tatrc::physiology::datamodel::CircuitPathData::Switch ( const Switch_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::CircuitPathData::Switch ( const Switch_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::CircuitPathData::Switch ( ::std::unique_ptr< Switch_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 CircuitPathData::TargetNode_type & mil::tatrc::physiology::datamodel::CircuitPathData::TargetNode ( ) const

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

Returns
A constant reference to the element.
CircuitPathData::TargetNode_type & mil::tatrc::physiology::datamodel::CircuitPathData::TargetNode ( )

Return a read-write reference to the element.

Returns
A reference to the element.
void mil::tatrc::physiology::datamodel::CircuitPathData::TargetNode ( const TargetNode_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::CircuitPathData::TargetNode ( ::std::unique_ptr< TargetNode_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 CircuitPathData::Valve_optional & mil::tatrc::physiology::datamodel::CircuitPathData::Valve ( ) const

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

Returns
A constant reference to the optional container.
CircuitPathData::Valve_optional & mil::tatrc::physiology::datamodel::CircuitPathData::Valve ( )

Return a read-write reference to the element container.

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