vtkGhostArray Class Reference

#include <vtkGhostArray.h>

Inheritance diagram for vtkGhostArray:

Collaboration diagram for vtkGhostArray:

List of all members.

Public Types
enum	{   INTERNAL = 0, SHARED = 1, GHOST = 2, VOID = 3,   IGNORE = 4, BOUNDARY = 5, PERIODIC = 6 }
enum	{ DUPLICATE = 0, EXTERNAL = 1, BLANK = 2, INTERIOR = 3 }
typedef vtkObject	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkGhostArray *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
Static Public Member Functions
static vtkGhostArray *	New ()
static int	IsTypeOf (const char *type)
static vtkGhostArray *	SafeDownCast (vtkObjectBase *o)
static void	SetProperty (unsigned char &propertyField, const int property)
static void	UnsetProperty (unsigned char &propertyField, const int property)
static bool	IsPropertySet (unsigned char &propertyField, const int property)
static void	Reset (unsigned char &propertyField)
Public Attributes
enum vtkGhostArray:: { ... }	NodeProperties
enum vtkGhostArray:: { ... }	CellProperties
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkGhostArray ()
	~vtkGhostArray ()

---

Detailed Description

vtkGhostArray provides functionality for manipulating a mesh entity property field, represented by an "unsigned char". Each mesh entity, e.g., a vertex or cell is associated with an "unsigned char" where each individual bit represents the state of a particular property. This class provides the logic required to manipulate individual bits in the "unsigned char".

Warning:

Since an unsigned char is used to represent a mesh entity property field, we are restricted to at most 8 properties, i.e., [0-7] that can be used to designate different states.

Tests:

vtkGhostArray (Tests)

Definition at line 41 of file vtkGhostArray.h.

---

Member Typedef Documentation

typedef vtkObject vtkGhostArray::Superclass

Reimplemented from vtkObject.

Definition at line 77 of file vtkGhostArray.h.

---

Member Enumeration Documentation

anonymous enum

Enumerator:

INTERNAL
SHARED
GHOST
VOID
IGNORE
BOUNDARY
PERIODIC

Definition at line 45 of file vtkGhostArray.h.

anonymous enum

Enumerator:

DUPLICATE
EXTERNAL
BLANK
INTERIOR

Definition at line 62 of file vtkGhostArray.h.

---

Constructor & Destructor Documentation

vtkGhostArray::vtkGhostArray

(

)

[protected]

vtkGhostArray::~vtkGhostArray

(

)

[protected]

---

Member Function Documentation

static vtkGhostArray* vtkGhostArray::New

(

)

[static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

static int vtkGhostArray::IsTypeOf

(

const char *

name

)

[static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

virtual int vtkGhostArray::IsA

(

const char *

name

)

[virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

static vtkGhostArray* vtkGhostArray::SafeDownCast

(

vtkObjectBase *

o

)

[static]

Reimplemented from vtkObject.

virtual vtkObjectBase* vtkGhostArray::NewInstanceInternal

(

)

const [protected, virtual]

Reimplemented from vtkObject.

vtkGhostArray* vtkGhostArray::NewInstance

(

)

const

Reimplemented from vtkObject.

void vtkGhostArray::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)		[virtual]

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

static void vtkGhostArray::SetProperty	(	unsigned char &	propertyField,
		const int	property
	)		[inline, static]

Sets the given property in the propertyField.

Definition at line 82 of file vtkGhostArray.h.

static void vtkGhostArray::UnsetProperty	(	unsigned char &	propertyField,
		const int	property
	)		[inline, static]

Unsets the property from the given propertyField.

Definition at line 92 of file vtkGhostArray.h.

static bool vtkGhostArray::IsPropertySet	(	unsigned char &	propertyField,
		const int	property
	)		[inline, static]

Checks if a property is set in the given property field.

Definition at line 102 of file vtkGhostArray.h.

static void vtkGhostArray::Reset

(

unsigned char &

propertyField

)

[inline, static]

Resets all the bits in the property field

Definition at line 118 of file vtkGhostArray.h.

---

Member Data Documentation

enum { ... } vtkGhostArray::NodeProperties

enum { ... } vtkGhostArray::CellProperties

---

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

• dox/Filters/Core/vtkGhostArray.h