vtkPVFileInformation Class Reference

Information object that can be used to obtain information about a file/directory. More...

#include <vtkPVFileInformation.h>

Inheritance diagram for vtkPVFileInformation:

Collaboration diagram for vtkPVFileInformation:

Public Types
enum	FileTypes {   INVALID = 0, SINGLE_FILE, SINGLE_FILE_LINK, DIRECTORY,   DIRECTORY_LINK, FILE_GROUP, DRIVE, NETWORK_ROOT,   NETWORK_DOMAIN, NETWORK_SERVER, NETWORK_SHARE, DIRECTORY_GROUP }
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) override
void	CopyFromObject (vtkObject *object) override
	Transfer information about a single object into this object. More...
void	Initialize ()
	Initializes the information object. More...
void	FetchDirectoryListing ()
	Fetch the directory listing to be able to use GetSize or GetContents with directories. More...
void	CopyToStream (vtkClientServerStream *) override
	Manage a serialized version of the information. More...
void	CopyFromStream (const vtkClientServerStream *) override
	Manage a serialized version of the information. More...
virtual char *	GetName ()
	Get the name of the file/directory whose information is represented by this object. More...
virtual char *	GetFullPath ()
	Get the full path of the file/directory whose information is represented by this object. More...
virtual int	GetType ()
	Get the type of this file object. More...
virtual bool	GetHidden ()
	Get the state of the hidden flag for the file/directory. More...
virtual bool	GetGroupFileSequences ()
	Groups file sequences when found. More...
virtual void	SetGroupFileSequences (bool)
	Groups file sequences when found. More...
virtual void	GroupFileSequencesOn ()
	Groups file sequences when found. More...
virtual void	GroupFileSequencesOff ()
	Groups file sequences when found. More...
virtual vtkCollection *	GetContents ()
	Get the Contents for this directory. More...
virtual char *	GetExtension ()
	Get the Contents for this directory. More...
virtual long long	GetSize ()
	Get the Contents for this directory. More...
virtual time_t	GetModificationTime ()
	Get the Contents for this directory. More...
Public Member Functions inherited from vtkPVInformation
void	PrintSelf (ostream &os, vtkIndent indent) override
virtual void	AddInformation (vtkPVInformation *)
	Merge another information object. More...
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...
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 vtkPVFileInformation *	New ()
static int	IsTypeOf (const char *type)
static vtkPVFileInformation *	SafeDownCast (vtkObject *o)
static std::string	GetParaViewSharedResourcesDirectory ()
	Returns the path to the base data directory path holding various files packaged with ParaView. More...
static std::string	GetParaViewExampleFilesDirectory ()
	Return the path of the example data packaged with ParaView. More...
static std::string	GetParaViewDocDirectory ()
	Return the path of the documents packaged with ParaView. More...
static std::string	GetParaViewTranslationsDirectory ()
	Return the path of the translations packaged with ParaView. More...
Static Public Member Functions inherited from vtkPVInformation
static int	IsTypeOf (const char *type)
static vtkPVInformation *	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
	vtkPVFileInformation ()
	~vtkPVFileInformation () override
virtual void	SetExtension (const char *)
virtual void	SetName (const char *)
virtual void	SetFullPath (const char *)
void	FetchWindowsDirectoryListing ()
void	FetchUnixDirectoryListing ()
void	OrganizeCollection (vtkPVFileInformationSet &vector)
bool	DetectType ()
void	GetSpecialDirectories ()
void	SetHiddenFlag ()
Protected Member Functions inherited from vtkPVInformation
	vtkPVInformation ()
	~vtkPVInformation () override
virtual void	SetRootOnly (int)
	vtkPVInformation (const vtkPVInformation &)=delete
void	operator= (const vtkPVInformation &)=delete
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
vtkCollection *	Contents
vtkFileSequenceParser *	SequenceParser
char *	Name
char *	FullPath
int	Type
bool	Hidden
char *	Extension
long long	Size
time_t	ModificationTime
int	FastFileTypeDetection
bool	ReadDetailedFileInformation
bool	GroupFileSequences
bool	IncludeExamples
Protected Attributes inherited from vtkPVInformation
int	RootOnly
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers
static bool	IsDirectory (int t)
	Helper that returns whether a FileType is a directory (DIRECTORY, DRIVE, NETWORK_ROOT, etc...) Or in other words, a type that we can do a DirectoryListing on. More...
bool	IsDirectory () const
	Helper that returns whether a FileType is a directory (DIRECTORY, DRIVE, NETWORK_ROOT, etc...) Or in other words, a type that we can do a DirectoryListing on. More...
static bool	IsGroup (int type)
	Helper that returns true if file-type is a network related file i.e. More...
bool	IsGroup () const
	Helper that returns true if file-type is a network related file i.e. More...

Detailed Description

Information object that can be used to obtain information about a file/directory.

vtkPVFileInformation can be used to collect information about file or directory. vtkPVFileInformation can collect information from a vtkPVFileInformationHelper object alone.

See also

vtkPVFileInformationHelper

Definition at line 27 of file vtkPVFileInformation.h.

Member Typedef Documentation

