Regina Calculation Engine
Public Member Functions | List of all members
regina::PacketShell Class Reference

Gives access to the final remains of a packet that is in the process of being destroyed. More...

#include <packet/packet.h>

Public Member Functions

 PacketShell (const Packet *packet)
 Creates a new shell referring to the given packet. More...
 
 PacketShell (const PacketShell &shell)=default
 Creates a copy of the given shell. More...
 
PacketShelloperator= (const PacketShell &shell)=default
 Sets this to be a copy of the given shell. More...
 
bool operator== (const PacketShell &shell) const
 Identifies if this and the given shell refer to the same underlying packet. More...
 
bool operator== (const Packet *packet) const
 Identifies if this shell refers to the given packet. More...
 
bool operator!= (const PacketShell &shell) const
 Identifies if this and the given shell refer to different underlying packets. More...
 
bool operator!= (const Packet *packet) const
 Identifies if this shell does not refer to the given packet. More...
 
const std::string & label () const
 Returns the label associated with this individual packet. More...
 
std::string humanLabel () const
 Returns the label associated with this individual packet, adjusted if necessary for human-readable output. More...
 
bool hasTag (const std::string &tag) const
 Determines whether this packet has the given associated tag. More...
 
bool hasTags () const
 Determines whether this packet has any associated tags at all. More...
 
const std::set< std::string > & tags () const
 
Returns the set of all tags associated with this packet. More...
 
std::string internalID () const
 Returns a unique string ID that identifies this packet. More...
 

Detailed Description

Gives access to the final remains of a packet that is in the process of being destroyed.

The main use of this class is to pass packet details to the callback function PacketListener::packetToBeDestroyed().

All functions in this class mirror the corresponding Packet functions, and are safe to call during PacketListener::packetToBeDestroyed().

This is a lightweight class, and objects may be safely passed by value.


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

Copyright © 1999-2021, The Regina development team
This software is released under the GNU General Public License, with some additional permissions; see the source code for details.
For further information, or to submit a bug or other problem, please contact Ben Burton (bab@maths.uq.edu.au).