Molecular Dynamics  v0.4
Project for the Practical hosted by the Scientific Computing Chair
List of all members
SingleParticles Class Reference

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

#include <ConfigurationFile.h>

Inheritance diagram for SingleParticles:
Inheritance graph
Collaboration diagram for SingleParticles:
Collaboration graph

Size

Accessor and modifier functions for the Size required element.

typedef ::Size Size_type
 Element type. More...
 
typedef ::xsd::cxx::tree::traits< Size_type, char > Size_traits
 Element traits type. More...
 
const Size_typeSize () const
 Return a read-only (constant) reference to the element. More...
 
Size_typeSize ()
 Return a read-write reference to the element. More...
 
void Size (const Size_type &x)
 Set the element value. More...
 
void Size (::std::unique_ptr< Size_type > p)
 Set the element value without copying. More...
 

SingleParticle

Accessor and modifier functions for the SingleParticle sequence element.

typedef ::SingleParticle SingleParticle_type
 Element type. More...
 
typedef ::xsd::cxx::tree::sequence< SingleParticle_typeSingleParticle_sequence
 Element sequence container type. More...
 
typedef SingleParticle_sequence::iterator SingleParticle_iterator
 Element iterator type. More...
 
typedef SingleParticle_sequence::const_iterator SingleParticle_const_iterator
 Element constant iterator type. More...
 
typedef ::xsd::cxx::tree::traits< SingleParticle_type, char > SingleParticle_traits
 Element traits type. More...
 
const SingleParticle_sequenceSingleParticle () const
 Return a read-only (constant) reference to the element sequence. More...
 
SingleParticle_sequenceSingleParticle ()
 Return a read-write reference to the element sequence. More...
 
void SingleParticle (const SingleParticle_sequence &s)
 Copy elements from a given sequence. More...
 

Constructors

 SingleParticles (const Size_type &)
 Create an instance from the ultimate base and initializers for required elements and attributes. More...
 
 SingleParticles (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Create an instance from a DOM element. More...
 
 SingleParticles (const SingleParticles &x, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
 Copy constructor. More...
 
virtual SingleParticles_clone (::xml_schema::flags f=0, ::xml_schema::container *c=0) const
 Copy the instance polymorphically. More...
 
SingleParticlesoperator= (const SingleParticles &x)
 Copy assignment operator. More...
 
virtual ~SingleParticles ()
 Destructor. More...
 

Detailed Description

Class corresponding to the SingleParticles schema type.

Member Typedef Documentation

◆ SingleParticle_const_iterator

typedef SingleParticle_sequence::const_iterator SingleParticles::SingleParticle_const_iterator

Element constant iterator type.

◆ SingleParticle_iterator

typedef SingleParticle_sequence::iterator SingleParticles::SingleParticle_iterator

Element iterator type.

◆ SingleParticle_sequence

typedef ::xsd::cxx::tree::sequence< SingleParticle_type > SingleParticles::SingleParticle_sequence

Element sequence container type.

◆ SingleParticle_traits

typedef ::xsd::cxx::tree::traits< SingleParticle_type, char > SingleParticles::SingleParticle_traits

Element traits type.

◆ SingleParticle_type

Element type.

◆ Size_traits

typedef ::xsd::cxx::tree::traits< Size_type, char > SingleParticles::Size_traits

Element traits type.

◆ Size_type

Element type.

Constructor & Destructor Documentation

◆ SingleParticles() [1/3]

SingleParticles::SingleParticles ( const Size_type Size)

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

◆ SingleParticles() [2/3]

SingleParticles::SingleParticles ( const ::xercesc::DOMElement &  e,
::xml_schema::flags  f = 0,
::xml_schema::container c = 0 
)

Create an instance from a DOM element.

Parameters
eA DOM element to extract the data from.
fFlags to create the new instance with.
cA pointer to the object that will contain the new instance.

◆ SingleParticles() [3/3]

SingleParticles::SingleParticles ( const SingleParticles x,
::xml_schema::flags  f = 0,
::xml_schema::container c = 0 
)

Copy constructor.

Parameters
xAn instance to make a copy of.
fFlags to create the copy with.
cA pointer to the object that will contain the copy.

For polymorphic object models use the _clone function instead.

◆ ~SingleParticles()

SingleParticles::~SingleParticles ( )
virtual

Destructor.

Member Function Documentation

◆ _clone()

SingleParticles * SingleParticles::_clone ( ::xml_schema::flags  f = 0,
::xml_schema::container c = 0 
) const
virtual

Copy the instance polymorphically.

Parameters
fFlags to create the copy with.
cA 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.

◆ operator=()

SingleParticles & SingleParticles::operator= ( const SingleParticles x)

Copy assignment operator.

Parameters
xAn instance to make a copy of.
Returns
A reference to itself.

For polymorphic object models use the _clone function instead.

◆ SingleParticle() [1/3]

SingleParticles::SingleParticle_sequence & SingleParticles::SingleParticle ( )

Return a read-write reference to the element sequence.

Returns
A reference to the sequence container.

◆ SingleParticle() [2/3]

const SingleParticles::SingleParticle_sequence & SingleParticles::SingleParticle ( ) const

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

Returns
A constant reference to the sequence container.
Here is the caller graph for this function:

◆ SingleParticle() [3/3]

void SingleParticles::SingleParticle ( const SingleParticle_sequence s)

Copy elements from a given sequence.

Parameters
sA sequence to copy elements from.

For each element in s this function makes a copy and adds it to the sequence. Note that this operation completely changes the sequence and all old elements will be lost.

◆ Size() [1/4]

SingleParticles::Size_type & SingleParticles::Size ( )

Return a read-write reference to the element.

Returns
A reference to the element.

◆ Size() [2/4]

const SingleParticles::Size_type & SingleParticles::Size ( ) 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:

◆ Size() [3/4]

void SingleParticles::Size ( ::std::unique_ptr< Size_type p)

Set the element value without copying.

Parameters
pA new value to use.

This function will try to use the passed value directly instead of making a copy.

◆ Size() [4/4]

void SingleParticles::Size ( const Size_type x)

Set the element value.

Parameters
xA 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: