ALib C++ Library
Library Version: 2510 R0
Documentation generated by doxygen
Loading...
Searching...
No Matches
alib::exceptions::Message Struct Reference

Description:

This struct stores a list of information objects of arbitrary types, by publicly inheriting type BoxesMA. In addition, the CallerInfo is attached, which usually refers to the place (and thread) tat constructed an instance of this type.
Finally, a type identifier is available with field Type.

Note that while message data might be passed with construction, informational data may be added, changed or removed during the life-cycle of an instance using the inherited interface of class TBoxes.

Inside ALib, the struct is used with the type Exception.

Definition at line 23 of file message.inl.

Inheritance diagram for alib::exceptions::Message:
[legend]
Collaboration diagram for alib::exceptions::Message:
[legend]

Public Field Index:

CallerInfo CI
 The source code location that this message relates to.
 
Enum Type
 

Public Method Index:

template<typename... TBoxables>
 Message (const CallerInfo &ci, MonoAllocator &monoAllocator, const Enum &type, TBoxables &&... args)
 
- Public Method Index: inherited from alib::boxing::TBoxes< MonoAllocator >
 TBoxes ()
 Defaulted default constructor, usable only with heap allocation.
 
 TBoxes ()
 Defaulted default constructor, usable only with heap allocation.
 
 TBoxes (MonoAllocator &pAllocator)
 
 TBoxes (MonoAllocator &pAllocator)
 
 TBoxes (TBoxes &)=delete
 Deleted copy constructor.
 
 TBoxes (TBoxes &)=delete
 Deleted copy constructor.
 
TBoxesAdd ()
 
TBoxesAdd ()
 
TBoxesAdd (const Box &box)
 
TBoxesAdd (const Box &box)
 
TBoxesAdd (const Box(&boxArray)[TExtend])
 
TBoxesAdd (const Box(&boxArray)[TExtend])
 
TBoxesAdd (const TBoxes< TAllocatorArgs > &boxes)
 
TBoxesAdd (const TBoxes< TAllocatorArgs > &boxes)
 
TBoxesAdd (TBoxables &&... args)
 
TBoxesAdd (TBoxables &&... args)
 
void AddArray (const Box *boxArray, integer length)
 
void AddArray (const Box *boxArray, integer length)
 
void CallAll (TArgs &&... args)
 
void CallAll (TArgs &&... args)
 
void CallAll (TArgs &&... args) const
 
void CallAll (TArgs &&... args) const
 
void CloneAll ()
 
void CloneAll ()
 
TBoxesoperator+= (TBoxable &&src)
 
TBoxesoperator+= (TBoxable &&src)
 
TBoxesoperator<< (TBoxable &&src)
 
TBoxesoperator<< (TBoxable &&src)
 
TBoxesoperator= (TBoxes &)=delete
 
TBoxesoperator= (TBoxes &)=delete
 
void Reserve (integer newCapacity)
 
void Reserve (integer newCapacity)
 
integer Size () const
 
integer Size () const
 

Additional Inherited Members

- Public Type Index: inherited from alib::boxing::TBoxes< MonoAllocator >
using AllocatorType
 The allocator type that TAllocator specifies.
 
- Protected Type Index: inherited from alib::boxing::TBoxes< MonoAllocator >
using vectorBase
 The allocator type that TAllocator specifies.
 

Field Details:

◆ CI

CallerInfo alib::exceptions::Message::CI

The source code location that this message relates to.

Definition at line 25 of file message.inl.

◆ Type

Enum alib::exceptions::Message::Type

A type identifier, defined with construction by providing an element of an arbitrary enumeration type.

Definition at line 26 of file message.inl.

Constructor(s) / Destructor Details:

◆ Message()

template<typename... TBoxables>
alib::exceptions::Message::Message ( const CallerInfo & ci,
MonoAllocator & monoAllocator,
const Enum & type,
TBoxables &&... args )
inline

Constructor.

Parameters
ciInformation about the scope of invocation.
monoAllocatorThe allocator to store the arguments in.
typeThe message type.
argsVariadic, templated list of arguments.

Definition at line 34 of file message.inl.

Here is the call graph for this function:

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