Regina Calculation Engine
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions
regina::NPDF Class Reference

A packet that can hold a PDF document. More...

#include <packet/npdf.h>

Inheritance diagram for regina::NPDF:
regina::NPacket regina::ShareableObject regina::boost::noncopyable

List of all members.

Public Types

enum  OwnershipPolicy { OWN_MALLOC, OWN_NEW, DEEP_COPY }
 Describes how a PDF packet should claim ownership of a block of binary data. More...

Public Member Functions

 NPDF ()
 Creates a PDF packet with no document stored.
 NPDF (char *data, size_t size, OwnershipPolicy alloc)
 Creates a packet to store the given PDF data.
 ~NPDF ()
 Destroys this PDF packet and deallocates data if required.
const char * data () const
 Returns a pointer to the block of raw data that forms this PDF document.
size_t size () const
 Returns the size of this PDF document in bytes.
void reset ()
 Empties this PDF packet so that no document is stored.
void reset (char *data, size_t size, OwnershipPolicy alloc)
 Refills this PDF packet with the given PDF data.
virtual int getPacketType () const
 Returns the integer ID representing this type of packet.
virtual std::string getPacketTypeName () const
 Returns an English name for this type of packet.
virtual void writeTextShort (std::ostream &out) const
 Writes this object in short text format to the given output stream.
virtual void writePacket (NFile &out) const
 Writes the packet details to the given old-style binary file.
virtual bool dependsOnParent () const
 Determines if this packet depends upon its parent.

Static Public Member Functions

static NXMLPacketReadergetXMLReader (NPacket *parent)
 (end: File I/O)
static NPDFreadPacket (NFile &in, NPacket *parent)
 Reads a single packet from the specified file and returns a newly created object containing that information.

Static Public Attributes

static const int packetType
 Contains the integer ID for this packet.

Protected Member Functions

virtual NPacketinternalClonePacket (NPacket *parent) const
 Makes a newly allocated copy of this packet.
virtual void writeXMLPacketData (std::ostream &out) const
 Writes a chunk of XML containing the data for this packet only.

Detailed Description

A packet that can hold a PDF document.

This packet may or may not contain a PDF document at any given time. This state can be changed by calling reset().


Member Enumeration Documentation

Describes how a PDF packet should claim ownership of a block of binary data.

Python:
Not present.
Enumerator:
OWN_MALLOC 

The packet should claim ownership of the block, and should assume that it was allocated using malloc().

OWN_NEW 

The packet should claim ownership of the block, and should assume that it was allocated using new[].

DEEP_COPY 

The packet should not claim ownership of the block, but should instead make its own deep copy.


Constructor & Destructor Documentation

regina::NPDF::NPDF ( ) [inline]

Creates a PDF packet with no document stored.

regina::NPDF::NPDF ( char *  data,
size_t  size,
OwnershipPolicy  alloc 
) [inline]

Creates a packet to store the given PDF data.

The data array must contain a full PDF document as a block of binary data.

The alloc argument shows if/how this packet claims ownership of the data. In particular, unless alloc is DEEP_COPY, this packet will claim ownership of the given data block and will deallocate it when the packet is destroyed. If alloc is DEEP_COPY then the given block of data will not be modified in any way.

It is possible to pass a null pointer as the data array, in which case the new packet will have no PDF document stored.

Python:
Not present.
Parameters:
datathe block of binary data that forms the PDF document, or null if no document is to be stored.
sizethe number of bytes in this block of binary data; if actual data is passed (i.e., data is not null) then this must be strictly positive.
allocdescribes if/how this packet should claim ownership of the given block of data; see the notes above for details.
regina::NPDF::~NPDF ( ) [inline]

Destroys this PDF packet and deallocates data if required.


Member Function Documentation

const char * regina::NPDF::data ( ) const [inline]

Returns a pointer to the block of raw data that forms this PDF document.

The number of bytes in this block can be found by calling size().

If no PDF document is currently stored, this routine will return a null pointer.

Python:
Not present.
Returns:
the raw PDF data.
bool regina::NPDF::dependsOnParent ( ) const [inline, virtual]

Determines if this packet depends upon its parent.

This is true if the parent cannot be altered without invalidating or otherwise upsetting this packet.

Returns:
true if and only if this packet depends on its parent.

Implements regina::NPacket.

virtual int regina::NPDF::getPacketType ( ) const [virtual]

Returns the integer ID representing this type of packet.

This is the same for all packets of this class.

Returns:
the packet type ID.

Implements regina::NPacket.

virtual std::string regina::NPDF::getPacketTypeName ( ) const [virtual]

Returns an English name for this type of packet.

An example is NTriangulation. This is the same for all packets of this class.

Returns:
the packet type name.

Implements regina::NPacket.

static NXMLPacketReader* regina::NPDF::getXMLReader ( NPacket parent) [static]

(end: File I/O)

Returns a newly created XML element reader that will read the contents of a single XML packet element. You may assume that the packet to be read is of the same type as the class in which you are implementing this routine.

The XML element reader should read exactly what writeXMLPacketData() writes, and vice versa.

parent represents the packet which will become the new packet's parent in the tree structure, and may be assumed to have already been read from the file. This information is for reference only, and does not need to be used. The XML element reader can either insert or not insert the new packet beneath parent in the tree structure as it pleases. Note however that parent will be 0 if the new packet is to become a tree matriarch.

