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

vtkSpreadSheetView is a vtkPVView subclass for a view used to show any data as a spreadsheet. More...

#include <vtkSpreadSheetView.h>

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

Public Types

typedef vtkPVView Superclass
 
- Public Types inherited from vtkPVView
enum  { ViewTimeChangedEvent = 9000 }
 
typedef vtkView Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void StillRender ()
 Triggers a high-resolution render. More...
 
virtual void InteractiveRender ()
 Triggers a interactive render. More...
 
virtual void Update ()
 Overridden to identify and locate the active-representation. More...
 
vtkIdType GetNumberOfColumns ()
 Get the number of columns. More...
 
vtkIdType GetNumberOfRows ()
 Get the number of rows. More...
 
const char * GetColumnName (vtkIdType index)
 Returns the name for the column. More...
 
bool IsRowSelected (vtkIdType row)
 Returns true if the row is selected. More...
 
bool IsAvailable (vtkIdType row)
 Returns true is the data for the particular row is locally available. More...
 
void SetColumnNameToSort (const char *)
 Get/Set the column name to sort by. More...
 
void SetColumnNameToSort ()
 
void SetComponentToSort (int val)
 Get/Set the component to sort with. More...
 
void SetInvertSortOrder (bool)
 Get/Set whether the sort order must be Max to Min rather than Min to Max. More...
 
void SetBlockSize (vtkIdType val)
 Set the block size . More...
 
bool Export (vtkCSVExporter *exporter)
 Export the contents of this view using the exporter. More...
 
void ClearCache ()
 Allow user to clear the cache if he needs to. More...
 
vtkTable * FetchBlockCallback (vtkIdType blockindex, bool filterColumnForExport=false)
 
void SetShowExtractedSelection (bool)
 Get/Set if the view shows extracted selection only or the actual data. More...
 
virtual void ShowExtractedSelectionOn ()
 Get/Set if the view shows extracted selection only or the actual data. More...
 
virtual void ShowExtractedSelectionOff ()
 Get/Set if the view shows extracted selection only or the actual data. More...
 
virtual bool GetShowExtractedSelection ()
 Get/Set if the view shows extracted selection only or the actual data. More...
 
void SetColumnVisibility (int fieldAssociation, const char *column, int visibility)
 Manage column visibilities, used only for export. More...
 
void ClearColumnVisibilities ()
 Manage column visibilities, used only for export. More...
 
vtkVariant GetValue (vtkIdType row, vtkIdType col)
 Returns the value at given location. More...
 
vtkVariant GetValueByName (vtkIdType row, const char *columnName)
 Returns the value at given location. More...
 
- Public Member Functions inherited from vtkPVView
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void Initialize (unsigned int id)
 Initialize the view with an identifier. More...
 
bool InTileDisplayMode ()
 Returns true if the application is currently in tile display mode. More...
 
bool InCaveDisplayMode ()
 Returns true if the application is currently in cave/immersive display mode. More...
 
bool GetLocalProcessSupportsInteraction ()
 Returns true if the local process can support interaction. More...
 
virtual unsigned int GetIdentifier ()
 
virtual void SetPosition (int, int)
 Set the position on this view in the multiview configuration. More...
 
virtual int * GetPosition ()
 Set the position on this view in the multiview configuration. More...
 
virtual void GetPosition (int &, int &)
 Set the position on this view in the multiview configuration. More...
 
virtual void GetPosition (int [2])
 Set the position on this view in the multiview configuration. More...
 
virtual void SetSize (int, int)
 Set the size of this view in the multiview configuration. More...
 
virtual int * GetSize ()
 Set the size of this view in the multiview configuration. More...
 
virtual void GetSize (int &, int &)
 Set the size of this view in the multiview configuration. More...
 
virtual void GetSize (int [2])
 Set the size of this view in the multiview configuration. More...
 
bool SynchronizeBounds (double bounds[6])
 This encapsulates a whole lot of logic for communication between processes. More...
 
bool SynchronizeSize (double &size)
 This encapsulates a whole lot of logic for communication between processes. More...
 
bool SynchronizeSize (unsigned int &size)
 This encapsulates a whole lot of logic for communication between processes. More...
 
virtual void SetViewTime (double value)
 Get/Set the time this view is showing. More...
 
virtual double GetViewTime ()
 Get/Set the time this view is showing. More...
 
virtual void SetCacheKey (double)
 Get/Set the cache key. More...
 
virtual double GetCacheKey ()
 Get/Set the cache key. More...
 
virtual void SetUseCache (bool)
 Get/Set whether caching is enabled. More...
 
virtual bool GetUseCache ()
 Get/Set whether caching is enabled. More...
 
virtual void PrepareForScreenshot ()
 These methods are used to setup the view for capturing screen shots. More...
 
virtual void CleanupAfterScreenshot ()
 These methods are used to setup the view for capturing screen shots. More...
 

Static Public Member Functions

static vtkSpreadSheetViewNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSpreadSheetViewSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkPVView
static int IsTypeOf (const char *type)
 
static vtkPVViewSafeDownCast (vtkObject *o)
 
static void SetEnableStreaming (bool)
 
static bool GetEnableStreaming ()
 
static vtkInformationObjectBaseKey * VIEW ()
 Key used to pass the vtkPVView pointer to the representation during any of the view passes such as REQUEST_UPDATE(), REQUEST_UPDATE_LOD(), REQUEST_RENDER(), etc. More...
 
static vtkInformationRequestKey * REQUEST_UPDATE ()
 This is a Update-Data pass. More...
 
static vtkInformationRequestKey * REQUEST_UPDATE_LOD ()
 This is a Update-LOD-Data pass. More...
 
static vtkInformationRequestKey * REQUEST_RENDER ()
 This is a render pass. More...
 

Protected Types

enum  { FETCH_BLOCK_TAG = 394732 }
 

Protected Member Functions

 vtkSpreadSheetView ()
 
 ~vtkSpreadSheetView ()
 
int StreamToClient ()
 On render streams all the data from the processes to the client. More...
 
void OnRepresentationUpdated ()
 
vtkTable * FetchBlock (vtkIdType blockindex, bool filterColumnForExport=false)
 
- Protected Member Functions inherited from vtkPVView
 vtkPVView ()
 
 ~vtkPVView ()
 
virtual void AddRepresentationInternal (vtkDataRepresentation *rep)
 Overridden to check that the representation has View setup properly. More...
 
void CallProcessViewRequest (vtkInformationRequestKey *passType, vtkInformation *request, vtkInformationVector *reply)
 Subclasses can use this method to trigger a pass on all representations. More...
 

Protected Attributes

bool ShowExtractedSelection
 
vtkSortedTableStreamerTableStreamer
 
vtkMarkSelectedRowsTableSelectionMarker
 
vtkReductionFilterReductionFilter
 
vtkClientServerMoveDataDeliveryFilter
 
vtkPassArrays * PassFilter
 
vtkIdType NumberOfRows
 
- Protected Attributes inherited from vtkPVView
vtkPVSynchronizedRenderWindowsSynchronizedWindows
 
unsigned int Identifier
 Every view gets a unique identifier that it uses to register itself with the SynchronizedWindows. More...
 
double CacheKey
 
bool UseCache
 
int Size [2]
 
int Position [2]
 
vtkInformation * RequestInformation
 These are passed as arguments to vtkDataRepresentation::ProcessViewRequest(). More...
 
vtkInformationVector * ReplyInformationVector
 These are passed as arguments to vtkDataRepresentation::ProcessViewRequest(). More...
 
double ViewTime
 Subclasses can use this method to trigger a pass on all representations. More...
 

Friends

class vtkInternals
 

Detailed Description

vtkSpreadSheetView is a vtkPVView subclass for a view used to show any data as a spreadsheet.

This view can only show one representation at a time. If more than one representation is added to this view, only the first visible representation will be shown.

Definition at line 41 of file vtkSpreadSheetView.h.

Member Typedef Documentation

◆ Superclass

Definition at line 45 of file vtkSpreadSheetView.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protected
Enumerator
FETCH_BLOCK_TAG 

Definition at line 189 of file vtkSpreadSheetView.h.

Constructor & Destructor Documentation

◆ vtkSpreadSheetView()

vtkSpreadSheetView::vtkSpreadSheetView ( )
protected

◆ ~vtkSpreadSheetView()

vtkSpreadSheetView::~vtkSpreadSheetView ( )
protected

Member Function Documentation

◆ New()

static vtkSpreadSheetView* vtkSpreadSheetView::New ( )
static

◆ GetClassName()

virtual const char* vtkSpreadSheetView::GetClassName ( )
virtual

Reimplemented from vtkPVView.

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented from vtkPVView.

◆ SafeDownCast()

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

◆ PrintSelf()

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

◆ StillRender()

virtual void vtkSpreadSheetView::StillRender ( )
inlinevirtual

Triggers a high-resolution render.

Implements vtkPVView.

Definition at line 52 of file vtkSpreadSheetView.h.

◆ InteractiveRender()

virtual void vtkSpreadSheetView::InteractiveRender ( )
inlinevirtual

Triggers a interactive render.

Based on the settings on the view, this may result in a low-resolution rendering or a simplified geometry rendering.

Implements vtkPVView.

Definition at line 59 of file vtkSpreadSheetView.h.

◆ Update()

virtual void vtkSpreadSheetView::Update ( )
virtual

Overridden to identify and locate the active-representation.

Reimplemented from vtkPVView.

◆ SetShowExtractedSelection()

void vtkSpreadSheetView::SetShowExtractedSelection ( bool  )

Get/Set if the view shows extracted selection only or the actual data.

false by default.

◆ ShowExtractedSelectionOn()

virtual void vtkSpreadSheetView::ShowExtractedSelectionOn ( )
virtual

Get/Set if the view shows extracted selection only or the actual data.

false by default.

◆ ShowExtractedSelectionOff()

virtual void vtkSpreadSheetView::ShowExtractedSelectionOff ( )
virtual

