#include <guiObservers.hxx>

Inheritance diagram for YACS::HMI::Subject:

Collaboration diagram for YACS::HMI::Subject:

Public Member Functions
	Subject (Subject *parent=0)

virtual	~Subject ()

virtual void	attach (GuiObserver *obs)

virtual void	detach (GuiObserver *obs)

virtual void	select (bool isSelected)

virtual void	update (GuiEvent event, int type, Subject *son)

virtual std::string	getName ()

virtual bool	setName (std::string name)

virtual bool	setProperties (std::map< std::string, std::string > properties)

virtual std::map< std::string, std::string >	getProperties ()

virtual std::vector< std::string >	knownProperties ()

virtual Subject *	getParent ()

virtual void	setParent (Subject *son)

virtual bool	destroy (Subject *son)
	From user action in Ihm, destroy an object. More...

virtual void	loadChildren ()

virtual void	loadLinks ()

virtual void	addSubjectReference (Subject *ref)

virtual void	clean (Command *command=0)

void	localclean (Command *command=0)

void	registerUndoDestroy ()

void	askRegisterUndoDestroy ()

bool	isDestructible ()

virtual TypeOfElem	getType ()

virtual void	setProgress (std::string newProgress)

virtual std::string	getProgress ()

Public Member Functions inherited from YACS::ENGINE::Observer
virtual void	notifyObserver (Node *object, const std::string &event)

virtual void	notifyObserver2 (Node object, const std::string &event, void something)

virtual	~Observer ()

Static Public Member Functions
static void	erase (Subject sub, Command command=0, bool post=false)

Protected Attributes
std::set< GuiObserver * >	_setObs

Subject *	_parent

bool	_destructible

bool	_askRegisterUndo

std::string	_progress

Friends
class	CommandReparentNode

Detailed Description

Definition at line 116 of file guiObservers.hxx.

Constructor & Destructor Documentation

Subject::Subject ( Subject * parent = 0 )

Definition at line 85 of file guiObservers.cxx.

References _askRegisterUndo, and _destructible.

                                 : _parent(parent)
 {
   _destructible = true;
   _askRegisterUndo = false;
 }

Subject::~Subject ( )

virtual

Destructor must only be called by Subject::erase to clean completely the context (detach observers), before the delete process itself. Some actions involving dynamic_cast can't be done in destructor.

Definition at line 97 of file guiObservers.cxx.

References DEBTRACE, and getName().

 {
   DEBTRACE("Subject::~Subject " << this << " "<< getName());
 }

Member Function Documentation

void Subject::addSubjectReference ( Subject * ref )

virtual

Reimplemented in YACS::HMI::SubjectServiceNode.

Definition at line 322 of file guiObservers.cxx.

References YACS::HMI::ADDREF, DEBTRACE, getName(), and update().

Referenced by YACS::HMI::SubjectComponent::setContainer().

 {
   DEBTRACE("Subject::addSubjectReference " << getName() << " " << ref->getName());
   SubjectReference *son = new SubjectReference(ref, this);
   update(ADDREF, 0, son);
 }

void YACS::HMI::Subject::askRegisterUndoDestroy ( )

inline

Definition at line 140 of file guiObservers.hxx.

Referenced by YACS::HMI::GuiEditor::DeleteSubject().

140 {_askRegisterUndo=true; };

void Subject::attach ( GuiObserver * obs )

virtual

Definition at line 146 of file guiObservers.cxx.

References _setObs, DEBTRACE, and YACS::HMI::GuiObserver::incrementSubjects().

Referenced by YACS::HMI::ItemEditionBase::ItemEditionBase(), YACS::HMI::RootSceneItem::RootSceneItem(), YACS::HMI::SceneObserverItem::SceneObserverItem(), YACS::HMI::SchemaModel::SchemaModel(), and YACS::HMI::SubjectReference::SubjectReference().

 {
   DEBTRACE("Subject::attach " << obs);
   _setObs.insert(obs);
   obs->incrementSubjects(this);
 }

void Subject::clean ( Command * command = 0 )

virtual

Clean process prior to delete is redefined in derived classes: a local clean treatment relative to the derived class, then a call to the parent class clean method.

Definition at line 107 of file guiObservers.cxx.

References localclean().

