cadabra::ActionSetRunStatus Class Reference

Description

Update the running status of the indicated cell.

#include <Actions.hh>

Inheritance diagram for cadabra::ActionSetRunStatus:

Public Member Functions
	ActionSetRunStatus (DataCell::id_t ref_id_, bool running)
virtual	~ActionSetRunStatus ()
virtual void	execute (DocumentThread &, GUIBase &) override
	Perform the action.
virtual void	revert (DocumentThread &, GUIBase &) override
	Revert the change to the DTree document and the GUI.
virtual bool	undoable () const override
	Can this action be undone?
Public Member Functions inherited from cadabra::ActionBase
	ActionBase (DataCell::id_t ref_id)

Private Attributes
DTree::iterator	this_cell
bool	was_running_
bool	new_running_

Additional Inherited Members
Public Attributes inherited from cadabra::ActionBase
DataCell::id_t	ref_id
std::function< void()>	callback
	If you want a callback once this action has finished, set it here before queuing.
Protected Attributes inherited from cadabra::ActionBase
DTree::iterator	ref

Constructor & Destructor Documentation

ActionSetRunStatus()

ActionSetRunStatus::ActionSetRunStatus	(	DataCell::id_t	ref_id_,
		bool	running
	)

~ActionSetRunStatus()

virtual cadabra::ActionSetRunStatus::~ActionSetRunStatus ( )

inlinevirtual

Member Function Documentation

execute()

void ActionSetRunStatus::execute ( DocumentThread &  cl, GUIBase &    )

overridevirtual

Perform the action.

This should update both the document tree data structure and the GUI. The latter is updated by calling relevant methods on the GUIBase object passed in.

The base class just looks up the cell given its id_t. If your action does not refer to a cell at all, you do not need to call the base class execute.

Reimplemented from cadabra::ActionBase.

revert()

void ActionSetRunStatus::revert ( DocumentThread &  , GUIBase &    )

overridevirtual

Revert the change to the DTree document and the GUI.

Implements cadabra::ActionBase.

undoable()

bool ActionSetRunStatus::undoable ( ) const

overridevirtual

Can this action be undone?

Reimplemented from cadabra::ActionBase.

Member Data Documentation

new_running_

bool cadabra::ActionSetRunStatus::new_running_

private

this_cell

DTree::iterator cadabra::ActionSetRunStatus::this_cell

private

was_running_

bool cadabra::ActionSetRunStatus::was_running_

private

---

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

• client_server/Actions.hh
• client_server/Actions.cc