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

Representation for showing data in a vtkSpreadSheetView. More...

#include <vtkSpreadSheetRepresentation.h>

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

Public Types

typedef vtkPVDataRepresentation Superclass
 
- Public Types inherited from vtkPVDataRepresentation
typedef vtkDataRepresentation Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void MarkModified ()
 Since this has no delivery, just mark ourselves modified. More...
 
vtkAlgorithmOutput * GetDataProducer ()
 
vtkAlgorithmOutput * GetExtractedDataProducer ()
 
vtkAlgorithmOutput * GetSelectionProducer ()
 
void SetFieldAssociation (int val)
 
int GetFieldAssociation ()
 
void SetGenerateCellConnectivity (bool)
 Allow user to enable/disable cell connectivity generation in the datamodel. More...
 
bool GetGenerateCellConnectivity ()
 Allow user to enable/disable cell connectivity generation in the datamodel. More...
 
void AddCompositeDataSetIndex (unsigned int index)
 Select the block indices to extract. More...
 
void RemoveAllCompositeDataSetIndices ()
 Select the block indices to extract. More...
 
- Public Member Functions inherited from vtkPVDataRepresentation
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual int ProcessViewRequest (vtkInformationRequestKey *request_type, vtkInformation *inInfo, vtkInformation *outInfo)
 vtkAlgorithm::ProcessRequest() equivalent for rendering passes. More...
 
virtual unsigned int Initialize (unsigned int minIdAvailable, unsigned int maxIdAvailable)
 Initialize the representation with an identifier range so each internal representation can own a unique ID. More...
 
unsigned int GetUniqueIdentifier ()
 Return 0 if the Initialize() method was not called otherwise a unique ID that will be shared across the processes for that same object. More...
 
virtual void SetVisibility (bool val)
 Get/Set the visibility for this representation. More...
 
virtual bool GetVisibility ()
 
virtual vtkDataObject * GetRenderedDataObject (int vtkNotUsed(port))
 Returns the data object that is rendered from the given input port. More...
 
virtual void SetForcedCacheKey (double val)
 Typically a representation decides whether to use cache based on the view's values for UseCache and CacheKey. More...
 
virtual void SetForceUseCache (bool val)
 
bool GetUsingCacheForUpdate ()
 Called by vtkPVDataRepresentationPipeline to see if using cache is valid and will be used for the update. More...
 
virtual bool GetNeedUpdate ()
 
virtual vtkAlgorithmOutput * GetInternalOutputPort ()
 Retrieves an output port for the input data object at the specified port and connection index. More...
 
virtual vtkAlgorithmOutput * GetInternalOutputPort (int port)
 
virtual vtkAlgorithmOutput * GetInternalOutputPort (int port, int conn)
 
vtkView * GetView () const
 Provides access to the view. More...
 
virtual void SetUpdateTime (double time)
 Set the update time. More...
 
virtual double GetUpdateTime ()
 Set the update time. More...
 
virtual bool GetUpdateTimeValid ()
 Set whether the UpdateTime is valid. More...
 
virtual void SetUseCache (bool)
 
virtual void SetCacheKey (double val)
 
virtual double GetCacheKey ()
 Returns whether caching is used and what key to use when caching is enabled. More...
 
virtual bool GetUseCache ()
 Returns whether caching is used and what key to use when caching is enabled. More...
 
virtual bool AddToView (vtkView *view)
 Making these methods public. More...
 
virtual bool RemoveFromView (vtkView *view)
 Making these methods public. More...
 

Static Public Member Functions

static vtkSpreadSheetRepresentationNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSpreadSheetRepresentationSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkPVDataRepresentation
static int IsTypeOf (const char *type)
 
static vtkPVDataRepresentationSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkSpreadSheetRepresentation ()
 
 ~vtkSpreadSheetRepresentation ()
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 Fill input port information. More...
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 Overridden to invoke vtkCommand::UpdateDataEvent. More...
 
- Protected Member Functions inherited from vtkPVDataRepresentation
 vtkPVDataRepresentation ()
 
 ~vtkPVDataRepresentation ()
 
virtual bool IsCached (double cache_key)
 Subclasses should override this method when they support caching to indicate if the particular key is cached. More...
 
virtual vtkExecutive * CreateDefaultExecutive ()
 Create a default executive. More...
 
