Molecular Dynamics  v0.4
Project for the Practical hosted by the Scientific Computing Chair
List of all members
Membrane Class Reference

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

#include <ConfigurationFile.h>

Inheritance diagram for Membrane:
Inheritance graph
Collaboration diagram for Membrane:
Collaboration graph

Pull

Accessor and modifier functions for the Pull required element.

typedef ::xml_schema::boolean Pull_type
 Element type. More...
 
typedef ::xsd::cxx::tree::traits< Pull_type, char > Pull_traits
 Element traits type. More...
 
const Pull_typePull () const
 Return a read-only (constant) reference to the element. More...
 
Pull_typePull ()
 Return a read-write reference to the element. More...
 
void Pull (const Pull_type &x)
 Set the element value. More...
 

PullingActiveUntil

Accessor and modifier functions for the PullingActiveUntil optional element.

typedef ::PullingActiveUntil PullingActiveUntil_type
 Element type. More...
 
typedef ::xsd::cxx::tree::optional< PullingActiveUntil_typePullingActiveUntil_optional
 Element optional container type. More...
 
typedef ::xsd::cxx::tree::traits< PullingActiveUntil_type, char > PullingActiveUntil_traits
 Element traits type. More...
 
const PullingActiveUntil_optionalPullingActiveUntil () const
 Return a read-only (constant) reference to the element container. More...
 
PullingActiveUntil_optionalPullingActiveUntil ()
 Return a read-write reference to the element container. More...
 
void PullingActiveUntil (const PullingActiveUntil_type &x)
 Set the element value. More...
 
void PullingActiveUntil (const PullingActiveUntil_optional &x)
 Set the element value. More...
 
void PullingActiveUntil (::std::unique_ptr< PullingActiveUntil_type > p)
 Set the element value without copying. More...
 

PullingForce

Accessor and modifier functions for the PullingForce optional element.

typedef ::PullingForce PullingForce_type
 Element type. More...
 
typedef ::xsd::cxx::tree::optional< PullingForce_typePullingForce_optional
 Element optional container type. More...
 
typedef ::xsd::cxx::tree::traits< PullingForce_type, char > PullingForce_traits
 Element traits type. More...
 
const PullingForce_optionalPullingForce () const
 Return a read-only (constant) reference to the element container. More...
 
PullingForce_optionalPullingForce ()
 Return a read-write reference to the element container. More...
 
void PullingForce (const PullingForce_type &x)
 Set the element value. More...
 
void PullingForce (const PullingForce_optional &x)
 Set the element value. More...
 
void PullingForce (::std::unique_ptr< PullingForce_type > p)
 Set the element value without copying. More...
 

r0

Accessor and modifier functions for the r0 required element.

typedef ::xml_schema::decimal r0_type
 Element type. More...
 
typedef ::xsd::cxx::tree::traits< r0_type, char, ::xsd::cxx::tree::schema_type::decimal > r0_traits
 Element traits type. More...
 
const r0_typer0 () const
 Return a read-only (constant) reference to the element. More...
 
r0_typer0 ()
 Return a read-write reference to the element. More...
 
void r0 (const r0_type &x)
 Set the element value. More...
 

k

Accessor and modifier functions for the k required element.

typedef ::xml_schema::decimal k_type
 Element type. More...
 
typedef ::xsd::cxx::tree::traits< k_type, char, ::xsd::cxx::tree::schema_type::decimal > k_traits
 Element traits type. More...
 
const k_typek () const
 Return a read-only (constant) reference to the element. More...
 
k_typek ()
 Return a read-write reference to the element. More...
 
void k (const k_type &x)
 Set the element value. More...
 

Velocity

Accessor and modifier functions for the Velocity required element.

typedef ::Velocity Velocity_type
 Element type. More...
 
typedef ::xsd::cxx::tree::traits< Velocity_type, char > Velocity_traits
 Element traits type. More...
 
const Velocity_typeVelocity () const
 Return a read-only (constant) reference to the element. More...
 
Velocity_typeVelocity ()
 Return a read-write reference to the element. More...
 
void Velocity (const Velocity_type &x)
 Set the element value. More...
 
void Velocity (::std::unique_ptr< Velocity_type > p)
 Set the element value without copying. More...
 

Position

Accessor and modifier functions for the Position required element.

typedef ::Position Position_type
 Element type. More...
 
typedef ::xsd::cxx::tree::traits< Position_type, char > Position_traits
 Element traits type. More...
 
const Position_typePosition () const
 Return a read-only (constant) reference to the element. More...
 
Position_typePosition ()
 Return a read-write reference to the element. More...
 
void Position (const Position_type &x)
 Set the element value. More...
 
void Position (::std::unique_ptr< Position_type > p)
 Set the element value without copying. More...
 

N1

Accessor and modifier functions for the N1 required element.

typedef ::N1 N1_type
 Element type. More...
 
typedef ::xsd::cxx::tree::traits< N1_type, char > N1_traits
 Element traits type. More...
 
const N1_typeN1 () const
 Return a read-only (constant) reference to the element. More...
 
N1_typeN1 ()
 Return a read-write reference to the element. More...
 
void N1 (const N1_type &x)
 Set the element value. More...
 
void N1 (::std::unique_ptr< N1_type > p)
 Set the element value without copying. More...
 

N2

Accessor and modifier functions for the N2 required element.

typedef ::N2 N2_type
 Element type. More...
 
typedef ::xsd::cxx::tree::traits< N2_type, char > N2_traits
 Element traits type. More...
 
const N2_typeN2 () const
 Return a read-only (constant) reference to the element. More...
 
N2_typeN2 ()
 Return a read-write reference to the element. More...
 
void N2 (const N2_type &x)
 Set the element value. More...
 
void N2 (::std::unique_ptr< N2_type > p)
 Set the element value without copying. More...
 

Mass

Accessor and modifier functions for the Mass required element.

typedef ::Mass Mass_type
 Element type. More...
 
typedef ::xsd::cxx::tree::traits< Mass_type, char > Mass_traits
 Element traits type. More...
 
const Mass_typeMass () const
 Return a read-only (constant) reference to the element. More...
 
Mass_typeMass ()
 Return a read-write reference to the element. More...
 
void Mass (const Mass_type &x)
 Set the element value. More...
 
void Mass (::std::unique_ptr< Mass_type > p)
 Set the element value without copying. More...
 

InterParticleDistance

Accessor and modifier functions for the InterParticleDistance required element.

typedef ::InterParticleDistance InterParticleDistance_type
 Element type. More...
 
typedef ::xsd::cxx::tree::traits< InterParticleDistance_type, char > InterParticleDistance_traits
 Element traits type. More...
 
const InterParticleDistance_typeInterParticleDistance () const
 Return a read-only (constant) reference to the element. More...
 
InterParticleDistance_typeInterParticleDistance ()
 Return a read-write reference to the element. More...
 
void InterParticleDistance (const InterParticleDistance_type &x)
 Set the element value. More...
 
void InterParticleDistance (::std::unique_ptr< InterParticleDistance_type > p)
 Set the element value without copying. More...
 

Sigma

Accessor and modifier functions for the Sigma required element.

typedef ::Sigma Sigma_type
 Element type. More...
 
typedef ::xsd::cxx::tree::traits< Sigma_type, char > Sigma_traits
 Element traits type. More...
 
const Sigma_typeSigma () const
 Return a read-only (constant) reference to the element. More...
 
Sigma_typeSigma ()
 Return a read-write reference to the element. More...
 
void Sigma (const Sigma_type &x)
 Set the element value. More...
 
void Sigma (::std::unique_ptr< Sigma_type > p)
 Set the element value without copying. More...
 

Epsilon

Accessor and modifier functions for the Epsilon required element.

typedef ::Epsilon Epsilon_type
 Element type. More...
 
typedef ::xsd::cxx::tree::traits< Epsilon_type, char > Epsilon_traits
 Element traits type. More...
 
const Epsilon_typeEpsilon () const
 Return a read-only (constant) reference to the element. More...
 
Epsilon_typeEpsilon ()
 Return a read-write reference to the element. More...
 
void Epsilon (const Epsilon_type &x)
 Set the element value. More...
 
void Epsilon (::std::unique_ptr< Epsilon_type > p)
 Set the element value without copying. More...
 

