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

Data array information like type. More...

#include <vtkPVArrayInformation.h>

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

Public Types

typedef vtkPVInformation Superclass
 
- Public Types inherited from vtkPVInformation
typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void SetComponentName (vtkIdType component, const char *name)
 Set the name for a component. More...
 
const char * GetComponentName (vtkIdType component)
 Get the component name for a given component. More...
 
void GetDataTypeRange (double range[2])
 This method return the Min and Max possible range of the native data type. More...
 
int Compare (vtkPVArrayInformation *info)
 Returns 1 if the array can be combined. More...
 
void DeepCopy (vtkPVArrayInformation *info)
 
void CopyFromObject (vtkObject *) override
 Transfer information about a single object into this object. More...
 
void AddInformation (vtkPVInformation *) override
 Merge another information object. More...
 
void Initialize ()
 Remove all infommation. More...
 
virtual void SetDataType (int)
 DataType is the string name of the data type: VTK_FLOAT ... More...
 
virtual int GetDataType ()
 DataType is the string name of the data type: VTK_FLOAT ... More...
 
virtual void SetName (const char *)
 Set/get array's name. More...
 
virtual char * GetName ()
 Set/get array's name. More...
 
void SetNumberOfComponents (int numComps)
 Changing the number of components clears the ranges back to the default. More...
 
virtual int GetNumberOfComponents ()
 Changing the number of components clears the ranges back to the default. More...
 
virtual void SetNumberOfTuples (vtkTypeInt64)
 Set/get the array's length. More...
 
virtual vtkTypeInt64 GetNumberOfTuples ()
 Set/get the array's length. More...
 
void SetComponentRange (int comp, double min, double max)
 There is a range for each component. More...
 
void SetComponentRange (int comp, double *range)
 There is a range for each component. More...
 
doubleGetComponentRange (int component) VTK_SIZEHINT(2)
 There is a range for each component. More...
 
void GetComponentRange (int comp, double range[2])
 There is a range for each component. More...
 
void SetComponentFiniteRange (int comp, double min, double max)
 There is a range for each component. More...
 
void SetComponentFiniteRange (int comp, double *range)
 There is a range for each component. More...
 
doubleGetComponentFiniteRange (int component)
 There is a range for each component. More...
 
void GetComponentFiniteRange (int comp, double range[2])
 There is a range for each component. More...
 
void CopyToStream (vtkClientServerStream *) override
 Manage a serialized version of the information. More...
 
void CopyFromStream (const vtkClientServerStream *) override
 Manage a serialized version of the information. More...
 
virtual void SetIsPartial (int)
 If IsPartial is true, this array is in only some of the parts of a multi-block dataset. More...
 
virtual int GetIsPartial ()
 If IsPartial is true, this array is in only some of the parts of a multi-block dataset. More...
 
void AddInformationKeys (vtkPVArrayInformation *info)
 Merge (union) keys into this object. More...
 
void AddInformationKey (const char *location, const char *name)
 Merge (union) keys into this object. More...
 
void AddUniqueInformationKey (const char *location, const char *name)
 Merge (union) keys into this object. More...
 
int GetNumberOfInformationKeys ()
 Get information on the InformationKeys of this array. More...
 
const char * GetInformationKeyLocation (int)
 Get information on the InformationKeys of this array. More...
 
const char * GetInformationKeyName (int)
 Get information on the InformationKeys of this array. More...
 
int HasInformationKey (const char *location, const char *name)
 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 vtkPVInformation
void PrintSelf (ostream &os, vtkIndent indent) override
 
virtual void CopyParametersToStream (vtkMultiProcessStream &)
 Serialize/Deserialize the parameters that control how/what information is gathered. More...
 
virtual void CopyParametersFromStream (vtkMultiProcessStream &)
 Serialize/Deserialize the parameters that control how/what information is gathered. More...
 
virtual int GetRootOnly ()
 Set/get whether to gather information only from the root. 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 vtkPVInformation
static int IsTypeOf (const char *type)
 
static vtkPVInformationSafeDownCast (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
 
void AddRanges (vtkPVArrayInformation *info)
 Merge (union) ranges/values into this object. More...
 
void AddFiniteRanges (vtkPVArrayInformation *info)
 
void AddValues (vtkPVArrayInformation *info)
 
void DetermineDefaultComponentName (const int &component_no, const int &numComps)
 assigns to a string to DefaultComponentName for this component More...
 
 vtkPVArrayInformation (const vtkPVArrayInformation &)=delete
 
void operator= (const vtkPVArrayInformation &)=delete
 
- Protected Member Functions inherited from vtkPVInformation
 vtkPVInformation ()
 
 ~vtkPVInformation () override
 
virtual void SetRootOnly (int)
 
 vtkPVInformation (const vtkPVInformation &)=delete
 
void operator= (const vtkPVInformation &)=delete
 
- 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 &)
 

Protected Attributes

int IsPartial
 
int DataType
 
int NumberOfComponents
 
vtkTypeInt64 NumberOfTuples
 
char * Name
 
doubleRanges
 
doubleFiniteRanges
 
std::vector< std::stringStringValues
 