Referenced by YACS::HMI::SubjectReference::clean(), YACS::HMI::SubjectDataPort::clean(), YACS::HMI::SubjectNode::clean(), YACS::HMI::SubjectContainerBase::clean(), YACS::HMI::SubjectComponent::clean(), YACS::HMI::SubjectDataType::clean(), YACS::HMI::SubjectLink::clean(), YACS::HMI::SubjectControlLink::clean(), and erase().

 {
   localclean(command);
 }

bool Subject::destroy ( Subject * son )

virtual

From user action in Ihm, destroy an object.

Called from GuiEditor::DeleteSubject(parent, toRemove). The subject (this) is the parent of the subject (son) to remove. Son must represent a Node, a DataPort, a Link or a ControlLink. All other objects can only be destroyed automatically, not via an user command. Only the destruction originated from user, using this method, are registered for undo-redo.

Definition at line 238 of file guiObservers.cxx.

References YACS::HMI::GuiContext::_lastErrorMessage, YACS::HMI::Invocator::add(), DEBTRACE, YACS::HMI::Command::execute(), YACS::ENGINE::ComposedNode::getChildName(), YACS::HMI::GuiContext::getCurrent(), YACS::HMI::GuiContext::getInvoc(), YACS::ENGINE::ComposedNode::getName(), getName(), YACS::HMI::SubjectNode::getNode(), getParent(), YACS::HMI::GuiContext::getProc(), getType(), isDestructible(), and YACS::HMI::UNKNOWN.

Referenced by YACS::HMI::GuiEditor::DeleteSubject(), and YACS::HMI::SubjectContainerBase::~SubjectContainerBase().

 {
   string toDestroy = son->getName();
   DEBTRACE("Subject::destroy " << toDestroy);
   Proc *proc = GuiContext::getCurrent()->getProc();
   string startnode = "";
   string endnode = "";
   string startport = "";
   string endport = "";
   TypeOfElem startportType = UNKNOWN;
   TypeOfElem endportType = UNKNOWN;
 
   if (dynamic_cast<SubjectProc*>(son))
     startnode = proc->getName();
   else
     {
       if (SubjectNode *subNode = dynamic_cast<SubjectNode*>(son))
         {
           if (subNode->getNode()->getFather() )
             startnode = proc->getChildName(subNode->getNode());
         }
       else if (dynamic_cast<SubjectDataPort*>(son))
         {
           SubjectNode *subNodep = dynamic_cast<SubjectNode*>(son->getParent());
           startnode = proc->getChildName(subNodep->getNode());
           startport = son->getName();
           startportType = son->getType();
         }
       else if (SubjectLink* slink = dynamic_cast<SubjectLink*>(son))
         {
           startnode = proc->getChildName(slink->getSubjectOutNode()->getNode());
           endnode = proc->getChildName(slink->getSubjectInNode()->getNode());
           startport = slink->getSubjectOutPort()->getName();
           endport = slink->getSubjectInPort()->getName();
           startportType = slink->getSubjectOutPort()->getType();
           endportType = slink->getSubjectInPort()->getType();
         }
       else if (SubjectControlLink* sclink = dynamic_cast<SubjectControlLink*>(son))
         {
           startnode = proc->getChildName(sclink->getSubjectOutNode()->getNode());
           endnode = proc->getChildName(sclink->getSubjectInNode()->getNode());
         }
       else if (SubjectContainerBase* scont = dynamic_cast<SubjectContainerBase*>(son))
         {
           if(scont->getName() == "DefaultContainer")
             {
               GuiContext::getCurrent()->_lastErrorMessage = "You can't delete the default container";
               return false;
             }
           if(scont->isUsed())
             {
               GuiContext::getCurrent()->_lastErrorMessage = "You can't delete a container that contains components";
               return false;
             }
           startnode = scont->getName();
         }
       else
         {
           GuiContext::getCurrent()->_lastErrorMessage = "No command Destroy for that type";
           return false;
         }
     }
   if (son->isDestructible())
     {
       CommandDestroy* command = new CommandDestroy(son->getType(), startnode, startport, startportType, endnode, endport, endportType);
       if (command->execute())
         {
           DEBTRACE("Destruction done: " << toDestroy);
           GuiContext::getCurrent()->getInvoc()->add(command);
           return true;
         }
       else delete command;
     }
   return false;
 }

void Subject::detach ( GuiObserver * obs )

virtual

Definition at line 153 of file guiObservers.cxx.

References _setObs, DEBTRACE, and YACS::HMI::GuiObserver::decrementSubjects().