Get/Set if the view shows extracted selection only or the actual data.

false by default.

◆ GetShowExtractedSelection()

virtual bool vtkSpreadSheetView::GetShowExtractedSelection ( )
virtual

Get/Set if the view shows extracted selection only or the actual data.

false by default.

◆ SetColumnVisibility()

void vtkSpreadSheetView::SetColumnVisibility ( int  fieldAssociation,
const char *  column,
int  visibility 
)

Manage column visibilities, used only for export.

◆ ClearColumnVisibilities()

void vtkSpreadSheetView::ClearColumnVisibilities ( )

Manage column visibilities, used only for export.

◆ GetNumberOfColumns()

vtkIdType vtkSpreadSheetView::GetNumberOfColumns ( )

Get the number of columns.

◆ GetNumberOfRows()

vtkIdType vtkSpreadSheetView::GetNumberOfRows ( )

Get the number of rows.

◆ GetColumnName()

const char* vtkSpreadSheetView::GetColumnName ( vtkIdType  index)

Returns the name for the column.

◆ GetValue()

vtkVariant vtkSpreadSheetView::GetValue ( vtkIdType  row,
vtkIdType  col 
)

Returns the value at given location.

This may result in collective operations is data is not available locally. This method can only be called on the CLIENT process for now.

◆ GetValueByName()

vtkVariant vtkSpreadSheetView::GetValueByName ( vtkIdType  row,
const char *  columnName 
)

Returns the value at given location.

This may result in collective operations is data is not available locally. This method can only be called on the CLIENT process for now.

◆ IsRowSelected()

bool vtkSpreadSheetView::IsRowSelected ( vtkIdType  row)

Returns true if the row is selected.

◆ IsAvailable()

bool vtkSpreadSheetView::IsAvailable ( vtkIdType  row)

Returns true is the data for the particular row is locally available.

◆ SetColumnNameToSort() [1/2]

void vtkSpreadSheetView::SetColumnNameToSort ( const char *  )

Get/Set the column name to sort by.

◆ SetColumnNameToSort() [2/2]

void vtkSpreadSheetView::SetColumnNameToSort ( )
inline

Definition at line 131 of file vtkSpreadSheetView.h.

◆ SetComponentToSort()

void vtkSpreadSheetView::SetComponentToSort ( int  val)

Get/Set the component to sort with.

Use -1 (default) for magnitude.

◆ SetInvertSortOrder()

void vtkSpreadSheetView::SetInvertSortOrder ( bool  )

Get/Set whether the sort order must be Max to Min rather than Min to Max.

◆ SetBlockSize()

void vtkSpreadSheetView::SetBlockSize ( vtkIdType  val)

Set the block size .

◆ Export()

bool vtkSpreadSheetView::Export ( vtkCSVExporter exporter)

Export the contents of this view using the exporter.

◆ ClearCache()

void vtkSpreadSheetView::ClearCache ( )

Allow user to clear the cache if he needs to.

◆ FetchBlockCallback()

vtkTable* vtkSpreadSheetView::FetchBlockCallback ( vtkIdType  blockindex,
bool  filterColumnForExport = false 
)

◆ StreamToClient()

int vtkSpreadSheetView::StreamToClient ( )
protected

On render streams all the data from the processes to the client.

Returns 0 on failure. Note: Was removed from update because you can't call update() while in an update

◆ OnRepresentationUpdated()

void vtkSpreadSheetView::OnRepresentationUpdated ( )
protected

◆ FetchBlock()

vtkTable* vtkSpreadSheetView::FetchBlock ( vtkIdType  blockindex,
bool  filterColumnForExport = false 
)
protected

Friends And Related Function Documentation

◆ vtkInternals

friend class vtkInternals
friend

Definition at line 198 of file vtkSpreadSheetView.h.

Member Data Documentation

◆ ShowExtractedSelection

bool vtkSpreadSheetView::ShowExtractedSelection
protected

Definition at line 180 of file vtkSpreadSheetView.h.

◆ TableStreamer

vtkSortedTableStreamer* vtkSpreadSheetView::TableStreamer
protected

Definition at line 181 of file vtkSpreadSheetView.h.

◆ TableSelectionMarker

vtkMarkSelectedRows* vtkSpreadSheetView::TableSelectionMarker
protected

Definition at line 182 of file vtkSpreadSheetView.h.

◆ ReductionFilter

vtkReductionFilter* vtkSpreadSheetView::ReductionFilter
protected

Definition at line 183 of file vtkSpreadSheetView.h.

◆ DeliveryFilter

vtkClientServerMoveData* vtkSpreadSheetView::DeliveryFilter
protected

Definition at line 184 of file vtkSpreadSheetView.h.

◆ PassFilter

vtkPassArrays* vtkSpreadSheetView::PassFilter
protected

Definition at line 185 of file vtkSpreadSheetView.h.

◆ NumberOfRows

vtkIdType vtkSpreadSheetView::NumberOfRows
protected

Definition at line 187 of file vtkSpreadSheetView.h.


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