Superclass

typedef vtkPVInformation vtkPVFileInformation::Superclass

Definition at line 31 of file vtkPVFileInformation.h.

Member Enumeration Documentation

FileTypes

enum vtkPVFileInformation::FileTypes

Enumerator
INVALID
SINGLE_FILE
SINGLE_FILE_LINK
DIRECTORY
DIRECTORY_LINK
FILE_GROUP
DRIVE
NETWORK_ROOT
NETWORK_DOMAIN
NETWORK_SERVER
NETWORK_SHARE
DIRECTORY_GROUP

Definition at line 48 of file vtkPVFileInformation.h.

Constructor & Destructor Documentation

vtkPVFileInformation()

vtkPVFileInformation::vtkPVFileInformation ( )

protected

~vtkPVFileInformation()

vtkPVFileInformation::~vtkPVFileInformation ( )

overrideprotected

Member Function Documentation

New()

static vtkPVFileInformation* vtkPVFileInformation::New ( )

static

GetClassName()

virtual const char* vtkPVFileInformation::GetClassName ( )

virtual

Reimplemented from vtkPVInformation.

IsTypeOf()

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

static

IsA()

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

virtual

Reimplemented from vtkPVInformation.

SafeDownCast()

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

static

PrintSelf()

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

overridevirtual

Reimplemented from vtkObject.

CopyFromObject()

void vtkPVFileInformation::CopyFromObject ( vtkObject *  object )

overridevirtual

Transfer information about a single object into this object.

The object must be a vtkPVFileInformationHelper.

Reimplemented from vtkPVInformation.

CopyToStream()

void vtkPVFileInformation::CopyToStream ( vtkClientServerStream *  )

overridevirtual

Manage a serialized version of the information.

Implements vtkPVInformation.

CopyFromStream()

void vtkPVFileInformation::CopyFromStream ( const vtkClientServerStream *  )

overridevirtual

Manage a serialized version of the information.

Reimplemented from vtkPVInformation.

IsDirectory() [1/2]

static bool vtkPVFileInformation::IsDirectory ( int  t )

static

Helper that returns whether a FileType is a directory (DIRECTORY, DRIVE, NETWORK_ROOT, etc...) Or in other words, a type that we can do a DirectoryListing on.

IsDirectory() [2/2]

bool vtkPVFileInformation::IsDirectory ( ) const

inline

Helper that returns whether a FileType is a directory (DIRECTORY, DRIVE, NETWORK_ROOT, etc...) Or in other words, a type that we can do a DirectoryListing on.

Definition at line 71 of file vtkPVFileInformation.h.

IsGroup() [1/2]

static bool vtkPVFileInformation::IsGroup ( int  type )

inlinestatic

Helper that returns true if file-type is a network related file i.e.

either a FILE_GROUP or a DIRECTORY_GROUP.

Definition at line 79 of file vtkPVFileInformation.h.

IsGroup() [2/2]

bool vtkPVFileInformation::IsGroup ( ) const

inline

Helper that returns true if file-type is a network related file i.e.

either a FILE_GROUP or a DIRECTORY_GROUP.

Definition at line 90 of file vtkPVFileInformation.h.

Initialize()

void vtkPVFileInformation::Initialize

(

)

Initializes the information object.

GetName()

virtual char* vtkPVFileInformation::GetName ( )

virtual

Get the name of the file/directory whose information is represented by this object.

GetFullPath()

virtual char* vtkPVFileInformation::GetFullPath ( )

virtual

Get the full path of the file/directory whose information is represented by this object.

GetType()

virtual int vtkPVFileInformation::GetType ( )

virtual

Get the type of this file object.

GetHidden()

virtual bool vtkPVFileInformation::GetHidden ( )

virtual

Get the state of the hidden flag for the file/directory.

GetGroupFileSequences()

virtual bool vtkPVFileInformation::GetGroupFileSequences ( )

virtual

Groups file sequences when found.

A file sequence could be [foo1.png, foo2.png, foo6.png]. When turned on, the series of files is grouped and our sequence example is named foo..png and original files are discarded from the listing. By default, this flag is set to true.

SetGroupFileSequences()

virtual void vtkPVFileInformation::SetGroupFileSequences ( bool  )

virtual

Groups file sequences when found.

A file sequence could be [foo1.png, foo2.png, foo6.png]. When turned on, the series of files is grouped and our sequence example is named foo..png and original files are discarded from the listing. By default, this flag is set to true.

GroupFileSequencesOn()

virtual void vtkPVFileInformation::GroupFileSequencesOn ( )

virtual

Groups file sequences when found.

A file sequence could be [foo1.png, foo2.png, foo6.png]. When turned on, the series of files is grouped and our sequence example is named foo..png and original files are discarded from the listing. By default, this flag is set to true.

GroupFileSequencesOff()

virtual void vtkPVFileInformation::GroupFileSequencesOff ( )

virtual

Groups file sequences when found.

A file sequence could be [foo1.png, foo2.png, foo6.png]. When turned on, the series of files is grouped and our sequence example is named foo..png and original files are discarded from the listing. By default, this flag is set to true.

