DiscType Class Reference

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

#include <SimulationXSD.h>

Inheritance diagram for DiscType:

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.

radius
Accessor and modifier functions for the radius required element.
typedef ::xml_schema::Int	RadiusType
	Element type.
typedef ::xsd::cxx::tree::traits< RadiusType, char >	RadiusTraits
	Element traits type.
const RadiusType &	radius () const
	Return a read-only (constant) reference to the element.
RadiusType &	radius ()
	Return a read-write reference to the element.
void	radius (const RadiusType &x)
	Set the element value.

distance
Accessor and modifier functions for the distance required element.
typedef ::xml_schema::Double	DistanceType
	Element type.
typedef ::xsd::cxx::tree::traits< DistanceType, char, ::xsd::cxx::tree::schema_type::double_ >	DistanceTraits
	Element traits type.
const DistanceType &	distance () const
	Return a read-only (constant) reference to the element.
DistanceType &	distance ()
	Return a read-write reference to the element.
void	distance (const DistanceType &x)
	Set the element value.

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.

Constructors
	DiscType (const PositionType &, const VelocityType &, const RadiusType &, const DistanceType &, const MassType &)
	Create an instance from the ultimate base and initializers for required elements and attributes.
	DiscType (::std::unique_ptr< PositionType >, ::std::unique_ptr< VelocityType >, const RadiusType &, const DistanceType &, const MassType &)
	Create an instance from the ultimate base and initializers for required elements and attributes (::std::unique_ptr version).
	DiscType (const ::xercesc::DOMElement &e, ::xml_schema::Flags f=0, ::xml_schema::Container *c=0)
	Create an instance from a DOM element.
	DiscType (const DiscType &x, ::xml_schema::Flags f=0, ::xml_schema::Container *c=0)
	Copy constructor.
virtual DiscType *	_clone (::xml_schema::Flags f=0, ::xml_schema::Container *c=0) const
	Copy the instance polymorphically.
DiscType &	operator= (const DiscType &x)
	Copy assignment operator.
virtual	~DiscType ()
	Destructor.

Detailed Description

Class corresponding to the discType schema type.

Member Typedef Documentation

DistanceTraits

typedef ::xsd::cxx::tree::traits<DistanceType, char, ::xsd::cxx::tree::schema_type::double_> DiscType::DistanceTraits

Element traits type.

DistanceType

typedef ::xml_schema::Double DiscType::DistanceType

Element type.

EpsilonOptional

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

Element optional container type.

EpsilonTraits

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

Element traits type.

EpsilonType

typedef ::xml_schema::Double DiscType::EpsilonType

Element type.

MassTraits

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

Element traits type.

MassType

typedef ::xml_schema::Double DiscType::MassType

Element type.

PositionTraits

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

Element traits type.

PositionType

typedef ::PositionType DiscType::PositionType

Element type.

RadiusTraits

typedef ::xsd::cxx::tree::traits<RadiusType, char> DiscType::RadiusTraits

Element traits type.

RadiusType

typedef ::xml_schema::Int DiscType::RadiusType

Element type.

SigmaOptional

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

Element optional container type.

SigmaTraits

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

Element traits type.

SigmaType

typedef ::xml_schema::Double DiscType::SigmaType

Element type.

TypeOptional

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

Element optional container type.

TypeTraits

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

Element traits type.

TypeType

typedef ::xml_schema::Int DiscType::TypeType

Element type.

VelocityTraits

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

Element traits type.

VelocityType

typedef ::VelocityType DiscType::VelocityType

Element type.

Constructor & Destructor Documentation

DiscType() [1/4]

DiscType::DiscType	(	const PositionType &	,
		const VelocityType &	,
		const RadiusType &	,
		const DistanceType &	,
		const MassType &
	)

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

DiscType() [2/4]

DiscType::DiscType	(	::std::unique_ptr< PositionType >	,
		::std::unique_ptr< VelocityType >	,
		const RadiusType &	,
		const DistanceType &	,
		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.

DiscType() [3/4]

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

DiscType() [4/4]

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

~DiscType()

virtual DiscType::~DiscType ( )

virtual

Destructor.

Member Function Documentation

_clone()

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

distance() [1/3]

DistanceType & DiscType::distance

(

)

Return a read-write reference to the element.

Returns

A reference to the element.

distance() [2/3]

const DistanceType & DiscType::distance

(

)

const

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

Returns

A constant reference to the element.

distance() [3/3]

void DiscType::distance

(

const DistanceType &

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 & DiscType::epsilon

(

)

Return a read-write reference to the element container.

Returns

A reference to the optional container.

epsilon() [2/4]

const EpsilonOptional & DiscType::epsilon

(

)

const

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

Returns

A constant reference to the optional container.

epsilon() [3/4]

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

mass() [1/3]

MassType & DiscType::mass

(

)

Return a read-write reference to the element.

Returns

A reference to the element.

mass() [2/3]

const MassType & DiscType::mass

(

)

const

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

Returns

A constant reference to the element.

mass() [3/3]

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

operator=()

DiscType & DiscType::operator=

(

const DiscType &

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 & DiscType::position

(

)

Return a read-write reference to the element.

Returns

A reference to the element.

position() [2/4]

const PositionType & DiscType::position

(

)

const

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

Returns

A constant reference to the element.

position() [3/4]

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

radius() [1/3]

RadiusType & DiscType::radius

(

)

Return a read-write reference to the element.

Returns

A reference to the element.

radius() [2/3]

const RadiusType & DiscType::radius

(

)

const

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

Returns

A constant reference to the element.

radius() [3/3]

void DiscType::radius

(

const RadiusType &

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 & DiscType::sigma

(

)

Return a read-write reference to the element container.

Returns

A reference to the optional container.

sigma() [2/4]

const SigmaOptional & DiscType::sigma

(

)

const

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

Returns

A constant reference to the optional container.

sigma() [3/4]

void DiscType::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 DiscType::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 & DiscType::type

(

)

Return a read-write reference to the element container.

Returns

A reference to the optional container.

type() [2/4]

const TypeOptional & DiscType::type

(

)

const

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

Returns

A constant reference to the optional container.

type() [3/4]

void DiscType::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 DiscType::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 & DiscType::velocity

(

)

Return a read-write reference to the element.

Returns

A reference to the element.

velocity() [2/4]

const VelocityType & DiscType::velocity

(

)

const

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

Returns

A constant reference to the element.

velocity() [3/4]

void DiscType::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 DiscType::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