Referenced by localclean().

 {
   DEBTRACE("Subject::detach " << obs);
   obs->decrementSubjects(this);
   _setObs.erase(obs);
 }

void Subject::erase	(	Subject *	sub,
		Command *	command = `0`,
		bool	post = `false`
	)

static

Definition at line 74 of file guiObservers.cxx.

References clean(), and getParent().

 {
   Subject* parent =sub->getParent();
   sub->clean(command);
   delete sub;
   if (!post) // --- avoid recursion in erase, see cleanPostErase
     GuiContext::getCurrent()->getSubjectProc()->cleanPostErase();
 }

std::string Subject::getName ( )

virtual

Reimplemented in YACS::HMI::SubjectControlLink, YACS::HMI::SubjectLink, YACS::HMI::SubjectSplitterNode, YACS::HMI::SubjectDataType, YACS::HMI::SubjectComponent, YACS::HMI::SubjectContainerBase, YACS::HMI::SubjectNode, YACS::HMI::SubjectDataPort, and YACS::HMI::SubjectReference.

Definition at line 160 of file guiObservers.cxx.

 {
   return "generic";
 }

Subject * Subject::getParent ( )

virtual

Definition at line 220 of file guiObservers.cxx.

References _parent.

 {
   return _parent;
 }

virtual std::string YACS::HMI::Subject::getProgress ( )

inlinevirtual

Definition at line 145 of file guiObservers.hxx.

Referenced by YACS::HMI::SceneComposedNodeItem::update().

145 { return _progress; };

std::map< std::string, std::string > Subject::getProperties ( )

virtual

Reimplemented in YACS::HMI::SubjectLink, YACS::HMI::SubjectComponent, YACS::HMI::SubjectContainerBase, YACS::HMI::SubjectNode, YACS::HMI::SubjectOutputDataStreamPort, and YACS::HMI::SubjectInputDataStreamPort.

Definition at line 170 of file guiObservers.cxx.

Referenced by YACS::HMI::SubjectLink::getProperties(), and YACS::HMI::PropertyEditor::update().

 {
   std::map<std::string, std::string> empty;
   return empty;
 }

virtual TypeOfElem YACS::HMI::Subject::getType ( )

inlinevirtual

Definition at line 143 of file guiObservers.hxx.

References YACS::HMI::UNKNOWN.

Referenced by destroy(), YACS::HMI::SubjectDataPort::registerUndoDestroy(), YACS::HMI::SubjectLink::registerUndoDestroy(), YACS::HMI::SchemaComposedNodeItem::SchemaComposedNodeItem(), YACS::HMI::SchemaLinkItem::SchemaLinkItem(), YACS::HMI::EditionOutputPort::select(), YACS::HMI::EditionInputPort::select(), YACS::HMI::SubjectDataPort::setName(), and YACS::HMI::SubjectDataPort::tryCreateLink().

143 {return UNKNOWN;}

bool YACS::HMI::Subject::isDestructible ( )

inline

Definition at line 141 of file guiObservers.hxx.

Referenced by destroy(), localclean(), YACS::HMI::SubjectLink::localclean(), YACS::HMI::SubjectControlLink::~SubjectControlLink(), and YACS::HMI::SubjectDataPort::~SubjectDataPort().

141 { return _destructible; };

std::vector< std::string > Subject::knownProperties ( )

virtual

Reimplemented in YACS::HMI::SubjectLink, and YACS::HMI::SubjectInputDataStreamPort.

Definition at line 181 of file guiObservers.cxx.

Referenced by YACS::HMI::SubjectLink::knownProperties(), and YACS::HMI::PropertyEditor::PropertyEditor().

 {
   std::vector<std::string> empty;
   return empty;
 }

void Subject::loadChildren ( )

virtual

Reimplemented in YACS::HMI::SubjectElementaryNode, and YACS::HMI::SubjectComposedNode.

Definition at line 314 of file guiObservers.cxx.

Referenced by YACS::HMI::SubjectComposedNode::loadChildren(), YACS::HMI::CommandAddNodeFromCatalog::localExecute(), and YACS::HMI::CommandCopyNode::localExecute().

315 {

316 }

void Subject::loadLinks ( )

virtual

Reimplemented in YACS::HMI::SubjectComposedNode.

Definition at line 318 of file guiObservers.cxx.

Referenced by YACS::HMI::CommandAddNodeFromCatalog::localExecute(), and YACS::HMI::CommandCopyNode::localExecute().

