载入中...
搜索中...
未找到
Public 类型 | Public 成员函数 | 静态 Public 成员函数 | 友元 | 所有成员列表
eve::game_event::CausationRef类 参考

Tagged direct causation reference to an event or command. 更多...

#include <GameEvent.h>

Public 类型

enum class  Kind : uint8_t { None , Event , Command , Legacy }
 Kind public API. 更多...
 

Public 成员函数

 CausationRef ()=default
 Constructs an absent causation reference.
 
Kind kind () const noexcept
 Returns the tagged causation kind.
 
bool isCanonical () const noexcept
 Returns whether this reference uses the canonical ID form.
 
std::string format () const
 Returns the stable UUID or compatibility text projection.
 

静态 Public 成员函数

static CausationRef fromEventId (EventId value)
 Creates a causation reference to an event.
 
static CausationRef fromCommandId (CommandId value)
 Creates a causation reference to a command.
 
static CausationRef fromLegacy (std::string value)
 Creates a compatibility-only arbitrary string causation.
 

友元

bool operator== (const CausationRef &, const CausationRef &) noexcept=default
 

详细描述

Tagged direct causation reference to an event or command.

A legacy string can be carried by compatibility callers. New producers should use fromEventId or fromCommandId; append preserves legacy data.

在文件 GameEvent.h 第 96 行定义.

成员枚举类型说明

◆ Kind

enum class eve::game_event::CausationRef::Kind : uint8_t
strong

Kind public API.

枚举值
None 
Event 
Command 
Legacy 

在文件 GameEvent.h 第 99 行定义.

构造及析构函数说明

◆ CausationRef()

eve::game_event::CausationRef::CausationRef ( )
default

Constructs an absent causation reference.

成员函数说明

◆ format()

std::string eve::game_event::CausationRef::format ( ) const
inline

Returns the stable UUID or compatibility text projection.

在文件 GameEvent.h 第 139 行定义.

引用了 Command, Event , 以及 Legacy.

◆ fromCommandId()

static CausationRef eve::game_event::CausationRef::fromCommandId ( CommandId  value)
inlinestatic

Creates a causation reference to a command.

在文件 GameEvent.h 第 115 行定义.

引用了 Command , 以及 value.

◆ fromEventId()

static CausationRef eve::game_event::CausationRef::fromEventId ( EventId  value)
inlinestatic

Creates a causation reference to an event.

在文件 GameEvent.h 第 105 行定义.

引用了 Event , 以及 value.

被这些函数引用 eve::settlement::SettlementPipeline::settleChain().

◆ fromLegacy()

static CausationRef eve::game_event::CausationRef::fromLegacy ( std::string  value)
inlinestatic

Creates a compatibility-only arbitrary string causation.

在文件 GameEvent.h 第 125 行定义.

引用了 Legacy, None , 以及 value.

◆ isCanonical()

bool eve::game_event::CausationRef::isCanonical ( ) const
inlinenoexcept

Returns whether this reference uses the canonical ID form.

在文件 GameEvent.h 第 136 行定义.

引用了 Legacy.

◆ kind()

Kind eve::game_event::CausationRef::kind ( ) const
inlinenoexcept

Returns the tagged causation kind.

在文件 GameEvent.h 第 133 行定义.

被这些函数引用 eve::game_event::GameEventLog::restore().

友元及相关函数文档

◆ operator==

bool operator== ( const CausationRef &  ,
const CausationRef &   
)
friend
该类的文档由以下文件生成: