server side object used to gather information from, by vtkPVFileInformation. More...
#include <vtkPVFileInformationHelper.h>
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 32 of file vtkPVFileInformationHelper.h.
Constructor & Destructor Documentation
| vtkPVFileInformationHelper::vtkPVFileInformationHelper | ( | ) | [protected] |
| vtkPVFileInformationHelper::~vtkPVFileInformationHelper | ( | ) | [protected] |
Member Function Documentation
| static vtkPVFileInformationHelper* vtkPVFileInformationHelper::New | ( | ) | [static] |
Reimplemented from vtkObject.
| virtual const char* vtkPVFileInformationHelper::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkObject.
| static int vtkPVFileInformationHelper::IsTypeOf | ( | const char * | type | ) | [static] |
Reimplemented from vtkObject.
| virtual int vtkPVFileInformationHelper::IsA | ( | const char * | type | ) | [virtual] |
Reimplemented from vtkObject.
| static vtkPVFileInformationHelper* vtkPVFileInformationHelper::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkObject.
| void vtkPVFileInformationHelper::PrintSelf | ( | ostream & | os, |
| vtkIndent | indent | ||
| ) | [virtual] |
Reimplemented from vtkObject.
| 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.
| 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.
| 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.
| 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.
| 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.
| 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.
| 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.
| 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.
| 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 sepcial directories such as "My Documents", "Destop" etc on Windows systems and "Home" on Unix based systems.
| 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 sepcial directories such as "My Documents", "Destop" etc on Windows systems and "Home" on Unix based systems.
| 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 sepcial directories such as "My Documents", "Destop" etc on Windows systems and "Home" on Unix based systems.
| 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 sepcial directories such as "My Documents", "Destop" etc on Windows systems and "Home" on Unix based systems.
| 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.
| 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.
| virtual char* vtkPVFileInformationHelper::GetPathSeparator | ( | ) | [virtual] |
Returns the platform specific path separator.
| bool vtkPVFileInformationHelper::GetActiveFileIsReadable | ( | ) |
Returns if this->Path is a readable file.
| bool vtkPVFileInformationHelper::GetActiveFileIsDirectory | ( | ) |
Returns if this->Path is a directory.
| virtual void vtkPVFileInformationHelper::SetPathSeparator | ( | const char * | ) | [protected, virtual] |
Member Data Documentation
char* vtkPVFileInformationHelper::Path [protected] |
Definition at line 101 of file vtkPVFileInformationHelper.h.
char* vtkPVFileInformationHelper::WorkingDirectory [protected] |
Definition at line 102 of file vtkPVFileInformationHelper.h.
int vtkPVFileInformationHelper::DirectoryListing [protected] |
Definition at line 103 of file vtkPVFileInformationHelper.h.
int vtkPVFileInformationHelper::SpecialDirectories [protected] |
Definition at line 104 of file vtkPVFileInformationHelper.h.
int vtkPVFileInformationHelper::FastFileTypeDetection [protected] |
Definition at line 105 of file vtkPVFileInformationHelper.h.
char* vtkPVFileInformationHelper::PathSeparator [protected] |
Definition at line 107 of file vtkPVFileInformationHelper.h.
The documentation for this class was generated from the following file:
- dox/ParaViewCore/ClientServerCore/vtkPVFileInformationHelper.h
