YACS::HMI::Command Class Reference

#include <commands.hxx>

Inheritance diagram for YACS::HMI::Command:

Collaboration diagram for YACS::HMI::Command:

Public Member Functions
	Command ()
virtual bool	execute ()
	the command is executed a first time after its registration for undo redo, then on redo More...
virtual bool	reverse (bool isNormal=true)
	Reverse action: undo. More...
virtual bool	executeSubOnly ()
	execute only sub commands in a reverse action More...
virtual std::string	dump ()
std::string	recursiveDump (int level=0)
void	addSubCommand (Command *command)
bool	isNormalReverse ()

Protected Member Functions
virtual bool	localExecute ()=0
virtual bool	localReverse ()=0

Protected Attributes
std::vector< Command * >	_subCommands
bool	_normalReverse

Detailed Description

Definition at line 38 of file commands.hxx.

Constructor & Destructor Documentation

Command()

Command::Command

(

)

Definition at line 37 of file commands.cxx.

{
  _subCommands.clear();
  _normalReverse = true;
}

References _normalReverse, and _subCommands.

Member Function Documentation

addSubCommand()

void Command::addSubCommand

(

Command *

command

)

Definition at line 134 of file commands.cxx.

{
  _subCommands.push_back(command); 
}

References _subCommands.

dump()

std::string Command::dump ( )

virtual

Reimplemented in YACS::HMI::CommandAddNodeFromCatalog, YACS::HMI::CommandReparentNode, YACS::HMI::CommandPutInComposedNode, YACS::HMI::CommandCopyNode, YACS::HMI::CommandRenameNode, YACS::HMI::CommandRenameContainer, YACS::HMI::CommandRenameInDataPort, YACS::HMI::CommandRenameOutDataPort, YACS::HMI::CommandAddDataTypeFromCatalog, YACS::HMI::CommandAddInputPortFromCatalog, YACS::HMI::CommandAddOutputPortFromCatalog, YACS::HMI::CommandAddIDSPortFromCatalog, YACS::HMI::CommandAddODSPortFromCatalog, YACS::HMI::CommandOrderInputPorts, YACS::HMI::CommandOrderOutputPorts, YACS::HMI::CommandSetInPortValue, YACS::HMI::CommandSetOutPortValue, YACS::HMI::CommandSetSwitchSelect, YACS::HMI::CommandSetSwitchCase, YACS::HMI::CommandSetForLoopSteps, YACS::HMI::CommandSetWhileCondition, YACS::HMI::CommandSetForEachBranch, YACS::HMI::CommandSetAlgo, YACS::HMI::CommandAddLink, YACS::HMI::CommandAddControlLink, YACS::HMI::CommandAddContainer, YACS::HMI::CommandAddHPContainer, YACS::HMI::CommandSetContainerProperties, YACS::HMI::CommandSetNodeProperties, YACS::HMI::CommandSetComponentInstanceProperties, YACS::HMI::CommandSetDSPortProperties, YACS::HMI::CommandSetLinkProperties, YACS::HMI::CommandSetFuncNodeFunctionName, YACS::HMI::CommandSetInlineNodeScript, YACS::HMI::CommandAddComponentInstance, YACS::HMI::CommandSetExecutionMode, YACS::HMI::CommandSetContainer, YACS::HMI::CommandAssociateComponentToContainer, YACS::HMI::CommandAssociateServiceToComponent, YACS::HMI::CommandAddComponentFromCatalog, and YACS::HMI::CommandDestroy.

Definition at line 119 of file commands.cxx.

{
  return "=== generic command dump ===";
}

Referenced by recursiveDump().

execute()

bool Command::execute ( )

virtual

the command is executed a first time after its registration for undo redo, then on redo

Execute may induce subcommands to be registered during its execution. Subcommands must be deleted before redo, to be recreated by redo. CommandDestroy is a special case, where subcommands are registered before Execute, and undo action calls executeSubOnly instead of reverse. Subcommands pf CommandDestroy must not be deleted.

Definition at line 51 of file commands.cxx.

{
  if ( !GuiContext::getCurrent() || !GuiContext::getCurrent()->getInvoc() )
    return false;
 
  bool commandInProgress = !GuiContext::getCurrent()->getInvoc()->isSpecialReverse();
  if (commandInProgress)
    GuiContext::getCurrent()->getInvoc()->_commandsInProgress.push_back(this);
 
  bool ret=true;
  if (GuiContext::getCurrent()->getInvoc()->_isRedo && _normalReverse) 
    {
      for (int i=0; i<_subCommands.size(); i++)
        delete _subCommands[i];
      _subCommands.clear();
    }
  ret = localExecute();
  if (ret) GuiContext::getCurrent()->setNotSaved(true);
 
  if (commandInProgress)
    GuiContext::getCurrent()->getInvoc()->_commandsInProgress.pop_back();
  return ret;
}

