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

#include <ConfigurationFile.h>

Inheritance diagram for ThermostatConfig:

Collaboration diagram for ThermostatConfig:

Type
Accessor and modifier functions for the Type required element.
typedef ::Type	Type_type
	Element type. More...

typedef ::xsd::cxx::tree::traits< Type_type, char >	Type_traits
	Element traits type. More...

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

Type_type &	Type ()
	Return a read-write reference to the element. More...

void	Type (const Type_type &x)
	Set the element value. More...

void	Type (::std::unique_ptr< Type_type > p)
	Set the element value without copying. More...

InitialTemperature
Accessor and modifier functions for the InitialTemperature required element.
typedef ::InitialTemperature	InitialTemperature_type
	Element type. More...

typedef ::xsd::cxx::tree::traits< InitialTemperature_type, char >	InitialTemperature_traits
	Element traits type. More...

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

InitialTemperature_type &	InitialTemperature ()
	Return a read-write reference to the element. More...

void	InitialTemperature (const InitialTemperature_type &x)
	Set the element value. More...

void	InitialTemperature (::std::unique_ptr< InitialTemperature_type > p)
	Set the element value without copying. More...

TargetTemperature
Accessor and modifier functions for the TargetTemperature required element.
typedef ::TargetTemperature	TargetTemperature_type
	Element type. More...

typedef ::xsd::cxx::tree::traits< TargetTemperature_type, char >	TargetTemperature_traits
	Element traits type. More...

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

TargetTemperature_type &	TargetTemperature ()
	Return a read-write reference to the element. More...

void	TargetTemperature (const TargetTemperature_type &x)
	Set the element value. More...

void	TargetTemperature (::std::unique_ptr< TargetTemperature_type > p)
	Set the element value without copying. More...

InitialBrownian
Accessor and modifier functions for the InitialBrownian required element.
typedef ::xml_schema::boolean	InitialBrownian_type
	Element type. More...

typedef ::xsd::cxx::tree::traits< InitialBrownian_type, char >	InitialBrownian_traits
	Element traits type. More...

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

InitialBrownian_type &	InitialBrownian ()
	Return a read-write reference to the element. More...

void	InitialBrownian (const InitialBrownian_type &x)
	Set the element value. More...

ScalingGradually
Accessor and modifier functions for the ScalingGradually required element.
typedef ::xml_schema::boolean	ScalingGradually_type
	Element type. More...

typedef ::xsd::cxx::tree::traits< ScalingGradually_type, char >	ScalingGradually_traits
	Element traits type. More...

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

ScalingGradually_type &	ScalingGradually ()
	Return a read-write reference to the element. More...

void	ScalingGradually (const ScalingGradually_type &x)
	Set the element value. More...

MaximumTemperatureChange
Accessor and modifier functions for the MaximumTemperatureChange optional element.
typedef ::MaximumTemperatureChange	MaximumTemperatureChange_type
	Element type. More...

typedef ::xsd::cxx::tree::optional< MaximumTemperatureChange_type >	MaximumTemperatureChange_optional
	Element optional container type. More...

typedef ::xsd::cxx::tree::traits< MaximumTemperatureChange_type, char >	MaximumTemperatureChange_traits
	Element traits type. More...

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

MaximumTemperatureChange_optional &	MaximumTemperatureChange ()
	Return a read-write reference to the element container. More...

void	MaximumTemperatureChange (const MaximumTemperatureChange_type &x)
	Set the element value. More...

void	MaximumTemperatureChange (const MaximumTemperatureChange_optional &x)
	Set the element value. More...

void	MaximumTemperatureChange (::std::unique_ptr< MaximumTemperatureChange_type > p)
	Set the element value without copying. More...

ApplyAfterHowManySteps
Accessor and modifier functions for the ApplyAfterHowManySteps required element.
typedef ::ApplyAfterHowManySteps	ApplyAfterHowManySteps_type
	Element type. More...

typedef ::xsd::cxx::tree::traits< ApplyAfterHowManySteps_type, char >	ApplyAfterHowManySteps_traits
	Element traits type. More...

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

