PUnstructuredGrid_t Class Reference

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

#include <vtk-punstructured.h>

Inheritance diagram for PUnstructuredGrid_t:

PPointData
Accessor and modifier functions for the PPointData required element.
typedef ::xsd::cxx::tree::traits< PPointData_type, char >	PPointData_traits
	Element traits type.
typedef::PPointData	PPointData_type
	Element type.
const PPointData_type &	PPointData () const
	Return a read-only (constant) reference to the element. More...
PPointData_type &	PPointData ()
	Return a read-write reference to the element. More...
void	PPointData (const PPointData_type &x)
	Set the element value. More...
void	PPointData (::std::unique_ptr< PPointData_type > p)
	Set the element value without copying. More...

PCellData
Accessor and modifier functions for the PCellData required element.
typedef ::xsd::cxx::tree::traits< PCellData_type, char >	PCellData_traits
	Element traits type.
typedef::PCellData	PCellData_type
	Element type.
const PCellData_type &	PCellData () const
	Return a read-only (constant) reference to the element. More...
PCellData_type &	PCellData ()
	Return a read-write reference to the element. More...
void	PCellData (const PCellData_type &x)
	Set the element value. More...
void	PCellData (::std::unique_ptr< PCellData_type > p)
	Set the element value without copying. More...

PPoints
Accessor and modifier functions for the PPoints required element.
typedef ::xsd::cxx::tree::traits< PPoints_type, char >	PPoints_traits
	Element traits type.
typedef::PPoints	PPoints_type
	Element type.
const PPoints_type &	PPoints () const
	Return a read-only (constant) reference to the element. More...
PPoints_type &	PPoints ()
	Return a read-write reference to the element. More...
void	PPoints (const PPoints_type &x)
	Set the element value. More...
void	PPoints (::std::unique_ptr< PPoints_type > p)
	Set the element value without copying. More...

PCells
Accessor and modifier functions for the PCells required element.
typedef ::xsd::cxx::tree::traits< PCells_type, char >	PCells_traits
	Element traits type.
typedef::PCells	PCells_type
	Element type.
const PCells_type &	PCells () const
	Return a read-only (constant) reference to the element. More...
PCells_type &	PCells ()
	Return a read-write reference to the element. More...
void	PCells (const PCells_type &x)
	Set the element value. More...
void	PCells (::std::unique_ptr< PCells_type > p)
	Set the element value without copying. More...

Piece
Accessor and modifier functions for the Piece sequence element.
typedef ::xsd::cxx::tree::sequence< Piece_type >	Piece_sequence
	Element sequence container type.
typedef Piece_sequence::iterator	Piece_iterator
	Element iterator type.
typedef Piece_sequence::const_iterator	Piece_const_iterator
	Element constant iterator type.
typedef ::xsd::cxx::tree::traits< Piece_type, char >	Piece_traits
	Element traits type.
typedef::Piece	Piece_type
	Element type.
const Piece_sequence &	Piece () const
	Return a read-only (constant) reference to the element sequence. More...
Piece_sequence &	Piece ()
	Return a read-write reference to the element sequence. More...
void	Piece (const Piece_sequence &s)
	Copy elements from a given sequence. More...

GhostLevel
Accessor and modifier functions for the GhostLevel required attribute.
typedef ::xsd::cxx::tree::traits< GhostLevel_type, char >	GhostLevel_traits
	Attribute traits type.
typedef::xml_schema::integer	GhostLevel_type
	Attribute type.
const GhostLevel_type &	GhostLevel () const
	Return a read-only (constant) reference to the attribute. More...
static GhostLevel_type	GhostLevel_default_value ()
	Return the default value for the attribute. More...