References YACS::HMI::Invocator::_commandsInProgress, _normalReverse, _subCommands, YACS::HMI::GuiContext::getCurrent(), YACS::HMI::GuiContext::getInvoc(), yacsorb.CORBAEngineTest::i, YACS::HMI::Invocator::isSpecialReverse(), localExecute(), and YACS::HMI::GuiContext::setNotSaved().

Referenced by YACS::HMI::SubjectProc::addComponent(), YACS::HMI::SubjectProc::addComSubjectDataType(), YACS::HMI::SubjectProc::addContainer(), YACS::HMI::SubjectProc::addDataType(), YACS::HMI::SubjectProc::addHPContainer(), YACS::HMI::SubjectElementaryNode::addIDSPort(), YACS::HMI::SubjectElementaryNode::addInputPort(), YACS::HMI::SubjectElementaryNode::addODSPort(), YACS::HMI::SubjectElementaryNode::addOutputPort(), YACS::HMI::SubjectServiceNode::associateToComponent(), YACS::HMI::SubjectComponent::associateToContainer(), YACS::HMI::SubjectNode::copy(), YACS::HMI::SubjectComposedNode::createNode(), YACS::HMI::Subject::destroy(), YACS::HMI::SubjectElementaryNode::OrderDataPorts(), YACS::HMI::SubjectNode::putInComposedNode(), YACS::HMI::SubjectNode::reparent(), YACS::HMI::SubjectOptimizerLoop::setAlgorithm(), YACS::HMI::SubjectSwitch::setCase(), YACS::HMI::SubjectServiceNode::setComponentFromCatalog(), YACS::HMI::SubjectWhileLoop::setCondition(), YACS::HMI::SubjectInlineNode::setContainer(), YACS::HMI::SubjectInlineNode::setExecutionMode(), YACS::HMI::SubjectPyFuncNode::setFunctionName(), YACS::HMI::SubjectDataPort::setName(), YACS::HMI::SubjectNode::setName(), YACS::HMI::SubjectContainerBase::setName(), YACS::HMI::SubjectDynParaLoop::setNbBranches(), YACS::HMI::SubjectForLoop::setNbSteps(), YACS::HMI::SubjectInputDataStreamPort::setProperties(), YACS::HMI::SubjectOutputDataStreamPort::setProperties(), YACS::HMI::SubjectNode::setProperties(), YACS::HMI::SubjectContainerBase::setProperties(), YACS::HMI::SubjectComponent::setProperties(), YACS::HMI::SubjectLink::setProperties(), YACS::HMI::SubjectInlineNode::setScript(), YACS::HMI::SubjectSwitch::setSelect(), YACS::HMI::SubjectInputPort::setValue(), YACS::HMI::SubjectOutputPort::setValue(), YACS::HMI::SubjectDataPort::tryCreateLink(), and YACS::HMI::SubjectNode::tryCreateLink().

executeSubOnly()

bool Command::executeSubOnly ( )

virtual

execute only sub commands in a reverse action

for undo of commandDestroy, only sub commands of commandDestroy must be executed, via subcommand->reverse(false)

Definition at line 105 of file commands.cxx.

{
  bool ret=true;
  if (! _subCommands.empty())
    {
      for (int i=0; i<_subCommands.size(); i++)
        {
          ret =_subCommands[i]->reverse(false);
          if (!ret) break;
        }
    }
  return ret;
}

References _subCommands, and yacsorb.CORBAEngineTest::i.

isNormalReverse()

bool YACS::HMI::Command::isNormalReverse ( )

inline

Definition at line 48 of file commands.hxx.

{ return _normalReverse; };

References _normalReverse.

localExecute()

virtual bool YACS::HMI::Command::localExecute ( )

protectedpure virtual

Implemented in YACS::HMI::CommandAddNodeFromCatalog, YACS::HMI::CommandReparentNode, YACS::HMI::CommandPutInComposedNode, YACS::HMI::CommandCopyNode, YACS::HMI::CommandRenameNode, YACS::HMI::CommandRenameContainer, YACS::HMI::CommandRenameInDataPort, YACS::HMI::CommandRenameOutDataPort, YACS::HMI::CommandAddDataTypeFromCatalog, YACS::HMI::CommandAddInputPortFromCatalog, YACS::HMI::CommandAddOutputPortFromCatalog, YACS::HMI::CommandAddIDSPortFromCatalog, YACS::HMI::CommandAddODSPortFromCatalog, YACS::HMI::CommandOrderInputPorts, YACS::HMI::CommandOrderOutputPorts, YACS::HMI::CommandSetInPortValue, YACS::HMI::CommandSetOutPortValue, YACS::HMI::CommandSetSwitchSelect, YACS::HMI::CommandSetSwitchCase, YACS::HMI::CommandSetForLoopSteps, YACS::HMI::CommandSetWhileCondition, YACS::HMI::CommandSetForEachBranch, YACS::HMI::CommandSetAlgo, YACS::HMI::CommandAddLink, YACS::HMI::CommandAddControlLink, YACS::HMI::CommandAddContainerBase, YACS::HMI::CommandSetContainerProperties, YACS::HMI::CommandSetNodeProperties, YACS::HMI::CommandSetComponentInstanceProperties, YACS::HMI::CommandSetDSPortProperties, YACS::HMI::CommandSetLinkProperties, YACS::HMI::CommandSetFuncNodeFunctionName, YACS::HMI::CommandSetInlineNodeScript, YACS::HMI::CommandAddComponentInstance, YACS::HMI::CommandSetExecutionMode, YACS::HMI::CommandSetContainer, YACS::HMI::CommandAssociateComponentToContainer, YACS::HMI::CommandAssociateServiceToComponent, YACS::HMI::CommandAddComponentFromCatalog, and YACS::HMI::CommandDestroy.