ApplyAfterHowManySteps_type &	ApplyAfterHowManySteps ()
	Return a read-write reference to the element. More...

void	ApplyAfterHowManySteps (const ApplyAfterHowManySteps_type &x)
	Set the element value. More...

void	ApplyAfterHowManySteps (::std::unique_ptr< ApplyAfterHowManySteps_type > p)
	Set the element value without copying. More...

Dimension
Accessor and modifier functions for the Dimension required element.
typedef ::Dimension	Dimension_type
	Element type. More...

typedef ::xsd::cxx::tree::traits< Dimension_type, char >	Dimension_traits
	Element traits type. More...

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

Dimension_type &	Dimension ()
	Return a read-write reference to the element. More...

void	Dimension (const Dimension_type &x)
	Set the element value. More...

void	Dimension (::std::unique_ptr< Dimension_type > p)
	Set the element value without copying. More...

Constructors
	ThermostatConfig (const Type_type &, const InitialTemperature_type &, const TargetTemperature_type &, const InitialBrownian_type &, const ScalingGradually_type &, const ApplyAfterHowManySteps_type &, const Dimension_type &)
	Create an instance from the ultimate base and initializers for required elements and attributes. More...

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

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

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

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

virtual	~ThermostatConfig ()
	Destructor. More...

Detailed Description

Class corresponding to the ThermostatConfig schema type.

Member Typedef Documentation

◆ ApplyAfterHowManySteps_traits

typedef ::xsd::cxx::tree::traits< ApplyAfterHowManySteps_type, char > ThermostatConfig::ApplyAfterHowManySteps_traits

Element traits type.

◆ ApplyAfterHowManySteps_type

typedef ::ApplyAfterHowManySteps ThermostatConfig::ApplyAfterHowManySteps_type

Element type.

◆ Dimension_traits

typedef ::xsd::cxx::tree::traits< Dimension_type, char > ThermostatConfig::Dimension_traits

Element traits type.

◆ Dimension_type

typedef ::Dimension ThermostatConfig::Dimension_type

Element type.

◆ InitialBrownian_traits

typedef ::xsd::cxx::tree::traits< InitialBrownian_type, char > ThermostatConfig::InitialBrownian_traits

Element traits type.

◆ InitialBrownian_type

typedef ::xml_schema::boolean ThermostatConfig::InitialBrownian_type

Element type.

◆ InitialTemperature_traits

typedef ::xsd::cxx::tree::traits< InitialTemperature_type, char > ThermostatConfig::InitialTemperature_traits

Element traits type.

◆ InitialTemperature_type

typedef ::InitialTemperature ThermostatConfig::InitialTemperature_type

Element type.

◆ MaximumTemperatureChange_optional

typedef ::xsd::cxx::tree::optional< MaximumTemperatureChange_type > ThermostatConfig::MaximumTemperatureChange_optional

Element optional container type.

◆ MaximumTemperatureChange_traits

typedef ::xsd::cxx::tree::traits< MaximumTemperatureChange_type, char > ThermostatConfig::MaximumTemperatureChange_traits

Element traits type.

◆ MaximumTemperatureChange_type

typedef ::MaximumTemperatureChange ThermostatConfig::MaximumTemperatureChange_type

Element type.

◆ ScalingGradually_traits

typedef ::xsd::cxx::tree::traits< ScalingGradually_type, char > ThermostatConfig::ScalingGradually_traits

Element traits type.

◆ ScalingGradually_type

typedef ::xml_schema::boolean ThermostatConfig::ScalingGradually_type

Element type.

◆ TargetTemperature_traits

typedef ::xsd::cxx::tree::traits< TargetTemperature_type, char > ThermostatConfig::TargetTemperature_traits

Element traits type.

◆ TargetTemperature_type

typedef ::TargetTemperature ThermostatConfig::TargetTemperature_type

Element type.

◆ Type_traits

typedef ::xsd::cxx::tree::traits< Type_type, char > ThermostatConfig::Type_traits

Element traits type.

◆ Type_type

typedef ::Type ThermostatConfig::Type_type

Element type.

