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

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

#include <ConfigurationFile.h>

Inheritance diagram for Cuboid:
Inheritance graph
Collaboration diagram for Cuboid:
Collaboration graph

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

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

N1

Accessor and modifier functions for the N1 required element.

typedef ::N11 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 ::N21 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...
 

N3

Accessor and modifier functions for the N3 required element.

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

Distance

Accessor and modifier functions for the Distance required element.

typedef ::Distance Distance_type
 Element type. More...
 
typedef ::xsd::cxx::tree::traits< Distance_type, char > Distance_traits
 Element traits type. More...
 
const Distance_typeDistance () const
 Return a read-only (constant) reference to the element. More...
 
Distance_typeDistance ()
 Return a read-write reference to the element. More...
 
void Distance (const Distance_type &x)
 Set the element value. More...
 
void Distance (::std::unique_ptr< Distance_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...
 

Brownian

Accessor and modifier functions for the Brownian required element.

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

DimensionBrownian

Accessor and modifier functions for the DimensionBrownian required element.

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

Sigma

Accessor and modifier functions for the Sigma optional element.

typedef ::Sigma Sigma_type
 Element type. More...
 
typedef ::xsd::cxx::tree::optional< Sigma_typeSigma_optional
 Element optional container type. More...
 
typedef ::xsd::cxx::tree::traits< Sigma_type, char > Sigma_traits
 Element traits type. More...
 
const Sigma_optionalSigma () const
 Return a read-only (constant) reference to the element container. More...
 
Sigma_optionalSigma ()
 Return a read-write reference to the element container. More...
 
void Sigma (const Sigma_type &x)
 Set the element value. More...
 
void Sigma (const Sigma_optional &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 optional element.

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

Fixed

Accessor and modifier functions for the Fixed optional element.

typedef ::xml_schema::boolean Fixed_type
 Element type. More...
 
typedef ::xsd::cxx::tree::optional< Fixed_typeFixed_optional
 Element optional container type. More...
 
typedef ::xsd::cxx::tree::traits< Fixed_type, char > Fixed_traits
 Element traits type. More...
 
const Fixed_optionalFixed () const
 Return a read-only (constant) reference to the element container. More...
 
Fixed_optionalFixed ()
 Return a read-write reference to the element container. More...
 
void Fixed (const Fixed_type &x)
 Set the element value. More...
 
void Fixed (const Fixed_optional &x)
 Set the element value. More...
 

Constructors

 Cuboid (const Position_type &, const Velocity_type &, const N1_type &, const N2_type &, const N3_type &, const Distance_type &, const Mass_type &, const Brownian_type &, const DimensionBrownian_type &)
 Create an instance from the ultimate base and initializers for required elements and attributes. More...
 
 Cuboid (::std::unique_ptr< Position_type >, ::std::unique_ptr< Velocity_type >, const N1_type &, const N2_type &, const N3_type &, const Distance_type &, const Mass_type &, const Brownian_type &, const DimensionBrownian_type &)
 Create an instance from the ultimate base and initializers for required elements and attributes (::std::unique_ptr version). More...
 
 Cuboid (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Create an instance from a DOM element. More...
 
 Cuboid (const Cuboid &x, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Copy constructor. More...
 
virtual Cuboid_clone (::xml_schema::flags f=0, ::xml_schema::container *c=0) const
 Copy the instance polymorphically. More...
 
Cuboidoperator= (const Cuboid &x)
 Copy assignment operator. More...
 
virtual ~Cuboid ()
 Destructor. More...
 

Detailed Description

Class corresponding to the Cuboid schema type.

Member Typedef Documentation

◆ Brownian_traits

typedef ::xsd::cxx::tree::traits< Brownian_type, char > Cuboid::Brownian_traits

Element traits type.

◆ Brownian_type

Element type.

◆ DimensionBrownian_traits

typedef ::xsd::cxx::tree::traits< DimensionBrownian_type, char > Cuboid::DimensionBrownian_traits

Element traits type.

◆ DimensionBrownian_type

Element type.

◆ Distance_traits

typedef ::xsd::cxx::tree::traits< Distance_type, char > Cuboid::Distance_traits

Element traits type.

◆ Distance_type

Element type.

◆ Epsilon_optional

typedef ::xsd::cxx::tree::optional< Epsilon_type > Cuboid::Epsilon_optional

Element optional container type.

◆ Epsilon_traits

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

Element traits type.

◆ Epsilon_type

Element type.

◆ Fixed_optional

typedef ::xsd::cxx::tree::optional< Fixed_type > Cuboid::Fixed_optional

Element optional container type.

◆ Fixed_traits

typedef ::xsd::cxx::tree::traits< Fixed_type, char > Cuboid::Fixed_traits

Element traits type.

◆ Fixed_type

Element type.

◆ Mass_traits

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

Element traits type.

◆ Mass_type

Element type.

◆ N1_traits

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

Element traits type.

◆ N1_type

typedef ::N11 Cuboid::N1_type

Element type.

◆ N2_traits

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

Element traits type.

◆ N2_type

typedef ::N21 Cuboid::N2_type

Element type.

◆ N3_traits

typedef ::xsd::cxx::tree::traits< N3_type, char > Cuboid::N3_traits

Element traits type.

◆ N3_type

typedef ::N3 Cuboid::N3_type

Element type.

◆ Position_traits

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

Element traits type.

◆ Position_type

Element type.

◆ Sigma_optional

typedef ::xsd::cxx::tree::optional< Sigma_type > Cuboid::Sigma_optional

Element optional container type.

◆ Sigma_traits

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

Element traits type.

◆ Sigma_type

Element type.

◆ Velocity_traits

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

Element traits type.

◆ Velocity_type

Element type.

Constructor & Destructor Documentation

◆ Cuboid() [1/4]

Cuboid::Cuboid ( const Position_type Position,
const Velocity_type Velocity,
const N1_type N1,
const N2_type N2,
const N3_type N3,
const Distance_type Distance,
const Mass_type Mass,
const Brownian_type Brownian,
const DimensionBrownian_type DimensionBrownian 
)

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

◆ Cuboid() [2/4]

Cuboid::Cuboid ( ::std::unique_ptr< Position_type Position,
::std::unique_ptr< Velocity_type Velocity,
const N1_type N1,
const N2_type N2,
const N3_type N3,
const Distance_type Distance,
const Mass_type Mass,
const Brownian_type Brownian,
const DimensionBrownian_type DimensionBrownian 
)

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.

◆ Cuboid() [3/4]

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

◆ Cuboid() [4/4]

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

◆ ~Cuboid()

Cuboid::~Cuboid ( )
virtual

Destructor.

Member Function Documentation

◆ _clone()

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

◆ Brownian() [1/4]

Cuboid::Brownian_type & Cuboid::Brownian ( )

Return a read-write reference to the element.

Returns
A reference to the element.

◆ Brownian() [2/4]

const Cuboid::Brownian_type & Cuboid::Brownian ( ) 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:

◆ Brownian() [3/4]

void Cuboid::Brownian ( ::std::unique_ptr< Brownian_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.

◆ Brownian() [4/4]

void Cuboid::Brownian ( const Brownian_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.

◆ DimensionBrownian() [1/4]

Cuboid::DimensionBrownian_type & Cuboid::DimensionBrownian ( )

Return a read-write reference to the element.

Returns
A reference to the element.

◆ DimensionBrownian() [2/4]

const Cuboid::DimensionBrownian_type & Cuboid::DimensionBrownian ( ) 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:

◆ DimensionBrownian() [3/4]

void Cuboid::DimensionBrownian ( ::std::unique_ptr< DimensionBrownian_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.

◆ DimensionBrownian() [4/4]

void Cuboid::DimensionBrownian ( const DimensionBrownian_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.

◆ Distance() [1/4]

Cuboid::Distance_type & Cuboid::Distance ( )

Return a read-write reference to the element.

Returns
A reference to the element.

◆ Distance() [2/4]

const Cuboid::Distance_type & Cuboid::Distance ( ) 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:

◆ Distance() [3/4]

void Cuboid::Distance ( ::std::unique_ptr< Distance_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.

◆ Distance() [4/4]

void Cuboid::Distance ( const Distance_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.

◆ Epsilon() [1/5]

Cuboid::Epsilon_optional & Cuboid::Epsilon ( )

Return a read-write reference to the element container.

Returns
A reference to the optional container.

◆ Epsilon() [2/5]

const Cuboid::Epsilon_optional & Cuboid::Epsilon ( ) 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:

◆ Epsilon() [3/5]

void Cuboid::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/5]

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

◆ Epsilon() [5/5]

void Cuboid::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.

◆ Fixed() [1/4]

Cuboid::Fixed_optional & Cuboid::Fixed ( )

Return a read-write reference to the element container.

Returns
A reference to the optional container.

◆ Fixed() [2/4]

const Cuboid::Fixed_optional & Cuboid::Fixed ( ) 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:

◆ Fixed() [3/4]

void Cuboid::Fixed ( const Fixed_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.

◆ Fixed() [4/4]

void Cuboid::Fixed ( const Fixed_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]

Cuboid::Mass_type & Cuboid::Mass ( )

Return a read-write reference to the element.

Returns
A reference to the element.

◆ Mass() [2/4]

const Cuboid::Mass_type & Cuboid::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 Cuboid::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 Cuboid::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]

Cuboid::N1_type & Cuboid::N1 ( )

Return a read-write reference to the element.

Returns
A reference to the element.

◆ N1() [2/4]

const Cuboid::N1_type & Cuboid::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 Cuboid::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 Cuboid::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]

Cuboid::N2_type & Cuboid::N2 ( )

Return a read-write reference to the element.

Returns
A reference to the element.

◆ N2() [2/4]

const Cuboid::N2_type & Cuboid::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 Cuboid::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 Cuboid::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.

◆ N3() [1/4]

Cuboid::N3_type & Cuboid::N3 ( )

Return a read-write reference to the element.

Returns
A reference to the element.

◆ N3() [2/4]

const Cuboid::N3_type & Cuboid::N3 ( ) 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:

◆ N3() [3/4]

void Cuboid::N3 ( ::std::unique_ptr< N3_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.

◆ N3() [4/4]

void Cuboid::N3 ( const N3_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=()

Cuboid & Cuboid::operator= ( const Cuboid 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]

Cuboid::Position_type & Cuboid::Position ( )

Return a read-write reference to the element.

Returns
A reference to the element.

◆ Position() [2/4]

const Cuboid::Position_type & Cuboid::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 Cuboid::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 Cuboid::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.

◆ Sigma() [1/5]

Cuboid::Sigma_optional & Cuboid::Sigma ( )

Return a read-write reference to the element container.

Returns
A reference to the optional container.

◆ Sigma() [2/5]

const Cuboid::Sigma_optional & Cuboid::Sigma ( ) 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:

◆ Sigma() [3/5]

void Cuboid::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/5]

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

◆ Sigma() [5/5]

void Cuboid::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]

Cuboid::Velocity_type & Cuboid::Velocity ( )

Return a read-write reference to the element.

Returns
A reference to the element.

◆ Velocity() [2/4]

const Cuboid::Velocity_type & Cuboid::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 Cuboid::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 Cuboid::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: