regina::PacketInfo Class Reference

A class used to query general information about different packet types. More...

#include <packet/packettype.h>

Static Public Member Functions
static constexpr const char *	name (PacketType packetType)
	Returns a human-readable name for the given packet type. More...

Detailed Description

A class used to query general information about different packet types.

This class has become much simpler since Regina 7.0. It is no longer templated, and instead just offers a name() function that is accessible at both compile time and runtime.

Member Function Documentation

name()

static constexpr const char * regina::PacketInfo::name ( PacketType  packetType )

inlinestaticconstexpr

Returns a human-readable name for the given packet type.

The first letter of the returned string will be upper-case, and all subsequent letters will be lower-case (except for special words such as "PDF" and "SnapPea", which will retain their internal upper-case letters where required).

This routine is guaranteed to return a non-null string, even if packetType is not one of the PacketType enum values.

Parameters

packetType

the packet type being queried.

Returns

the name of the given packet type.

---

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

• packet/packettype.h