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

#include <SimulationXSD.h>

Inheritance diagram for ParticleType:

position
Accessor and modifier functions for the position required element.
typedef ::PositionType	PositionType
	Element type.

typedef ::xsd::cxx::tree::traits< PositionType, char >	PositionTraits
	Element traits type.

const PositionType &	position () const
	Return a read-only (constant) reference to the element.

PositionType &	position ()
	Return a read-write reference to the element.

void	position (const PositionType &x)
	Set the element value.

void	position (::std::unique_ptr< PositionType > p)
	Set the element value without copying.

velocity
Accessor and modifier functions for the velocity required element.
typedef ::VelocityType	VelocityType
	Element type.

typedef ::xsd::cxx::tree::traits< VelocityType, char >	VelocityTraits
	Element traits type.

const VelocityType &	velocity () const
	Return a read-only (constant) reference to the element.

VelocityType &	velocity ()
	Return a read-write reference to the element.

void	velocity (const VelocityType &x)
	Set the element value.

void	velocity (::std::unique_ptr< VelocityType > p)
	Set the element value without copying.

force
Accessor and modifier functions for the force optional element.
typedef ::ForceType	ForceType
	Element type.

typedef ::xsd::cxx::tree::optional< ForceType >	ForceOptional
	Element optional container type.

typedef ::xsd::cxx::tree::traits< ForceType, char >	ForceTraits
	Element traits type.

const ForceOptional &	force () const
	Return a read-only (constant) reference to the element container.

ForceOptional &	force ()
	Return a read-write reference to the element container.

void	force (const ForceType &x)
	Set the element value.

void	force (const ForceOptional &x)
	Set the element value.

void	force (::std::unique_ptr< ForceType > p)
	Set the element value without copying.

oldForce
Accessor and modifier functions for the oldForce optional element.
typedef ::ForceType	OldForceType
	Element type.

typedef ::xsd::cxx::tree::optional< OldForceType >	OldForceOptional
	Element optional container type.

typedef ::xsd::cxx::tree::traits< OldForceType, char >	OldForceTraits
	Element traits type.

const OldForceOptional &	oldForce () const
	Return a read-only (constant) reference to the element container.

OldForceOptional &	oldForce ()
	Return a read-write reference to the element container.

void	oldForce (const OldForceType &x)
	Set the element value.

void	oldForce (const OldForceOptional &x)
	Set the element value.

void	oldForce (::std::unique_ptr< OldForceType > p)
	Set the element value without copying.

mass
Accessor and modifier functions for the mass required element.
typedef ::xml_schema::Double	MassType
	Element type.

typedef ::xsd::cxx::tree::traits< MassType, char, ::xsd::cxx::tree::schema_type::double_ >	MassTraits
	Element traits type.

const MassType &	mass () const
	Return a read-only (constant) reference to the element.

MassType &	mass ()
	Return a read-write reference to the element.

void	mass (const MassType &x)
	Set the element value.

type
Accessor and modifier functions for the type optional element.
typedef ::xml_schema::Int	TypeType
	Element type.

typedef ::xsd::cxx::tree::optional< TypeType >	TypeOptional
	Element optional container type.

typedef ::xsd::cxx::tree::traits< TypeType, char >	TypeTraits
	Element traits type.

const TypeOptional &	type () const
	Return a read-only (constant) reference to the element container.

TypeOptional &	type ()
	Return a read-write reference to the element container.

void	type (const TypeType &x)
	Set the element value.

void	type (const TypeOptional &x)
	Set the element value.

epsilon
Accessor and modifier functions for the epsilon optional element.
typedef ::xml_schema::Double	EpsilonType
	Element type.

typedef ::xsd::cxx::tree::optional< EpsilonType >	EpsilonOptional
	Element optional container type.

typedef ::xsd::cxx::tree::traits< EpsilonType, char, ::xsd::cxx::tree::schema_type::double_ >	EpsilonTraits
	Element traits type.

const EpsilonOptional &	epsilon () const
	Return a read-only (constant) reference to the element container.

EpsilonOptional &	epsilon ()
	Return a read-write reference to the element container.

void	epsilon (const EpsilonType &x)
	Set the element value.

void	epsilon (const EpsilonOptional &x)
	Set the element value.

sigma
Accessor and modifier functions for the sigma optional element.
typedef ::xml_schema::Double	SigmaType
	Element type.

typedef ::xsd::cxx::tree::optional< SigmaType >	SigmaOptional
	Element optional container type.

typedef ::xsd::cxx::tree::traits< SigmaType, char, ::xsd::cxx::tree::schema_type::double_ >	SigmaTraits
	Element traits type.

const SigmaOptional &	sigma () const
	Return a read-only (constant) reference to the element container.

SigmaOptional &	sigma ()
	Return a read-write reference to the element container.

void	sigma (const SigmaType &x)
	Set the element value.

void	sigma (const SigmaOptional &x)
	Set the element value.

cellIndex
Accessor and modifier functions for the cellIndex optional element.
typedef ::xml_schema::Int	CellIndexType
	Element type.

typedef ::xsd::cxx::tree::optional< CellIndexType >	CellIndexOptional
	Element optional container type.

typedef ::xsd::cxx::tree::traits< CellIndexType, char >	CellIndexTraits
	Element traits type.

const CellIndexOptional &	cellIndex () const
	Return a read-only (constant) reference to the element container.

CellIndexOptional &	cellIndex ()
	Return a read-write reference to the element container.

void	cellIndex (const CellIndexType &x)
	Set the element value.

void	cellIndex (const CellIndexOptional &x)
	Set the element value.

Constructors
	ParticleType (const PositionType &, const VelocityType &, const MassType &)
	Create an instance from the ultimate base and initializers for required elements and attributes.

	ParticleType (::std::unique_ptr< PositionType >, ::std::unique_ptr< VelocityType >, const MassType &)
	Create an instance from the ultimate base and initializers for required elements and attributes (::std::unique_ptr version).

	ParticleType (const ::xercesc::DOMElement &e, ::xml_schema::Flags f=0, ::xml_schema::Container *c=0)
	Create an instance from a DOM element.

	ParticleType (const ParticleType &x, ::xml_schema::Flags f=0, ::xml_schema::Container *c=0)
	Copy constructor.

virtual ParticleType *	_clone (::xml_schema::Flags f=0, ::xml_schema::Container *c=0) const
	Copy the instance polymorphically.

ParticleType &	operator= (const ParticleType &x)
	Copy assignment operator.

virtual	~ParticleType ()
	Destructor.

Detailed Description

Class corresponding to the particleType schema type.

Member Typedef Documentation

◆ CellIndexOptional

typedef ::xsd::cxx::tree::optional<CellIndexType> ParticleType::CellIndexOptional

Element optional container type.

◆ CellIndexTraits

typedef ::xsd::cxx::tree::traits<CellIndexType, char> ParticleType::CellIndexTraits

Element traits type.

◆ CellIndexType

typedef ::xml_schema::Int ParticleType::CellIndexType

Element type.

◆ EpsilonOptional

typedef ::xsd::cxx::tree::optional<EpsilonType> ParticleType::EpsilonOptional

Element optional container type.

◆ EpsilonTraits

typedef ::xsd::cxx::tree::traits<EpsilonType, char, ::xsd::cxx::tree::schema_type::double_> ParticleType::EpsilonTraits

Element traits type.

◆ EpsilonType

typedef ::xml_schema::Double ParticleType::EpsilonType

Element type.

◆ ForceOptional

typedef ::xsd::cxx::tree::optional<ForceType> ParticleType::ForceOptional

Element optional container type.

◆ ForceTraits

typedef ::xsd::cxx::tree::traits<ForceType, char> ParticleType::ForceTraits

Element traits type.

◆ ForceType

typedef ::ForceType ParticleType::ForceType

Element type.

◆ MassTraits

typedef ::xsd::cxx::tree::traits<MassType, char, ::xsd::cxx::tree::schema_type::double_> ParticleType::MassTraits

Element traits type.

◆ MassType

typedef ::xml_schema::Double ParticleType::MassType

Element type.

◆ OldForceOptional

typedef ::xsd::cxx::tree::optional<OldForceType> ParticleType::OldForceOptional

Element optional container type.

◆ OldForceTraits

