ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkPVFileInformation Class Reference

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

#include <vtkPVFileInformation.h>

Inheritance diagram for vtkPVFileInformation:
Inheritance graph
[legend]
Collaboration diagram for vtkPVFileInformation:
Collaboration graph
[legend]

List of all members.

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
}

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void CopyFromObject (vtkObject *object)
void Initialize ()
virtual void CopyToStream (vtkClientServerStream *)
virtual void CopyFromStream (const vtkClientServerStream *)
virtual char * GetName ()
virtual char * GetFullPath ()
virtual int GetType ()
virtual bool GetHidden ()

Static Public Member Functions

static vtkPVFileInformationNew ()
static int IsTypeOf (const char *type)
static vtkPVFileInformationSafeDownCast (vtkObject *o)
static bool IsDirectory (int t)

Protected Member Functions

virtual void SetName (const char *)
virtual void SetFullPath (const char *)
void GetWindowsDirectoryListing ()
void GetDirectoryListing ()
void OrganizeCollection (vtkPVFileInformationSet &vector)
bool DetectType ()
void GetSpecialDirectories ()
void SetHiddenFlag ()

Protected Attributes

vtkCollectionContents
vtkFileSequenceParserSequenceParser
char * Name
char * FullPath
int Type
bool Hidden
int FastFileTypeDetection
virtual vtkCollectionGetContents ()
 vtkPVFileInformation ()
 ~vtkPVFileInformation ()

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 35 of file vtkPVFileInformation.h.


Member Enumeration Documentation

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

Definition at line 53 of file vtkPVFileInformation.h.


Constructor & Destructor Documentation

vtkPVFileInformation::vtkPVFileInformation ( ) [protected]

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.

vtkPVFileInformation::~vtkPVFileInformation ( ) [protected]

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.


Member Function Documentation

static vtkPVFileInformation* vtkPVFileInformation::New ( ) [static]

Reimplemented from vtkObject.

virtual const char* vtkPVFileInformation::GetClassName ( ) [virtual]

Reimplemented from vtkPVInformation.

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

Reimplemented from vtkPVInformation.

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

Reimplemented from vtkPVInformation.

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

Reimplemented from vtkPVInformation.

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

Reimplemented from vtkPVInformation.

virtual void vtkPVFileInformation::CopyFromObject ( vtkObject object) [virtual]

Transfer information about a single object into this object. The object must be a vtkPVFileInformationHelper.

Reimplemented from vtkPVInformation.

virtual void vtkPVFileInformation::CopyToStream ( vtkClientServerStream *  ) [virtual]

Manage a serialized version of the information.

Implements vtkPVInformation.

virtual void vtkPVFileInformation::CopyFromStream ( const vtkClientServerStream *  ) [virtual]

Manage a serialized version of the information.

Reimplemented from vtkPVInformation.

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.

void vtkPVFileInformation::Initialize ( )

Initializes the information object.

virtual char* vtkPVFileInformation::GetName ( ) [virtual]

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

virtual char* vtkPVFileInformation::GetFullPath ( ) [virtual]

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

virtual int vtkPVFileInformation::GetType ( ) [virtual]

Get the type of this file object.

virtual bool vtkPVFileInformation::GetHidden ( ) [virtual]

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

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.

virtual void vtkPVFileInformation::SetName ( const char *  ) [protected, virtual]
virtual void vtkPVFileInformation::SetFullPath ( const char *  ) [protected, virtual]
void vtkPVFileInformation::GetWindowsDirectoryListing ( ) [protected]
void vtkPVFileInformation::GetDirectoryListing ( ) [protected]
void vtkPVFileInformation::OrganizeCollection ( vtkPVFileInformationSet &  vector) [protected]
bool vtkPVFileInformation::DetectType ( ) [protected]
void vtkPVFileInformation::GetSpecialDirectories ( ) [protected]
void vtkPVFileInformation::SetHiddenFlag ( ) [protected]

Member Data Documentation

Definition at line 112 of file vtkPVFileInformation.h.

Definition at line 113 of file vtkPVFileInformation.h.

char* vtkPVFileInformation::Name [protected]

Definition at line 115 of file vtkPVFileInformation.h.

char* vtkPVFileInformation::FullPath [protected]

Definition at line 116 of file vtkPVFileInformation.h.

Definition at line 117 of file vtkPVFileInformation.h.

bool vtkPVFileInformation::Hidden [protected]

Definition at line 118 of file vtkPVFileInformation.h.

Definition at line 133 of file vtkPVFileInformation.h.


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