GetContents()

virtual vtkCollection* vtkPVFileInformation::GetContents ( )

virtual

Get the Contents for this directory.

Returns a collection with vtkPVFileInformation objects for the contents of this directory if Type == DIRECTORY or the contents of this file group if Type == FILE_GROUP or the contents of this directory group if Type == DIRECTORY_GROUP.

GetExtension()

virtual char* vtkPVFileInformation::GetExtension ( )

virtual

Get the Contents for this directory.

Returns a collection with vtkPVFileInformation objects for the contents of this directory if Type == DIRECTORY or the contents of this file group if Type == FILE_GROUP or the contents of this directory group if Type == DIRECTORY_GROUP.

GetSize()

virtual long long vtkPVFileInformation::GetSize ( )

virtual

Get the Contents for this directory.

Returns a collection with vtkPVFileInformation objects for the contents of this directory if Type == DIRECTORY or the contents of this file group if Type == FILE_GROUP or the contents of this directory group if Type == DIRECTORY_GROUP.

GetModificationTime()

virtual time_t vtkPVFileInformation::GetModificationTime ( )

virtual

Get the Contents for this directory.

Returns a collection with vtkPVFileInformation objects for the contents of this directory if Type == DIRECTORY or the contents of this file group if Type == FILE_GROUP or the contents of this directory group if Type == DIRECTORY_GROUP.

FetchDirectoryListing()

void vtkPVFileInformation::FetchDirectoryListing

(

)

Fetch the directory listing to be able to use GetSize or GetContents with directories.

GetParaViewSharedResourcesDirectory()

static std::string vtkPVFileInformation::GetParaViewSharedResourcesDirectory ( )

static

Returns the path to the base data directory path holding various files packaged with ParaView.

GetParaViewExampleFilesDirectory()

static std::string vtkPVFileInformation::GetParaViewExampleFilesDirectory ( )

static

Return the path of the example data packaged with ParaView.

GetParaViewDocDirectory()

static std::string vtkPVFileInformation::GetParaViewDocDirectory ( )

static

Return the path of the documents packaged with ParaView.

GetParaViewTranslationsDirectory()

static std::string vtkPVFileInformation::GetParaViewTranslationsDirectory ( )

static

Return the path of the translations packaged with ParaView.

SetExtension()

virtual void vtkPVFileInformation::SetExtension ( const char *  )

protectedvirtual

SetName()

virtual void vtkPVFileInformation::SetName ( const char *  )

protectedvirtual

SetFullPath()

virtual void vtkPVFileInformation::SetFullPath ( const char *  )

protectedvirtual

FetchWindowsDirectoryListing()

void vtkPVFileInformation::FetchWindowsDirectoryListing ( )

protected

FetchUnixDirectoryListing()

void vtkPVFileInformation::FetchUnixDirectoryListing ( )

protected

OrganizeCollection()

void vtkPVFileInformation::OrganizeCollection ( vtkPVFileInformationSet &  vector )

protected

DetectType()

bool vtkPVFileInformation::DetectType ( )

protected

GetSpecialDirectories()

void vtkPVFileInformation::GetSpecialDirectories ( )

protected

SetHiddenFlag()

void vtkPVFileInformation::SetHiddenFlag ( )

protected

Member Data Documentation

Contents

vtkCollection* vtkPVFileInformation::Contents

protected

Definition at line 184 of file vtkPVFileInformation.h.

SequenceParser

vtkFileSequenceParser* vtkPVFileInformation::SequenceParser

protected

Definition at line 185 of file vtkPVFileInformation.h.

Name

char* vtkPVFileInformation::Name

protected

Definition at line 187 of file vtkPVFileInformation.h.

FullPath

char* vtkPVFileInformation::FullPath

protected

Definition at line 188 of file vtkPVFileInformation.h.

Type

int vtkPVFileInformation::Type

protected

Definition at line 189 of file vtkPVFileInformation.h.

Hidden

bool vtkPVFileInformation::Hidden

protected

Definition at line 190 of file vtkPVFileInformation.h.

Extension

char* vtkPVFileInformation::Extension

protected

Definition at line 191 of file vtkPVFileInformation.h.

Size

long long vtkPVFileInformation::Size

protected

Definition at line 192 of file vtkPVFileInformation.h.

ModificationTime

time_t vtkPVFileInformation::ModificationTime

protected

Definition at line 193 of file vtkPVFileInformation.h.

FastFileTypeDetection

int vtkPVFileInformation::FastFileTypeDetection

protected

Definition at line 209 of file vtkPVFileInformation.h.

ReadDetailedFileInformation

bool vtkPVFileInformation::ReadDetailedFileInformation

protected

Definition at line 210 of file vtkPVFileInformation.h.

GroupFileSequences

bool vtkPVFileInformation::GroupFileSequences

protected

Definition at line 211 of file vtkPVFileInformation.h.

IncludeExamples

bool vtkPVFileInformation::IncludeExamples

protected

Definition at line 212 of file vtkPVFileInformation.h.

---

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

• /builds/gitlab-kitware-sciviz-ci/Remoting/Core/vtkPVFileInformation.h