Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends | List of all members
vtkPVArrayInformation Class Reference

provides meta data about arrays. More...

#include <vtkPVArrayInformation.h>

Inheritance diagram for vtkPVArrayInformation:
Inheritance graph
[legend]
Collaboration diagram for vtkPVArrayInformation:
Collaboration graph
[legend]

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void Initialize ()
 Resets to default state. More...
 
virtual int GetDataType ()
 Get the type for values in the array e.g. More...
 
const char * GetDataTypeAsString () const
 Returns a printable string for the array value type. More...
 
std::string GetRangesAsString () const
 Returns range as a string. More...
 
const char * GetName () const
 Get array's name. More...
 
int GetNumberOfComponents () const
 Get number of components. More...
 
const char * GetComponentName (int component) const
 Returns the name for a component. More...
 
virtual vtkTypeInt64 GetNumberOfTuples ()
 Returns the number of tuples in this array. More...
 
void GetDataTypeRange (double range[2]) const
 This method return the Min and Max possible range of the native data type. More...
 
void CopyFromArray (vtkAbstractArray *array)
 
void CopyFromGenericAttribute (vtkGenericAttribute *array)
 
void CopyToStream (vtkClientServerStream *) const
 
bool CopyFromStream (const vtkClientServerStream *)
 
const doubleGetComponentRange (int comp) const VTK_SIZEHINT(2)
 Returns component range. More...
 
void GetComponentRange (int comp, double range[2]) const
 Returns component range. More...
 
const doubleGetComponentFiniteRange (int component) const VTK_SIZEHINT(2)
 Returns the finite range for each component. More...
 
void GetComponentFiniteRange (int comp, double range[2]) const
 Returns the finite range for each component. More...
 
virtual bool GetIsPartial ()
 If IsPartial is true, this array is in only some of the parts of a multi-block dataset. More...
 
int GetNumberOfInformationKeys () const
 Get information on the InformationKeys of this array. More...
 
const char * GetInformationKeyLocation (int) const
 Get information on the InformationKeys of this array. More...
 
const char * GetInformationKeyName (int) const
 Get information on the InformationKeys of this array. More...
 
bool HasInformationKey (const char *location, const char *name) const
 Get information on the InformationKeys of this array. More...
 
int GetNumberOfStringValues ()
 For string arrays, this returns first few non-empty values. More...
 
const char * GetStringValue (int)
 For string arrays, this returns first few non-empty values. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual vtkMTimeType GetMTime ()
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
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 *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
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)
 
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 *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
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)
 
- 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)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 

Static Public Member Functions

static vtkPVArrayInformationNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPVArrayInformationSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 
static vtkObjectBaseNew ()
 

Protected Member Functions

 vtkPVArrayInformation ()
 
 ~vtkPVArrayInformation () override
 
virtual void SetName (std::string)
 
void DeepCopy (vtkPVArrayInformation *info)
 API for vtkPVDataSetAttributesInformation. More...
 
void AddInformation (vtkPVArrayInformation *, int fieldAssociation)
 API for vtkPVDataSetAttributesInformation. More...
 
virtual void SetIsPartial (bool)
 API for vtkPVDataSetAttributesInformation. More...
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
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 &)
 

Friends

class vtkPVDataSetAttributesInformation
 
class vtkPVDataInformation
 

Additional Inherited Members

- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

provides meta data about arrays.

vtkPVArrayInformation provides meta-data about individual arrays. It is accessed through vtkPVDataInformation and provides information like ranges, component names, etc. for array present in a dataset.

Definition at line 39 of file vtkPVArrayInformation.h.

Member Typedef Documentation

◆ Superclass

Definition at line 43 of file vtkPVArrayInformation.h.

Constructor & Destructor Documentation

◆ vtkPVArrayInformation()

vtkPVArrayInformation::vtkPVArrayInformation ( )
protected

◆ ~vtkPVArrayInformation()

vtkPVArrayInformation::~vtkPVArrayInformation ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkPVArrayInformation* vtkPVArrayInformation::New ( )
static

◆ GetClassName()

virtual const char* vtkPVArrayInformation::GetClassName ( )
virtual

◆ IsTypeOf()

static int vtkPVArrayInformation::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual int vtkPVArrayInformation::IsA ( const char *  type)
virtual

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

static vtkPVArrayInformation* vtkPVArrayInformation::SafeDownCast ( vtkObject o)
static

◆ PrintSelf()

void vtkPVArrayInformation::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Reimplemented from vtkObject.

◆ Initialize()

void vtkPVArrayInformation::Initialize ( )

Resets to default state.

◆ GetDataType()

virtual int vtkPVArrayInformation::GetDataType ( )
virtual

Get the type for values in the array e.g.

VTK_FLOAT, VTK_DOUBLE etc.

◆ GetDataTypeAsString()

const char* vtkPVArrayInformation::GetDataTypeAsString ( ) const
inline

