mil::tatrc::physiology::datamodel::CircuitData Class Reference

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

#include <Circuit.hxx>

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

Public Member Functions

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

ReferenceNode

Accessor and modifier functions for the ReferenceNode sequence element.

typedef ::xml_schema::string ReferenceNode_type
 Element type. More...
 
typedef ::xsd::cxx::tree::sequence< ReferenceNode_typeReferenceNode_sequence
 Element sequence container type. More...
 
typedef ReferenceNode_sequence::iterator ReferenceNode_iterator
 Element iterator type. More...
 
typedef ReferenceNode_sequence::const_iterator ReferenceNode_const_iterator
 Element constant iterator type. More...
 
typedef ::xsd::cxx::tree::traits< ReferenceNode_type, char > ReferenceNode_traits
 Element traits type. More...
 
const ReferenceNode_sequenceReferenceNode () const
 Return a read-only (constant) reference to the element sequence. More...
 
ReferenceNode_sequenceReferenceNode ()
 Return a read-write reference to the element sequence. More...
 
void ReferenceNode (const ReferenceNode_sequence &s)
 Copy elements from a given sequence. More...
 

Constructors

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

Member Typedef Documentation

Element traits type.

Element constant iterator type.

Element iterator type.

Element sequence container type.

Element traits type.

Constructor & Destructor Documentation

mil::tatrc::physiology::datamodel::CircuitData::CircuitData ( )

Default constructor.

Note that this constructor leaves required elements and attributes uninitialized.

mil::tatrc::physiology::datamodel::CircuitData::CircuitData ( const Name_type Name)

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

mil::tatrc::physiology::datamodel::CircuitData::CircuitData ( ::std::unique_ptr< Name_type Name)

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

Destructor.

Member Function Documentation

CircuitData * mil::tatrc::physiology::datamodel::CircuitData::_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::ThermalCircuitData, mil::tatrc::physiology::datamodel::FluidCircuitData, and mil::tatrc::physiology::datamodel::ElectricalCircuitData.

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

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

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

Return a read-write reference to the element.

Returns
A reference to the element.
void mil::tatrc::physiology::datamodel::CircuitData::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::CircuitData::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.

CircuitData & mil::tatrc::physiology::datamodel::CircuitData::operator= ( const CircuitData 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 CircuitData::ReferenceNode_sequence & mil::tatrc::physiology::datamodel::CircuitData::ReferenceNode ( ) const

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

Returns
A constant reference to the sequence container.
CircuitData::ReferenceNode_sequence & mil::tatrc::physiology::datamodel::CircuitData::ReferenceNode ( )

Return a read-write reference to the element sequence.

Returns
A reference to the sequence container.
void mil::tatrc::physiology::datamodel::CircuitData::ReferenceNode ( const ReferenceNode_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.