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

#include <SimulationXSD.h>

Inheritance diagram for SimType:

args
Accessor and modifier functions for the args optional element.
typedef ::ArgsType	ArgsType
	Element type.

typedef ::xsd::cxx::tree::optional< ArgsType >	ArgsOptional
	Element optional container type.

typedef ::xsd::cxx::tree::traits< ArgsType, char >	ArgsTraits
	Element traits type.

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

ArgsOptional &	args ()
	Return a read-write reference to the element container.

void	args (const ArgsType &x)
	Set the element value.

void	args (const ArgsOptional &x)
	Set the element value.

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

thermostat
Accessor and modifier functions for the thermostat required element.
typedef ::ThermostatType	ThermostatType
	Element type.

typedef ::xsd::cxx::tree::traits< ThermostatType, char >	ThermostatTraits
	Element traits type.

const ThermostatType &	thermostat () const
	Return a read-only (constant) reference to the element.

ThermostatType &	thermostat ()
	Return a read-write reference to the element.

void	thermostat (const ThermostatType &x)
	Set the element value.

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

membrane
Accessor and modifier functions for the membrane optional element.
typedef ::MembraneType	MembraneType
	Element type.

typedef ::xsd::cxx::tree::optional< MembraneType >	MembraneOptional
	Element optional container type.

typedef ::xsd::cxx::tree::traits< MembraneType, char >	MembraneTraits
	Element traits type.

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

MembraneOptional &	membrane ()
	Return a read-write reference to the element container.

void	membrane (const MembraneType &x)
	Set the element value.

void	membrane (const MembraneOptional &x)
	Set the element value.

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

type
Accessor and modifier functions for the type required element.
typedef ::xml_schema::String	TypeType
	Element type.

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

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

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

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

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

linkedCells
Accessor and modifier functions for the linkedCells optional element.
typedef ::xml_schema::Boolean	LinkedCellsType
	Element type.

typedef ::xsd::cxx::tree::optional< LinkedCellsType >	LinkedCellsOptional
	Element optional container type.

typedef ::xsd::cxx::tree::traits< LinkedCellsType, char >	LinkedCellsTraits
	Element traits type.

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

LinkedCellsOptional &	linkedCells ()
	Return a read-write reference to the element container.

void	linkedCells (const LinkedCellsType &x)
	Set the element value.

void	linkedCells (const LinkedCellsOptional &x)
	Set the element value.

dimensions
Accessor and modifier functions for the dimensions optional element.
typedef ::xml_schema::PositiveInteger	DimensionsType
	Element type.

typedef ::xsd::cxx::tree::optional< DimensionsType >	DimensionsOptional
	Element optional container type.

typedef ::xsd::cxx::tree::traits< DimensionsType, char >	DimensionsTraits
	Element traits type.

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

DimensionsOptional &	dimensions ()
	Return a read-write reference to the element container.

void	dimensions (const DimensionsType &x)
	Set the element value.

void	dimensions (const DimensionsOptional &x)
	Set the element value.

analyzer
Accessor and modifier functions for the analyzer optional element.
typedef ::AnalyzerType	AnalyzerType
	Element type.

typedef ::xsd::cxx::tree::optional< AnalyzerType >	AnalyzerOptional
	Element optional container type.

typedef ::xsd::cxx::tree::traits< AnalyzerType, char >	AnalyzerTraits
	Element traits type.

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

AnalyzerOptional &	analyzer ()
	Return a read-write reference to the element container.

void	analyzer (const AnalyzerType &x)
	Set the element value.

void	analyzer (const AnalyzerOptional &x)
	Set the element value.

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

objects
Accessor and modifier functions for the objects required element.
typedef ::ObjectsType	ObjectsType
	Element type.

typedef ::xsd::cxx::tree::traits< ObjectsType, char >	ObjectsTraits
	Element traits type.

const ObjectsType &	objects () const
	Return a read-only (constant) reference to the element.

