server side object used to gather information from, by vtkPVFileInformation. More...

#include <vtkPVFileInformationHelper.h>

Inheritance diagram for vtkPVFileInformationHelper:

Collaboration diagram for vtkPVFileInformationHelper:

[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	GetActiveFileIsReadable ()
	Returns if this->Path is a readable file. More...

bool	GetActiveFileIsDirectory ()
	Returns if this->Path is a directory. More...


virtual void	SetPath (const char *)
	Get/Set the path to the directory/file whose information we are interested in. More...

virtual char *	GetPath ()
	Get/Set the path to the directory/file whose information we are interested in. More...


virtual void	SetWorkingDirectory (const char *)
	Get/Set the current working directory. More...

virtual char *	GetWorkingDirectory ()
	Get/Set the current working directory. More...


virtual int	GetDirectoryListing ()
	Get/Set if the we should attempt to get the information of contents if Path is a directory. More...

virtual void	SetDirectoryListing (int)
	Get/Set if the we should attempt to get the information of contents if Path is a directory. More...

virtual void	DirectoryListingOn ()
	Get/Set if the we should attempt to get the information of contents if Path is a directory. More...

virtual void	DirectoryListingOff ()
	Get/Set if the we should attempt to get the information of contents if Path is a directory. More...


virtual int	GetSpecialDirectories ()
	Get/Set if the query is for special directories. More...

virtual void	SetSpecialDirectories (int)
	Get/Set if the query is for special directories. More...

virtual void	SpecialDirectoriesOn ()
	Get/Set if the query is for special directories. More...

virtual void	SpecialDirectoriesOff ()
	Get/Set if the query is for special directories. More...


virtual bool	GetExamplesInSpecialDirectories ()
	Get/Set if special directories includes the Examples placeholder. More...

virtual void	SetExamplesInSpecialDirectories (bool)
	Get/Set if special directories includes the Examples placeholder. More...

virtual void	ExamplesInSpecialDirectoriesOn ()
	Get/Set if special directories includes the Examples placeholder. More...

virtual void	ExamplesInSpecialDirectoriesOff ()
	Get/Set if special directories includes the Examples placeholder. More...


virtual int	GetFastFileTypeDetection ()
	When on, while listing a directory, whenever a group of files is encountered, we verify the type/accessibility of only the first file in the group and assume that all other have similar permissions. More...

virtual void	SetFastFileTypeDetection (int)
	When on, while listing a directory, whenever a group of files is encountered, we verify the type/accessibility of only the first file in the group and assume that all other have similar permissions. 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 char *	GetPathSeparator ()
	Returns the platform specific path separator. More...


virtual bool	GetReadDetailedFileInformation ()
	When off, while listing a directory we skip the expensive fstat call on every file and instead return only their names and basic information about them. More...

virtual void	SetReadDetailedFileInformation (bool)
	When off, while listing a directory we skip the expensive fstat call on every file and instead return only their names and basic information about them. 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 vtkPVFileInformationHelper *	New ()

static int	IsTypeOf (const char *type)

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

	~vtkPVFileInformationHelper () override

virtual void	SetPathSeparator (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
char *	Path

char *	WorkingDirectory

int	DirectoryListing

int	SpecialDirectories

int	FastFileTypeDetection

bool	GroupFileSequences

bool	ExamplesInSpecialDirectories

bool	ReadDetailedFileInformation

char *	PathSeparator

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

server side object used to gather information from, by vtkPVFileInformation.

When collection information, ProcessModule cannot pass parameters to the information object. In case of vtkPVFileInformation, we need data on the server side such as which directory/file are we concerned with. To make such information available, we use vtkPVFileInformationHelper. One creates a server side representation of vtkPVFileInformationHelper and sets attributes on it, then requests a gather information on the helper object.

Definition at line 24 of file vtkPVFileInformationHelper.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkPVFileInformationHelper::Superclass

Definition at line 28 of file vtkPVFileInformationHelper.h.

Constructor & Destructor Documentation

◆ vtkPVFileInformationHelper()

vtkPVFileInformationHelper::vtkPVFileInformationHelper ( )

protected

◆ ~vtkPVFileInformationHelper()

vtkPVFileInformationHelper::~vtkPVFileInformationHelper ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkPVFileInformationHelper* vtkPVFileInformationHelper::New ( )

static

◆ GetClassName()

virtual const char* vtkPVFileInformationHelper::GetClassName ( )

virtual

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkObject.

◆ SetPath()

virtual void vtkPVFileInformationHelper::SetPath ( const char * )

virtual

Get/Set the path to the directory/file whose information we are interested in.

This is ignored when SpecialDirectories is set to True.

◆ GetPath()

virtual char* vtkPVFileInformationHelper::GetPath ( )

virtual

Get/Set the path to the directory/file whose information we are interested in.

This is ignored when SpecialDirectories is set to True.

◆ SetWorkingDirectory()

virtual void vtkPVFileInformationHelper::SetWorkingDirectory ( const char * )

virtual

Get/Set the current working directory.

This is needed if Path is relative. The relative path will be converted to absolute path using the working directory specified before obtaining information about it. If 0 (default), then the application's current working directory will be used to flatten relative paths.

◆ GetWorkingDirectory()

virtual char* vtkPVFileInformationHelper::GetWorkingDirectory ( )

virtual

Get/Set the current working directory.

This is needed if Path is relative. The relative path will be converted to absolute path using the working directory specified before obtaining information about it. If 0 (default), then the application's current working directory will be used to flatten relative paths.

◆ GetDirectoryListing()

virtual int vtkPVFileInformationHelper::GetDirectoryListing ( )

virtual

Get/Set if the we should attempt to get the information of contents if Path is a directory.

Default value is 0. This is ignored when SpecialDirectories is set to True.

◆ SetDirectoryListing()

virtual void vtkPVFileInformationHelper::SetDirectoryListing ( int )

virtual

Get/Set if the we should attempt to get the information of contents if Path is a directory.

Default value is 0. This is ignored when SpecialDirectories is set to True.

◆ DirectoryListingOn()

virtual void vtkPVFileInformationHelper::DirectoryListingOn ( )

virtual

Get/Set if the we should attempt to get the information of contents if Path is a directory.

Default value is 0. This is ignored when SpecialDirectories is set to True.

◆ DirectoryListingOff()

virtual void vtkPVFileInformationHelper::DirectoryListingOff ( )

virtual

Get/Set if the we should attempt to get the information of contents if Path is a directory.

Default value is 0. This is ignored when SpecialDirectories is set to True.

◆ GetSpecialDirectories()

virtual int vtkPVFileInformationHelper::GetSpecialDirectories ( )

virtual

Get/Set if the query is for special directories.

Off by default. If set to true, Path and DirectoryListing are ignored and the vtkPVFileInformation object is populated with information about special directories such as "My Documents", "Desktop" etc on Windows systems and "Home" on Unix based systems.

◆ SetSpecialDirectories()

virtual void vtkPVFileInformationHelper::SetSpecialDirectories ( int )

virtual

Get/Set if the query is for special directories.

Off by default. If set to true, Path and DirectoryListing are ignored and the vtkPVFileInformation object is populated with information about special directories such as "My Documents", "Desktop" etc on Windows systems and "Home" on Unix based systems.

◆ SpecialDirectoriesOn()

virtual void vtkPVFileInformationHelper::SpecialDirectoriesOn ( )

virtual

Get/Set if the query is for special directories.

Off by default. If set to true, Path and DirectoryListing are ignored and the vtkPVFileInformation object is populated with information about special directories such as "My Documents", "Desktop" etc on Windows systems and "Home" on Unix based systems.

◆ SpecialDirectoriesOff()

virtual void vtkPVFileInformationHelper::SpecialDirectoriesOff ( )

virtual

Get/Set if the query is for special directories.

Off by default. If set to true, Path and DirectoryListing are ignored and the vtkPVFileInformation object is populated with information about special directories such as "My Documents", "Desktop" etc on Windows systems and "Home" on Unix based systems.

◆ GetExamplesInSpecialDirectories()

virtual bool vtkPVFileInformationHelper::GetExamplesInSpecialDirectories ( )

virtual

Get/Set if special directories includes the Examples placeholder.

On by default.

◆ SetExamplesInSpecialDirectories()

virtual void vtkPVFileInformationHelper::SetExamplesInSpecialDirectories ( bool )

virtual

Get/Set if special directories includes the Examples placeholder.

On by default.

◆ ExamplesInSpecialDirectoriesOn()

virtual void vtkPVFileInformationHelper::ExamplesInSpecialDirectoriesOn ( )

virtual

Get/Set if special directories includes the Examples placeholder.

On by default.

◆ ExamplesInSpecialDirectoriesOff()

virtual void vtkPVFileInformationHelper::ExamplesInSpecialDirectoriesOff ( )

virtual

Get/Set if special directories includes the Examples placeholder.

On by default.

◆ GetFastFileTypeDetection()

virtual int vtkPVFileInformationHelper::GetFastFileTypeDetection ( )

virtual

When on, while listing a directory, whenever a group of files is encountered, we verify the type/accessibility of only the first file in the group and assume that all other have similar permissions.

On by default.

◆ SetFastFileTypeDetection()

virtual void vtkPVFileInformationHelper::SetFastFileTypeDetection ( int )

virtual

When on, while listing a directory, whenever a group of files is encountered, we verify the type/accessibility of only the first file in the group and assume that all other have similar permissions.

On by default.

◆ GetGroupFileSequences()

virtual bool vtkPVFileInformationHelper::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 vtkPVFileInformationHelper::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 vtkPVFileInformationHelper::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 vtkPVFileInformationHelper::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.

◆ GetPathSeparator()

virtual char* vtkPVFileInformationHelper::GetPathSeparator ( )

virtual

Returns the platform specific path separator.

◆ GetActiveFileIsReadable()

bool vtkPVFileInformationHelper::GetActiveFileIsReadable ( )

Returns if this->Path is a readable file.

◆ GetActiveFileIsDirectory()

bool vtkPVFileInformationHelper::GetActiveFileIsDirectory ( )

Returns if this->Path is a directory.

◆ GetReadDetailedFileInformation()

virtual bool vtkPVFileInformationHelper::GetReadDetailedFileInformation ( )

virtual

When off, while listing a directory we skip the expensive fstat call on every file and instead return only their names and basic information about them.

Defaults to off. To enable the detailed information like file size and modified time turn this on.

◆ SetReadDetailedFileInformation()

virtual void vtkPVFileInformationHelper::SetReadDetailedFileInformation ( bool )

virtual

When off, while listing a directory we skip the expensive fstat call on every file and instead return only their names and basic information about them.

Defaults to off. To enable the detailed information like file size and modified time turn this on.

◆ SetPathSeparator()

virtual void vtkPVFileInformationHelper::SetPathSeparator ( const char * )

protectedvirtual

Member Data Documentation

◆ Path

char* vtkPVFileInformationHelper::Path

protected

Definition at line 144 of file vtkPVFileInformationHelper.h.

◆ WorkingDirectory

char* vtkPVFileInformationHelper::WorkingDirectory

protected

Definition at line 145 of file vtkPVFileInformationHelper.h.

◆ DirectoryListing

int vtkPVFileInformationHelper::DirectoryListing

protected

Definition at line 146 of file vtkPVFileInformationHelper.h.

◆ SpecialDirectories

int vtkPVFileInformationHelper::SpecialDirectories

protected

Definition at line 147 of file vtkPVFileInformationHelper.h.

◆ FastFileTypeDetection

int vtkPVFileInformationHelper::FastFileTypeDetection

protected

Definition at line 148 of file vtkPVFileInformationHelper.h.

◆ GroupFileSequences

bool vtkPVFileInformationHelper::GroupFileSequences

protected

Definition at line 149 of file vtkPVFileInformationHelper.h.

◆ ExamplesInSpecialDirectories

bool vtkPVFileInformationHelper::ExamplesInSpecialDirectories

protected

Definition at line 150 of file vtkPVFileInformationHelper.h.

◆ ReadDetailedFileInformation

bool vtkPVFileInformationHelper::ReadDetailedFileInformation

protected

Definition at line 152 of file vtkPVFileInformationHelper.h.

◆ PathSeparator

char* vtkPVFileInformationHelper::PathSeparator

protected

Definition at line 153 of file vtkPVFileInformationHelper.h.

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

/builds/gitlab-kitware-sciviz-ci/Remoting/Core/vtkPVFileInformationHelper.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkPVFileInformationHelper()

◆ ~vtkPVFileInformationHelper()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ SetPath()

◆ GetPath()

◆ SetWorkingDirectory()

◆ GetWorkingDirectory()

◆ GetDirectoryListing()

◆ SetDirectoryListing()

◆ DirectoryListingOn()

◆ DirectoryListingOff()

◆ GetSpecialDirectories()

◆ SetSpecialDirectories()

◆ SpecialDirectoriesOn()

◆ SpecialDirectoriesOff()

◆ GetExamplesInSpecialDirectories()

◆ SetExamplesInSpecialDirectories()

◆ ExamplesInSpecialDirectoriesOn()

◆ ExamplesInSpecialDirectoriesOff()

◆ GetFastFileTypeDetection()

◆ SetFastFileTypeDetection()

◆ GetGroupFileSequences()

◆ SetGroupFileSequences()

◆ GroupFileSequencesOn()

◆ GroupFileSequencesOff()

◆ GetPathSeparator()

◆ GetActiveFileIsReadable()

◆ GetActiveFileIsDirectory()

◆ GetReadDetailedFileInformation()

◆ SetReadDetailedFileInformation()

◆ SetPathSeparator()

Member Data Documentation

◆ Path

◆ WorkingDirectory

◆ DirectoryListing

◆ SpecialDirectories

◆ FastFileTypeDetection

◆ GroupFileSequences

◆ ExamplesInSpecialDirectories

◆ ReadDetailedFileInformation

◆ PathSeparator