RosettaStone::TaskMeta Class Reference

TaskMeta class. More...

#include <Rosetta/Tasks/TaskMeta.hpp>

Inheritance diagram for RosettaStone::TaskMeta:
RosettaStone::TaskMetaTrait

Public Member Functions

 TaskMeta ()=default
 Default constructor. More...
 
 TaskMeta (const TaskMetaTrait &trait)
 
 TaskMeta (const TaskMetaTrait &trait, std::any object)
 
 ~TaskMeta ()=default
 Default destructor. More...
 
 TaskMeta (const TaskMeta &)
 Copy constructor. More...
 
 TaskMeta (TaskMeta &&meta) noexcept
 Move constructor. More...
 
TaskMetaoperator= (const TaskMeta &)
 Copy assignment operator. More...
 
TaskMetaoperator= (TaskMeta &&meta) noexcept
 Move assignment operator. More...
 
void Reset ()
 Resets object. More...
 
bool HasObjects () const
 
template<typename T >
T & GetObject ()
 
template<typename T >
const T & GetObject () const
 
template<typename T >
MoveObject ()
 
- Public Member Functions inherited from RosettaStone::TaskMetaTrait
 TaskMetaTrait ()=default
 Default constructor. More...
 
 TaskMetaTrait (TaskID id)
 
 TaskMetaTrait (TaskID id, TaskStatus status)
 
 TaskMetaTrait (TaskID id, TaskStatus status, std::size_t userID)
 
 ~TaskMetaTrait ()=default
 Default destructor. More...
 
 TaskMetaTrait (const TaskMetaTrait &trait)=default
 Default copy constructor. More...
 
 TaskMetaTrait (TaskMetaTrait &&trait)=default
 Default move constructor. More...
 
TaskMetaTraitoperator= (const TaskMetaTrait &trait)=default
 Default copy assignment operator. More...
 
TaskMetaTraitoperator= (TaskMetaTrait &&trait)=default
 Default move assignment operator. More...
 
bool operator== (const TaskMetaTrait &trait) const
 Operator overloading: The equality operator. More...
 
TaskID GetID () const
 
void SetID (TaskID id)
 
TaskStatus GetStatus () const
 
void SetStatus (TaskStatus status)
 
std::size_t GetUserID () const
 

Additional Inherited Members

- Static Public Attributes inherited from RosettaStone::TaskMetaTrait
static constexpr std::size_t USER_INVALID = Player::USER_INVALID
 
- Protected Attributes inherited from RosettaStone::TaskMetaTrait
TaskID m_id = TaskID::INVALID
 
TaskStatus m_status = TaskStatus::INVALID
 
std::size_t m_userID = USER_INVALID
 

Detailed Description

TaskMeta class.

This class manages task array as buffer. Also, it provides conversion methods to/from flatbuffers type.

Constructor & Destructor Documentation

◆ TaskMeta() [1/5]

RosettaStone::TaskMeta::TaskMeta ( )
default

Default constructor.

◆ TaskMeta() [2/5]

RosettaStone::TaskMeta::TaskMeta ( const TaskMetaTrait trait)

Constructs task meta with given trait.

Parameters
traitAn instance of base class that stores default meta data.

◆ TaskMeta() [3/5]

RosettaStone::TaskMeta::TaskMeta ( const TaskMetaTrait trait,
std::any  object 
)

Constructs task meta with given trait and object.

Parameters
traitAn instance of base class that stores default meta data.
objectAn object to save in this class.

◆ ~TaskMeta()

RosettaStone::TaskMeta::~TaskMeta ( )
default

Default destructor.

◆ TaskMeta() [4/5]

RosettaStone::TaskMeta::TaskMeta ( const TaskMeta )

Copy constructor.

◆ TaskMeta() [5/5]

RosettaStone::TaskMeta::TaskMeta ( TaskMeta &&  meta)
noexcept

Move constructor.

Member Function Documentation

◆ GetObject() [1/2]

template<typename T >
T& RosettaStone::TaskMeta::GetObject ( )
inline

Gets object from this class.

Returns
Object from this class.

◆ GetObject() [2/2]

template<typename T >
const T& RosettaStone::TaskMeta::GetObject ( ) const
inline

Gets object from this class.

Returns
Object from this class.

◆ HasObjects()

bool RosettaStone::TaskMeta::HasObjects ( ) const

Queries that object has value.

Returns
true if object has value, false otherwise.

◆ MoveObject()

template<typename T >
T RosettaStone::TaskMeta::MoveObject ( )
inline

Moves object from this class.

Returns
Moved object from this class.

◆ operator=() [1/2]

TaskMeta& RosettaStone::TaskMeta::operator= ( const TaskMeta )

Copy assignment operator.

◆ operator=() [2/2]

TaskMeta& RosettaStone::TaskMeta::operator= ( TaskMeta &&  meta)
noexcept

Move assignment operator.

◆ Reset()

void RosettaStone::TaskMeta::Reset ( )

Resets object.


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