ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
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]

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
}
 
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)
 
virtual void CopyFromObject (vtkObject *object)
 Transfer information about a single object into this object. More...
 
void Initialize ()
 Initializes the information object. More...
 
virtual void CopyToStream (vtkClientServerStream *)
 Manage a serialized version of the information. More...
 
virtual void CopyFromStream (const vtkClientServerStream *)
 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 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)
 
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...
 

Static Public Member Functions

static vtkPVFileInformationNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPVFileInformationSafeDownCast (vtkObject *o)
 
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...
 
- Static Public Member Functions inherited from vtkPVInformation
static int IsTypeOf (const char *type)
 
static vtkPVInformationSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkPVFileInformation ()
 
 ~vtkPVFileInformation ()
 
virtual void SetExtension (const char *)
 
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 Member Functions inherited from vtkPVInformation
 vtkPVInformation ()
 
 ~vtkPVInformation ()
 
virtual void SetRootOnly (int)
 
 vtkPVInformation (const vtkPVInformation &) VTK_DELETE_FUNCTION
 
void operator= (const vtkPVInformation &) VTK_DELETE_FUNCTION
 

Protected Attributes

vtkCollection * Contents
 
vtkFileSequenceParserSequenceParser
 
char * Name
 
char * FullPath
 
int Type
 
bool Hidden
 
char * Extension
 
long long Size
 
time_t ModificationTime
 
int FastFileTypeDetection
 
- Protected Attributes inherited from vtkPVInformation
int RootOnly
 

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

Member Typedef Documentation

◆ Superclass

Definition at line 41 of file vtkPVFileInformation.h.

Member Enumeration Documentation

◆ FileTypes

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

Definition at line 58 of file vtkPVFileInformation.h.

Constructor & Destructor Documentation

◆ vtkPVFileInformation()

vtkPVFileInformation::vtkPVFileInformation ( )
protected

◆ ~vtkPVFileInformation()

vtkPVFileInformation::~vtkPVFileInformation ( )
protected

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 
)

◆ CopyFromObject()

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.

◆ CopyToStream()

virtual void vtkPVFileInformation::CopyToStream ( vtkClientServerStream )
virtual

Manage a serialized version of the information.

Implements vtkPVInformation.

◆ CopyFromStream()

virtual void vtkPVFileInformation::CopyFromStream ( const vtkClientServerStream )
virtual

Manage a serialized version of the information.

Reimplemented from vtkPVInformation.

◆ IsDirectory()

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.

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

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

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

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

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

◆ SetExtension()

virtual void vtkPVFileInformation::SetExtension ( const char *  )
protectedvirtual

◆ SetName()

virtual void vtkPVFileInformation::SetName ( const char *  )
protectedvirtual

◆ SetFullPath()

virtual void vtkPVFileInformation::SetFullPath ( const char *  )
protectedvirtual

◆ GetWindowsDirectoryListing()

void vtkPVFileInformation::GetWindowsDirectoryListing ( )
protected

◆ GetDirectoryListing()

void vtkPVFileInformation::GetDirectoryListing ( )
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 132 of file vtkPVFileInformation.h.

◆ SequenceParser

vtkFileSequenceParser* vtkPVFileInformation::SequenceParser
protected

Definition at line 133 of file vtkPVFileInformation.h.

◆ Name

char* vtkPVFileInformation::Name
protected

Definition at line 135 of file vtkPVFileInformation.h.

◆ FullPath

char* vtkPVFileInformation::FullPath
protected

Definition at line 136 of file vtkPVFileInformation.h.

◆ Type

int vtkPVFileInformation::Type
protected

Definition at line 137 of file vtkPVFileInformation.h.

◆ Hidden

bool vtkPVFileInformation::Hidden
protected

Definition at line 138 of file vtkPVFileInformation.h.

◆ Extension

char* vtkPVFileInformation::Extension
protected

Definition at line 139 of file vtkPVFileInformation.h.

◆ Size

long long vtkPVFileInformation::Size
protected

Definition at line 140 of file vtkPVFileInformation.h.

◆ ModificationTime

time_t vtkPVFileInformation::ModificationTime
protected

Definition at line 141 of file vtkPVFileInformation.h.

◆ FastFileTypeDetection

int vtkPVFileInformation::FastFileTypeDetection
protected

Definition at line 157 of file vtkPVFileInformation.h.


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