regina::PDF Class Reference

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

#include <packet/pdf.h>

Inheritance diagram for regina::PDF:

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...
typedef Packet	SafePointeeType
	The type of object being pointed to. More...

Public Member Functions
	PDF ()
	Creates a PDF packet with no document stored. More...
	PDF (const char *filename)
	Creates a PDF packet with data read from the given PDF file. More...
	PDF (char *data, size_t size, OwnershipPolicy alloc)
	Creates a packet to store the given PDF data. More...
	~PDF ()
	Destroys this PDF packet and deallocates data if required. More...
bool	isNull () const
	Determines whether this packet is currently holding a PDF document. More...
const char *	data () const
	Returns a pointer to the block of raw data that forms this PDF document. More...
size_t	size () const
	Returns the size of this PDF document in bytes. More...
void	reset ()
	Empties this PDF packet so that no document is stored. More...
void	reset (char *data, size_t size, OwnershipPolicy alloc)
	Refills this PDF packet with the given PDF data. More...
bool	savePDF (const char *filename) const
	Saves this PDF document to the given file in PDF format. More...
virtual void	writeTextShort (std::ostream &out) const override
	Writes a short text representation of this object to the given output stream. More...
virtual bool	dependsOnParent () const override
	Determines if this packet depends upon its parent. More...
std::string	str () const
	Returns a short text representation of this object. More...
std::string	utf8 () const
	Returns a short text representation of this object using unicode characters. More...
std::string	detail () const
	Returns a detailed text representation of this object. More...
bool	hasSafePtr () const
	Is there one or more SafePtr currently pointing to this object? More...

Static Public Member Functions
static XMLPacketReader *	xmlReader (Packet *parent, XMLTreeResolver &resolver)

Protected Member Functions
virtual Packet *	internalClonePacket (Packet *parent) const override
	Makes a newly allocated copy of this packet. More...
virtual void	writeXMLPacketData (std::ostream &out) const override
	Writes a chunk of XML containing the data for this packet only. More...

File I/O
bool	save (const char *filename, bool compressed=true) const
	Saves the subtree rooted at this packet to the given Regina data file, using Regina's native XML file format. More...
bool	save (std::ostream &s, bool compressed=true) const
	Writes the subtree rooted at this packet to the given output stream, in the format of a Regina XML data file. More...
void	writeXMLFile (std::ostream &out) const
	Writes the subtree rooted at this packet to the given output stream in Regina's native XML file format. More...
std::string	internalID () const
	Returns a unique string ID that identifies this packet. More...
virtual void	writeTextLong (std::ostream &out) const
	Writes a detailed text representation of this object to the given output stream. More...
bool	hasOwner () const
	Indicates whether some other object in the calculation engine is responsible for ultimately destroying this object. More...
void	writeXMLPacketTree (std::ostream &out) const
	Writes a chunk of XML containing the subtree with this packet as matriarch. More...

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 can be tested by calling isNull(), and can be changed by calling reset().

Member Typedef Documentation

SafePointeeType

typedef Packet regina::SafePointeeBase< Packet >::SafePointeeType

inherited

The type of object being pointed to.

Member Function Documentation

detail()

std::string regina::Output< Packet , false >::detail ( ) const

inherited

Returns a detailed text representation of this object.

This text may span many lines, and should provide the user with all the information they could want. It should be human-readable, should not contain extremely long lines (which cause problems for users reading the output in a terminal), and should end with a final newline. There are no restrictions on the underlying character set.

Returns

a detailed text representation of this object.

hasSafePtr()

bool regina::SafePointeeBase< Packet >::hasSafePtr

inlineinherited

Is there one or more SafePtr currently pointing to this object?

str()

std::string regina::Output< Packet , false >::str ( ) const

inherited

Returns a short text representation of this object.

This text should be human-readable, should fit on a single line, and should not end with a newline. Where possible, it should use plain ASCII characters.

Python:\n In addition to str(), this is also used as the

Python "stringification" function __str__().

Returns

a short text representation of this object.

utf8()

std::string regina::Output< Packet , false >::utf8 ( ) const

inherited

Returns a short text representation of this object using unicode characters.

Like str(), this text should be human-readable, should fit on a single line, and should not end with a newline. In addition, it may use unicode characters to make the output more pleasant to read. This string will be encoded in UTF-8.

Returns

a short text representation of this object.

---

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

• packet/pdf.h