Constructor & Destructor Documentation

◆ ThermostatConfig() [1/3]

ThermostatConfig::ThermostatConfig	(	const Type_type &	Type,
		const InitialTemperature_type &	InitialTemperature,
		const TargetTemperature_type &	TargetTemperature,
		const InitialBrownian_type &	InitialBrownian,
		const ScalingGradually_type &	ScalingGradually,
		const ApplyAfterHowManySteps_type &	ApplyAfterHowManySteps,
		const Dimension_type &	Dimension
	)

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

◆ ThermostatConfig() [2/3]

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

◆ ThermostatConfig() [3/3]

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

◆ ~ThermostatConfig()

ThermostatConfig::~ThermostatConfig ( )

virtual

Destructor.

Member Function Documentation

◆ _clone()

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

◆ ApplyAfterHowManySteps() [1/4]

ThermostatConfig::ApplyAfterHowManySteps_type & ThermostatConfig::ApplyAfterHowManySteps ( )

Return a read-write reference to the element.

Returns: A reference to the element.

◆ ApplyAfterHowManySteps() [2/4]

const ThermostatConfig::ApplyAfterHowManySteps_type & ThermostatConfig::ApplyAfterHowManySteps ( ) 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:

◆ ApplyAfterHowManySteps() [3/4]