vtkInternalInformationKeys * InformationKeys
 
std::stringDefaultComponentName
 
vtkInternalComponentNames * ComponentNames
 
- Protected Attributes inherited from vtkPVInformation
int RootOnly
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

Data array information like type.

This objects is for eliminating direct access to vtkDataObjects by the "client". Only vtkPVPart and vtkPVProcessModule should access the data directly. At the moment, this object is only a container and has no useful methods for operating on data. Note: I could just use vtkDataArray objects and store the range as values in the array. This would eliminate this object.

Definition at line 40 of file vtkPVArrayInformation.h.

Member Typedef Documentation

◆ Superclass

Definition at line 44 of file vtkPVArrayInformation.h.

Constructor & Destructor Documentation

◆ vtkPVArrayInformation() [1/2]

vtkPVArrayInformation::vtkPVArrayInformation ( )
protected

◆ ~vtkPVArrayInformation()

vtkPVArrayInformation::~vtkPVArrayInformation ( )
overrideprotected

◆ vtkPVArrayInformation() [2/2]

vtkPVArrayInformation::vtkPVArrayInformation ( const vtkPVArrayInformation )
protecteddelete

Member Function Documentation

◆ New()

static vtkPVArrayInformation* vtkPVArrayInformation::New ( )
static

◆ GetClassName()

virtual const char* vtkPVArrayInformation::GetClassName ( )
virtual

Reimplemented from vtkPVInformation.

Reimplemented in vtkPVGenericAttributeInformation.

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented from vtkPVInformation.

Reimplemented in vtkPVGenericAttributeInformation.

◆ SafeDownCast()

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

◆ PrintSelf()

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

Reimplemented from vtkObject.

Reimplemented in vtkPVGenericAttributeInformation.

◆ SetDataType()

virtual void vtkPVArrayInformation::SetDataType ( int  )
virtual

DataType is the string name of the data type: VTK_FLOAT ...

the value "VTK_VOID" means that different processes have different types.

◆ GetDataType()

virtual int vtkPVArrayInformation::GetDataType ( )
virtual

DataType is the string name of the data type: VTK_FLOAT ...

the value "VTK_VOID" means that different processes have different types.

◆ SetName()

virtual void vtkPVArrayInformation::SetName ( const char *  )
virtual

Set/get array's name.

◆ GetName()

virtual char* vtkPVArrayInformation::GetName ( )
virtual

Set/get array's name.

◆ SetNumberOfComponents()

void vtkPVArrayInformation::SetNumberOfComponents ( int  numComps)

Changing the number of components clears the ranges back to the default.

◆ GetNumberOfComponents()

virtual int vtkPVArrayInformation::GetNumberOfComponents ( )
virtual

Changing the number of components clears the ranges back to the default.

◆ SetComponentName()

void vtkPVArrayInformation::SetComponentName ( vtkIdType  component,
const char *  name 
)

Set the name for a component.

Must be >= 1.

◆ GetComponentName()

const char* vtkPVArrayInformation::GetComponentName ( vtkIdType  component)

Get the component name for a given component.

Note: the const char* that is returned is only valid intill the next call to this method!

◆ SetNumberOfTuples()

virtual void vtkPVArrayInformation::SetNumberOfTuples ( vtkTypeInt64  )
virtual

Set/get the array's length.

◆ GetNumberOfTuples()

virtual vtkTypeInt64 vtkPVArrayInformation::GetNumberOfTuples ( )
virtual

Set/get the array's length.

◆ SetComponentRange() [1/2]

void vtkPVArrayInformation::SetComponentRange ( int  comp,
double  min,
double  max 
)

There is a range for each component.

Range for component -1 is the range of the vector magnitude. The number of components should be set before these ranges.

◆ SetComponentRange() [2/2]

void vtkPVArrayInformation::SetComponentRange ( int  comp,
double range 
)
inline

There is a range for each component.

Range for component -1 is the range of the vector magnitude. The number of components should be set before these ranges.

Definition at line 99 of file vtkPVArrayInformation.h.

◆ GetComponentRange() [1/2]

double* vtkPVArrayInformation::GetComponentRange ( int  component)

There is a range for each component.

Range for component -1 is the range of the vector magnitude. The number of components should be set before these ranges.

◆ GetComponentRange() [2/2]

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

There is a range for each component.

Range for component -1 is the range of the vector magnitude. The number of components should be set before these ranges.

◆ SetComponentFiniteRange() [1/2]

void vtkPVArrayInformation::SetComponentFiniteRange ( int  comp,
double  min,
double  max 
)

There is a range for each component.

Range for component -1 is the range of the vector magnitude. The number of components should be set before these ranges.

◆ SetComponentFiniteRange() [2/2]

void vtkPVArrayInformation::SetComponentFiniteRange ( int  comp,
double range 
)
inline

There is a range for each component.

Range for component -1 is the range of the vector magnitude. The number of components should be set before these ranges.

Definition at line 114 of file vtkPVArrayInformation.h.

◆ GetComponentFiniteRange() [1/2]

double* vtkPVArrayInformation::GetComponentFiniteRange ( int  component)

There is a range for each component.

Range for component -1 is the range of the vector magnitude. The number of components should be set before these ranges.

◆ GetComponentFiniteRange() [2/2]

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

There is a range for each component.

Range for component -1 is the range of the vector magnitude. The number of components should be set before these ranges.

◆ GetDataTypeRange()

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

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

◆ Compare()

int vtkPVArrayInformation::Compare ( vtkPVArrayInformation info)

Returns 1 if the array can be combined.

It must have the same name and number of components.

◆ DeepCopy()

void vtkPVArrayInformation::DeepCopy ( vtkPVArrayInformation info)

◆ CopyFromObject()

void vtkPVArrayInformation::CopyFromObject ( vtkObject )
overridevirtual

Transfer information about a single object into this object.

Reimplemented from vtkPVInformation.

Reimplemented in vtkPVGenericAttributeInformation.

◆ AddInformation()

void vtkPVArrayInformation::AddInformation ( vtkPVInformation )
overridevirtual

Merge another information object.

Reimplemented from vtkPVInformation.

◆ CopyToStream()

void vtkPVArrayInformation::CopyToStream ( vtkClientServerStream )
overridevirtual

Manage a serialized version of the information.

Implements vtkPVInformation.

◆ CopyFromStream()

void vtkPVArrayInformation::CopyFromStream ( const vtkClientServerStream )
overridevirtual

Manage a serialized version of the information.

Reimplemented from vtkPVInformation.

◆ SetIsPartial()

virtual void vtkPVArrayInformation::SetIsPartial ( int  )
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.

◆ GetIsPartial()

virtual int 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.

◆ Initialize()

void vtkPVArrayInformation::Initialize ( )

Remove all infommation.

Next add will be like a copy.

◆ AddInformationKeys()

void vtkPVArrayInformation::AddInformationKeys ( vtkPVArrayInformation info)

Merge (union) keys into this object.

◆ AddInformationKey()

void vtkPVArrayInformation::AddInformationKey ( const char *  location,
const char *  name 
)

Merge (union) keys into this object.

◆ AddUniqueInformationKey()

void vtkPVArrayInformation::AddUniqueInformationKey ( const char *  location,
const char *  name 
)

Merge (union) keys into this object.

◆ GetNumberOfInformationKeys()

int vtkPVArrayInformation::GetNumberOfInformationKeys ( )

Get information on the InformationKeys of this array.

◆ GetInformationKeyLocation()

const char* vtkPVArrayInformation::GetInformationKeyLocation ( int  )

Get information on the InformationKeys of this array.

◆ GetInformationKeyName()

const char* vtkPVArrayInformation::GetInformationKeyName ( int  )

Get information on the InformationKeys of this array.

◆ HasInformationKey()

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

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.

◆ AddRanges()

void vtkPVArrayInformation::AddRanges ( vtkPVArrayInformation info)
protected

Merge (union) ranges/values into this object.

◆ AddFiniteRanges()

void vtkPVArrayInformation::AddFiniteRanges ( vtkPVArrayInformation info)
protected

◆ AddValues()

void vtkPVArrayInformation::AddValues ( vtkPVArrayInformation info)
protected

◆ DetermineDefaultComponentName()

void vtkPVArrayInformation::DetermineDefaultComponentName ( const int component_no,
const int numComps 
)
protected

assigns to a string to DefaultComponentName for this component

◆ operator=()

void vtkPVArrayInformation::operator= ( const vtkPVArrayInformation )
protecteddelete

Member Data Documentation

◆ IsPartial

int vtkPVArrayInformation::IsPartial
protected

Definition at line 209 of file vtkPVArrayInformation.h.

◆ DataType

int vtkPVArrayInformation::DataType
protected

Definition at line 210 of file vtkPVArrayInformation.h.

◆ NumberOfComponents

int vtkPVArrayInformation::NumberOfComponents
protected

Definition at line 211 of file vtkPVArrayInformation.h.

◆ NumberOfTuples

vtkTypeInt64 vtkPVArrayInformation::NumberOfTuples
protected

Definition at line 212 of file vtkPVArrayInformation.h.

◆ Name

char* vtkPVArrayInformation::Name
protected

Definition at line 213 of file vtkPVArrayInformation.h.

◆ Ranges

double* vtkPVArrayInformation::Ranges
protected

Definition at line 214 of file vtkPVArrayInformation.h.

◆ FiniteRanges

double* vtkPVArrayInformation::FiniteRanges
protected

Definition at line 215 of file vtkPVArrayInformation.h.

◆ StringValues

std::vector<std::string> vtkPVArrayInformation::StringValues
protected

Definition at line 216 of file vtkPVArrayInformation.h.

◆ InformationKeys

vtkInternalInformationKeys* vtkPVArrayInformation::InformationKeys
protected

Definition at line 220 of file vtkPVArrayInformation.h.

◆ DefaultComponentName

std::string* vtkPVArrayInformation::DefaultComponentName
protected

Definition at line 225 of file vtkPVArrayInformation.h.

◆ ComponentNames

vtkInternalComponentNames* vtkPVArrayInformation::ComponentNames
protected

Definition at line 230 of file vtkPVArrayInformation.h.


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