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

#include <ConfigurationFile.h>

Inheritance diagram for Disc:

Collaboration diagram for Disc:

Center
Accessor and modifier functions for the Center required element.
typedef ::Center	Center_type
	Element type. More...

typedef ::xsd::cxx::tree::traits< Center_type, char >	Center_traits
	Element traits type. More...

const Center_type &	Center () const
	Return a read-only (constant) reference to the element. More...

Center_type &	Center ()
	Return a read-write reference to the element. More...

void	Center (const Center_type &x)
	Set the element value. More...

void	Center (::std::unique_ptr< Center_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_type &	Mass () const
	Return a read-only (constant) reference to the element. More...

Mass_type &	Mass ()
	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_type &	InterParticleDistance () const
	Return a read-only (constant) reference to the element. More...

InterParticleDistance_type &	InterParticleDistance ()
	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...

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_type &	Velocity () const
	Return a read-only (constant) reference to the element. More...

Velocity_type &	Velocity ()
	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...

Radius
Accessor and modifier functions for the Radius required element.
typedef ::xml_schema::decimal	Radius_type
	Element type. More...

typedef ::xsd::cxx::tree::traits< Radius_type, char, ::xsd::cxx::tree::schema_type::decimal >	Radius_traits
	Element traits type. More...

const Radius_type &	Radius () const
	Return a read-only (constant) reference to the element. More...

Radius_type &	Radius ()
	Return a read-write reference to the element. More...

void	Radius (const Radius_type &x)
	Set the element value. More...

Brownian
Accessor and modifier functions for the Brownian required element.
typedef ::xml_schema::decimal	Brownian_type
	Element type. More...

typedef ::xsd::cxx::tree::traits< Brownian_type, char, ::xsd::cxx::tree::schema_type::decimal >	Brownian_traits
	Element traits type. More...

const Brownian_type &	Brownian () const
	Return a read-only (constant) reference to the element. More...

Brownian_type &	Brownian ()
	Return a read-write reference to the element. More...

void	Brownian (const Brownian_type &x)
	Set the element value. More...

DimensionBrownian
Accessor and modifier functions for the DimensionBrownian required element.
typedef ::xml_schema::unsigned_byte	DimensionBrownian_type
	Element type. More...

typedef ::xsd::cxx::tree::traits< DimensionBrownian_type, char >	DimensionBrownian_traits
	Element traits type. More...

const DimensionBrownian_type &	DimensionBrownian () const
	Return a read-only (constant) reference to the element. More...

DimensionBrownian_type &	DimensionBrownian ()
	Return a read-write reference to the element. More...

void	DimensionBrownian (const DimensionBrownian_type &x)
	Set the element value. More...

Sigma
Accessor and modifier functions for the Sigma optional element.
typedef ::Sigma	Sigma_type
	Element type. More...

typedef ::xsd::cxx::tree::optional< Sigma_type >	Sigma_optional
	Element optional container type. More...

typedef ::xsd::cxx::tree::traits< Sigma_type, char >	Sigma_traits
	Element traits type. More...

const Sigma_optional &	Sigma () const
	Return a read-only (constant) reference to the element container. More...

Sigma_optional &	Sigma ()
	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_type >	Epsilon_optional
	Element optional container type. More...

typedef ::xsd::cxx::tree::traits< Epsilon_type, char >	Epsilon_traits
	Element traits type. More...

const Epsilon_optional &	Epsilon () const
	Return a read-only (constant) reference to the element container. More...

Epsilon_optional &	Epsilon ()
	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_type >	Fixed_optional
	Element optional container type. More...

typedef ::xsd::cxx::tree::traits< Fixed_type, char >	Fixed_traits
	Element traits type. More...

const Fixed_optional &	Fixed () const
	Return a read-only (constant) reference to the element container. More...

Fixed_optional &	Fixed ()
	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
	Disc (const Center_type &, const Mass_type &, const InterParticleDistance_type &, const Velocity_type &, const Radius_type &, const Brownian_type &, const DimensionBrownian_type &)
	Create an instance from the ultimate base and initializers for required elements and attributes. More...

	Disc (::std::unique_ptr< Center_type >, const Mass_type &, const InterParticleDistance_type &, ::std::unique_ptr< Velocity_type >, const Radius_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...

	Disc (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
	Create an instance from a DOM element. More...

	Disc (const Disc &x, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
	Copy constructor. More...

virtual Disc *	_clone (::xml_schema::flags f=0, ::xml_schema::container *c=0) const
	Copy the instance polymorphically. More...

Disc &	operator= (const Disc &x)
	Copy assignment operator. More...

virtual	~Disc ()
	Destructor. More...

Detailed Description

Class corresponding to the Disc schema type.

Member Typedef Documentation

◆ Brownian_traits

typedef ::xsd::cxx::tree::traits< Brownian_type, char, ::xsd::cxx::tree::schema_type::decimal > Disc::Brownian_traits

Element traits type.

◆ Brownian_type

typedef ::xml_schema::decimal Disc::Brownian_type

Element type.

◆ Center_traits

typedef ::xsd::cxx::tree::traits< Center_type, char > Disc::Center_traits

Element traits type.

◆ Center_type

typedef ::Center Disc::Center_type

Element type.

◆ DimensionBrownian_traits

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

Element traits type.

◆ DimensionBrownian_type

typedef ::xml_schema::unsigned_byte Disc::DimensionBrownian_type

Element type.

◆ Epsilon_optional

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

Element optional container type.

◆ Epsilon_traits

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

Element traits type.

◆ Epsilon_type

typedef ::Epsilon Disc::Epsilon_type

Element type.

◆ Fixed_optional

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

Element optional container type.

◆ Fixed_traits

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

Element traits type.

◆ Fixed_type

typedef ::xml_schema::boolean Disc::Fixed_type

Element type.

◆ InterParticleDistance_traits

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

Element traits type.

◆ InterParticleDistance_type

typedef ::InterParticleDistance Disc::InterParticleDistance_type

Element type.

◆ Mass_traits

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

Element traits type.

◆ Mass_type

typedef ::Mass Disc::Mass_type

Element type.

◆ Radius_traits

typedef ::xsd::cxx::tree::traits< Radius_type, char, ::xsd::cxx::tree::schema_type::decimal > Disc::Radius_traits

Element traits type.

◆ Radius_type

typedef ::xml_schema::decimal Disc::Radius_type

Element type.

◆ Sigma_optional

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

Element optional container type.

◆ Sigma_traits

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

Element traits type.

◆ Sigma_type

typedef ::Sigma Disc::Sigma_type

Element type.

◆ Velocity_traits

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

Element traits type.

◆ Velocity_type

typedef ::Velocity Disc::Velocity_type

Element type.

Constructor & Destructor Documentation

◆ Disc() [1/4]

Disc::Disc	(	const Center_type &	Center,
		const Mass_type &	Mass,
		const InterParticleDistance_type &	InterParticleDistance,
		const Velocity_type &	Velocity,
		const Radius_type &	Radius,
		const Brownian_type &	Brownian,
		const DimensionBrownian_type &	DimensionBrownian
	)

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

◆ Disc() [2/4]

Disc::Disc	(	::std::unique_ptr< Center_type >	Center,
		const Mass_type &	Mass,
		const InterParticleDistance_type &	InterParticleDistance,
		::std::unique_ptr< Velocity_type >	Velocity,
		const Radius_type &	Radius,
		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.

◆ Disc() [3/4]

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

◆ Disc() [4/4]

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

◆ ~Disc()

Disc::~Disc ( )

virtual

Destructor.

Member Function Documentation

◆ _clone()

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

◆ Brownian() [1/3]

Disc::Brownian_type & Disc::Brownian ( )

Return a read-write reference to the element.

Returns: A reference to the element.

◆ Brownian() [2/3]

const Disc::Brownian_type & Disc::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/3]

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

◆ Center() [1/4]

Disc::Center_type & Disc::Center ( )

Return a read-write reference to the element.

Returns: A reference to the element.

◆ Center() [2/4]

const Disc::Center_type & Disc::Center ( ) 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:

◆ Center() [3/4]

void Disc::Center ( ::std::unique_ptr< Center_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.

◆ Center() [4/4]

void Disc::Center ( const Center_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.

◆ DimensionBrownian() [1/3]

Disc::DimensionBrownian_type & Disc::DimensionBrownian ( )

Return a read-write reference to the element.

Returns: A reference to the element.

◆ DimensionBrownian() [2/3]

const Disc::DimensionBrownian_type & Disc::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/3]

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

◆ Epsilon() [1/5]

Disc::Epsilon_optional & Disc::Epsilon ( )

Return a read-write reference to the element container.

Returns: A reference to the optional container.

◆ Epsilon() [2/5]

const Disc::Epsilon_optional & Disc::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 Disc::Epsilon ( ::std::unique_ptr< Epsilon_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.

◆ Epsilon() [4/5]

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

◆ Epsilon() [5/5]

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

◆ Fixed() [1/4]

Disc::Fixed_optional & Disc::Fixed ( )

Return a read-write reference to the element container.

Returns: A reference to the optional container.

◆ Fixed() [2/4]

const Disc::Fixed_optional & Disc::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 Disc::Fixed ( const Fixed_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.

◆ Fixed() [4/4]

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

◆ InterParticleDistance() [1/4]

Disc::InterParticleDistance_type & Disc::InterParticleDistance ( )

Return a read-write reference to the element.

Returns: A reference to the element.

◆ InterParticleDistance() [2/4]

const Disc::InterParticleDistance_type & Disc::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 Disc::InterParticleDistance ( ::std::unique_ptr< InterParticleDistance_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.

◆ InterParticleDistance() [4/4]

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

◆ Mass() [1/4]

Disc::Mass_type & Disc::Mass ( )

Return a read-write reference to the element.

Returns: A reference to the element.

◆ Mass() [2/4]

const Disc::Mass_type & Disc::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 Disc::Mass ( ::std::unique_ptr< Mass_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.

◆ Mass() [4/4]

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

◆ operator=()

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

◆ Radius() [1/3]

Disc::Radius_type & Disc::Radius ( )

Return a read-write reference to the element.

Returns: A reference to the element.

◆ Radius() [2/3]

const Disc::Radius_type & Disc::Radius ( ) 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:

◆ Radius() [3/3]

void Disc::Radius ( const Radius_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.

◆ Sigma() [1/5]

Disc::Sigma_optional & Disc::Sigma ( )

Return a read-write reference to the element container.

Returns: A reference to the optional container.

◆ Sigma() [2/5]

const Disc::Sigma_optional & Disc::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 Disc::Sigma ( ::std::unique_ptr< Sigma_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.

◆ Sigma() [4/5]

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

◆ Sigma() [5/5]

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

◆ Velocity() [1/4]

Disc::Velocity_type & Disc::Velocity ( )

Return a read-write reference to the element.

Returns: A reference to the element.

◆ Velocity() [2/4]

const Disc::Velocity_type & Disc::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 Disc::Velocity ( ::std::unique_ptr< Velocity_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.

◆ Velocity() [4/4]

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

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

/home/runner/work/MolSim/MolSim/src/fileHandling/reader/XMLHandling/ConfigurationFile.h
/home/runner/work/MolSim/MolSim/src/fileHandling/reader/XMLHandling/ConfigurationFile.cpp

Center

Mass

InterParticleDistance

Velocity

Radius

Brownian

DimensionBrownian

Sigma

Epsilon

Fixed

Constructors

Detailed Description

Member Typedef Documentation

◆ Brownian_traits

◆ Brownian_type

◆ Center_traits

◆ Center_type

◆ DimensionBrownian_traits

◆ DimensionBrownian_type

◆ Epsilon_optional

◆ Epsilon_traits

◆ Epsilon_type

◆ Fixed_optional

◆ Fixed_traits

◆ Fixed_type

◆ InterParticleDistance_traits

◆ InterParticleDistance_type

◆ Mass_traits

◆ Mass_type

◆ Radius_traits

◆ Radius_type

◆ Sigma_optional

◆ Sigma_traits

◆ Sigma_type

◆ Velocity_traits

◆ Velocity_type

Constructor & Destructor Documentation

◆ Disc() [1/4]

◆ Disc() [2/4]

◆ Disc() [3/4]

◆ Disc() [4/4]

◆ ~Disc()

Member Function Documentation

◆ _clone()

◆ Brownian() [1/3]

◆ Brownian() [2/3]

◆ Brownian() [3/3]

◆ Center() [1/4]

◆ Center() [2/4]

◆ Center() [3/4]

◆ Center() [4/4]

◆ DimensionBrownian() [1/3]

◆ DimensionBrownian() [2/3]

◆ DimensionBrownian() [3/3]

◆ Epsilon() [1/5]

◆ Epsilon() [2/5]

◆ Epsilon() [3/5]

◆ Epsilon() [4/5]

◆ Epsilon() [5/5]

◆ Fixed() [1/4]

◆ Fixed() [2/4]

◆ Fixed() [3/4]

◆ Fixed() [4/4]

◆ InterParticleDistance() [1/4]

◆ InterParticleDistance() [2/4]

◆ InterParticleDistance() [3/4]

◆ InterParticleDistance() [4/4]

◆ Mass() [1/4]

◆ Mass() [2/4]

◆ Mass() [3/4]

◆ Mass() [4/4]

◆ operator=()

◆ Radius() [1/3]

◆ Radius() [2/3]

◆ Radius() [3/3]

◆ Sigma() [1/5]

◆ Sigma() [2/5]

◆ Sigma() [3/5]

◆ Sigma() [4/5]

◆ Sigma() [5/5]