MembraneType Class Reference

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

#include <SimulationXSD.h>

Inheritance diagram for MembraneType:

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

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

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

specialCase
Accessor and modifier functions for the specialCase sequence element.
typedef ::SpecialCaseType	SpecialCaseType
	Element type.
typedef ::xsd::cxx::tree::sequence< SpecialCaseType >	SpecialCaseSequence
	Element sequence container type.
typedef SpecialCaseSequence::iterator	SpecialCaseIterator
	Element iterator type.
typedef SpecialCaseSequence::const_iterator	SpecialCaseConstIterator
	Element constant iterator type.
typedef ::xsd::cxx::tree::traits< SpecialCaseType, char >	SpecialCaseTraits
	Element traits type.
const SpecialCaseSequence &	specialCase () const
	Return a read-only (constant) reference to the element sequence.
SpecialCaseSequence &	specialCase ()
	Return a read-write reference to the element sequence.
void	specialCase (const SpecialCaseSequence &s)
	Copy elements from a given sequence.

scIterationLimit
Accessor and modifier functions for the scIterationLimit optional element.
typedef ::xml_schema::Int	ScIterationLimitType
	Element type.
typedef ::xsd::cxx::tree::optional< ScIterationLimitType >	ScIterationLimitOptional
	Element optional container type.
typedef ::xsd::cxx::tree::traits< ScIterationLimitType, char >	ScIterationLimitTraits
	Element traits type.
const ScIterationLimitOptional &	scIterationLimit () const
	Return a read-only (constant) reference to the element container.
ScIterationLimitOptional &	scIterationLimit ()
	Return a read-write reference to the element container.
void	scIterationLimit (const ScIterationLimitType &x)
	Set the element value.
void	scIterationLimit (const ScIterationLimitOptional &x)
	Set the element value.

Constructors
	MembraneType (const StiffnessType &, const AvgBondLengthType &, const ZForceType &)
	Create an instance from the ultimate base and initializers for required elements and attributes.
	MembraneType (const ::xercesc::DOMElement &e, ::xml_schema::Flags f=0, ::xml_schema::Container *c=0)
	Create an instance from a DOM element.
	MembraneType (const MembraneType &x, ::xml_schema::Flags f=0, ::xml_schema::Container *c=0)
	Copy constructor.
virtual MembraneType *	_clone (::xml_schema::Flags f=0, ::xml_schema::Container *c=0) const
	Copy the instance polymorphically.
MembraneType &	operator= (const MembraneType &x)
	Copy assignment operator.
virtual	~MembraneType ()
	Destructor.

Detailed Description

Class corresponding to the membraneType schema type.

Member Typedef Documentation

AvgBondLengthTraits

typedef ::xsd::cxx::tree::traits<AvgBondLengthType, char, ::xsd::cxx::tree::schema_type::double_> MembraneType::AvgBondLengthTraits

Element traits type.

AvgBondLengthType

typedef ::xml_schema::Double MembraneType::AvgBondLengthType

Element type.

ScIterationLimitOptional

typedef ::xsd::cxx::tree::optional<ScIterationLimitType> MembraneType::ScIterationLimitOptional

Element optional container type.

ScIterationLimitTraits

typedef ::xsd::cxx::tree::traits<ScIterationLimitType, char> MembraneType::ScIterationLimitTraits

Element traits type.

ScIterationLimitType

typedef ::xml_schema::Int MembraneType::ScIterationLimitType

Element type.

SpecialCaseConstIterator

typedef SpecialCaseSequence::const_iterator MembraneType::SpecialCaseConstIterator

Element constant iterator type.

SpecialCaseIterator

typedef SpecialCaseSequence::iterator MembraneType::SpecialCaseIterator

Element iterator type.

SpecialCaseSequence

typedef ::xsd::cxx::tree::sequence<SpecialCaseType> MembraneType::SpecialCaseSequence

Element sequence container type.

SpecialCaseTraits

typedef ::xsd::cxx::tree::traits<SpecialCaseType, char> MembraneType::SpecialCaseTraits

Element traits type.

SpecialCaseType

typedef ::SpecialCaseType MembraneType::SpecialCaseType

Element type.

StiffnessTraits

typedef ::xsd::cxx::tree::traits<StiffnessType, char, ::xsd::cxx::tree::schema_type::double_> MembraneType::StiffnessTraits

Element traits type.

StiffnessType

typedef ::xml_schema::Double MembraneType::StiffnessType

Element type.

ZForceTraits

typedef ::xsd::cxx::tree::traits<ZForceType, char, ::xsd::cxx::tree::schema_type::double_> MembraneType::ZForceTraits

Element traits type.

ZForceType

typedef ::xml_schema::Double MembraneType::ZForceType

Element type.

Constructor & Destructor Documentation

MembraneType() [1/3]

MembraneType::MembraneType	(	const StiffnessType &	,
		const AvgBondLengthType &	,
		const ZForceType &
	)

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

MembraneType() [2/3]

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

MembraneType() [3/3]

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

~MembraneType()

virtual MembraneType::~MembraneType ( )

virtual

Destructor.

Member Function Documentation

_clone()

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

avgBondLength() [1/3]

AvgBondLengthType & MembraneType::avgBondLength

(

)

Return a read-write reference to the element.

Returns

A reference to the element.

avgBondLength() [2/3]

const AvgBondLengthType & MembraneType::avgBondLength

(

)

const

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

Returns

A constant reference to the element.

avgBondLength() [3/3]

void MembraneType::avgBondLength

(

const AvgBondLengthType &

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=()

MembraneType & MembraneType::operator=

(

const MembraneType &

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.

scIterationLimit() [1/4]

ScIterationLimitOptional & MembraneType::scIterationLimit

(

)

Return a read-write reference to the element container.

Returns

A reference to the optional container.

scIterationLimit() [2/4]

const ScIterationLimitOptional & MembraneType::scIterationLimit

(

)

const

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

Returns

A constant reference to the optional container.

scIterationLimit() [3/4]

void MembraneType::scIterationLimit

(

const ScIterationLimitOptional &

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.

scIterationLimit() [4/4]

void MembraneType::scIterationLimit

(

const ScIterationLimitType &

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.

specialCase() [1/3]

SpecialCaseSequence & MembraneType::specialCase

(

)

Return a read-write reference to the element sequence.

Returns

A reference to the sequence container.

specialCase() [2/3]

const SpecialCaseSequence & MembraneType::specialCase

(

)

const

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

Returns

A constant reference to the sequence container.

specialCase() [3/3]

void MembraneType::specialCase

(

const SpecialCaseSequence &

s

)

Copy elements from a given sequence.

Parameters

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

stiffness() [1/3]

StiffnessType & MembraneType::stiffness

(

)

Return a read-write reference to the element.

Returns

A reference to the element.

stiffness() [2/3]

const StiffnessType & MembraneType::stiffness

(

)

const

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

Returns

A constant reference to the element.

stiffness() [3/3]

void MembraneType::stiffness

(

const StiffnessType &

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.

zForce() [1/3]

ZForceType & MembraneType::zForce

(

)

Return a read-write reference to the element.

Returns

A reference to the element.

zForce() [2/3]

const ZForceType & MembraneType::zForce

(

)

const

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

Returns

A constant reference to the element.

zForce() [3/3]

void MembraneType::zForce

(

const ZForceType &

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