Returns a printable string for the array value type.

Definition at line 59 of file vtkPVArrayInformation.h.

◆ GetRangesAsString()

std::string vtkPVArrayInformation::GetRangesAsString ( ) const

Returns range as a string.

For string arrays, this lists string values instead.

◆ GetName()

const char* vtkPVArrayInformation::GetName ( ) const
inline

Get array's name.

Definition at line 70 of file vtkPVArrayInformation.h.

◆ GetNumberOfComponents()

int vtkPVArrayInformation::GetNumberOfComponents ( ) const

Get number of components.

◆ GetComponentName()

const char* vtkPVArrayInformation::GetComponentName ( int  component) const

Returns the name for a component.

If none present, a default component name may be returned.

◆ GetNumberOfTuples()

virtual vtkTypeInt64 vtkPVArrayInformation::GetNumberOfTuples ( )
virtual

Returns the number of tuples in this array.

◆ GetComponentRange() [1/2]

const double* vtkPVArrayInformation::GetComponentRange ( int  comp) const

Returns component range.

If component is -1, then the range of the magnitude (L2 norm) over all components will be provided.

Returns invalid range for non-numeric arrays.

◆ GetComponentRange() [2/2]

void vtkPVArrayInformation::GetComponentRange ( int  comp,
double  range[2] 
) const

Returns component range.

If component is -1, then the range of the magnitude (L2 norm) over all components will be provided.

Returns invalid range for non-numeric arrays.

◆ GetComponentFiniteRange() [1/2]

const double* vtkPVArrayInformation::GetComponentFiniteRange ( int  component) const

Returns the finite range for each component.

If component is -1, then the range of the magnitude (L2 norm) over all components will be provided.

Returns invalid range for non-numeric arrays.

◆ GetComponentFiniteRange() [2/2]

void vtkPVArrayInformation::GetComponentFiniteRange ( int  comp,
double  range[2] 
) const

Returns the finite range for each component.

If component is -1, then the range of the magnitude (L2 norm) over all components will be provided.

Returns invalid range for non-numeric arrays.

◆ GetDataTypeRange()

void vtkPVArrayInformation::GetDataTypeRange ( double  range[2]) const

This method return the Min and Max possible range of the native data type.

For example if a vtkScalars consists of unsigned char data these will return (0,255). Nothing particular for 12bits data is done

◆ GetIsPartial()

virtual bool vtkPVArrayInformation::GetIsPartial ( )
virtual

If IsPartial is true, this array is in only some of the parts of a multi-block dataset.

By default, IsPartial is set to 0.

◆ GetNumberOfInformationKeys()

int vtkPVArrayInformation::GetNumberOfInformationKeys ( ) const

Get information on the InformationKeys of this array.

◆ GetInformationKeyLocation()

const char* vtkPVArrayInformation::GetInformationKeyLocation ( int  ) const

Get information on the InformationKeys of this array.

◆ GetInformationKeyName()

const char* vtkPVArrayInformation::GetInformationKeyName ( int  ) const

Get information on the InformationKeys of this array.

◆ HasInformationKey()

bool vtkPVArrayInformation::HasInformationKey ( const char *  location,
const char *  name 
) const

Get information on the InformationKeys of this array.

◆ GetNumberOfStringValues()

int vtkPVArrayInformation::GetNumberOfStringValues ( )

For string arrays, this returns first few non-empty values.

◆ GetStringValue()

const char* vtkPVArrayInformation::GetStringValue ( int  )

For string arrays, this returns first few non-empty values.

◆ CopyFromArray()

void vtkPVArrayInformation::CopyFromArray ( vtkAbstractArray array)

◆ CopyFromGenericAttribute()

void vtkPVArrayInformation::CopyFromGenericAttribute ( vtkGenericAttribute array)

◆ CopyToStream()

void vtkPVArrayInformation::CopyToStream ( vtkClientServerStream ) const

◆ CopyFromStream()

bool vtkPVArrayInformation::CopyFromStream ( const vtkClientServerStream )

◆ DeepCopy()

void vtkPVArrayInformation::DeepCopy ( vtkPVArrayInformation info)
protected

◆ AddInformation()

void vtkPVArrayInformation::AddInformation ( vtkPVArrayInformation ,
int  fieldAssociation 
)
protected

◆ SetIsPartial()

virtual void vtkPVArrayInformation::SetIsPartial ( bool  )
protectedvirtual

◆ SetName()

virtual void vtkPVArrayInformation::SetName ( std::string  )
protectedvirtual

Friends And Related Function Documentation

◆ vtkPVDataSetAttributesInformation

friend class vtkPVDataSetAttributesInformation
friend

Definition at line 155 of file vtkPVArrayInformation.h.

◆ vtkPVDataInformation

friend class vtkPVDataInformation
friend

Definition at line 156 of file vtkPVArrayInformation.h.


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