YACS::HMI::SubjectComponent Class Reference

#include <guiObservers.hxx>

Inheritance diagram for YACS::HMI::SubjectComponent:

Collaboration diagram for YACS::HMI::SubjectComponent:

Public Member Functions
	SubjectComponent (YACS::ENGINE::ComponentInstance *component, Subject *parent)
virtual	~SubjectComponent ()
virtual std::string	getName ()
virtual void	setContainer ()
virtual bool	associateToContainer (SubjectContainerBase *subcont)
virtual SubjectReference *	attachService (SubjectServiceNode *service)
virtual void	detachService (SubjectServiceNode *service)
virtual void	moveService (SubjectReference *reference)
virtual void	removeSubServiceFromSet (SubjectServiceNode *service)
virtual bool	setProperties (std::map< std::string, std::string > properties)
virtual std::map< std::string, std::string >	getProperties ()
virtual void	notifyServicesChange (GuiEvent event, int type, Subject *son)
virtual std::pair< std::string, int >	getKey ()
virtual void	clean (Command *command=0)
bool	hasServices ()
void	localclean (Command *command=0)
YACS::ENGINE::ComponentInstance *	getComponent () const
virtual TypeOfElem	getType ()
Public Member Functions inherited from YACS::HMI::Subject
	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 bool	setName (std::string name)
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)
void	localclean (Command *command=0)
void	registerUndoDestroy ()
void	askRegisterUndoDestroy ()
bool	isDestructible ()
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 void	notifyObserverFromClone (Node *originalInstance, const std::string &event, Node *clonedInstanceGeneratingEvent)
virtual	~Observer ()

Public Attributes
SubjectReference *	_subRefContainer

Protected Attributes
int	_id
YACS::ENGINE::ComponentInstance *	_compoInst
std::set< SubjectServiceNode * >	_subServiceSet
std::map< SubjectServiceNode *, SubjectReference * >	_subReferenceMap
Protected Attributes inherited from YACS::HMI::Subject
std::set< GuiObserver * >	_setObs
Subject *	_parent
bool	_destructible
bool	_askRegisterUndo
std::string	_progress

Friends
class	SubjectNode

Additional Inherited Members
Static Public Member Functions inherited from YACS::HMI::Subject
static void	erase (Subject *sub, Command *command=0, bool post=false)

Detailed Description

Definition at line 461 of file guiObservers.hxx.

Constructor & Destructor Documentation

SubjectComponent()

SubjectComponent::SubjectComponent	(	YACS::ENGINE::ComponentInstance *	component,
		Subject *	parent
	)

Definition at line 4202 of file guiObservers.cxx.

  : Subject(parent), _compoInst(component)
{
  _compoInst->incrRef();
  _subRefContainer = 0;
  _subServiceSet.clear();
  _subReferenceMap.clear();
}

References _compoInst, _subRefContainer, _subReferenceMap, _subServiceSet, and YACS::ENGINE::RefCounter::incrRef().

~SubjectComponent()

SubjectComponent::~SubjectComponent ( )

virtual

Definition at line 4211 of file guiObservers.cxx.

{
  Proc* aProc = GuiContext::getCurrent()->getProc();
  if ( aProc )
  {
    aProc->componentInstanceMap.erase(_compoInst->getInstanceName());
    GuiContext::getCurrent()->_mapOfSubjectComponent.erase(_compoInst);
  }
  _compoInst->decrRef();
}

References _compoInst, YACS::HMI::GuiContext::_mapOfSubjectComponent, YACS::ENGINE::Proc::componentInstanceMap, YACS::ENGINE::RefCounter::decrRef(), YACS::HMI::GuiContext::getCurrent(), YACS::ENGINE::ComponentInstance::getInstanceName(), and YACS::HMI::GuiContext::getProc().

Member Function Documentation

associateToContainer()

bool SubjectComponent::associateToContainer ( SubjectContainerBase *  subcont )

virtual

Definition at line 4311 of file guiObservers.cxx.

{
  DEBTRACE("SubjectComponent::associateToContainer " << getName() << " " << subcont->getName());
  CommandAssociateComponentToContainer *command =
    new CommandAssociateComponentToContainer(_compoInst->getInstanceName(), subcont->getName());
  if (command->execute())
    {
      if (!GuiContext::getCurrent()->isLoading()) // do not register command when loading a schema
        GuiContext::getCurrent()->getInvoc()->add(command);
      else delete command;
      return true;
    }
  else delete command;
  return false;
}