319 {

320 }

void Subject::localclean ( Command * command = 0 )

the local clean method of base class of subjects take care of Observers. Remaining Observers in the list are detached, if an observer has no more Subject to observe, it can be deleted.

Definition at line 117 of file guiObservers.cxx.

References _setObs, DEBTRACE, detach(), YACS::HMI::GuiObserver::getNbSubjects(), and isDestructible().

Referenced by clean().

 {
   DEBTRACE("Subject::localClean ");
   set<GuiObserver*>::iterator it;
   while (int nbObs = _setObs.size())
     {
       DEBTRACE("--- " << this << " nbObs " << nbObs);
       set<GuiObserver*> copySet = _setObs;
       for (it = copySet.begin(); it != copySet.end(); ++it)
         {
           GuiObserver* anObs = (*it);
           detach(anObs);
           int nbsub = anObs->getNbSubjects();
           DEBTRACE("nbSubjects=" << nbsub << " obs=" << anObs);
           if (nbsub <= 0 && anObs->isDestructible())
             {
               delete anObs ;
               break; // --- each delete may induce remove of other observers
             }
         }
     }
   _setObs.clear();
 }

void Subject::registerUndoDestroy ( )

Definition at line 141 of file guiObservers.cxx.

References DEBTRACE.

Referenced by YACS::HMI::SubjectReference::clean(), YACS::HMI::SubjectContainerBase::clean(), YACS::HMI::SubjectComponent::clean(), and YACS::HMI::SubjectDataType::clean().

 {
   DEBTRACE("Subject::registerUndoDestroy");
 }

void Subject::select ( bool isSelected )

virtual

Definition at line 187 of file guiObservers.cxx.

References _setObs, DEBTRACE, and YACS::HMI::GuiObserver::select().

 {
   DEBTRACE("Subject::select " << isSelected << " " << this);
   set<GuiObserver*> copySet = _setObs;
   for (set<GuiObserver *>::iterator it = copySet.begin(); it != copySet.end(); ++it)
     {
       GuiObserver* currOb = *it;
       currOb->select(isSelected);
     }
 }

bool Subject::setName ( std::string name )

virtual

Reimplemented in YACS::HMI::SubjectContainerBase, YACS::HMI::SubjectNode, and YACS::HMI::SubjectDataPort.

Definition at line 165 of file guiObservers.cxx.

Referenced by YACS::HMI::ItemEdition::onApply().

 {
   return false;
 }

void Subject::setParent ( Subject * son )

virtual

Definition at line 225 of file guiObservers.cxx.

References _parent.

Referenced by YACS::HMI::CommandPutInComposedNode::localExecute(), and YACS::HMI::CommandPutInComposedNode::localReverse().

 {
   _parent=son;
 }

void Subject::setProgress ( std::string newProgress )

virtual

Definition at line 329 of file guiObservers.cxx.

References _progress.

 {
   _progress = newProgress;
 }

bool Subject::setProperties ( std::map< std::string, std::string > properties )

virtual

Reimplemented in YACS::HMI::SubjectLink, YACS::HMI::SubjectComponent, YACS::HMI::SubjectContainerBase, YACS::HMI::SubjectNode, YACS::HMI::SubjectOutputDataStreamPort, and YACS::HMI::SubjectInputDataStreamPort.

Definition at line 176 of file guiObservers.cxx.

Referenced by YACS::HMI::PropertyEditor::setProperties().

 {
   return true;
 }

void Subject::update	(	GuiEvent	event,
		int	type,
		Subject *	son
	)

virtual

Reimplemented in YACS::HMI::SubjectNode.

Definition at line 198 of file guiObservers.cxx.

References _setObs, and YACS::Exception::what().

 {
   //DEBTRACE("Subject::update " << type << "," << GuiObserver::eventName(event) << "," << son);
   set<GuiObserver*> copySet = _setObs;
   for (set<GuiObserver *>::iterator it = copySet.begin(); it != copySet.end(); ++it)
     {
       //DEBTRACE("Subject::update " << *it);
       try
         {
           (*it)->update(event, type, son);
         }
       catch(Exception& ex)
         {
           std::cerr << "Internal error in Subject::update: " << ex.what() << std::endl;
         }
       catch(...)
         {
           std::cerr << "Internal error in Subject::update: " << std::endl;
         }
     }
 }