regina::NFileInfo Class Reference
[File I/O]

Stores information about a Regina data file, including file type and version. More...

#include <nfileinfo.h>

Inheritance diagram for regina::NFileInfo:

List of all members.

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.

---

Detailed Description

Stores information about a Regina data file, including file type and version.

Routine identify() can be used to determine this information for a given file.

---

Member Function Documentation

const std::string & regina::NFileInfo::getPathname

(

)

const [inline]

Returns the pathname of the data file being described.

Internationalisation:

The character encoding used in the pathname will be whatever was originally passed to identify(). This might or might not be UTF-8, since it needs to be understood by the low-level C/C++ file I/O routines.

Returns:

the pathname.

int regina::NFileInfo::getType

(

)

const [inline]

Returns the type of data file.

The type will be given as one of the file type constants defined in this class.

Returns:

the type of data file.

const std::string & regina::NFileInfo::getTypeDescription

(

)

const [inline]

Returns a human-readable description of the type of data file.

Returns:

a description of the type of data file.

const std::string & regina::NFileInfo::getEngine

(

)

const [inline]

Returns the version of the calculation engine that wrote this file.

Returns:

the engine version for this file.

bool regina::NFileInfo::isCompressed

(

)

const [inline]

Returns whether this file is stored in compressed format.

Currently this option only applies to XML data files.

Returns:

true if this file is compressed or false otherwise.

bool regina::NFileInfo::isInvalid

(

)

const [inline]

Returns whether the file metadata could not be read.

Returns:

true if the metadata could not be read, false otherwise.

static NFileInfo* regina::NFileInfo::identify

(

const std::string &

idPathname

)

[static]

Return information about the given Regina data file.

Internationalisation:

This routine makes no assumptions about the character encoding used in the given path name, and simply passes it through unchanged to low-level C/C++ file I/O routines. If an NFileInfo structure is returned, its getPathname() routine will use the same encoding that is passed here.

Parameters:

idPathname

the pathname of the data file to be examined.

Returns:

a newly created NFileInfo structure containing information about the given file, or 0 if the file type could not be identified.

void regina::NFileInfo::writeTextShort

(

std::ostream &

out

)

const [virtual]

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.

Python:

The parameter out does not exist; standard output will be used.

Parameters:

out

the output stream to which to write.

Implements regina::ShareableObject.

void regina::NFileInfo::writeTextLong

(

std::ostream &

out

)

const [virtual]

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.

Python:

The parameter out does not exist; standard output will be used.

Parameters:

out

the output stream to which to write.

Reimplemented from regina::ShareableObject.

---

Member Data Documentation

const int regina::NFileInfo::TYPE_BINARY [static]

Represents an old-style binary data file.

const int regina::NFileInfo::TYPE_XML [static]

Represents a new-style XML data file.

---

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

• nfileinfo.h