Constructors

 Membrane (const Pull_type &, const r0_type &, const k_type &, const Velocity_type &, const Position_type &, const N1_type &, const N2_type &, const Mass_type &, const InterParticleDistance_type &, const Sigma_type &, const Epsilon_type &)
 Create an instance from the ultimate base and initializers for required elements and attributes. More...
 
 Membrane (const Pull_type &, const r0_type &, const k_type &, ::std::unique_ptr< Velocity_type >, ::std::unique_ptr< Position_type >, const N1_type &, const N2_type &, const Mass_type &, const InterParticleDistance_type &, const Sigma_type &, const Epsilon_type &)
 Create an instance from the ultimate base and initializers for required elements and attributes (::std::unique_ptr version). More...
 
 Membrane (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Create an instance from a DOM element. More...
 
 Membrane (const Membrane &x, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Copy constructor. More...
 
virtual Membrane_clone (::xml_schema::flags f=0, ::xml_schema::container *c=0) const
 Copy the instance polymorphically. More...
 
Membraneoperator= (const Membrane &x)
 Copy assignment operator. More...
 
virtual ~Membrane ()
 Destructor. More...
 

Detailed Description

Class corresponding to the Membrane schema type.

Member Typedef Documentation

◆ Epsilon_traits

typedef ::xsd::cxx::tree::traits< Epsilon_type, char > Membrane::Epsilon_traits

Element traits type.

◆ Epsilon_type

Element type.

◆ InterParticleDistance_traits

typedef ::xsd::cxx::tree::traits< InterParticleDistance_type, char > Membrane::InterParticleDistance_traits

Element traits type.

◆ InterParticleDistance_type

Element type.

◆ k_traits

typedef ::xsd::cxx::tree::traits< k_type, char, ::xsd::cxx::tree::schema_type::decimal > Membrane::k_traits

Element traits type.

◆ k_type

Element type.

◆ Mass_traits

typedef ::xsd::cxx::tree::traits< Mass_type, char > Membrane::Mass_traits

Element traits type.

◆ Mass_type

Element type.

◆ N1_traits

typedef ::xsd::cxx::tree::traits< N1_type, char > Membrane::N1_traits

Element traits type.

◆ N1_type

typedef ::N1 Membrane::N1_type

Element type.

◆ N2_traits

typedef ::xsd::cxx::tree::traits< N2_type, char > Membrane::N2_traits

Element traits type.

◆ N2_type

typedef ::N2 Membrane::N2_type

Element type.

◆ Position_traits

typedef ::xsd::cxx::tree::traits< Position_type, char > Membrane::Position_traits

Element traits type.

◆ Position_type

Element type.

◆ Pull_traits

typedef ::xsd::cxx::tree::traits< Pull_type, char > Membrane::Pull_traits

Element traits type.

◆ Pull_type

Element type.

◆ PullingActiveUntil_optional

typedef ::xsd::cxx::tree::optional< PullingActiveUntil_type > Membrane::PullingActiveUntil_optional

Element optional container type.

◆ PullingActiveUntil_traits

typedef ::xsd::cxx::tree::traits< PullingActiveUntil_type, char > Membrane::PullingActiveUntil_traits

Element traits type.

◆ PullingActiveUntil_type

Element type.

◆ PullingForce_optional

typedef ::xsd::cxx::tree::optional< PullingForce_type > Membrane::PullingForce_optional

Element optional container type.

◆ PullingForce_traits

typedef ::xsd::cxx::tree::traits< PullingForce_type, char > Membrane::PullingForce_traits

Element traits type.

◆ PullingForce_type

Element type.

◆ r0_traits

typedef ::xsd::cxx::tree::traits< r0_type, char, ::xsd::cxx::tree::schema_type::decimal > Membrane::r0_traits

Element traits type.

◆ r0_type

Element type.

◆ Sigma_traits

typedef ::xsd::cxx::tree::traits< Sigma_type, char > Membrane::Sigma_traits

Element traits type.

◆ Sigma_type

Element type.

◆ Velocity_traits

typedef ::xsd::cxx::tree::traits< Velocity_type, char > Membrane::Velocity_traits

Element traits type.

◆ Velocity_type

Element type.

Constructor & Destructor Documentation

◆ Membrane() [1/4]

Membrane::Membrane ( const Pull_type Pull,
const r0_type r0,
const k_type k,
const Velocity_type Velocity,
const Position_type Position,
const N1_type N1,
const N2_type N2,
const Mass_type Mass,
const InterParticleDistance_type InterParticleDistance,
const Sigma_type Sigma,
const Epsilon_type Epsilon 
)

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

◆ Membrane() [2/4]

Membrane::Membrane ( const Pull_type Pull,
const r0_type r0,
const k_type k,
::std::unique_ptr< Velocity_type Velocity,
::std::unique_ptr< Position_type Position,
const N1_type N1,
const N2_type N2,
const Mass_type Mass,
const InterParticleDistance_type InterParticleDistance,
const Sigma_type Sigma,
const Epsilon_type Epsilon 
)

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.

◆ Membrane() [3/4]

Membrane::Membrane ( 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.

◆ Membrane() [4/4]

Membrane::Membrane ( const Membrane 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.

◆ ~Membrane()

Membrane::~Membrane ( )
virtual

Destructor.

Member Function Documentation

◆ _clone()

Membrane * Membrane::_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.

◆ Epsilon() [1/4]

Membrane::Epsilon_type & Membrane::Epsilon ( )

Return a read-write reference to the element.

Returns
A reference to the element.

◆ Epsilon() [2/4]

const Membrane::Epsilon_type & Membrane::Epsilon ( ) const

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

Returns
A constant reference to the element.
Here is the caller graph for this function:

◆ Epsilon() [3/4]

void Membrane::Epsilon ( ::std::unique_ptr< Epsilon_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.

◆ Epsilon() [4/4]

void Membrane::Epsilon ( const Epsilon_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.

◆ InterParticleDistance() [1/4]

Membrane::InterParticleDistance_type & Membrane::InterParticleDistance ( )

Return a read-write reference to the element.

Returns
A reference to the element.

◆ InterParticleDistance() [2/4]

const Membrane::InterParticleDistance_type & Membrane::InterParticleDistance ( ) const

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

Returns
A constant reference to the element.
Here is the caller graph for this function:

◆ InterParticleDistance() [3/4]

void Membrane::InterParticleDistance ( ::std::unique_ptr< InterParticleDistance_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.

◆ InterParticleDistance() [4/4]

void Membrane::InterParticleDistance ( const InterParticleDistance_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.

◆ k() [1/3]

Membrane::k_type & Membrane::k ( )

Return a read-write reference to the element.

Returns
A reference to the element.

◆ k() [2/3]

const Membrane::k_type & Membrane::k ( ) const

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

Returns
A constant reference to the element.
Here is the caller graph for this function:

◆ k() [3/3]

void Membrane::k ( const k_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.

◆ Mass() [1/4]

Membrane::Mass_type & Membrane::Mass ( )

Return a read-write reference to the element.

Returns
A reference to the element.

◆ Mass() [2/4]

const Membrane::Mass_type & Membrane::Mass ( ) const

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

Returns
A constant reference to the element.
Here is the caller graph for this function:

◆ Mass() [3/4]

void Membrane::Mass ( ::std::unique_ptr< Mass_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.

◆ Mass() [4/4]

void Membrane::Mass ( const Mass_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.

◆ N1() [1/4]

Membrane::N1_type & Membrane::N1 ( )

Return a read-write reference to the element.

Returns
A reference to the element.

◆ N1() [2/4]

const Membrane::N1_type & Membrane::N1 ( ) const

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

Returns
A constant reference to the element.
Here is the caller graph for this function:

◆ N1() [3/4]

void Membrane::N1 ( ::std::unique_ptr< N1_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.

◆ N1() [4/4]

void Membrane::N1 ( const N1_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.

◆ N2() [1/4]

Membrane::N2_type & Membrane::N2 ( )

Return a read-write reference to the element.

Returns
A reference to the element.

◆ N2() [2/4]

const Membrane::N2_type & Membrane::N2 ( ) const

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

Returns
A constant reference to the element.
Here is the caller graph for this function:

◆ N2() [3/4]

void Membrane::N2 ( ::std::unique_ptr< N2_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.

◆ N2() [4/4]

void Membrane::N2 ( const N2_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.

◆ operator=()

Membrane & Membrane::operator= ( const Membrane 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.

◆ Position() [1/4]

Membrane::Position_type & Membrane::Position ( )

Return a read-write reference to the element.

Returns
A reference to the element.

◆ Position() [2/4]

const Membrane::Position_type & Membrane::Position ( ) const

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

Returns
A constant reference to the element.
Here is the caller graph for this function:

◆ Position() [3/4]

void Membrane::Position ( ::std::unique_ptr< Position_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.

◆ Position() [4/4]

void Membrane::Position ( const Position_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.

◆ Pull() [1/3]

Membrane::Pull_type & Membrane::Pull ( )

Return a read-write reference to the element.

Returns
A reference to the element.

◆ Pull() [2/3]

const Membrane::Pull_type & Membrane::Pull ( ) const

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

Returns
A constant reference to the element.
Here is the caller graph for this function:

◆ Pull() [3/3]

void Membrane::Pull ( const Pull_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.

◆ PullingActiveUntil() [1/5]

Membrane::PullingActiveUntil_optional & Membrane::PullingActiveUntil ( )

Return a read-write reference to the element container.

Returns
A reference to the optional container.

◆ PullingActiveUntil() [2/5]

const Membrane::PullingActiveUntil_optional & Membrane::PullingActiveUntil ( ) const

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

Returns
A constant reference to the optional container.
Here is the caller graph for this function:

◆ PullingActiveUntil() [3/5]

void Membrane::PullingActiveUntil ( ::std::unique_ptr< PullingActiveUntil_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.

◆ PullingActiveUntil() [4/5]

void Membrane::PullingActiveUntil ( const PullingActiveUntil_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.

◆ PullingActiveUntil() [5/5]

void Membrane::PullingActiveUntil ( const PullingActiveUntil_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.

◆ PullingForce() [1/5]

Membrane::PullingForce_optional & Membrane::PullingForce ( )

Return a read-write reference to the element container.

Returns
A reference to the optional container.

◆ PullingForce() [2/5]

const Membrane::PullingForce_optional & Membrane::PullingForce ( ) const

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

Returns
A constant reference to the optional container.
Here is the caller graph for this function:

◆ PullingForce() [3/5]

void Membrane::PullingForce ( ::std::unique_ptr< PullingForce_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.

◆ PullingForce() [4/5]

void Membrane::PullingForce ( const PullingForce_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.

◆ PullingForce() [5/5]

void Membrane::PullingForce ( const PullingForce_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.

◆ r0() [1/3]

Membrane::r0_type & Membrane::r0 ( )

Return a read-write reference to the element.

Returns
A reference to the element.

◆ r0() [2/3]

const Membrane::r0_type & Membrane::r0 ( ) const

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

Returns
A constant reference to the element.
Here is the caller graph for this function:

◆ r0() [3/3]

void Membrane::r0 ( const r0_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.

◆ Sigma() [1/4]

Membrane::Sigma_type & Membrane::Sigma ( )

Return a read-write reference to the element.

Returns
A reference to the element.

◆ Sigma() [2/4]

const Membrane::Sigma_type & Membrane::Sigma ( ) const

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

Returns
A constant reference to the element.
Here is the caller graph for this function:

◆ Sigma() [3/4]

void Membrane::Sigma ( ::std::unique_ptr< Sigma_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.

◆ Sigma() [4/4]

void Membrane::Sigma ( const Sigma_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.

◆ Velocity() [1/4]

Membrane::Velocity_type & Membrane::Velocity ( )

Return a read-write reference to the element.

Returns
A reference to the element.

◆ Velocity() [2/4]

const Membrane::Velocity_type & Membrane::Velocity ( ) const

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

Returns
A constant reference to the element.
Here is the caller graph for this function:

◆ Velocity() [3/4]

void Membrane::Velocity ( ::std::unique_ptr< Velocity_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.

◆ Velocity() [4/4]

void Membrane::Velocity ( const Velocity_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.


The documentation for this class was generated from the following files: