Helper class to process file series. More...

#include <vtkFileSeriesHelper.h>

Inheritance diagram for vtkFileSeriesHelper:

Collaboration diagram for vtkFileSeriesHelper:

[legend]

Classes
class	vtkTimeInformation

Public Types
typedef vtkObject	Superclass

typedef bool(*	FileNameFunctorType) (vtkAlgorithm *reader, const std::string &filename)

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

unsigned int	GetNumberOfFiles () const
	Get the number of files in the series. More...

virtual bool	ReadMetaFile (const char *metafilename)
	Setup file names in the series using a meta-file. More...

virtual bool	UpdateInformation (vtkAlgorithm *reader, const FileNameFunctorType &ftor)
	vtkFileSeriesHelper needs to collect information about the nature of the fileseries. More...

virtual vtkMTimeType	GetUpdateInformationTime ()
	The time stamp for the most recent `UpdateInformation` call that did some work to update the file series. More...

const std::vector< double > &	GetTimeSteps () const
	Returns the timesteps determined. More...

const std::pair< double, double > &	GetTimeRange (bool *isvalid=NULL) const
	Returns the time range determined. More...

void	FillTimeInformation (vtkInformation *info) const
	Fills up info with information about timesteps and timerange. More...

virtual bool	GetPartitionedFiles ()
	Returns true if the file series is a series of partitions rather than a series of timesteps. More...

std::vector< std::string >	GetActiveFiles (vtkInformation *outInfo) const
	Returns the list of files to read on current rank to satisfy the request. More...


void	RemoveAllFileNames ()
	Specify the set of files that comprise the series. More...

void	AddFileName (const char *fname)
	Specify the set of files that comprise the series. More...

void	SetFileNames (const std::vector< std::string > &filenames)
	Specify the set of files that comprise the series. More...


void	SetController (vtkMultiProcessController *)
	Get/Set the parallel controller. More...

virtual vtkMultiProcessController *	GetController ()
	Get/Set the parallel controller. More...


virtual void	SetIgnoreReaderTime (bool)
	In vtkFileSeriesHelper::UpdateInformation, vtkFileSeriesHelper tries to determine time information from the reader by making it read each of the files and then collecting the timesteps provided by each. More...

virtual bool	GetIgnoreReaderTime ()
	In vtkFileSeriesHelper::UpdateInformation, vtkFileSeriesHelper tries to determine time information from the reader by making it read each of the files and then collecting the timesteps provided by each. More...

virtual void	IgnoreReaderTimeOn ()
	In vtkFileSeriesHelper::UpdateInformation, vtkFileSeriesHelper tries to determine time information from the reader by making it read each of the files and then collecting the timesteps provided by each. More...

virtual void	IgnoreReaderTimeOff ()
	In vtkFileSeriesHelper::UpdateInformation, vtkFileSeriesHelper tries to determine time information from the reader by making it read each of the files and then collecting the timesteps provided by each. 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)

vtkCommand *	GetCommand (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)