void ThermostatConfig::ApplyAfterHowManySteps ( ::std::unique_ptr< ApplyAfterHowManySteps_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.

◆ ApplyAfterHowManySteps() [4/4]

void ThermostatConfig::ApplyAfterHowManySteps ( const ApplyAfterHowManySteps_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.

◆ Dimension() [1/4]

ThermostatConfig::Dimension_type & ThermostatConfig::Dimension ( )

Return a read-write reference to the element.

Returns: A reference to the element.

◆ Dimension() [2/4]

const ThermostatConfig::Dimension_type & ThermostatConfig::Dimension ( ) 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:

◆ Dimension() [3/4]

void ThermostatConfig::Dimension ( ::std::unique_ptr< Dimension_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.

◆ Dimension() [4/4]

void ThermostatConfig::Dimension ( const Dimension_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.

◆ InitialBrownian() [1/3]

ThermostatConfig::InitialBrownian_type & ThermostatConfig::InitialBrownian ( )

Return a read-write reference to the element.

Returns: A reference to the element.

◆ InitialBrownian() [2/3]

const ThermostatConfig::InitialBrownian_type & ThermostatConfig::InitialBrownian ( ) 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:

◆ InitialBrownian() [3/3]

void ThermostatConfig::InitialBrownian ( const InitialBrownian_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.

◆ InitialTemperature() [1/4]

ThermostatConfig::InitialTemperature_type & ThermostatConfig::InitialTemperature ( )

Return a read-write reference to the element.

Returns: A reference to the element.

◆ InitialTemperature() [2/4]

const ThermostatConfig::InitialTemperature_type & ThermostatConfig::InitialTemperature ( ) 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:

◆ InitialTemperature() [3/4]

void ThermostatConfig::InitialTemperature ( ::std::unique_ptr< InitialTemperature_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.

◆ InitialTemperature() [4/4]

void ThermostatConfig::InitialTemperature ( const InitialTemperature_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.

◆ MaximumTemperatureChange() [1/5]

ThermostatConfig::MaximumTemperatureChange_optional & ThermostatConfig::MaximumTemperatureChange ( )

Return a read-write reference to the element container.

Returns: A reference to the optional container.

◆ MaximumTemperatureChange() [2/5]

const ThermostatConfig::MaximumTemperatureChange_optional & ThermostatConfig::MaximumTemperatureChange ( ) 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:

◆ MaximumTemperatureChange() [3/5]

void ThermostatConfig::MaximumTemperatureChange ( ::std::unique_ptr< MaximumTemperatureChange_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.

◆ MaximumTemperatureChange() [4/5]

void ThermostatConfig::MaximumTemperatureChange ( const MaximumTemperatureChange_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.

◆ MaximumTemperatureChange() [5/5]

void ThermostatConfig::MaximumTemperatureChange ( const MaximumTemperatureChange_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=()

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

◆ ScalingGradually() [1/3]

ThermostatConfig::ScalingGradually_type & ThermostatConfig::ScalingGradually ( )

Return a read-write reference to the element.

Returns: A reference to the element.

◆ ScalingGradually() [2/3]

const ThermostatConfig::ScalingGradually_type & ThermostatConfig::ScalingGradually ( ) 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:

◆ ScalingGradually() [3/3]

void ThermostatConfig::ScalingGradually ( const ScalingGradually_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.

◆ TargetTemperature() [1/4]

ThermostatConfig::TargetTemperature_type & ThermostatConfig::TargetTemperature ( )

Return a read-write reference to the element.

Returns: A reference to the element.

◆ TargetTemperature() [2/4]

const ThermostatConfig::TargetTemperature_type & ThermostatConfig::TargetTemperature ( ) 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:

◆ TargetTemperature() [3/4]

void ThermostatConfig::TargetTemperature ( ::std::unique_ptr< TargetTemperature_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.

◆ TargetTemperature() [4/4]

void ThermostatConfig::TargetTemperature ( const TargetTemperature_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.

◆ Type() [1/4]

ThermostatConfig::Type_type & ThermostatConfig::Type ( )

Return a read-write reference to the element.

Returns: A reference to the element.

◆ Type() [2/4]

const ThermostatConfig::Type_type & ThermostatConfig::Type ( ) 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:

◆ Type() [3/4]

void ThermostatConfig::Type ( ::std::unique_ptr< Type_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.

◆ Type() [4/4]

void ThermostatConfig::Type ( const Type_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

Type

InitialTemperature

TargetTemperature

InitialBrownian

ScalingGradually

MaximumTemperatureChange

ApplyAfterHowManySteps

Dimension

Constructors

Detailed Description

Member Typedef Documentation

◆ ApplyAfterHowManySteps_traits

◆ ApplyAfterHowManySteps_type

◆ Dimension_traits

◆ Dimension_type

◆ InitialBrownian_traits

◆ InitialBrownian_type

◆ InitialTemperature_traits

◆ InitialTemperature_type

◆ MaximumTemperatureChange_optional

◆ MaximumTemperatureChange_traits

◆ MaximumTemperatureChange_type

◆ ScalingGradually_traits

◆ ScalingGradually_type

◆ TargetTemperature_traits

◆ TargetTemperature_type

◆ Type_traits

◆ Type_type

Constructor & Destructor Documentation

◆ ThermostatConfig() [1/3]

◆ ThermostatConfig() [2/3]

◆ ThermostatConfig() [3/3]

◆ ~ThermostatConfig()

Member Function Documentation

◆ _clone()

◆ ApplyAfterHowManySteps() [1/4]

◆ ApplyAfterHowManySteps() [2/4]

◆ ApplyAfterHowManySteps() [3/4]

◆ ApplyAfterHowManySteps() [4/4]

◆ Dimension() [1/4]

◆ Dimension() [2/4]

◆ Dimension() [3/4]

◆ Dimension() [4/4]

◆ InitialBrownian() [1/3]

◆ InitialBrownian() [2/3]

◆ InitialBrownian() [3/3]

◆ InitialTemperature() [1/4]

◆ InitialTemperature() [2/4]

◆ InitialTemperature() [3/4]

◆ InitialTemperature() [4/4]

◆ MaximumTemperatureChange() [1/5]

◆ MaximumTemperatureChange() [2/5]

◆ MaximumTemperatureChange() [3/5]

◆ MaximumTemperatureChange() [4/5]

◆ MaximumTemperatureChange() [5/5]

◆ operator=()

◆ ScalingGradually() [1/3]

◆ ScalingGradually() [2/3]

◆ ScalingGradually() [3/3]

◆ TargetTemperature() [1/4]

◆ TargetTemperature() [2/4]

◆ TargetTemperature() [3/4]

◆ TargetTemperature() [4/4]

◆ Type() [1/4]

◆ Type() [2/4]

◆ Type() [3/4]

◆ Type() [4/4]