Constructors
	PUnstructuredGrid_t (const PPointData_type &, const PCellData_type &, const PPoints_type &, const PCells_type &)
	Create an instance from the ultimate base and initializers for required elements and attributes.
	PUnstructuredGrid_t (::std::unique_ptr< PPointData_type >, ::std::unique_ptr< PCellData_type >, ::std::unique_ptr< PPoints_type >, ::std::unique_ptr< PCells_type >)
	Create an instance from the ultimate base and initializers for required elements and attributes (::std::unique_ptr version). More...
	PUnstructuredGrid_t (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
	Create an instance from a DOM element. More...
	PUnstructuredGrid_t (const PUnstructuredGrid_t &x, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
	Copy constructor. More...
virtual PUnstructuredGrid_t *	_clone (::xml_schema::flags f=0, ::xml_schema::container *c=0) const
	Copy the instance polymorphically. More...
PUnstructuredGrid_t &	operator= (const PUnstructuredGrid_t &x)
	Copy assignment operator. More...
virtual	~PUnstructuredGrid_t ()
	Destructor.

Detailed Description

Class corresponding to the PUnstructuredGrid_t schema type.

Constructor & Destructor Documentation

PUnstructuredGrid_t() [1/3]

PUnstructuredGrid_t::PUnstructuredGrid_t	(	::std::unique_ptr< PPointData_type >	PPointData,
		::std::unique_ptr< PCellData_type >	PCellData,
		::std::unique_ptr< PPoints_type >	PPoints,
		::std::unique_ptr< PCells_type >	PCells
	)

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.

PUnstructuredGrid_t() [2/3]

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

PUnstructuredGrid_t() [3/3]

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

Member Function Documentation

_clone()

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

GhostLevel()

const PUnstructuredGrid_t::GhostLevel_type & PUnstructuredGrid_t::GhostLevel

(

)

const

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

Returns

A constant reference to the attribute.

GhostLevel_default_value()

PUnstructuredGrid_t::GhostLevel_type PUnstructuredGrid_t::GhostLevel_default_value ( )

static

Return the default value for the attribute.

Returns

The attribute's default value.

operator=()

PUnstructuredGrid_t & PUnstructuredGrid_t::operator=

(

const PUnstructuredGrid_t &

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.

PCellData() [1/4]

PUnstructuredGrid_t::PCellData_type & PUnstructuredGrid_t::PCellData

(

)

Return a read-write reference to the element.

Returns

A reference to the element.

PCellData() [2/4]

const PUnstructuredGrid_t::PCellData_type & PUnstructuredGrid_t::PCellData

(

)

const

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

Returns

A constant reference to the element.

PCellData() [3/4]

void PUnstructuredGrid_t::PCellData

(

::std::unique_ptr< PCellData_type >

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.

PCellData() [4/4]

void PUnstructuredGrid_t::PCellData

(

const PCellData_type &

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.

PCells() [1/4]

PUnstructuredGrid_t::PCells_type & PUnstructuredGrid_t::PCells

(

)

Return a read-write reference to the element.

Returns

A reference to the element.

PCells() [2/4]

const PUnstructuredGrid_t::PCells_type & PUnstructuredGrid_t::PCells

(

)

const

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

Returns

A constant reference to the element.

PCells() [3/4]

void PUnstructuredGrid_t::PCells

(

::std::unique_ptr< PCells_type >

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.

PCells() [4/4]

void PUnstructuredGrid_t::PCells

(

const PCells_type &

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.

Piece() [1/3]

PUnstructuredGrid_t::Piece_sequence & PUnstructuredGrid_t::Piece

(

)

Return a read-write reference to the element sequence.

Returns

A reference to the sequence container.

Piece() [2/3]

const PUnstructuredGrid_t::Piece_sequence & PUnstructuredGrid_t::Piece

(

)

const

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

Returns

A constant reference to the sequence container.

Piece() [3/3]

void PUnstructuredGrid_t::Piece

(

const Piece_sequence &

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.

PPointData() [1/4]

PUnstructuredGrid_t::PPointData_type & PUnstructuredGrid_t::PPointData

(

)

Return a read-write reference to the element.

Returns

A reference to the element.

PPointData() [2/4]

const PUnstructuredGrid_t::PPointData_type & PUnstructuredGrid_t::PPointData

(

)

const

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

Returns

A constant reference to the element.

PPointData() [3/4]

void PUnstructuredGrid_t::PPointData

(

::std::unique_ptr< PPointData_type >

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.

PPointData() [4/4]

void PUnstructuredGrid_t::PPointData

(

const PPointData_type &

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.

PPoints() [1/4]

PUnstructuredGrid_t::PPoints_type & PUnstructuredGrid_t::PPoints

(

)

Return a read-write reference to the element.

Returns

A reference to the element.

PPoints() [2/4]

const PUnstructuredGrid_t::PPoints_type & PUnstructuredGrid_t::PPoints

(

)

const

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

Returns

A constant reference to the element.

PPoints() [3/4]

void PUnstructuredGrid_t::PPoints

(

::std::unique_ptr< PPoints_type >

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.

PPoints() [4/4]

void PUnstructuredGrid_t::PPoints

(

const PPoints_type &

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 files:

• src/io/vtk/vtk-punstructured.h
• src/io/vtk/vtk-punstructured.cpp