virtual int RequestUpdateExtent (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int RequestUpdateTime (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 

Protected Attributes

vtkNew< vtkCleanArraysCleanArrays
 
vtkNew< vtkBlockDeliveryPreprocessorDataConditioner
 
vtkNew< vtkCleanArraysExtractedCleanArrays
 
vtkNew< vtkBlockDeliveryPreprocessorExtractedDataConditioner
 
- Protected Attributes inherited from vtkPVDataRepresentation
double UpdateTime
 
bool UpdateTimeValid
 
unsigned int UniqueIdentifier
 

Detailed Description

Representation for showing data in a vtkSpreadSheetView.

Unlike typical ParaView representations, this one does not do any data movement, it merely updates the input and provides access to the input data objects (rather clones of those). This filer has 3 input ports:

Definition at line 38 of file vtkSpreadSheetRepresentation.h.

Member Typedef Documentation

§ Superclass

Definition at line 43 of file vtkSpreadSheetRepresentation.h.

Constructor & Destructor Documentation

§ vtkSpreadSheetRepresentation()

vtkSpreadSheetRepresentation::vtkSpreadSheetRepresentation ( )
protected

§ ~vtkSpreadSheetRepresentation()

vtkSpreadSheetRepresentation::~vtkSpreadSheetRepresentation ( )
protected

Member Function Documentation

§ New()

static vtkSpreadSheetRepresentation* vtkSpreadSheetRepresentation::New ( )
static

§ GetClassName()

virtual const char* vtkSpreadSheetRepresentation::GetClassName ( )
virtual

Reimplemented from vtkPVDataRepresentation.

§ IsTypeOf()

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

§ IsA()

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

Reimplemented from vtkPVDataRepresentation.

§ SafeDownCast()

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

§ PrintSelf()

void vtkSpreadSheetRepresentation::PrintSelf ( ostream &  os,
vtkIndent  indent 
)

§ MarkModified()

virtual void vtkSpreadSheetRepresentation::MarkModified ( )
inlinevirtual

Since this has no delivery, just mark ourselves modified.

Reimplemented from vtkPVDataRepresentation.

Definition at line 49 of file vtkSpreadSheetRepresentation.h.

§ GetDataProducer()

vtkAlgorithmOutput* vtkSpreadSheetRepresentation::GetDataProducer ( )

§ GetExtractedDataProducer()

vtkAlgorithmOutput* vtkSpreadSheetRepresentation::GetExtractedDataProducer ( )

§ GetSelectionProducer()

vtkAlgorithmOutput* vtkSpreadSheetRepresentation::GetSelectionProducer ( )

§ SetGenerateCellConnectivity()

void vtkSpreadSheetRepresentation::SetGenerateCellConnectivity ( bool  )

Allow user to enable/disable cell connectivity generation in the datamodel.

§ GetGenerateCellConnectivity()

bool vtkSpreadSheetRepresentation::GetGenerateCellConnectivity ( )

Allow user to enable/disable cell connectivity generation in the datamodel.

§ SetFieldAssociation()

void vtkSpreadSheetRepresentation::SetFieldAssociation ( int  val)

§ GetFieldAssociation()

int vtkSpreadSheetRepresentation::GetFieldAssociation ( )

§ AddCompositeDataSetIndex()

void vtkSpreadSheetRepresentation::AddCompositeDataSetIndex ( unsigned int  index)

Select the block indices to extract.

Each node in the multi-block tree is identified by an index. The index can be obtained by performing a preorder traversal of the tree (including empty nodes). eg. A(B (D, E), C(F, G)). Inorder traversal yields: A, B, D, E, C, F, G Index of A is 0, while index of C is 4.

§ RemoveAllCompositeDataSetIndices()

void vtkSpreadSheetRepresentation::RemoveAllCompositeDataSetIndices ( )

Select the block indices to extract.

Each node in the multi-block tree is identified by an index. The index can be obtained by performing a preorder traversal of the tree (including empty nodes). eg. A(B (D, E), C(F, G)). Inorder traversal yields: A, B, D, E, C, F, G Index of A is 0, while index of C is 4.

§ FillInputPortInformation()

virtual int vtkSpreadSheetRepresentation::FillInputPortInformation ( int  port,
vtkInformation *  info 
)
protectedvirtual

Fill input port information.

§ RequestData()

virtual int vtkSpreadSheetRepresentation::RequestData ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protectedvirtual

Overridden to invoke vtkCommand::UpdateDataEvent.

Reimplemented from vtkPVDataRepresentation.

Member Data Documentation

§ CleanArrays

vtkNew<vtkCleanArrays> vtkSpreadSheetRepresentation::CleanArrays
protected

Definition at line 95 of file vtkSpreadSheetRepresentation.h.

§ DataConditioner

vtkNew<vtkBlockDeliveryPreprocessor> vtkSpreadSheetRepresentation::DataConditioner
protected

Definition at line 96 of file vtkSpreadSheetRepresentation.h.

§ ExtractedCleanArrays

vtkNew<vtkCleanArrays> vtkSpreadSheetRepresentation::ExtractedCleanArrays
protected

Definition at line 98 of file vtkSpreadSheetRepresentation.h.

§ ExtractedDataConditioner

vtkNew<vtkBlockDeliveryPreprocessor> vtkSpreadSheetRepresentation::ExtractedDataConditioner
protected

Definition at line 99 of file vtkSpreadSheetRepresentation.h.


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