Maps VehicleOrder domain payloads onto an orders::CommandQueue. 更多...

#include <VehicleOrderQueueAdapter.h>

类
struct	Impl

Public 成员函数
	VehicleOrderQueueAdapter ()
	Creates an empty adapter with an owned generic queue.

	~VehicleOrderQueueAdapter ()
	Releases the owned generic queue and domain payloads.

	VehicleOrderQueueAdapter (const VehicleOrderQueueAdapter &)
	Deep-copies generic lifecycle state and Vehicle payloads.

VehicleOrderQueueAdapter &	operator= (const VehicleOrderQueueAdapter &)
	Deep-copies generic lifecycle state and Vehicle payloads.

	VehicleOrderQueueAdapter (VehicleOrderQueueAdapter &&) noexcept
	Transfers adapter ownership without copying queue state.

VehicleOrderQueueAdapter &	operator= (VehicleOrderQueueAdapter &&) noexcept
	Transfers adapter ownership without copying queue state.

eve::Result< std::string >	append (const VehicleOrder &order, int priority=0, double timeoutSeconds=0.0)
	Appends a Vehicle domain order to the generic queue.

eve::Result< std::string >	replace (const VehicleOrder &order, int priority=0, double timeoutSeconds=0.0)
	Cancels unfinished orders and starts a replacement.

eve::Result< std::string >	interrupt (const VehicleOrder &order, int priority=0, double timeoutSeconds=0.0)
	Interrupts the active order when the generic priority permits.

eve::Result< void >	completeCurrent ()
	Completes the current generic order and activates the next one.

eve::Result< void >	failCurrent (const std::string &reason)
	Fails the current generic order and activates the next one.

eve::Result< void >	cancel (const std::string &id, const std::string &reason="cancelled")
	Cancels an active or queued generic order by stable id.

void	update (double dtSeconds)
	Advances generic timeout handling.

void	clear ()
	Clears generic queue history and Vehicle domain payloads.

const VehicleOrder *	current () const
	Returns the Vehicle payload for the active generic order, or null.

int	activeOrQueuedCount () const
	Returns the number of active and queued Vehicle orders.

void	syncCompatibility (VehicleEntity::Orders &legacy) const
	Refreshes the legacy component projection.

详细描述

Maps VehicleOrder domain payloads onto an orders::CommandQueue.

The adapter owns its queue and domain payload map. The observation returned by current() is borrowed until the next mutating adapter call. The legacy Orders::queue/current fields are refreshed by syncCompatibility() and are a read-only compatibility projection for existing Vehicle consumers.

在文件 VehicleOrderQueueAdapter.h 第 29 行定义.

构造及析构函数说明

◆ VehicleOrderQueueAdapter() [1/3]

eve::vehicle::VehicleOrderQueueAdapter::VehicleOrderQueueAdapter ( )

Creates an empty adapter with an owned generic queue.

在文件 VehicleOrderQueueAdapter.cpp 第 32 行定义.

◆ ~VehicleOrderQueueAdapter()

eve::vehicle::VehicleOrderQueueAdapter::~VehicleOrderQueueAdapter ( )

default

Releases the owned generic queue and domain payloads.

◆ VehicleOrderQueueAdapter() [2/3]

eve::vehicle::VehicleOrderQueueAdapter::VehicleOrderQueueAdapter ( const VehicleOrderQueueAdapter & other )

Deep-copies generic lifecycle state and Vehicle payloads.

在文件 VehicleOrderQueueAdapter.cpp 第 36 行定义.

◆ VehicleOrderQueueAdapter() [3/3]

eve::vehicle::VehicleOrderQueueAdapter::VehicleOrderQueueAdapter ( VehicleOrderQueueAdapter && )

defaultnoexcept

Transfers adapter ownership without copying queue state.

成员函数说明

◆ activeOrQueuedCount()

int eve::vehicle::VehicleOrderQueueAdapter::activeOrQueuedCount ( ) const

Returns the number of active and queued Vehicle orders.

在文件 VehicleOrderQueueAdapter.cpp 第 124 行定义.

引用了 eve::orders::Active, count, eve::orders::Queued , 以及 eve::orders::Order::state.

◆ append()

eve::Result< std::string > eve::vehicle::VehicleOrderQueueAdapter::append	(	const VehicleOrder &	order,
		int	priority = `0`,
		double	timeoutSeconds = `0.0`
	)

Appends a Vehicle domain order to the generic queue.

在文件 VehicleOrderQueueAdapter.cpp 第 48 行定义.

引用了 append(), eve::Applied, id, key, order, priority, eve::Status::success(), eve::Result< T >::success() , 以及 eve::vehicle::vehicleOrderTypeName().

被这些函数引用 append().

