Parses out the base file name of a file sequence and also the specific index of the given file. More...

#include <vtkFileSequenceParser.h>

Inheritance diagram for vtkFileSequenceParser:

Collaboration diagram for vtkFileSequenceParser:

[legend]

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

bool	ParseFileSequence (const char *file)
	Extract base file name sequence from the file. More...

virtual char *	GetSequenceName ()
	Getter to use to get the sequence name after calling ParseFileSequence. More...

virtual int	GetSequenceIndex ()
	Getter to use to get the sequence index after calling ParseFileSequence. More...

virtual std::string	GetSequenceIndexString ()
	Getter to use to get the sequence index string after calling ParseFileSequence. 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 vtkFileSequenceParser *	New ()

static int	IsTypeOf (const char *type)

static vtkFileSequenceParser *	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
	vtkFileSequenceParser ()

	~vtkFileSequenceParser () override

virtual void	SetSequenceName (const char *)

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
std::unique_ptr< vtksys::RegularExpression >	reg_ex

std::unique_ptr< vtksys::RegularExpression >	reg_ex2

std::unique_ptr< vtksys::RegularExpression >	reg_ex3

std::unique_ptr< vtksys::RegularExpression >	reg_ex4

std::unique_ptr< vtksys::RegularExpression >	reg_ex5

std::unique_ptr< vtksys::RegularExpression >	reg_ex6

std::unique_ptr< vtksys::RegularExpression >	reg_ex_last

int	SequenceIndex

char *	SequenceName

std::string	SequenceIndexString

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

Parses out the base file name of a file sequence and also the specific index of the given file.

Given a file name (without path). I will extract the base portion of the file name that is common to all the files in the sequence. It will also provide the current sequence index of the provided file name. by several vtkPVUpdateSuppressor objects.

Definition at line 29 of file vtkFileSequenceParser.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkFileSequenceParser::Superclass

Definition at line 33 of file vtkFileSequenceParser.h.

Constructor & Destructor Documentation

◆ vtkFileSequenceParser()

vtkFileSequenceParser::vtkFileSequenceParser ( )

protected

◆ ~vtkFileSequenceParser()

vtkFileSequenceParser::~vtkFileSequenceParser ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkFileSequenceParser* vtkFileSequenceParser::New ( )

static

◆ GetClassName()

virtual const char* vtkFileSequenceParser::GetClassName ( )

virtual

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkObject.

◆ ParseFileSequence()

bool vtkFileSequenceParser::ParseFileSequence ( const char * file )

Extract base file name sequence from the file.

Returns true if a sequence is detected and sets SequenceName and SequenceIndex.

◆ GetSequenceName()

virtual char* vtkFileSequenceParser::GetSequenceName ( )

virtual

Getter to use to get the sequence name after calling ParseFileSequence.

◆ GetSequenceIndex()

virtual int vtkFileSequenceParser::GetSequenceIndex ( )

virtual

Getter to use to get the sequence index after calling ParseFileSequence.

◆ GetSequenceIndexString()

virtual std::string vtkFileSequenceParser::GetSequenceIndexString ( )

virtual

Getter to use to get the sequence index string after calling ParseFileSequence.

It can be useful when sequence index is duplicated.

◆ SetSequenceName()

virtual void vtkFileSequenceParser::SetSequenceName ( const char * )

protectedvirtual

Member Data Documentation

◆ reg_ex

std::unique_ptr<vtksys::RegularExpression> vtkFileSequenceParser::reg_ex

protected

Definition at line 66 of file vtkFileSequenceParser.h.

◆ reg_ex2

std::unique_ptr<vtksys::RegularExpression> vtkFileSequenceParser::reg_ex2

protected

Definition at line 67 of file vtkFileSequenceParser.h.

◆ reg_ex3

std::unique_ptr<vtksys::RegularExpression> vtkFileSequenceParser::reg_ex3

protected

Definition at line 68 of file vtkFileSequenceParser.h.

◆ reg_ex4

std::unique_ptr<vtksys::RegularExpression> vtkFileSequenceParser::reg_ex4

protected

Definition at line 69 of file vtkFileSequenceParser.h.

◆ reg_ex5

std::unique_ptr<vtksys::RegularExpression> vtkFileSequenceParser::reg_ex5

protected

Definition at line 70 of file vtkFileSequenceParser.h.

◆ reg_ex6

std::unique_ptr<vtksys::RegularExpression> vtkFileSequenceParser::reg_ex6

protected

Definition at line 71 of file vtkFileSequenceParser.h.

◆ reg_ex_last

std::unique_ptr<vtksys::RegularExpression> vtkFileSequenceParser::reg_ex_last

protected

Definition at line 72 of file vtkFileSequenceParser.h.

◆ SequenceIndex

int vtkFileSequenceParser::SequenceIndex

protected

Definition at line 75 of file vtkFileSequenceParser.h.

◆ SequenceName

char* vtkFileSequenceParser::SequenceName

protected

Definition at line 78 of file vtkFileSequenceParser.h.

◆ SequenceIndexString

std::string vtkFileSequenceParser::SequenceIndexString

protected

Definition at line 79 of file vtkFileSequenceParser.h.

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

/builds/gitlab-kitware-sciviz-ci/VTKExtensions/Core/vtkFileSequenceParser.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkFileSequenceParser()

◆ ~vtkFileSequenceParser()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ ParseFileSequence()

◆ GetSequenceName()

◆ GetSequenceIndex()

◆ GetSequenceIndexString()

◆ SetSequenceName()

Member Data Documentation

◆ reg_ex

◆ reg_ex2

◆ reg_ex3

◆ reg_ex4

◆ reg_ex5

◆ reg_ex6

◆ reg_ex_last

◆ SequenceIndex

◆ SequenceName

◆ SequenceIndexString