#include "steam/control/command-storage-holder.hpp"

Description

template<typename SIG, typename MEM>
class steam::control::StorageHolder< SIG, MEM >

This is "the" top level CmdClosure implementation.

It is a specifically typed CmdClosure, which serves for actually allocating storage to hold the command arguments and the UNDO state (memento) for Steam-Layer commands. Both the contained components within StorageHolder can be in empty state; there are no distinct lifecycle limitations. StorageHolder is part of Steam-Layer command's implementation and should not be used standalone.

Definition at line 71 of file command-storage-holder.hpp.

Public Types
using	SIG_op = CommandSignature< SIG, MEM >::OperateSig

using	SIG_cap = CommandSignature< SIG, MEM >::CaptureSig

using	SIG_undo = CommandSignature< SIG, MEM >::UndoOp_Sig

Public Member Functions
virtual bool	isValid () const override
	does this closure hold a valid argument tuple?

virtual bool	isCaptured () const override
	does this closure hold captured UNDO state?

virtual void	bindArguments (Arguments &args) override
	assign a new parameter tuple to this

virtual void	bindArguments (lib::diff::Rec const &paramData) override
	assign a new set of parameter values to this.

virtual void	unbindArguments () override
	discard any argument data and return to empty state

virtual void	invoke (CmdFunctor const &func) override
	invoke functor using the stored parameter values

virtual	operator string () const override

	StorageHolder ()
	per default, all data within StorageHolder is set up in empty state.

	StorageHolder (StorageHolder const &oAh)
	copy construction allowed(but no assignment).

StorageHolder &	operator= (StorageHolder const &)=delete
	copy construction allowed(but no assignment)

void	accept (CommandImplCloneBuilder &visitor) const override
	assist with creating a clone copy; this results in invocation of the copy ctor

bool	canUndo () const
	has undo state capturing been invoked?

bool	empty () const

void	storeTuple (ArgTuple const &argTup)
	store a new argument tuple within this StorageHolder, discarding any previously stored arguments

void	clearStorage ()

MementoTie< SIG, MEM > &	tie (function< SIG_undo > const &undoFunc, function< SIG_cap > const &captureFunc)
	create a new memento storage wiring, discarding existing memento state.

MementoTie< SIG, MEM > &	getMementoWiring ()
	just re-access an existing memento storage wiring.

MEM &	memento ()
	direct "backdoor" access to stored memento value.

Public Member Functions inherited from CmdClosure
virtual	~CmdClosure ()

	operator bool () const

Private Types
using	ArgHolder = OpClosure< SIG >

using	MemHolder = MementoTie< SIG, MEM >

using	ArgumentBuff = InPlaceBuffer< ArgHolder >

using	MementoBuff = InPlaceBuffer< MemHolder >

using	ArgTuple = ArgHolder::ArgTuple

using	Args = lib::meta::RebindTupleTypes< ArgTuple >::Seq

Private Attributes
ArgumentBuff	arguments_

MementoBuff	memento_

Description

Public Types

Public Member Functions

Private Types

Private Attributes

Constructor & Destructor Documentation

◆ StorageHolder() [1/2]

◆ StorageHolder() [2/2]

Member Typedef Documentation

◆ ArgHolder

◆ MemHolder

◆ ArgumentBuff

◆ MementoBuff

◆ ArgTuple

◆ Args

◆ SIG_op

◆ SIG_cap

◆ SIG_undo

Member Function Documentation

◆ isValid()

◆ isCaptured()

◆ bindArguments() [1/2]

◆ bindArguments() [2/2]

◆ unbindArguments()

◆ invoke()

◆ operator string()

◆ operator=()

◆ accept()

◆ canUndo()

◆ empty()

◆ storeTuple()

◆ clearStorage()

◆ tie()

◆ getMementoWiring()

◆ memento()

Member Data Documentation

◆ arguments_

◆ memento_