◆ cancel()

eve::Result< void > eve::vehicle::VehicleOrderQueueAdapter::cancel	(	const std::string &	id,
		const std::string &	reason = `"cancelled"`
	)

Cancels an active or queued generic order by stable id.

在文件 VehicleOrderQueueAdapter.cpp 第 99 行定义.

◆ clear()

void eve::vehicle::VehicleOrderQueueAdapter::clear ( )

Clears generic queue history and Vehicle domain payloads.

在文件 VehicleOrderQueueAdapter.cpp 第 111 行定义.

◆ completeCurrent()

eve::Result< void > eve::vehicle::VehicleOrderQueueAdapter::completeCurrent ( )

Completes the current generic order and activates the next one.

在文件 VehicleOrderQueueAdapter.cpp 第 77 行定义.

引用了 eve::Conflict, current(), eve::Diagnostic::error() , 以及 eve::Result< T >::failure().

◆ current()

const VehicleOrder * eve::vehicle::VehicleOrderQueueAdapter::current ( ) const

Returns the Vehicle payload for the active generic order, or null.

返回: Borrowed nullable payload owned by this adapter. @ownership VehicleOrderQueueAdapter owns the payload; callers must not delete it. @lifetime Valid until the next mutating adapter call, clear(), or destruction. @thread Call on the adapter's owning simulation thread. @reentrancy Do not retain or re-enter adapter mutation while observing the result.

在文件 VehicleOrderQueueAdapter.cpp 第 116 行定义.

引用了 eve::scheduling::ItemMetadata::id.

被这些函数引用 completeCurrent() , 以及 failCurrent().

◆ failCurrent()

eve::Result< void > eve::vehicle::VehicleOrderQueueAdapter::failCurrent ( const std::string & reason )

Fails the current generic order and activates the next one.

在文件 VehicleOrderQueueAdapter.cpp 第 88 行定义.

引用了 eve::Conflict, current(), eve::Diagnostic::error() , 以及 eve::Result< T >::failure().

◆ interrupt()

eve::Result< std::string > eve::vehicle::VehicleOrderQueueAdapter::interrupt	(	const VehicleOrder &	order,
		int	priority = `0`,
		double	timeoutSeconds = `0.0`
	)

Interrupts the active order when the generic priority permits.

在文件 VehicleOrderQueueAdapter.cpp 第 67 行定义.

引用了 eve::Applied, id, key, order, priority, eve::Status::success(), eve::Result< T >::success() , 以及 eve::vehicle::vehicleOrderTypeName().

◆ operator=() [1/2]

VehicleOrderQueueAdapter & eve::vehicle::VehicleOrderQueueAdapter::operator= ( const VehicleOrderQueueAdapter & other )

Deep-copies generic lifecycle state and Vehicle payloads.

在文件 VehicleOrderQueueAdapter.cpp 第 39 行定义.

◆ operator=() [2/2]

VehicleOrderQueueAdapter & eve::vehicle::VehicleOrderQueueAdapter::operator= ( VehicleOrderQueueAdapter && )

defaultnoexcept

Transfers adapter ownership without copying queue state.

◆ replace()

eve::Result< std::string > eve::vehicle::VehicleOrderQueueAdapter::replace	(	const VehicleOrder &	order,
		int	priority = `0`,
		double	timeoutSeconds = `0.0`
	)

Cancels unfinished orders and starts a replacement.

在文件 VehicleOrderQueueAdapter.cpp 第 57 行定义.

引用了 eve::Applied, id, key, order, priority, eve::Status::success(), eve::Result< T >::success() , 以及 eve::vehicle::vehicleOrderTypeName().

◆ syncCompatibility()

void eve::vehicle::VehicleOrderQueueAdapter::syncCompatibility ( VehicleEntity::Orders & legacy ) const

Refreshes the legacy component projection.

参数

legacy VehicleEntity::Orders component to update.

备注: The adapter remains the only lifecycle authority.

在文件 VehicleOrderQueueAdapter.cpp 第 137 行定义.

引用了 eve::orders::Active, eve::vehicle::VehicleEntity::Orders::current, eve::scheduling::ItemMetadata::id, eve::vehicle::VehicleEntity::Orders::queue, eve::orders::Queued , 以及 eve::orders::Order::state.

◆ update()

void eve::vehicle::VehicleOrderQueueAdapter::update ( double dtSeconds )

Advances generic timeout handling.

在文件 VehicleOrderQueueAdapter.cpp 第 105 行定义.

引用了 updated.

该类的文档由以下文件生成:

src/modules/vehicle/VehicleOrderQueueAdapter.h
src/modules/vehicle/VehicleOrderQueueAdapter.cpp

类

Public 成员函数