YACS::HMI::CommandAddContainerBase Class Reference

#include <commandsProc.hxx>

Inheritance diagram for YACS::HMI::CommandAddContainerBase:

Collaboration diagram for YACS::HMI::CommandAddContainerBase:

Public Member Functions
	CommandAddContainerBase (std::string name, std::string refContainer)
virtual	~CommandAddContainerBase ()
SubjectContainerBase *	getSubjectContainer ()
Public Member Functions inherited from YACS::HMI::Command
	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 ()
virtual bool	localReverse ()
virtual YACS::ENGINE::Container *	createNewInstance () const =0
virtual bool	localExecute ()=0
virtual bool	localReverse ()=0

Protected Attributes
std::string	_name
std::string	_containerToClone
SubjectContainerBase *	_subcont
Protected Attributes inherited from YACS::HMI::Command
std::vector< Command * >	_subCommands
bool	_normalReverse

Detailed Description

Definition at line 530 of file commandsProc.hxx.

Constructor & Destructor Documentation

CommandAddContainerBase()

CommandAddContainerBase::CommandAddContainerBase	(	std::string	name,
		std::string	refContainer
	)

Definition at line 3114 of file commandsProc.cxx.

  : Command(), _name(name), _containerToClone(refContainer), _subcont(0)
{
  DEBTRACE("CommandAddContainerBase::CommandAddContainerBase " << name << " " << refContainer);
}

References DEBTRACE.

~CommandAddContainerBase()

CommandAddContainerBase::~CommandAddContainerBase ( )

virtual

Definition at line 3120 of file commandsProc.cxx.

{
}

Member Function Documentation

createNewInstance()

virtual YACS::ENGINE::Container * YACS::HMI::CommandAddContainerBase::createNewInstance ( ) const

protectedpure virtual

Implemented in YACS::HMI::CommandAddContainer, and YACS::HMI::CommandAddHPContainer.

Referenced by localExecute().

getSubjectContainer()

SubjectContainerBase * YACS::HMI::CommandAddContainerBase::getSubjectContainer ( )

inline

Definition at line 535 of file commandsProc.hxx.

{ return _subcont; }

References _subcont.

Referenced by YACS::HMI::SubjectProc::addContainer(), and YACS::HMI::SubjectProc::addHPContainer().

localExecute()

bool CommandAddContainerBase::localExecute ( )

protectedvirtual

Implements YACS::HMI::Command.

Definition at line 3124 of file commandsProc.cxx.

{
  DEBTRACE("CommandAddContainerBase::localExecute");
  try
    {
      Proc* proc = GuiContext::getCurrent()->getProc();
      if (proc->containerMap.count(_name))
        {
          GuiContext::getCurrent()->_lastErrorMessage = "There is already a container with that name";
          return false;
        }
      Container *container(createNewInstance());
      if (! _containerToClone.empty())
        {
          if (proc->containerMap.count(_containerToClone))
            {
              Container *ref = proc->containerMap[_containerToClone];
              YASSERT(ref);
              container->setProperties(ref->getProperties());
            }
          else
            {
              GuiContext::getCurrent()->_lastErrorMessage = "There is no reference container to clone properties";
              return false;
            }
        }
      container->setName(_name);
      container->setProc(proc);
      proc->containerMap[_name] = container;
 
      SubjectProc* sproc = GuiContext::getCurrent()->getSubjectProc();
      _subcont = sproc->addSubjectContainer(container, _name);
      return true;
    }
  catch (Exception& ex)
    {
      DEBTRACE("CommandAddContainerBase::localExecute() : " << ex.what());
      setErrorMsg(ex);
      return false;
    }
}

References _containerToClone, YACS::HMI::GuiContext::_lastErrorMessage, _name, _subcont, YACS::HMI::SubjectProc::addSubjectContainer(), YACS::ENGINE::Proc::containerMap, createNewInstance(), DEBTRACE, testCppPluginInvokation::ex, YACS::HMI::GuiContext::getCurrent(), YACS::HMI::GuiContext::getProc(), YACS::HMI::GuiContext::getSubjectProc(), gui.CONNECTOR::ref(), setErrorMsg(), YACS::ENGINE::Container::setName(), YACS::ENGINE::Container::setProc(), YACS::ENGINE::Container::setProperties(), and YASSERT.

localReverse()

bool CommandAddContainerBase::localReverse ( )

protectedvirtual

Implements YACS::HMI::Command.

Definition at line 3166 of file commandsProc.cxx.

{
  DEBTRACE("CommandAddContainerBase::localReverse");
  try
    {
      Proc* proc = GuiContext::getCurrent()->getProc();
      YASSERT(proc->containerMap.count(_name));
      Container *container = proc->containerMap[_name];
      YASSERT(GuiContext::getCurrent()->_mapOfSubjectContainer.count(container));
      _subcont = GuiContext::getCurrent()->_mapOfSubjectContainer[container];
      YASSERT(!_subcont->isUsed());
      SubjectProc* sproc = GuiContext::getCurrent()->getSubjectProc();
      sproc->removeSubjectContainer(_subcont);
      return true;
    }
  catch (Exception& ex)
    {
      DEBTRACE("CommandAddContainer::localExecute() : " << ex.what());
      setErrorMsg(ex);
      return false;
    }
}

References YACS::HMI::GuiContext::_mapOfSubjectContainer, _name, _subcont, YACS::ENGINE::Proc::containerMap, DEBTRACE, testCppPluginInvokation::ex, YACS::HMI::GuiContext::getCurrent(), YACS::HMI::GuiContext::getProc(), YACS::HMI::GuiContext::getSubjectProc(), YACS::HMI::SubjectContainerBase::isUsed(), YACS::HMI::SubjectProc::removeSubjectContainer(), setErrorMsg(), and YASSERT.

Member Data Documentation

_containerToClone

std::string YACS::HMI::CommandAddContainerBase::_containerToClone

protected

Definition at line 541 of file commandsProc.hxx.

Referenced by YACS::HMI::CommandAddContainer::dump(), YACS::HMI::CommandAddHPContainer::dump(), and localExecute().

_name

std::string YACS::HMI::CommandAddContainerBase::_name

protected

Definition at line 540 of file commandsProc.hxx.

Referenced by YACS::HMI::CommandAddContainer::dump(), YACS::HMI::CommandAddHPContainer::dump(), localExecute(), and localReverse().

_subcont

SubjectContainerBase* YACS::HMI::CommandAddContainerBase::_subcont

protected

Definition at line 542 of file commandsProc.hxx.

Referenced by getSubjectContainer(), localExecute(), and localReverse().

---

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

• src/hmi/commandsProc.hxx
• src/hmi/commandsProc.cxx