typedef ::xsd::cxx::tree::traits<OldForceType, char> ParticleType::OldForceTraits

Element traits type.

◆ OldForceType

typedef ::ForceType ParticleType::OldForceType

Element type.

◆ PositionTraits

typedef ::xsd::cxx::tree::traits<PositionType, char> ParticleType::PositionTraits

Element traits type.

◆ PositionType

typedef ::PositionType ParticleType::PositionType

Element type.

◆ SigmaOptional

typedef ::xsd::cxx::tree::optional<SigmaType> ParticleType::SigmaOptional

Element optional container type.

◆ SigmaTraits

typedef ::xsd::cxx::tree::traits<SigmaType, char, ::xsd::cxx::tree::schema_type::double_> ParticleType::SigmaTraits

Element traits type.

◆ SigmaType

typedef ::xml_schema::Double ParticleType::SigmaType

Element type.

◆ TypeOptional

typedef ::xsd::cxx::tree::optional<TypeType> ParticleType::TypeOptional

Element optional container type.

◆ TypeTraits

typedef ::xsd::cxx::tree::traits<TypeType, char> ParticleType::TypeTraits

Element traits type.

◆ TypeType

typedef ::xml_schema::Int ParticleType::TypeType

Element type.

◆ VelocityTraits

typedef ::xsd::cxx::tree::traits<VelocityType, char> ParticleType::VelocityTraits

Element traits type.

◆ VelocityType

typedef ::VelocityType ParticleType::VelocityType

Element type.

Constructor & Destructor Documentation

◆ ParticleType() [1/4]

ParticleType::ParticleType	(	const PositionType &	,
		const VelocityType &	,
		const MassType &
	)

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

◆ ParticleType() [2/4]

ParticleType::ParticleType	(	::std::unique_ptr< PositionType >	,
		::std::unique_ptr< VelocityType >	,
		const MassType &
	)

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.

◆ ParticleType() [3/4]

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

◆ ParticleType() [4/4]

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

◆ ~ParticleType()

virtual ParticleType::~ParticleType ( )

virtual

Destructor.

Member Function Documentation

◆ _clone()

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

◆ cellIndex() [1/4]

CellIndexOptional & ParticleType::cellIndex ( )

Return a read-write reference to the element container.

Returns: A reference to the optional container.

◆ cellIndex() [2/4]

const CellIndexOptional & ParticleType::cellIndex ( ) const

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

Returns: A constant reference to the optional container.

◆ cellIndex() [3/4]