ObjectsType &	objects ()
	Return a read-write reference to the element.

void	objects (const ObjectsType &x)
	Set the element value.

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

totalParticles
Accessor and modifier functions for the totalParticles optional element.
typedef ::xml_schema::Long	TotalParticlesType
	Element type.

typedef ::xsd::cxx::tree::optional< TotalParticlesType >	TotalParticlesOptional
	Element optional container type.

typedef ::xsd::cxx::tree::traits< TotalParticlesType, char >	TotalParticlesTraits
	Element traits type.

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

TotalParticlesOptional &	totalParticles ()
	Return a read-write reference to the element container.

void	totalParticles (const TotalParticlesType &x)
	Set the element value.

void	totalParticles (const TotalParticlesOptional &x)
	Set the element value.

Constructors
	SimType (const ThermostatType &, const TypeType &, const ObjectsType &)
	Create an instance from the ultimate base and initializers for required elements and attributes.

	SimType (::std::unique_ptr< ThermostatType >, const TypeType &, ::std::unique_ptr< ObjectsType >)
	Create an instance from the ultimate base and initializers for required elements and attributes (::std::unique_ptr version).

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

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

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

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

virtual	~SimType ()
	Destructor.

Detailed Description

Class corresponding to the simType schema type.

Member Typedef Documentation

◆ AnalyzerOptional

typedef ::xsd::cxx::tree::optional<AnalyzerType> SimType::AnalyzerOptional

Element optional container type.

◆ AnalyzerTraits

typedef ::xsd::cxx::tree::traits<AnalyzerType, char> SimType::AnalyzerTraits

Element traits type.

◆ AnalyzerType

typedef ::AnalyzerType SimType::AnalyzerType

Element type.

◆ ArgsOptional

typedef ::xsd::cxx::tree::optional<ArgsType> SimType::ArgsOptional

Element optional container type.

◆ ArgsTraits

typedef ::xsd::cxx::tree::traits<ArgsType, char> SimType::ArgsTraits

Element traits type.

◆ ArgsType

typedef ::ArgsType SimType::ArgsType

Element type.

◆ DimensionsOptional

typedef ::xsd::cxx::tree::optional<DimensionsType> SimType::DimensionsOptional

Element optional container type.

◆ DimensionsTraits

typedef ::xsd::cxx::tree::traits<DimensionsType, char> SimType::DimensionsTraits

Element traits type.

◆ DimensionsType

typedef ::xml_schema::PositiveInteger SimType::DimensionsType

Element type.

◆ LinkedCellsOptional

typedef ::xsd::cxx::tree::optional<LinkedCellsType> SimType::LinkedCellsOptional

Element optional container type.

◆ LinkedCellsTraits

typedef ::xsd::cxx::tree::traits<LinkedCellsType, char> SimType::LinkedCellsTraits

Element traits type.

◆ LinkedCellsType

typedef ::xml_schema::Boolean SimType::LinkedCellsType

Element type.

◆ MembraneOptional

typedef ::xsd::cxx::tree::optional<MembraneType> SimType::MembraneOptional

Element optional container type.

◆ MembraneTraits

typedef ::xsd::cxx::tree::traits<MembraneType, char> SimType::MembraneTraits

Element traits type.

◆ MembraneType

typedef ::MembraneType SimType::MembraneType

Element type.

◆ ObjectsTraits

typedef ::xsd::cxx::tree::traits<ObjectsType, char> SimType::ObjectsTraits

Element traits type.

◆ ObjectsType

typedef ::ObjectsType SimType::ObjectsType

Element type.

◆ ThermostatTraits

typedef ::xsd::cxx::tree::traits<ThermostatType, char> SimType::ThermostatTraits

Element traits type.

◆ ThermostatType

typedef ::ThermostatType SimType::ThermostatType

Element type.

◆ TotalParticlesOptional

typedef ::xsd::cxx::tree::optional<TotalParticlesType> SimType::TotalParticlesOptional

Element optional container type.

◆ TotalParticlesTraits

typedef ::xsd::cxx::tree::traits<TotalParticlesType, char> SimType::TotalParticlesTraits

Element traits type.

◆ TotalParticlesType

typedef ::xml_schema::Long SimType::TotalParticlesType

Element type.

◆ TypeTraits

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

Element traits type.

◆ TypeType

typedef ::xml_schema::String SimType::TypeType

Element type.

Constructor & Destructor Documentation

◆ SimType() [1/4]

SimType::SimType	(	const ThermostatType &	,
		const TypeType &	,
		const ObjectsType &
	)

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

◆ SimType() [2/4]

SimType::SimType	(	::std::unique_ptr< ThermostatType >	,
		const TypeType &	,
		::std::unique_ptr< ObjectsType >
	)

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.

◆ SimType() [3/4]

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

◆ SimType() [4/4]

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

◆ ~SimType()

virtual SimType::~SimType ( )

virtual

Destructor.

Member Function Documentation

◆ _clone()

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

◆ analyzer() [1/5]

AnalyzerOptional & SimType::analyzer ( )

Return a read-write reference to the element container.

Returns: A reference to the optional container.

◆ analyzer() [2/5]

const AnalyzerOptional & SimType::analyzer ( ) const

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

Returns: A constant reference to the optional container.

◆ analyzer() [3/5]

