#include <nfileinfo.h>
Inheritance diagram for regina::NFileInfo:
Public Member Functions | |
const std::string & | getPathname () const |
Returns the pathname of the data file being described. | |
int | getType () const |
Returns the type of data file. | |
const std::string & | getTypeDescription () const |
Returns a human-readable description of the type of data file. | |
const std::string & | getEngine () const |
Returns the version of the calculation engine that wrote this file. | |
bool | isCompressed () const |
Returns whether this file is stored in compressed format. | |
bool | isInvalid () const |
Returns whether the file metadata could not be read. | |
void | writeTextShort (std::ostream &out) const |
Writes this object in short text format to the given output stream. | |
void | writeTextLong (std::ostream &out) const |
Writes this object in long text format to the given output stream. | |
Static Public Member Functions | |
static NFileInfo * | identify (const std::string &idPathname) |
Return information about the given Regina data file. | |
Static Public Attributes | |
static const int | TYPE_BINARY |
Represents an old-style binary data file. | |
static const int | TYPE_XML |
Represents a new-style XML data file. |
Routine identify() can be used to determine this information for a given file.
|
Returns the version of the calculation engine that wrote this file.
|
|
Returns the pathname of the data file being described.
|
|
Returns the type of data file. The type will be given as one of the file type constants defined in this class.
|
|
Returns a human-readable description of the type of data file.
|
|
Return information about the given Regina data file.
|
|
Returns whether this file is stored in compressed format. Currently this option only applies to XML data files.
|
|
Returns whether the file metadata could not be read.
|
|
Writes this object in long text format to the given output stream. The output should provided the user with all the information they could want. The output should end with a newline. The default implementation of this routine merely calls writeTextShort() and adds a newline.
Reimplemented from regina::ShareableObject. |
|
Writes this object in short text format to the given output stream. The output should fit on a single line and no newline should be written.
Implements regina::ShareableObject. |
|
Represents an old-style binary data file.
|
|
Represents a new-style XML data file.
|