void ParticleType::cellIndex ( const CellIndexOptional & 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.

◆ cellIndex() [4/4]

void ParticleType::cellIndex ( const CellIndexType & 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/4]

EpsilonOptional & ParticleType::epsilon ( )

Return a read-write reference to the element container.

Returns: A reference to the optional container.

◆ epsilon() [2/4]

const EpsilonOptional & ParticleType::epsilon ( ) const

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

Returns: A constant reference to the optional container.

◆ epsilon() [3/4]

void ParticleType::epsilon ( const EpsilonOptional & 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() [4/4]

void ParticleType::epsilon ( const EpsilonType & 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.

◆ force() [1/5]

ForceOptional & ParticleType::force ( )

Return a read-write reference to the element container.

Returns: A reference to the optional container.

◆ force() [2/5]

const ForceOptional & ParticleType::force ( ) const

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

Returns: A constant reference to the optional container.

◆ force() [3/5]

void ParticleType::force ( ::std::unique_ptr< ForceType > 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.

◆ force() [4/5]

void ParticleType::force ( const ForceOptional & 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.

◆ force() [5/5]

void ParticleType::force ( const ForceType & 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/3]

MassType & ParticleType::mass ( )

Return a read-write reference to the element.

Returns: A reference to the element.

◆ mass() [2/3]

const MassType & ParticleType::mass ( ) const

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

Returns: A constant reference to the element.

◆ mass() [3/3]

void ParticleType::mass ( const MassType & 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.

◆ oldForce() [1/5]

OldForceOptional & ParticleType::oldForce ( )

Return a read-write reference to the element container.

Returns: A reference to the optional container.

◆ oldForce() [2/5]

const OldForceOptional & ParticleType::oldForce ( ) const

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

Returns: A constant reference to the optional container.

◆ oldForce() [3/5]

void ParticleType::oldForce ( ::std::unique_ptr< OldForceType > 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.

◆ oldForce() [4/5]

void ParticleType::oldForce ( const OldForceOptional & 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.

◆ oldForce() [5/5]

void ParticleType::oldForce ( const OldForceType & 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=()

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

PositionType & ParticleType::position ( )

Return a read-write reference to the element.

Returns: A reference to the element.

◆ position() [2/4]

const PositionType & ParticleType::position ( ) const

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

Returns: A constant reference to the element.

◆ position() [3/4]

void ParticleType::position ( ::std::unique_ptr< PositionType > 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 ParticleType::position ( const PositionType & 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/4]

SigmaOptional & ParticleType::sigma ( )

Return a read-write reference to the element container.

Returns: A reference to the optional container.

◆ sigma() [2/4]

const SigmaOptional & ParticleType::sigma ( ) const

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

Returns: A constant reference to the optional container.

◆ sigma() [3/4]

void ParticleType::sigma ( const SigmaOptional & 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() [4/4]

void ParticleType::sigma ( const SigmaType & 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]

TypeOptional & ParticleType::type ( )

Return a read-write reference to the element container.

Returns: A reference to the optional container.

◆ type() [2/4]

const TypeOptional & ParticleType::type ( ) const

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

Returns: A constant reference to the optional container.

◆ type() [3/4]

void ParticleType::type ( const TypeOptional & 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.

◆ type() [4/4]

void ParticleType::type ( const TypeType & 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]

VelocityType & ParticleType::velocity ( )

Return a read-write reference to the element.

Returns: A reference to the element.

◆ velocity() [2/4]

const VelocityType & ParticleType::velocity ( ) const

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

Returns: A constant reference to the element.

◆ velocity() [3/4]

void ParticleType::velocity ( ::std::unique_ptr< VelocityType > 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 ParticleType::velocity ( const VelocityType & 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 file:

src/io/xsd/SimulationXSD.h

position

velocity

force

oldForce

mass

type

epsilon

sigma

cellIndex

Constructors

Detailed Description

Member Typedef Documentation

◆ CellIndexOptional

◆ CellIndexTraits

◆ CellIndexType

◆ EpsilonOptional

◆ EpsilonTraits

◆ EpsilonType

◆ ForceOptional

◆ ForceTraits

◆ ForceType

◆ MassTraits

◆ MassType

◆ OldForceOptional

◆ OldForceTraits

◆ OldForceType

◆ PositionTraits

◆ PositionType

◆ SigmaOptional

◆ SigmaTraits

◆ SigmaType

◆ TypeOptional

◆ TypeTraits

◆ TypeType

◆ VelocityTraits

◆ VelocityType

Constructor & Destructor Documentation

◆ ParticleType() [1/4]

◆ ParticleType() [2/4]

◆ ParticleType() [3/4]

◆ ParticleType() [4/4]

◆ ~ParticleType()

Member Function Documentation

◆ _clone()

◆ cellIndex() [1/4]

◆ cellIndex() [2/4]

◆ cellIndex() [3/4]

◆ cellIndex() [4/4]

◆ epsilon() [1/4]

◆ epsilon() [2/4]

◆ epsilon() [3/4]

◆ epsilon() [4/4]

◆ force() [1/5]

◆ force() [2/5]

◆ force() [3/5]

◆ force() [4/5]

◆ force() [5/5]

◆ mass() [1/3]

◆ mass() [2/3]

◆ mass() [3/3]

◆ oldForce() [1/5]

◆ oldForce() [2/5]

◆ oldForce() [3/5]

◆ oldForce() [4/5]

◆ oldForce() [5/5]

◆ operator=()

◆ position() [1/4]

◆ position() [2/4]

◆ position() [3/4]

◆ position() [4/4]

◆ sigma() [1/4]

◆ sigma() [2/4]

◆ sigma() [3/4]

◆ sigma() [4/4]

◆ type() [1/4]

◆ type() [2/4]

◆ type() [3/4]

◆ type() [4/4]

◆ velocity() [1/4]

◆ velocity() [2/4]