vtkCommand *	GetCommand (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 vtkFileSeriesHelper *	New ()

static int	IsTypeOf (const char *type)

static vtkFileSeriesHelper *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()

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 vtkObjectBase *	New ()

static vtkObjectBase *	New ()

Protected Member Functions
	vtkFileSeriesHelper ()

	~vtkFileSeriesHelper () override

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
vtkMultiProcessController *	Controller

std::vector< std::string >	FileNames

bool	IgnoreReaderTime

bool	PartitionedFiles

std::vector< vtkTimeInformation >	Information

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

Helper class to process file series.

vtkFileSeriesHelper is intended to be a helper class that processes file series. File series encountered in ParaView are of two types: temporal or spatial. This class encapsulates logic to determine which form it is in.

Currently, this is used by vtkCGNSFileSeriesReader. Eventually, we should be able to refactor vtkFileSeriesReader to use this class.

Definition at line 43 of file vtkFileSeriesHelper.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkFileSeriesHelper::Superclass

Definition at line 47 of file vtkFileSeriesHelper.h.

◆ FileNameFunctorType

typedef bool(* vtkFileSeriesHelper::FileNameFunctorType) (vtkAlgorithm *reader, const std::string &filename)

Definition at line 50 of file vtkFileSeriesHelper.h.

Constructor & Destructor Documentation

◆ vtkFileSeriesHelper()

vtkFileSeriesHelper::vtkFileSeriesHelper ( )

protected

◆ ~vtkFileSeriesHelper()

vtkFileSeriesHelper::~vtkFileSeriesHelper ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkFileSeriesHelper* vtkFileSeriesHelper::New ( )

static

◆ GetClassName()

virtual const char* vtkFileSeriesHelper::GetClassName ( )

virtual

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkObject.

◆ RemoveAllFileNames()

void vtkFileSeriesHelper::RemoveAllFileNames ( )

Specify the set of files that comprise the series.

◆ AddFileName()

void vtkFileSeriesHelper::AddFileName ( const char * fname )

Specify the set of files that comprise the series.

◆ SetFileNames()

void vtkFileSeriesHelper::SetFileNames ( const std::vector< std::string > & filenames )

Specify the set of files that comprise the series.

◆ GetNumberOfFiles()

unsigned int vtkFileSeriesHelper::GetNumberOfFiles ( ) const

Get the number of files in the series.

◆ ReadMetaFile()

virtual bool vtkFileSeriesHelper::ReadMetaFile ( const char * metafilename )

virtual

Setup file names in the series using a meta-file.

The meta-file is simply lists the names of the files in the series sequentially in an ASCII file. All files in the file are relative to the location of the meta-file or absolute paths.

This will remove an preexisting files added to the helper irrespective of whether reading of the meta-file succeeded or not.

Returns: false if failed to read the meta-file, true otherwise.

◆ SetController()

void vtkFileSeriesHelper::SetController ( vtkMultiProcessController * )

Get/Set the parallel controller.

By default vtkMultiProcessController::GetGlobalController() will be used.

◆ GetController()

virtual vtkMultiProcessController* vtkFileSeriesHelper::GetController ( )

virtual

Get/Set the parallel controller.

By default vtkMultiProcessController::GetGlobalController() will be used.

◆ SetIgnoreReaderTime()

virtual void vtkFileSeriesHelper::SetIgnoreReaderTime ( bool )

virtual

In vtkFileSeriesHelper::UpdateInformation, vtkFileSeriesHelper tries to determine time information from the reader by making it read each of the files and then collecting the timesteps provided by each.

Sometimes, however, the time steps in the files in the fileseries are invalid (or same) in which case one may want to to simply use the time-step index as the time value. For that case, one should set IgnoreReaderTime to true (default: false).

◆ GetIgnoreReaderTime()

virtual bool vtkFileSeriesHelper::GetIgnoreReaderTime ( )

virtual

In vtkFileSeriesHelper::UpdateInformation, vtkFileSeriesHelper tries to determine time information from the reader by making it read each of the files and then collecting the timesteps provided by each.

Sometimes, however, the time steps in the files in the fileseries are invalid (or same) in which case one may want to to simply use the time-step index as the time value. For that case, one should set IgnoreReaderTime to true (default: false).

◆ IgnoreReaderTimeOn()

virtual void vtkFileSeriesHelper::IgnoreReaderTimeOn ( )

virtual

In vtkFileSeriesHelper::UpdateInformation, vtkFileSeriesHelper tries to determine time information from the reader by making it read each of the files and then collecting the timesteps provided by each.

Sometimes, however, the time steps in the files in the fileseries are invalid (or same) in which case one may want to to simply use the time-step index as the time value. For that case, one should set IgnoreReaderTime to true (default: false).

◆ IgnoreReaderTimeOff()

virtual void vtkFileSeriesHelper::IgnoreReaderTimeOff ( )

virtual

In vtkFileSeriesHelper::UpdateInformation, vtkFileSeriesHelper tries to determine time information from the reader by making it read each of the files and then collecting the timesteps provided by each.

Sometimes, however, the time steps in the files in the fileseries are invalid (or same) in which case one may want to to simply use the time-step index as the time value. For that case, one should set IgnoreReaderTime to true (default: false).

◆ UpdateInformation()

virtual bool vtkFileSeriesHelper::UpdateInformation	(	vtkAlgorithm *	reader,
		const FileNameFunctorType &	ftor
	)

virtual

vtkFileSeriesHelper needs to collect information about the nature of the fileseries.

This method should be called to collect this information.

This method has any effect only when the filenames (or any ivar that could affect the times e.g. IgnoreReaderTime) have changed, hence calling this repeatedly is acceptable.

When this method does any work, it updates this->UpdateInformationTime. One can use GetUpdateInformationTime to check if the file series has potentially been changed.

Parameters

[in]	reader	pointer to the single file reader to use.
[in]	ftor	callback to set the filename on the reader.

Returns: false if no filenames are specified or failed to collect meta-data.

◆ GetUpdateInformationTime()

virtual vtkMTimeType vtkFileSeriesHelper::GetUpdateInformationTime ( )

virtual

The time stamp for the most recent UpdateInformation call that did some work to update the file series.

◆ GetTimeSteps()

const std::vector<double>& vtkFileSeriesHelper::GetTimeSteps ( ) const

inline

Returns the timesteps determined.

This method will return valid values only after a successful call to UpdateInformation.

Definition at line 132 of file vtkFileSeriesHelper.h.

◆ GetTimeRange()

const std::pair<double, double>& vtkFileSeriesHelper::GetTimeRange ( bool * isvalid = NULL ) const

inline

Returns the time range determined.

Definition at line 137 of file vtkFileSeriesHelper.h.

◆ FillTimeInformation()

void vtkFileSeriesHelper::FillTimeInformation ( vtkInformation * info ) const

Fills up info with information about timesteps and timerange.

◆ GetPartitionedFiles()

virtual bool vtkFileSeriesHelper::GetPartitionedFiles ( )

virtual

Returns true if the file series is a series of partitions rather than a series of timesteps.

◆ GetActiveFiles()

std::vector<std::string> vtkFileSeriesHelper::GetActiveFiles ( vtkInformation * outInfo ) const

Returns the list of files to read on current rank to satisfy the request.

Requested time and piece information is obtained from outInfo. If outInfo has not piece information, however, than this->Controller is used.

Parameters

outInfo vtkInformation object with UPDATE_* keys that indicate the requested time and piece information.

Member Data Documentation

◆ Controller

vtkMultiProcessController* vtkFileSeriesHelper::Controller

protected

Definition at line 195 of file vtkFileSeriesHelper.h.

◆ FileNames

std::vector<std::string> vtkFileSeriesHelper::FileNames

protected

Definition at line 196 of file vtkFileSeriesHelper.h.

◆ IgnoreReaderTime

bool vtkFileSeriesHelper::IgnoreReaderTime

protected

Definition at line 197 of file vtkFileSeriesHelper.h.

◆ PartitionedFiles

bool vtkFileSeriesHelper::PartitionedFiles

protected

Definition at line 198 of file vtkFileSeriesHelper.h.

◆ Information

std::vector<vtkTimeInformation> vtkFileSeriesHelper::Information

protected

Definition at line 199 of file vtkFileSeriesHelper.h.

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

/builds/gitlab-kitware-sciviz-ci/VTKExtensions/CGNSReader/vtkFileSeriesHelper.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

◆ FileNameFunctorType

Constructor & Destructor Documentation

◆ vtkFileSeriesHelper()

◆ ~vtkFileSeriesHelper()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ RemoveAllFileNames()

◆ AddFileName()

◆ SetFileNames()

◆ GetNumberOfFiles()

◆ ReadMetaFile()

◆ SetController()

◆ GetController()

◆ SetIgnoreReaderTime()

◆ GetIgnoreReaderTime()

◆ IgnoreReaderTimeOn()

◆ IgnoreReaderTimeOff()

◆ UpdateInformation()

◆ GetUpdateInformationTime()

◆ GetTimeSteps()

◆ GetTimeRange()

◆ FillTimeInformation()

◆ GetPartitionedFiles()

◆ GetActiveFiles()

Member Data Documentation

◆ Controller

◆ FileNames

◆ IgnoreReaderTime

◆ PartitionedFiles

◆ Information