template<class Prefix>
Rodin::Alert::Message class

Base class for objects which represents output messages.

Represents a message to output to the user with potential visible effects.

Constructors, destructors, conversion operators

Message(const Message& other)
Performs a copy of the Alert's message.
Message(Message&& other) defaulted
Performs a move of the Alert's message.
~Message() defaulted virtual
Virtual destructor.

Public functions

auto what() const -> const char* noexcept
Gets the description (or reason) for the alert.
template<class T>
auto operator<<(const T& v) -> std::enable_if_t<Internal::CanBeOutput<T>::Value, Message&> noexcept
Operator overload to aid in the construction of Alert messages.
auto operator<<(const RaiseT&) -> void
Operator overload to raise the Alert from a stream.
auto raise() const -> void virtual
Raises the Alert to the user.

Function documentation

template<class Prefix _1>
Rodin::Alert::Message<_1>::Message(const Message& other)

Performs a copy of the Alert's message.

Parameters
other in Object to copy.

template<class Prefix _1>
Rodin::Alert::Message<_1>::Message(Message&& other) defaulted

Performs a move of the Alert's message.

Parameters
other in Object to move.

template<class Prefix _1>
const char* Rodin::Alert::Message<_1>::what() const noexcept

Gets the description (or reason) for the alert.

Returns String containing the message.

template<class Prefix _1>
void Rodin::Alert::Message<_1>::operator<<(const RaiseT&)

Operator overload to raise the Alert from a stream.

This method will call raise().

template<class Prefix _1>
void Rodin::Alert::Message<_1>::raise() const virtual

Raises the Alert to the user.

The actual behaviour for raising the Alert is specified in its subclasses by overriding this function.