SingleParticle Class Reference

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

#include <ConfigurationFile.h>

Inheritance diagram for SingleParticle:

Collaboration diagram for SingleParticle:

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

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

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

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

Detailed Description

Class corresponding to the SingleParticle schema type.

Member Typedef Documentation

Epsilon_optional

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

Element optional container type.

Epsilon_traits

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

Element traits type.

Epsilon_type

typedef ::Epsilon SingleParticle::Epsilon_type

Element type.

Mass_traits

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

Element traits type.

Mass_type

typedef ::Mass SingleParticle::Mass_type

Element type.

Position_traits

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

Element traits type.

Position_type

typedef ::Position SingleParticle::Position_type

Element type.

Sigma_optional

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

Element optional container type.

Sigma_traits

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

Element traits type.

Sigma_type

typedef ::Sigma SingleParticle::Sigma_type

Element type.

Velocity_traits

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

Element traits type.

Velocity_type

typedef ::Velocity SingleParticle::Velocity_type

Element type.

Constructor & Destructor Documentation

SingleParticle() [1/4]

SingleParticle::SingleParticle	(	const Position_type &	Position,
		const Velocity_type &	Velocity,
		const Mass_type &	Mass
	)

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

SingleParticle() [2/4]

SingleParticle::SingleParticle	(	::std::unique_ptr< Position_type >	Position,
		::std::unique_ptr< Velocity_type >	Velocity,
		const Mass_type &	Mass
	)

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.

SingleParticle() [3/4]

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

SingleParticle() [4/4]

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

~SingleParticle()

SingleParticle::~SingleParticle ( )

virtual

Destructor.

Member Function Documentation

_clone()

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

Epsilon() [1/5]

SingleParticle::Epsilon_optional & SingleParticle::Epsilon

(

)

Return a read-write reference to the element container.

Returns

A reference to the optional container.

Epsilon() [2/5]

const SingleParticle::Epsilon_optional & SingleParticle::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 SingleParticle::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 SingleParticle::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 SingleParticle::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.

Mass() [1/4]

SingleParticle::Mass_type & SingleParticle::Mass

(

)

Return a read-write reference to the element.

Returns

A reference to the element.

Mass() [2/4]

const SingleParticle::Mass_type & SingleParticle::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 SingleParticle::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 SingleParticle::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=()

SingleParticle & SingleParticle::operator=

(

const SingleParticle &

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.

Position() [1/4]

SingleParticle::Position_type & SingleParticle::Position

(

)

Return a read-write reference to the element.

Returns

A reference to the element.

Position() [2/4]

const SingleParticle::Position_type & SingleParticle::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 SingleParticle::Position

(

::std::unique_ptr< Position_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.

Position() [4/4]

void SingleParticle::Position

(

const Position_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]

SingleParticle::Sigma_optional & SingleParticle::Sigma

(

)

Return a read-write reference to the element container.

Returns

A reference to the optional container.

Sigma() [2/5]

const SingleParticle::Sigma_optional & SingleParticle::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 SingleParticle::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 SingleParticle::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 SingleParticle::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]

SingleParticle::Velocity_type & SingleParticle::Velocity

(

)

Return a read-write reference to the element.

Returns

A reference to the element.

Velocity() [2/4]

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