References _compoInst, YACS::HMI::Invocator::add(), DEBTRACE, YACS::HMI::Command::execute(), YACS::HMI::GuiContext::getCurrent(), YACS::ENGINE::ComponentInstance::getInstanceName(), YACS::HMI::GuiContext::getInvoc(), YACS::HMI::SubjectContainerBase::getName(), and getName().

Referenced by YACS::HMI::SchemaDirContainersItem::addComponentItem(), YACS::HMI::EditionComponent::changeContainer(), and YACS::HMI::EditionSalomeNode::changeContainer().

attachService()

SubjectReference * SubjectComponent::attachService ( SubjectServiceNode *  service )

virtual

Definition at line 4327 of file guiObservers.cxx.

{
  DEBTRACE("SubjectComponent::attachService");
  SubjectReference *son = new SubjectReference(service, this);
  _subServiceSet.insert(service);
  _subReferenceMap[service] = son;
  update(ADDCHILDREF, SALOMENODE, son);
  return son;
}

References _subReferenceMap, _subServiceSet, YACS::HMI::ADDCHILDREF, DEBTRACE, YACS::HMI::SALOMENODE, and YACS::HMI::Subject::update().

Referenced by YACS::HMI::CommandAssociateServiceToComponent::localExecute(), YACS::HMI::CommandAddComponentFromCatalog::localExecute(), YACS::HMI::CommandAssociateServiceToComponent::localReverse(), and YACS::HMI::SubjectServiceNode::setComponent().

clean()

void SubjectComponent::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.

Reimplemented from YACS::HMI::Subject.

Definition at line 4222 of file guiObservers.cxx.

{
  if (_askRegisterUndo)
    {
      _askRegisterUndo = false;
      registerUndoDestroy();
    }
  localclean(command);
  Subject::clean(command);
}

References YACS::HMI::Subject::_askRegisterUndo, YACS::HMI::Subject::clean(), localclean(), and YACS::HMI::Subject::registerUndoDestroy().

detachService()

void SubjectComponent::detachService ( SubjectServiceNode *  service )

virtual

Definition at line 4337 of file guiObservers.cxx.

{
  DEBTRACE("SubjectComponent::detachService");
  YASSERT(_subReferenceMap.count(service));
  SubjectReference *reference = _subReferenceMap[service];
  update(REMOVECHILDREF, SALOMENODE, reference);
  _subServiceSet.erase(service);
  _subReferenceMap.erase(service);
  service->removeSubRefComponent();
  erase(reference);
}

References _subReferenceMap, _subServiceSet, DEBTRACE, YACS::HMI::Subject::erase(), YACS::HMI::REMOVECHILDREF, YACS::HMI::SubjectServiceNode::removeSubRefComponent(), YACS::HMI::SALOMENODE, YACS::HMI::Subject::update(), and YASSERT.

Referenced by YACS::HMI::CommandAddComponentFromCatalog::localReverse().

getComponent()

YACS::ENGINE::ComponentInstance * SubjectComponent::getComponent

(

)

const

Definition at line 4281 of file guiObservers.cxx.

{
  return _compoInst;
}

References _compoInst.

Referenced by YACS::HMI::SchemaDirContainersItem::addComponentItem(), YACS::HMI::EditionComponent::changeContainer(), YACS::HMI::GuiEditor::CreateComponentInstance(), YACS::HMI::EditionComponent::fillContainerPanel(), and YACS::HMI::CommandAssociateServiceToComponent::localExecute().

getKey()

std::pair< std::string, int > SubjectComponent::getKey ( )

virtual

Definition at line 4275 of file guiObservers.cxx.

{
  std::pair<std::string, int> key = std::pair<std::string, int>(_compoInst->getCompoName(), _compoInst->getNumId());
  return key;
}

References _compoInst, YACS::ENGINE::ComponentInstance::getCompoName(), and YACS::ENGINE::ComponentInstance::getNumId().

getName()

std::string SubjectComponent::getName ( )

virtual

Reimplemented from YACS::HMI::Subject.

Definition at line 4270 of file guiObservers.cxx.

{
  return _compoInst->getInstanceName();
}

References _compoInst, and YACS::ENGINE::ComponentInstance::getInstanceName().

Referenced by YACS::HMI::SubjectServiceNode::associateToComponent(), associateToContainer(), YACS::HMI::CommandAssociateServiceToComponent::localExecute(), removeSubServiceFromSet(), setContainer(), and setProperties().

getProperties()

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

virtual

Reimplemented from YACS::HMI::Subject.

Definition at line 4395 of file guiObservers.cxx.

{
  return _compoInst->getProperties();
}

References _compoInst, and YACS::ENGINE::PropertyInterface::getProperties().

getType()

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

inlinevirtual

Reimplemented from YACS::HMI::Subject.

Definition at line 482 of file guiObservers.hxx.

{return COMPONENT;}

References YACS::HMI::COMPONENT.

Referenced by YACS::HMI::SubjectContainerBase::localclean().

hasServices()

bool YACS::HMI::SubjectComponent::hasServices ( )

inline

Definition at line 479 of file guiObservers.hxx.

{ return !_subServiceSet.empty(); };

Referenced by YACS::HMI::CommandAddComponentInstance::localReverse(), YACS::HMI::CommandAddComponentFromCatalog::localReverse(), moveService(), and YACS::HMI::SubjectServiceNode::~SubjectServiceNode().

localclean()

void SubjectComponent::localclean

(

Command *

command = 0

)

Definition at line 4233 of file guiObservers.cxx.

{
  DEBTRACE("SubjectComponent::localClean " << this);
  Proc* aProc = GuiContext::getCurrent()->getProc();
  if ( aProc )
  {
    std::map<Node*, SubjectNode*>::iterator it = GuiContext::getCurrent()->_mapOfSubjectNode.begin();
    std::list<SubjectNode*> services;
    for ( ; it!=GuiContext::getCurrent()->_mapOfSubjectNode.end(); it++ )
      {
        if(ServiceNode* service=dynamic_cast<ServiceNode*>((*it).first))
          {
            if ( service->getComponent() == _compoInst )
              {
                services.push_back((*it).second);
              }
          }
      }
    while(!services.empty())
      {
        SubjectNode* son=services.front();
        services.pop_front();
        Subject* parent=son->getParent();
//         parent->update(REMOVE,son->getType(),son);
        parent->erase(son);
        parent->update(REMOVE,0,0);
      }
      
    Container* container = _compoInst->getContainer();
    if (!container) return;
    SubjectContainerBase *subContainer(0);
    YASSERT(GuiContext::getCurrent()->_mapOfSubjectContainer.count(container));
    subContainer = GuiContext::getCurrent()->_mapOfSubjectContainer[container];
    subContainer->removeSubComponentFromSet(this);
  }
}

References _compoInst, YACS::HMI::GuiContext::_mapOfSubjectContainer, YACS::HMI::GuiContext::_mapOfSubjectNode, DEBTRACE, YACS::HMI::Subject::erase(), YACS::ENGINE::ComponentInstance::getContainer(), YACS::HMI::GuiContext::getCurrent(), YACS::HMI::Subject::getParent(), YACS::HMI::GuiContext::getProc(), YACS::HMI::REMOVE, YACS::HMI::SubjectContainerBase::removeSubComponentFromSet(), YACS::HMI::Subject::update(), and YASSERT.

Referenced by clean().

moveService()

void SubjectComponent::moveService ( SubjectReference *  reference )

virtual

Definition at line 4349 of file guiObservers.cxx.

{
  DEBTRACE("SubjectComponent::moveService");
  SubjectComponent* oldcomp = dynamic_cast<SubjectComponent*>(reference->getParent());
  YASSERT(oldcomp);
 
  SubjectServiceNode* service = dynamic_cast<SubjectServiceNode*>(reference->getReference());
  oldcomp->removeSubServiceFromSet(service);
  _subServiceSet.insert(service);
  _subReferenceMap[service] = reference;
  oldcomp->update(CUT, SALOMENODE, reference);
  reference->reparent(this);
  update(PASTE, SALOMENODE, reference);
  if (!oldcomp->hasServices())
    Subject::erase(oldcomp);
}

References _subReferenceMap, _subServiceSet, YACS::HMI::CUT, DEBTRACE, YACS::HMI::Subject::erase(), YACS::HMI::Subject::getParent(), YACS::HMI::SubjectReference::getReference(), hasServices(), YACS::HMI::PASTE, removeSubServiceFromSet(), YACS::HMI::SubjectReference::reparent(), YACS::HMI::SALOMENODE, YACS::HMI::Subject::update(), and YASSERT.

Referenced by YACS::HMI::CommandAssociateServiceToComponent::localExecute(), YACS::HMI::CommandAssociateServiceToComponent::localReverse(), and YACS::HMI::SubjectServiceNode::setComponent().

notifyServicesChange()

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

virtual

Definition at line 4373 of file guiObservers.cxx.

{
  DEBTRACE("SubjectComponent::notifyServicesChange");
  set<SubjectServiceNode*>::iterator it = _subServiceSet.begin();
  for(; it != _subServiceSet.end(); ++it)
    {
      (*it)->update(event, type, son);
    }
}

References _subServiceSet, and DEBTRACE.

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

removeSubServiceFromSet()

void SubjectComponent::removeSubServiceFromSet ( SubjectServiceNode *  service )

virtual

Definition at line 4366 of file guiObservers.cxx.

{
  DEBTRACE("SubjectComponent::removeSubServiceFromSet " << getName() << " " << service->getName());
  _subServiceSet.erase(service);
  _subReferenceMap.erase(service);
}

References _subReferenceMap, _subServiceSet, DEBTRACE, YACS::HMI::SubjectNode::getName(), and getName().

Referenced by YACS::HMI::SubjectServiceNode::localclean(), and moveService().

setContainer()

void SubjectComponent::setContainer ( )

virtual

When loading scheme from file, get the container associated to the component, if any, and create the corresponding subject.

Definition at line 4290 of file guiObservers.cxx.

{
  DEBTRACE("SubjectComponent::setContainer " << getName());
  Container* container = _compoInst->getContainer();
  if (container)
    {
      SubjectContainerBase *subContainer;
      if (GuiContext::getCurrent()->_mapOfSubjectContainer.count(container))
        subContainer = GuiContext::getCurrent()->_mapOfSubjectContainer[container];
      else
        subContainer = 
          GuiContext::getCurrent()->getSubjectProc()->addSubjectContainer(container, container->getName());
      addSubjectReference(subContainer);
      if (_subRefContainer)
        subContainer->moveComponent(_subRefContainer);
      else
        _subRefContainer = subContainer->attachComponent(this);
      notifyServicesChange(ASSOCIATE, CONTAINER, subContainer);
    }
}

References _compoInst, YACS::HMI::GuiContext::_mapOfSubjectContainer, _subRefContainer, YACS::HMI::SubjectProc::addSubjectContainer(), YACS::HMI::Subject::addSubjectReference(), YACS::HMI::ASSOCIATE, YACS::HMI::SubjectContainerBase::attachComponent(), YACS::HMI::CONTAINER, DEBTRACE, YACS::ENGINE::ComponentInstance::getContainer(), YACS::HMI::GuiContext::getCurrent(), getName(), YACS::ENGINE::Container::getName(), YACS::HMI::GuiContext::getSubjectProc(), YACS::HMI::SubjectContainerBase::moveComponent(), and notifyServicesChange().

Referenced by YACS::HMI::SubjectContainerBase::localclean().

setProperties()

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

virtual

Reimplemented from YACS::HMI::Subject.

Definition at line 4383 of file guiObservers.cxx.

{
  CommandSetComponentInstanceProperties *command = new CommandSetComponentInstanceProperties(getName(), properties);
  if (command->execute())
    {
      GuiContext::getCurrent()->getInvoc()->add(command);
      return true;
    }
  else delete command;
  return false;
}

References YACS::HMI::Invocator::add(), YACS::HMI::Command::execute(), YACS::HMI::GuiContext::getCurrent(), YACS::HMI::GuiContext::getInvoc(), and getName().

Friends And Related Function Documentation

SubjectNode

friend class SubjectNode

friend

Definition at line 464 of file guiObservers.hxx.

Member Data Documentation

_compoInst

YACS::ENGINE::ComponentInstance* YACS::HMI::SubjectComponent::_compoInst

protected

Definition at line 486 of file guiObservers.hxx.

Referenced by associateToContainer(), getComponent(), getKey(), getName(), getProperties(), localclean(), setContainer(), SubjectComponent(), and ~SubjectComponent().

_id

int YACS::HMI::SubjectComponent::_id

protected

Definition at line 485 of file guiObservers.hxx.

_subRefContainer

SubjectReference* YACS::HMI::SubjectComponent::_subRefContainer

Definition at line 483 of file guiObservers.hxx.

Referenced by YACS::HMI::CommandAssociateComponentToContainer::localExecute(), YACS::HMI::CommandAssociateComponentToContainer::localReverse(), setContainer(), and SubjectComponent().

_subReferenceMap

std::map<SubjectServiceNode*,SubjectReference*> YACS::HMI::SubjectComponent::_subReferenceMap

protected

Definition at line 488 of file guiObservers.hxx.

Referenced by attachService(), detachService(), moveService(), removeSubServiceFromSet(), and SubjectComponent().

_subServiceSet

std::set<SubjectServiceNode*> YACS::HMI::SubjectComponent::_subServiceSet

protected

Definition at line 487 of file guiObservers.hxx.

Referenced by attachService(), detachService(), moveService(), notifyServicesChange(), YACS::HMI::SubjectNode::registerUndoDestroy(), removeSubServiceFromSet(), and SubjectComponent().

---

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

• src/hmi/guiObservers.hxx
• src/hmi/guiObservers.cxx