TaskMetaTrait class. More...

#include <Rosetta/Tasks/TaskMeta.hpp>

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

Public Member Functions

 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
 

Static Public Attributes

static constexpr std::size_t USER_INVALID = Player::USER_INVALID
 

Protected Attributes

TaskID m_id = TaskID::INVALID
 
TaskStatus m_status = TaskStatus::INVALID
 
std::size_t m_userID = USER_INVALID
 

Detailed Description

TaskMetaTrait class.

This class is abstract class of TaskMeta class. It stores default meta data such as id, status and userID.

Constructor & Destructor Documentation

◆ TaskMetaTrait() [1/6]

RosettaStone::TaskMetaTrait::TaskMetaTrait ( )
default

Default constructor.

◆ TaskMetaTrait() [2/6]

RosettaStone::TaskMetaTrait::TaskMetaTrait ( TaskID  id)

Constructs task meta trait with given id.

Parameters
idThe task ID.

◆ TaskMetaTrait() [3/6]

RosettaStone::TaskMetaTrait::TaskMetaTrait ( TaskID  id,
TaskStatus  status 
)

Constructs task meta trait with given id and status.

Parameters
idThe task ID.
statusThe task status.

◆ TaskMetaTrait() [4/6]

RosettaStone::TaskMetaTrait::TaskMetaTrait ( TaskID  id,
TaskStatus  status,
std::size_t  userID 
)

Constructs task meta trait with given id, status and userID.

Parameters
idThe task ID.
statusThe task status.
userIDThe user ID.

◆ ~TaskMetaTrait()

RosettaStone::TaskMetaTrait::~TaskMetaTrait ( )
default

Default destructor.

◆ TaskMetaTrait() [5/6]

RosettaStone::TaskMetaTrait::TaskMetaTrait ( const TaskMetaTrait trait)
default

Default copy constructor.

◆ TaskMetaTrait() [6/6]

RosettaStone::TaskMetaTrait::TaskMetaTrait ( TaskMetaTrait &&  trait)
default

Default move constructor.

Member Function Documentation

◆ GetID()

TaskID RosettaStone::TaskMetaTrait::GetID ( ) const

Returns task ID.

Returns
Task ID.

◆ GetStatus()

TaskStatus RosettaStone::TaskMetaTrait::GetStatus ( ) const

Returns status of task meta.

Returns
Status of task meta.

◆ GetUserID()

std::size_t RosettaStone::TaskMetaTrait::GetUserID ( ) const

Returns user ID.

Returns
User ID.

◆ operator=() [1/2]

TaskMetaTrait& RosettaStone::TaskMetaTrait::operator= ( const TaskMetaTrait trait)
default

Default copy assignment operator.

◆ operator=() [2/2]

TaskMetaTrait& RosettaStone::TaskMetaTrait::operator= ( TaskMetaTrait &&  trait)
default

Default move assignment operator.

◆ operator==()

bool RosettaStone::TaskMetaTrait::operator== ( const TaskMetaTrait trait) const

Operator overloading: The equality operator.

◆ SetID()

void RosettaStone::TaskMetaTrait::SetID ( TaskID  id)

Sets task ID.

Parameters
idTask ID.

◆ SetStatus()

void RosettaStone::TaskMetaTrait::SetStatus ( TaskStatus  status)

Sets status of task meta.

Parameters
statusStatus of task meta.

Member Data Documentation

◆ m_id

TaskID RosettaStone::TaskMetaTrait::m_id = TaskID::INVALID
protected

◆ m_status

TaskStatus RosettaStone::TaskMetaTrait::m_status = TaskStatus::INVALID
protected

◆ m_userID

std::size_t RosettaStone::TaskMetaTrait::m_userID = USER_INVALID
protected

◆ USER_INVALID

constexpr std::size_t RosettaStone::TaskMetaTrait::USER_INVALID = Player::USER_INVALID
static

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