VTK
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | List of all members
vtkGhostArray Class Reference

#include <vtkGhostArray.h>

Inheritance diagram for vtkGhostArray:
[legend]
Collaboration diagram for vtkGhostArray:
[legend]

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 Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkGhostArrayNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
- Public Member Functions inherited from vtkObject
vtkObjectNewInstance () const
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
unsigned char GetDebug ()
 
void SetDebug (unsigned char debugFlag)
 
virtual void Modified ()
 
virtual unsigned long GetMTime ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

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)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObjectBase *o)
 
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 

Public Attributes

enum vtkGhostArray:: { ... }  NodeProperties
 
enum vtkGhostArray:: { ... }  CellProperties
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkGhostArray ()
 
 ~vtkGhostArray ()
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
virtual void RegisterInternal (vtkObjectBase *, int check)
 
virtual void UnRegisterInternal (vtkObjectBase *, int check)
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Additional Inherited Members

- Protected Attributes inherited from vtkObject
unsigned char Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt< vtkTypeInt32 > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

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

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 *  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
virtual vtkObjectBase* vtkGhostArray::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkObject.

vtkGhostArray* vtkGhostArray::NewInstance ( ) const
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 
)
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: