vtkFileType Class Reference

#include <vtkFileType.h>

List of all members.

---

Detailed Description

file format type data

vtkFileType contains enumeration of availible vtkIO file formats as well as methods to convert between the enumerations and file suffix strings.

Author:

Sean McInerney

Version:

Revision

1.3

Date:

Date

2004/08/10 07:37:22

Definition at line 37 of file vtkFileType.h.

Static Public Member Functions
int	SuffixToFileType (const char *key, const int parse=0)
	Returns a file type enumeration corresponding to a filename suffix.
const char *	FileTypeToSuffix (const int ftype)
	Returns a filename suffix corresponding to a file type enumeration.
int	FileTypeToDataType (const int ftype)
	Returns the VTK data object type for the enumerated file type provided.
const char *	FileTypeToDescription (const int ftype)
	Returns a description for the enumerated file type provided.
vtkFileTypeMap *	GetMap (void)
	Returns the underlying file type map.
Static Protected Member Functions
void	ClassInitialize (void)
void	ClassFinalize (void)

---

Member Function Documentation

void vtkFileType::ClassFinalize (  void   )  [static, protected]

void vtkFileType::ClassInitialize (  void   )  [static, protected]

int vtkFileType::FileTypeToDataType (  const int  ftype  )  [static]

Returns the VTK data object type for the enumerated file type provided. Parameters: ftype  A file type enumeration Returns: The default VTK data type enumeration found mapped to ftype on success or -1 on failure. This is one of VTK_STRUCTURED_GRID, VTK_STRUCTURED_POINTS, VTK_UNSTRUCTURED_GRID, VTK_POLY_DATA, or VTK_RECTILINEAR_GRID (see vtkSystemIncludes.h for definitions).

const char* vtkFileType::FileTypeToDescription (  const int  ftype  )  [static]

Returns a description for the enumerated file type provided. Parameters: ftype  A file type enumeration Returns: A file type description found mapped to ftype on success or the string "unknown (*)" on failure. Note: The string returned should contain a description (as advertised) devoid of parentheses followed by a filename matching pattern within a set of parentheses.

const char* vtkFileType::FileTypeToSuffix (  const int  ftype  )  [static]

Returns a filename suffix corresponding to a file type enumeration. Parameters: ftype  A file type enumeration Returns: The first filename suffix string found mapped to ftype on success or the empty string ( '\0' ) on failure. Note: Though more than one filename suffix string may be mapped to a given enumeration, only the first suffix found is returned.

vtkFileTypeMap* vtkFileType::GetMap (  void   )  [static]

Returns the underlying file type map.

int vtkFileType::SuffixToFileType (  const char *  key, const int  parse = 0 )  [static]

Returns a file type enumeration corresponding to a filename suffix. Parameters: key  A string containing the filename suffix or the suffix itself parse  Toggle parsing of key to find the suffix as a substring Returns: An enumeration mapped from key on success or VTK_FILE_TYPE_NONE on failure.

---

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

• vtkFileType.h

---