void SimType::analyzer ( ::std::unique_ptr< AnalyzerType > 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.

◆ analyzer() [4/5]

void SimType::analyzer ( const AnalyzerOptional & 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.

◆ analyzer() [5/5]

void SimType::analyzer ( const AnalyzerType & 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.

◆ args() [1/5]

ArgsOptional & SimType::args ( )

Return a read-write reference to the element container.

Returns: A reference to the optional container.

◆ args() [2/5]

const ArgsOptional & SimType::args ( ) const

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

Returns: A constant reference to the optional container.

◆ args() [3/5]

void SimType::args ( ::std::unique_ptr< ArgsType > 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.

◆ args() [4/5]

void SimType::args ( const ArgsOptional & 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.

◆ args() [5/5]

void SimType::args ( const ArgsType & 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.

◆ dimensions() [1/4]

DimensionsOptional & SimType::dimensions ( )

Return a read-write reference to the element container.

Returns: A reference to the optional container.

◆ dimensions() [2/4]

const DimensionsOptional & SimType::dimensions ( ) const

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

Returns: A constant reference to the optional container.

◆ dimensions() [3/4]

void SimType::dimensions ( const DimensionsOptional & 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.

◆ dimensions() [4/4]

void SimType::dimensions ( const DimensionsType & 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.

◆ linkedCells() [1/4]

LinkedCellsOptional & SimType::linkedCells ( )

Return a read-write reference to the element container.

Returns: A reference to the optional container.

◆ linkedCells() [2/4]

const LinkedCellsOptional & SimType::linkedCells ( ) const

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

Returns: A constant reference to the optional container.

◆ linkedCells() [3/4]

void SimType::linkedCells ( const LinkedCellsOptional & 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.

◆ linkedCells() [4/4]

void SimType::linkedCells ( const LinkedCellsType & 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.

◆ membrane() [1/5]

MembraneOptional & SimType::membrane ( )

Return a read-write reference to the element container.

Returns: A reference to the optional container.

◆ membrane() [2/5]

const MembraneOptional & SimType::membrane ( ) const

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

Returns: A constant reference to the optional container.

◆ membrane() [3/5]

void SimType::membrane ( ::std::unique_ptr< MembraneType > 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.

◆ membrane() [4/5]

void SimType::membrane ( const MembraneOptional & 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.

◆ membrane() [5/5]

void SimType::membrane ( const MembraneType & 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.

◆ objects() [1/4]

ObjectsType & SimType::objects ( )

Return a read-write reference to the element.

Returns: A reference to the element.

◆ objects() [2/4]

const ObjectsType & SimType::objects ( ) const

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

Returns: A constant reference to the element.

◆ objects() [3/4]

void SimType::objects ( ::std::unique_ptr< ObjectsType > 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.

◆ objects() [4/4]

void SimType::objects ( const ObjectsType & 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=()

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

◆ thermostat() [1/4]

ThermostatType & SimType::thermostat ( )

Return a read-write reference to the element.

Returns: A reference to the element.

◆ thermostat() [2/4]

const ThermostatType & SimType::thermostat ( ) const

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

Returns: A constant reference to the element.

◆ thermostat() [3/4]

void SimType::thermostat ( ::std::unique_ptr< ThermostatType > 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.

◆ thermostat() [4/4]

void SimType::thermostat ( const ThermostatType & 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.

◆ totalParticles() [1/4]

TotalParticlesOptional & SimType::totalParticles ( )

Return a read-write reference to the element container.

Returns: A reference to the optional container.

◆ totalParticles() [2/4]

const TotalParticlesOptional & SimType::totalParticles ( ) const

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

Returns: A constant reference to the optional container.

◆ totalParticles() [3/4]

void SimType::totalParticles ( const TotalParticlesOptional & 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.

◆ totalParticles() [4/4]

void SimType::totalParticles ( const TotalParticlesType & 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]

TypeType & SimType::type ( )

Return a read-write reference to the element.

Returns: A reference to the element.

◆ type() [2/4]

const TypeType & SimType::type ( ) const

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

Returns: A constant reference to the element.

◆ type() [3/4]

void SimType::type ( ::std::unique_ptr< TypeType > 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 SimType::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.

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

src/io/xsd/SimulationXSD.h

args

thermostat

membrane

type

linkedCells

dimensions

analyzer

objects

totalParticles

Constructors

Detailed Description

Member Typedef Documentation

◆ AnalyzerOptional

◆ AnalyzerTraits

◆ AnalyzerType

◆ ArgsOptional

◆ ArgsTraits

◆ ArgsType

◆ DimensionsOptional

◆ DimensionsTraits

◆ DimensionsType

◆ LinkedCellsOptional

◆ LinkedCellsTraits

◆ LinkedCellsType

◆ MembraneOptional

◆ MembraneTraits

◆ MembraneType

◆ ObjectsTraits

◆ ObjectsType

◆ ThermostatTraits

◆ ThermostatType

◆ TotalParticlesOptional

◆ TotalParticlesTraits

◆ TotalParticlesType

◆ TypeTraits

◆ TypeType

Constructor & Destructor Documentation

◆ SimType() [1/4]

◆ SimType() [2/4]

◆ SimType() [3/4]

◆ SimType() [4/4]

◆ ~SimType()

Member Function Documentation

◆ _clone()

◆ analyzer() [1/5]

◆ analyzer() [2/5]

◆ analyzer() [3/5]

◆ analyzer() [4/5]

◆ analyzer() [5/5]

◆ args() [1/5]

◆ args() [2/5]

◆ args() [3/5]

◆ args() [4/5]

◆ args() [5/5]

◆ dimensions() [1/4]

◆ dimensions() [2/4]

◆ dimensions() [3/4]

◆ dimensions() [4/4]

◆ linkedCells() [1/4]

◆ linkedCells() [2/4]

◆ linkedCells() [3/4]

◆ linkedCells() [4/4]

◆ membrane() [1/5]

◆ membrane() [2/5]

◆ membrane() [3/5]

◆ membrane() [4/5]

◆ membrane() [5/5]

◆ objects() [1/4]

◆ objects() [2/4]

◆ objects() [3/4]

◆ objects() [4/4]

◆ operator=()

◆ thermostat() [1/4]

◆ thermostat() [2/4]

◆ thermostat() [3/4]

◆ thermostat() [4/4]

◆ totalParticles() [1/4]

◆ totalParticles() [2/4]

◆ totalParticles() [3/4]

◆ totalParticles() [4/4]