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

Pipeline data object that contains multiple vtkArray objects. More...

#include <vtkArrayData.h>

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

Public Types

typedef vtkDataObject Superclass
 
- Public Types inherited from vtkDataObject
typedef vtkObject Superclass
 
enum  FieldAssociations {
  FIELD_ASSOCIATION_POINTS, FIELD_ASSOCIATION_CELLS, FIELD_ASSOCIATION_NONE, FIELD_ASSOCIATION_POINTS_THEN_CELLS,
  FIELD_ASSOCIATION_VERTICES, FIELD_ASSOCIATION_EDGES, FIELD_ASSOCIATION_ROWS, NUMBER_OF_ASSOCIATIONS
}
 
enum  AttributeTypes {
  POINT, CELL, FIELD, POINT_THEN_CELL,
  VERTEX, EDGE, ROW, NUMBER_OF_ATTRIBUTE_TYPES
}
 
enum  FieldOperations { FIELD_OPERATION_PRESERVED, FIELD_OPERATION_REINTERPOLATED, FIELD_OPERATION_MODIFIED, FIELD_OPERATION_REMOVED }
 
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkArrayData * NewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void AddArray (vtkArray *)
 
void ClearArrays ()
 
vtkIdType GetNumberOfArrays ()
 
vtkArray * GetArray (vtkIdType index)
 
vtkArray * GetArrayByName (const char *name)
 
virtual int GetDataObjectType ()
 
virtual void ShallowCopy (vtkDataObject *other)
 
virtual void DeepCopy (vtkDataObject *other)
 
- Public Member Functions inherited from vtkDataObject
vtkDataObject * NewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
unsigned long int GetMTime ()
 
virtual void Initialize ()
 
void ReleaseData ()
 
unsigned long GetUpdateTime ()
 
virtual unsigned long GetActualMemorySize ()
 
virtual void CopyInformationToPipeline (vtkInformation *vtkNotUsed(info))
 
void DataHasBeenGenerated ()
 
virtual void PrepareForNewData ()
 
virtual int GetExtentType ()
 
virtual void Crop (const int *updateExtent)
 
virtual vtkDataSetAttributes * GetAttributes (int type)
 
virtual vtkFieldData * GetAttributesAsFieldData (int type)
 
virtual int GetAttributeTypeForArray (vtkAbstractArray *arr)
 
virtual vtkIdType GetNumberOfElements (int type)
 
virtual vtkInformation * GetInformation ()
 
virtual void SetInformation (vtkInformation *)
 
virtual int GetDataReleased ()
 
virtual void SetFieldData (vtkFieldData *)
 
virtual vtkFieldData * GetFieldData ()
 
virtual void CopyInformationFromPipeline (vtkInformation *vtkNotUsed(info))
 
void GlobalReleaseDataFlagOn ()
 
void GlobalReleaseDataFlagOff ()
 
- Public Member Functions inherited from vtkObject
vtkObject * NewInstance () const
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommand * GetCommand (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 vtkArrayData * New ()
 
static int IsTypeOf (const char *type)
 
static vtkArrayData * SafeDownCast (vtkObjectBase *o)
 
static vtkArrayData * GetData (vtkInformation *info)
 
static vtkArrayData * GetData (vtkInformationVector *v, int i=0)
 
- Static Public Member Functions inherited from vtkDataObject
static vtkDataObject * New ()
 
static int IsTypeOf (const char *type)
 
static vtkDataObject * SafeDownCast (vtkObjectBase *o)
 
static const char * GetAssociationTypeAsString (int associationType)
 
static int GetAssociationTypeFromString (const char *associationType)
 
static vtkInformationStringKey * DATA_TYPE_NAME ()
 
static vtkInformationDataObjectKey * DATA_OBJECT ()
 
static vtkInformationIntegerKey * DATA_EXTENT_TYPE ()
 
static vtkInformationIntegerPointerKey * DATA_EXTENT ()
 
static vtkInformationIntegerVectorKey * ALL_PIECES_EXTENT ()
 
static vtkInformationIntegerKey * DATA_PIECE_NUMBER ()
 
static vtkInformationIntegerKey * DATA_NUMBER_OF_PIECES ()
 
static vtkInformationIntegerKey * DATA_NUMBER_OF_GHOST_LEVELS ()
 
static vtkInformationDoubleKey * DATA_TIME_STEP ()
 
static vtkInformationInformationVectorKey * POINT_DATA_VECTOR ()
 
static vtkInformationInformationVectorKey * CELL_DATA_VECTOR ()
 
static vtkInformationInformationVectorKey * VERTEX_DATA_VECTOR ()
 
static vtkInformationInformationVectorKey * EDGE_DATA_VECTOR ()
 
static vtkInformationIntegerKey * FIELD_ARRAY_TYPE ()
 
static vtkInformationIntegerKey * FIELD_ASSOCIATION ()
 
static vtkInformationIntegerKey * FIELD_ATTRIBUTE_TYPE ()
 
static vtkInformationIntegerKey * FIELD_ACTIVE_ATTRIBUTE ()
 
static vtkInformationIntegerKey * FIELD_NUMBER_OF_COMPONENTS ()
 
static vtkInformationIntegerKey * FIELD_NUMBER_OF_TUPLES ()
 
static vtkInformationIntegerKey * FIELD_OPERATION ()
 
static vtkInformationDoubleVectorKey * FIELD_RANGE ()
 
static vtkInformationIntegerVectorKey * PIECE_EXTENT ()
 
static vtkInformationStringKey * FIELD_NAME ()
 
static vtkInformationDoubleVectorKey * ORIGIN ()
 
static vtkInformationDoubleVectorKey * SPACING ()
 
static vtkInformationDoubleVectorKey * BOUNDING_BOX ()
 
static vtkInformationDataObjectKey * SIL ()
 
static vtkInformation * GetActiveFieldInformation (vtkInformation *info, int fieldAssociation, int attributeType)
 
static vtkInformation * GetNamedFieldInformation (vtkInformation *info, int fieldAssociation, const char *name)
 
static void RemoveNamedFieldInformation (vtkInformation *info, int fieldAssociation, const char *name)
 
static vtkInformation * SetActiveAttribute (vtkInformation *info, int fieldAssociation, const char *attributeName, int attributeType)
 
static void SetActiveAttributeInfo (vtkInformation *info, int fieldAssociation, int attributeType, const char *name, int arrayType, int numComponents, int numTuples)
 
static void SetPointDataActiveScalarInfo (vtkInformation *info, int arrayType, int numComponents)
 
static vtkDataObject * GetData (vtkInformation *info)
 
static vtkDataObject * GetData (vtkInformationVector *v, int i=0)
 
static void SetGlobalReleaseDataFlag (int val)
 
static int GetGlobalReleaseDataFlag ()
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObject * SafeDownCast (vtkObjectBase *o)
 
static vtkObject * New ()
 
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 vtkObjectBase * New ()
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkArrayData ()
 
 ~vtkArrayData ()
 
- Protected Member Functions inherited from vtkDataObject
 vtkDataObject ()
 
 ~vtkDataObject ()
 
- 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 vtkDataObject
vtkFieldData * FieldData
 
int DataReleased
 
vtkTimeStamp UpdateTime
 
vtkInformation * Information
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

Pipeline data object that contains multiple vtkArray objects.

Because vtkArray cannot be stored as attributes of data objects (yet), a "carrier" object is needed to pass vtkArray through the pipeline. vtkArrayData acts as a container of zero-to-many vtkArray instances, which can be retrieved via a zero-based index. Note that a collection of arrays stored in vtkArrayData may-or-may-not have related types, dimensions, or extents.

See also
vtkArrayDataAlgorithm, vtkArray
Thanks:
Developed by Timothy M. Shead (tshea.nosp@m.d@sa.nosp@m.ndia..nosp@m.gov) at Sandia National Laboratories.
Tests:
vtkArrayData (Tests)

Definition at line 51 of file vtkArrayData.h.

Member Typedef Documentation

typedef vtkDataObject vtkArrayData::Superclass

Definition at line 55 of file vtkArrayData.h.

Constructor & Destructor Documentation

vtkArrayData::vtkArrayData ( )
protected
vtkArrayData::~vtkArrayData ( )
protected

Member Function Documentation

static vtkArrayData* vtkArrayData::New ( )
static
static int vtkArrayData::IsTypeOf ( const char *  type)
static
virtual int vtkArrayData::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 vtkDataObject.

static vtkArrayData* vtkArrayData::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkArrayData::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkDataObject.

vtkArrayData* vtkArrayData::NewInstance ( ) const
void vtkArrayData::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 vtkArrayData* vtkArrayData::GetData ( vtkInformation *  info)
static
static vtkArrayData* vtkArrayData::GetData ( vtkInformationVector *  v,
int  i = 0 
)
static
void vtkArrayData::AddArray ( vtkArray *  )

Adds a vtkArray to the collection

void vtkArrayData::ClearArrays ( )

Clears the contents of the collection

vtkIdType vtkArrayData::GetNumberOfArrays ( )

Returns the number of vtkArray instances in the collection

vtkArray* vtkArrayData::GetArray ( vtkIdType  index)

Returns the n-th vtkArray in the collection

vtkArray* vtkArrayData::GetArrayByName ( const char *  name)

Returns the array having called name from the collection

virtual int vtkArrayData::GetDataObjectType ( )
inlinevirtual

Return class name of data type (VTK_ARRAY_DATA).

Reimplemented from vtkDataObject.

Definition at line 77 of file vtkArrayData.h.

virtual void vtkArrayData::ShallowCopy ( vtkDataObject *  src)
virtual

Shallow and Deep copy. These copy the data, but not any of the pipeline connections.

Reimplemented from vtkDataObject.

virtual void vtkArrayData::DeepCopy ( vtkDataObject *  src)
virtual

Shallow and Deep copy. These copy the data, but not any of the pipeline connections.

Reimplemented from vtkDataObject.

The documentation for this class was generated from the following file:
Generated on Wed Dec 16 2015 17:15:28 for VTK by   doxygen 1.8.9.1