VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | List of all members
vtkGhostArray Class Reference

#include <vtkGhostArray.h>

Inherits vtkObject.

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)
 
vtkGhostArrayNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 

Static Public Member Functions

static vtkGhostArrayNew ()
 
static int IsTypeOf (const char *type)
 
static vtkGhostArraySafeDownCast (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

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
static int vtkGhostArray::IsTypeOf ( const char *  type)
static
virtual int vtkGhostArray::IsA ( const char *  type)
virtual
static vtkGhostArray* vtkGhostArray::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkGhostArray::NewInstanceInternal ( ) const
protectedvirtual
vtkGhostArray* vtkGhostArray::NewInstance ( ) const
void vtkGhostArray::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
static void vtkGhostArray::SetProperty ( unsigned char &  propertyField,
const int  property 
)
inlinestatic

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 
)
inlinestatic

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 
)
inlinestatic

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)
inlinestatic

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: