ParaView
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)
 
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 AddRanges (vtkPVArrayInformation *info)
 Merge (union) ranges into this object. More...
 
void DeepCopy (vtkPVArrayInformation *info)
 
virtual void CopyFromObject (vtkObject *)
 Transfer information about a single object into this object. More...
 
virtual void AddInformation (vtkPVInformation *)
 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...
 
double * GetComponentRange (int component)
 There is a range for each component. More...
 
void GetComponentRange (int comp, double *range)
 There is a range for each component. More...
 
virtual void CopyToStream (vtkClientServerStream *)
 Manage a serialized version of the information. More...
 
virtual void CopyFromStream (const vtkClientServerStream *)
 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...
 
- Public Member Functions inherited from vtkPVInformation
void PrintSelf (ostream &os, vtkIndent indent)
 
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...
 

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)
 

Protected Member Functions

 vtkPVArrayInformation ()
 
 ~vtkPVArrayInformation ()
 
void DetermineDefaultComponentName (const int &component_no, const int &numComps)
 assigns to a string to DefaultComponentName for this component More...
 
 vtkPVArrayInformation (const vtkPVArrayInformation &) VTK_DELETE_FUNCTION
 
void operator= (const vtkPVArrayInformation &) VTK_DELETE_FUNCTION
 
- Protected Member Functions inherited from vtkPVInformation
 vtkPVInformation ()
 
 ~vtkPVInformation ()
 
virtual void SetRootOnly (int)
 
 vtkPVInformation (const vtkPVInformation &) VTK_DELETE_FUNCTION
 
void operator= (const vtkPVInformation &) VTK_DELETE_FUNCTION
 

Protected Attributes

int IsPartial
 
int DataType
 
int NumberOfComponents
 
vtkTypeInt64 NumberOfTuples
 
char * Name
 
double * Ranges
 
vtkInternalInformationKeys * InformationKeys
 
vtkStdString * DefaultComponentName
 
vtkInternalComponentNames * ComponentNames
 
- Protected Attributes inherited from vtkPVInformation
int RootOnly
 

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 37 of file vtkPVArrayInformation.h.

Member Typedef Documentation

§ Superclass

Definition at line 41 of file vtkPVArrayInformation.h.

Constructor & Destructor Documentation

§ vtkPVArrayInformation() [1/2]

vtkPVArrayInformation::vtkPVArrayInformation ( )
protected

§ ~vtkPVArrayInformation()

vtkPVArrayInformation::~vtkPVArrayInformation ( )
protected

§ vtkPVArrayInformation() [2/2]

vtkPVArrayInformation::vtkPVArrayInformation ( const vtkPVArrayInformation )
protected

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 
)

§ 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 96 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 
)

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.

§ AddRanges()

void vtkPVArrayInformation::AddRanges ( vtkPVArrayInformation info)

Merge (union) ranges into this object.

§ DeepCopy()

void vtkPVArrayInformation::DeepCopy ( vtkPVArrayInformation info)

§ CopyFromObject()

virtual void vtkPVArrayInformation::CopyFromObject ( vtkObject *  )
virtual

Transfer information about a single object into this object.

Reimplemented from vtkPVInformation.

Reimplemented in vtkPVGenericAttributeInformation.

§ AddInformation()

virtual void vtkPVArrayInformation::AddInformation ( vtkPVInformation )
virtual

Merge another information object.

Reimplemented from vtkPVInformation.

§ CopyToStream()

virtual void vtkPVArrayInformation::CopyToStream ( vtkClientServerStream )
virtual

Manage a serialized version of the information.

Implements vtkPVInformation.

§ CopyFromStream()

virtual void vtkPVArrayInformation::CopyFromStream ( const vtkClientServerStream )
virtual

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.

§ 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 )
protected

Member Data Documentation

§ IsPartial

int vtkPVArrayInformation::IsPartial
protected

Definition at line 181 of file vtkPVArrayInformation.h.

§ DataType

int vtkPVArrayInformation::DataType
protected

Definition at line 182 of file vtkPVArrayInformation.h.

§ NumberOfComponents

int vtkPVArrayInformation::NumberOfComponents
protected

Definition at line 183 of file vtkPVArrayInformation.h.

§ NumberOfTuples

vtkTypeInt64 vtkPVArrayInformation::NumberOfTuples
protected

Definition at line 184 of file vtkPVArrayInformation.h.

§ Name

char* vtkPVArrayInformation::Name
protected

Definition at line 185 of file vtkPVArrayInformation.h.

§ Ranges

double* vtkPVArrayInformation::Ranges
protected

Definition at line 186 of file vtkPVArrayInformation.h.

§ InformationKeys

vtkInternalInformationKeys* vtkPVArrayInformation::InformationKeys
protected

Definition at line 190 of file vtkPVArrayInformation.h.

§ DefaultComponentName

vtkStdString* vtkPVArrayInformation::DefaultComponentName
protected

Definition at line 195 of file vtkPVArrayInformation.h.

§ ComponentNames

vtkInternalComponentNames* vtkPVArrayInformation::ComponentNames
protected

Definition at line 200 of file vtkPVArrayInformation.h.


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