DWFCore::DWFFile Class Reference

#include "dwfcore/File.h"

Inheritance diagram for DWFCore::DWFFile:

Inheritance graph
[legend]
Collaboration diagram for DWFCore::DWFFile:

Collaboration graph
[legend]
List of all members.

Detailed Description

Generalized file specifier.

Since:
1.0.1
This class encapsulates only the most fundamental aspect of a file, it's name. It makes no assumptions as to how to interpret this value. File types requiring more information should extend this class accordingly (e.g. PIDLs, permissions, etc).
Examples:

Digest/main.cpp, Files/Files.cpp, and Strings/Strings.cpp.

Definition at line 72 of file File.h.

Public Member Functions

_DWFCORE_API DWFFile (const ASCII_char_t *zName=NULL) throw ()
_DWFCORE_API DWFFile (const DWFString &rName) throw ()
_DWFCORE_API DWFFile (const DWFFile &rFile) throw ()
_DWFCORE_API DWFFileoperator= (const DWFFile &rFile) throw ()
virtual _DWFCORE_API ~DWFFile () throw ()
virtual _DWFCORE_API const
DWFString
name () const throw ( DWFException )

Protected Attributes

DWFString _zName


Constructor & Destructor Documentation

_DWFCORE_API DWFCore::DWFFile::DWFFile const ASCII_char_t zName = NULL  )  throw ()
 

Constructor This constructor takes a string that may only be either a US-ASCII or UTF-8 encoded file name.

Parameters:
zName The file name.
Exceptions:
None 

_DWFCORE_API DWFCore::DWFFile::DWFFile const DWFString rName  )  throw ()
 

Constructor This constructor takes a file name encapsulated in a DWFString.

Parameters:
rName The file name.
Exceptions:
None 

_DWFCORE_API DWFCore::DWFFile::DWFFile const DWFFile rFile  )  throw ()
 

Copy Constructor

Parameters:
rFile The file to copy.
Exceptions:
None 

virtual _DWFCORE_API DWFCore::DWFFile::~DWFFile  )  throw () [virtual]
 

Destructor

Exceptions:
None 


Member Function Documentation

virtual _DWFCORE_API const DWFString& DWFCore::DWFFile::name  )  const throw ( DWFException ) [virtual]
 

Returns the current file name.

Returns:
The file name.
Exceptions:
DWFException 
Examples:
Files/Files.cpp.

_DWFCORE_API DWFFile& DWFCore::DWFFile::operator= const DWFFile rFile  )  throw ()
 

Assignment Operator

Parameters:
rFile The file to copy.
Exceptions:
None 


Member Data Documentation

DWFString DWFCore::DWFFile::_zName [protected]
 

The file name.

Definition at line 145 of file File.h.


The documentation for this class was generated from the following file:
Generated on Tue Jan 6 22:39:36 2009 for Autodesk DWF Core Library by  doxygen 1.4.5