dasmig::nickname Class Reference

Return type for nickname generation, holding both the transformed and original strings. More...

#include <nicknamegen.hpp>

Public Member Functions
std::wstring	plain () const
	Return the original word or name used to generate this nickname.
std::uint64_t	seed () const
	Retrieve the random seed used to generate this nickname.
	operator std::wstring () const
	Implicit conversion to std::wstring.

Friends
class	nng
	Allows nng to construct nicknames.
std::wostream &	operator<< (std::wostream &wos, const nickname &nickname)
	Stream the nickname to a wide output stream.

Detailed Description

Return type for nickname generation, holding both the transformed and original strings.

Supports implicit conversion to std::wstring and streaming via operator<<.

Definition at line 35 of file nicknamegen.hpp.

Member Function Documentation

operator std::wstring()

dasmig::nickname::operator std::wstring ( ) const

inline

Implicit conversion to std::wstring.

Returns

The transformed nickname string.

Definition at line 55 of file nicknamegen.hpp.

plain()

std::wstring dasmig::nickname::plain ( ) const

inline

Return the original word or name used to generate this nickname.

Returns

Original source string before any transforms.

Definition at line 40 of file nicknamegen.hpp.

seed()

std::uint64_t dasmig::nickname::seed ( ) const

inline

Retrieve the random seed used to generate this nickname.

Returns

The per-call seed for replay.

See also

nng::get_nickname(const std::wstring&, std::uint64_t)

Definition at line 48 of file nicknamegen.hpp.

Friends And Related Symbol Documentation

nng

friend class nng

friend

Allows nng to construct nicknames.

Definition at line 89 of file nicknamegen.hpp.

operator<<

std::wostream & operator<< ( std::wostream &  wos, const nickname &  nickname  )

friend

Stream the nickname to a wide output stream.

Parameters

wos	Output stream.
nickname	Nickname to stream.

Returns

Reference to the output stream.

Definition at line 64 of file nicknamegen.hpp.

---

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

• dasmig/nicknamegen.hpp