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

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

#include <vtkPVFileInformationHelper.h>

Inherits vtkObject.

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
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 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 char * GetPathSeparator ()
 Returns the platform specific path separator. More...
 

Static Public Member Functions

static vtkPVFileInformationHelperNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPVFileInformationHelperSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkPVFileInformationHelper ()
 
 ~vtkPVFileInformationHelper ()
 
virtual void SetPathSeparator (const char *)
 

Protected Attributes

char * Path
 
char * WorkingDirectory
 
int DirectoryListing
 
int SpecialDirectories
 
int FastFileTypeDetection
 
char * PathSeparator
 

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 34 of file vtkPVFileInformationHelper.h.

Member Typedef Documentation

§ Superclass

Definition at line 38 of file vtkPVFileInformationHelper.h.

Constructor & Destructor Documentation

§ vtkPVFileInformationHelper()

vtkPVFileInformationHelper::vtkPVFileInformationHelper ( )
protected

§ ~vtkPVFileInformationHelper()

vtkPVFileInformationHelper::~vtkPVFileInformationHelper ( )
protected

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

§ SafeDownCast()

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

§ PrintSelf()

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

§ 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.

§ 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.

§ 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.

§ SetPathSeparator()

virtual void vtkPVFileInformationHelper::SetPathSeparator ( const char *  )
protectedvirtual

Member Data Documentation

§ Path

char* vtkPVFileInformationHelper::Path
protected

Definition at line 122 of file vtkPVFileInformationHelper.h.

§ WorkingDirectory

char* vtkPVFileInformationHelper::WorkingDirectory
protected

Definition at line 123 of file vtkPVFileInformationHelper.h.

§ DirectoryListing

int vtkPVFileInformationHelper::DirectoryListing
protected

Definition at line 124 of file vtkPVFileInformationHelper.h.

§ SpecialDirectories

int vtkPVFileInformationHelper::SpecialDirectories
protected

Definition at line 125 of file vtkPVFileInformationHelper.h.

§ FastFileTypeDetection

int vtkPVFileInformationHelper::FastFileTypeDetection
protected

Definition at line 126 of file vtkPVFileInformationHelper.h.

§ PathSeparator

char* vtkPVFileInformationHelper::PathSeparator
protected

Definition at line 128 of file vtkPVFileInformationHelper.h.


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