This routine is not actually provided for NPacket itself, but must be declared and implemented for every packet subclass that will be instantiated.

Python:
Not present.
Parameters:
parentthe packet which will become the new packet's parent in the tree structure, or 0 if the new packet is to be tree matriarch.
Returns:
the newly created XML element reader.

Reimplemented from regina::NPacket.

NPacket * regina::NPDF::internalClonePacket ( NPacket parent) const [inline, protected, virtual]

Makes a newly allocated copy of this packet.

This routine should not insert the new packet into the tree structure, clone the packet's associated tags or give the packet a label. It should also not clone any descendants of this packet.

You may assume that the new packet will eventually be inserted into the tree beneath either the same parent as this packet or a clone of that parent.

Parameters:
parentthe parent beneath which the new packet will eventually be inserted.
Returns:
the newly allocated packet.

Implements regina::NPacket.

static NPDF* regina::NPDF::readPacket ( NFile in,
NPacket parent 
) [static]

Reads a single packet from the specified file and returns a newly created object containing that information.

You may assume that the packet to be read is of the same type as the class in which you are implementing this routine. The newly created object must also be of this type.

For instance, NTriangulation::readPacket() may assume that the packet is of type NTriangulation, and must return a pointer to a newly created NTriangulation. Deallocation of the newly created packet is the responsibility of whoever calls this routine.

The packet type and label may be assumed to have already been read from the file, and should not be reread. The readPacket() routine should read exactly what writePacket() writes, and vice versa.

parent represents the packet which will become the new packet's parent in the tree structure, and may be assumed to have already been read from the file. This information is for reference only, and does not need to be used. This routine can either insert or not insert the new packet beneath parent in the tree structure as it pleases. Note however that parent will be 0 if the new packet is to become a tree matriarch.

This routine is not actually provided for NPacket itself, but must be declared and implemented for every packet subclass that will be instantiated. Within each such subclass the function must be declared to return a pointer to an object of that subclass. For instance, NTriangulation::readPacket() must be declared to return an NTriangulation*, not simply an NPacket*.

New packet types should make this routine simply return 0 since this file format is now obsolete, and older calculation engines will not understand newer packet types anyway.

Deprecated:
For the preferred way to read packets from file, see getXMLReader() and class NXMLPacketReader instead.
Precondition:
The given file is open for reading and all above conditions have been satisfied.
Python:
Not present.
Parameters:
inthe file from which to read the packet.
parentthe packet which will become the new packet's parent in the tree structure, or 0 if the new packet is to be tree matriarch.
Returns:
the packet read from file, or 0 if an error occurred.

Reimplemented from regina::NPacket.

Empties this PDF packet so that no document is stored.

The old data will be deallocated if required.

void regina::NPDF::reset ( char *  data,
size_t  size,
OwnershipPolicy  alloc 
)

Refills this PDF packet with the given PDF data.

The old data will be deallocated if required.

This routine behaves like the class constructor; see the constructor documentation for details.

Python:
Not present.
Parameters:
datathe block of binary data that forms the new PDF document, or null if no document is to be stored.
sizethe number of bytes in this new block of binary data; if actual data is passed (i.e., data is not null) then this must be strictly positive.
allocdescribes if/how this packet should claim ownership of the given block of data; see the notes above for details.
size_t regina::NPDF::size ( ) const [inline]

Returns the size of this PDF document in bytes.

If no PDF document is currently stored, this routine will return zero.

Returns:
the number of bytes.
virtual void regina::NPDF::writePacket ( NFile out) const [virtual]

Writes the packet details to the given old-style binary file.

You may assume that the packet type and label have already been written. Only the actual data stored in the packet need be written.

The default implementation for this routine does nothing; new packet types should not implement this routine since this file format is now obsolete, and older calculation engines will simply skip unknown packet types when reading from binary files.

Deprecated:
For the preferred way to write packets to file, see writeXMLFile() and writeXMLPacketData() instead.
Precondition:
The given file is open for writing and satisfies the assumptions listed above.
Python:
Not present.
Parameters:
outthe file to be written to.

Reimplemented from regina::NPacket.

void regina::NPDF::writeTextShort ( std::ostream &  out) const [inline, 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:
outthe output stream to which to write.

Implements regina::ShareableObject.

virtual void regina::NPDF::writeXMLPacketData ( std::ostream &  out) const [protected, virtual]

Writes a chunk of XML containing the data for this packet only.

You may assume that the packet opening tag (including the packet type and label) has already been written, and that all child packets followed by the corresponding packet closing tag will be written immediately after this routine is called. This routine need only write the internal data stored in this specific packet.

Parameters:
outthe output stream to which the XML should be written.

Implements regina::NPacket.


Member Data Documentation

const int regina::NPDF::packetType [static]

Contains the integer ID for this packet.

Each distinct packet type must have a unique ID, and this should be a positive integer. See packetregistry.h for further requirements regarding ID selection.

This member is not actually provided for NPacket itself, but must be declared for every packet subclass that will be instantiated. A value need not be assigned; packetregistry.h will take care of this task when you register the packet.

Reimplemented from regina::NPacket.


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

Copyright © 1999-2011, The Regina development team
This software is released under the GNU General Public License.
For further information, or to submit a bug or other problem, please contact Ben Burton (bab@debian.org).