Referenced by execute(), and reverse().

localReverse()

virtual bool YACS::HMI::Command::localReverse ( )

protectedpure virtual

Implemented in YACS::HMI::CommandAddNodeFromCatalog, YACS::HMI::CommandReparentNode, YACS::HMI::CommandPutInComposedNode, YACS::HMI::CommandCopyNode, YACS::HMI::CommandRenameNode, YACS::HMI::CommandRenameContainer, YACS::HMI::CommandRenameInDataPort, YACS::HMI::CommandRenameOutDataPort, YACS::HMI::CommandAddDataTypeFromCatalog, YACS::HMI::CommandAddInputPortFromCatalog, YACS::HMI::CommandAddOutputPortFromCatalog, YACS::HMI::CommandAddIDSPortFromCatalog, YACS::HMI::CommandAddODSPortFromCatalog, YACS::HMI::CommandOrderInputPorts, YACS::HMI::CommandOrderOutputPorts, YACS::HMI::CommandSetInPortValue, YACS::HMI::CommandSetOutPortValue, YACS::HMI::CommandSetSwitchSelect, YACS::HMI::CommandSetSwitchCase, YACS::HMI::CommandSetForLoopSteps, YACS::HMI::CommandSetWhileCondition, YACS::HMI::CommandSetForEachBranch, YACS::HMI::CommandSetAlgo, YACS::HMI::CommandAddLink, YACS::HMI::CommandAddControlLink, YACS::HMI::CommandAddContainerBase, YACS::HMI::CommandSetContainerProperties, YACS::HMI::CommandSetNodeProperties, YACS::HMI::CommandSetComponentInstanceProperties, YACS::HMI::CommandSetDSPortProperties, YACS::HMI::CommandSetLinkProperties, YACS::HMI::CommandSetFuncNodeFunctionName, YACS::HMI::CommandSetInlineNodeScript, YACS::HMI::CommandAddComponentInstance, YACS::HMI::CommandSetExecutionMode, YACS::HMI::CommandSetContainer, YACS::HMI::CommandAssociateComponentToContainer, YACS::HMI::CommandAssociateServiceToComponent, YACS::HMI::CommandAddComponentFromCatalog, and YACS::HMI::CommandDestroy.

Referenced by reverse().

recursiveDump()

std::string Command::recursiveDump

(

int

level = 0

)

Definition at line 124 of file commands.cxx.

{
  string prefix = "";
  for (int i=0; i<level; i++) prefix += "  ";
  string ret = prefix + dump() + "\n";
  for (int i=0; i<_subCommands.size(); i++)
    ret += _subCommands[i]->recursiveDump(level+1);
  return ret;
}

References _subCommands, dump(), yacsorb.CORBAEngineTest::i, and recursiveDump().

Referenced by recursiveDump().

reverse()

bool Command::reverse ( bool  isNormal = true )

virtual

Reverse action: undo.

Recursive reverse of sub commands then local action

Parameters

isNormal

true for ordinary command, false for command Destroy

Definition at line 79 of file commands.cxx.

{
  bool ret=true;
  if (! _subCommands.empty())
    {
      for (int i=0; i<_subCommands.size(); i++)
        {
          ret =_subCommands[i]->reverse(isNormal);
          if (!ret) break;
        }
    }
  if (ret)
    {
      if (isNormal) // true for all commands but commandDestroy
        ret = localReverse();
      else
        ret = localExecute(); // subCommand of command Destroy 
    }
  return ret;
}

References _subCommands, yacsorb.CORBAEngineTest::i, localExecute(), and localReverse().

Member Data Documentation

_normalReverse

bool YACS::HMI::Command::_normalReverse

protected

Definition at line 53 of file commands.hxx.

Referenced by Command(), YACS::HMI::CommandDestroy::CommandDestroy(), execute(), and isNormalReverse().

_subCommands

std::vector<Command*> YACS::HMI::Command::_subCommands

protected

Definition at line 52 of file commands.hxx.

Referenced by addSubCommand(), Command(), execute(), executeSubOnly(), recursiveDump(), and reverse().

---

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

• src/hmi/commands.hxx
• src/hmi/commands.cxx