YACS::HMI::GuiObserver Class Reference

#include <guiObservers.hxx>

Inheritance diagram for YACS::HMI::GuiObserver:

Collaboration diagram for YACS::HMI::GuiObserver:

Public Member Functions
	GuiObserver ()
virtual	~GuiObserver ()
virtual void	select (bool isSelected)
virtual void	update (GuiEvent event, int type, Subject *son)
virtual void	incrementSubjects (Subject *subject)
virtual void	decrementSubjects (Subject *subject)
int	getNbSubjects ()
bool	isDestructible ()

Static Public Member Functions
static std::string	eventName (GuiEvent event)
static void	setEventMap ()

Protected Attributes
std::set< Subject * >	_subjectSet
bool	_destructible

Static Protected Attributes
static std::map< int, std::string >	_eventNameMap

Detailed Description

Definition at line 155 of file guiObservers.hxx.

Constructor & Destructor Documentation

GuiObserver()

GuiObserver::GuiObserver

(

)

Definition at line 336 of file guiObservers.cxx.

  : _destructible(true)
{
  //DEBTRACE("GuiObserver::GuiObserver " << this);
  _subjectSet.clear();
}

References _subjectSet.

~GuiObserver()

GuiObserver::~GuiObserver ( )

virtual

Definition at line 343 of file guiObservers.cxx.

{
  DEBTRACE("GuiObserver::~GuiObserver " << this);
  set<Subject*> subsetcpy = _subjectSet;
  set<Subject*>::iterator it= subsetcpy.begin();
  for (; it != subsetcpy.end(); ++it)
    (*it)->detach(this);
}

References _subjectSet, and DEBTRACE.

Member Function Documentation

decrementSubjects()

void GuiObserver::decrementSubjects ( Subject *  subject )

virtual

only called by subject when detach from subject.

See also

Subject::detach

Definition at line 378 of file guiObservers.cxx.

{
  if (_subjectSet.count(subject))
    _subjectSet.erase(subject);
  else
    DEBTRACE("subject " << subject << " is not a subject of observer " << this << "---------------------------");
  //DEBTRACE(this << " " << _subjectSet.size());
}

References _subjectSet, and DEBTRACE.

Referenced by YACS::HMI::Subject::detach().

eventName()

std::string GuiObserver::eventName ( GuiEvent  event )

static

Definition at line 428 of file guiObservers.cxx.

{
  if (_eventNameMap.count(event))
    return _eventNameMap[event];
  else return "Unknown Event";
}

References _eventNameMap.

Referenced by YACS::HMI::EditionBloc::update(), YACS::HMI::EditionComponent::update(), YACS::HMI::EditionDataLink::update(), YACS::HMI::EditionForEachLoop::update(), YACS::HMI::EditionLoop::update(), YACS::HMI::EditionOptimizerLoop::update(), YACS::HMI::EditionProc::update(), YACS::HMI::EditionScript::update(), YACS::HMI::EditionSwitch::update(), YACS::HMI::EditionWhile::update(), YACS::HMI::ItemEdition::update(), YACS::HMI::SceneComposedNodeItem::update(), YACS::HMI::SceneDataPortItem::update(), YACS::HMI::SceneElementaryNodeItem::update(), YACS::HMI::RootSceneItem::update(), YACS::HMI::SceneLinkItem::update(), YACS::HMI::SceneNodeItem::update(), YACS::HMI::SceneObserverItem::update(), YACS::HMI::SchemaComposedNodeItem::update(), YACS::HMI::SchemaContainerItem::update(), YACS::HMI::SchemaModel::update(), YACS::HMI::SchemaNodeItem::update(), YACS::HMI::SchemaReferenceItem::update(), and YACS::HMI::SubjectObserver::update().

getNbSubjects()

int GuiObserver::getNbSubjects

(

)

Gets the number of subjects observed. used by subject. When the subject is erased (Subject::erase), remaining observers are detached from subjects. If an observer has no more subject, it can be deleted.

See also

Subject::erase Subject::localClean

Definition at line 394 of file guiObservers.cxx.

{
  return _subjectSet.size();
}

References _subjectSet.

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

incrementSubjects()

void GuiObserver::incrementSubjects ( Subject *  subject )

virtual

only called by subject when attach to subject.

See also

Subject::attach

Definition at line 366 of file guiObservers.cxx.

{
  if (_subjectSet.count(subject))
    DEBTRACE("subject " << subject << " is already a subject of observer " << this << "---------------------------");
  _subjectSet.insert(subject);
  //DEBTRACE(this << " " << _subjectSet.size());
}

References _subjectSet, and DEBTRACE.

Referenced by YACS::HMI::Subject::attach().

isDestructible()

bool YACS::HMI::GuiObserver::isDestructible ( )

inline

Definition at line 165 of file guiObservers.hxx.

{ return _destructible; };

select()

void GuiObserver::select ( bool  isSelected )

virtual

Reimplemented in YACS::HMI::EditionInputPort, YACS::HMI::EditionOutputPort, YACS::HMI::ItemEditionBase, YACS::HMI::ItemEdition, YACS::HMI::SceneLinkItem, YACS::HMI::SceneObserverItem, YACS::HMI::SchemaItem, and YACS::HMI::SubjectObserver.

Definition at line 352 of file guiObservers.cxx.

{
  DEBTRACE("GuiObserver::select() " << isSelected);
}

References DEBTRACE.

Referenced by YACS::HMI::Subject::select().

setEventMap()

void GuiObserver::setEventMap ( )

static

Definition at line 399 of file guiObservers.cxx.

{
  _eventNameMap.clear();
  _eventNameMap[ADD]            = "ADD";
  _eventNameMap[REMOVE]         = "REMOVE";
  _eventNameMap[CUT]            = "CUT";
  _eventNameMap[PASTE]          = "PASTE";
  _eventNameMap[ORDER]          = "ORDER";
  _eventNameMap[EDIT]           = "EDIT";
  _eventNameMap[UPDATE]         = "UPDATE";
  _eventNameMap[UPDATEPROGRESS] = "UPDATEPROGRESS";
  _eventNameMap[SYNCHRO]        = "SYNCHRO";
  _eventNameMap[UP]             = "UP";
  _eventNameMap[DOWN]           = "DOWN";
  _eventNameMap[RENAME]         = "RENAME";
  _eventNameMap[NEWROOT]        = "NEWROOT";
  _eventNameMap[ENDLOAD]        = "ENDLOAD";
  _eventNameMap[ADDLINK]        = "ADDLINK";
  _eventNameMap[ADDCONTROLLINK] = "ADDCONTROLLINK";
  _eventNameMap[ADDREF]         = "ADDREF";
  _eventNameMap[ADDCHILDREF]    = "ADDCHILDREF";
  _eventNameMap[REMOVECHILDREF] = "REMOVECHILDREF";
  _eventNameMap[ASSOCIATE]      = "ASSOCIATE";
  _eventNameMap[SETVALUE]       = "SETVALUE";
  _eventNameMap[SETCASE]        = "SETCASE";
  _eventNameMap[SETSELECT]      = "SETSELECT";
  _eventNameMap[GEOMETRY]       = "GEOMETRY";
}

References _eventNameMap, YACS::HMI::ADD, YACS::HMI::ADDCHILDREF, YACS::HMI::ADDCONTROLLINK, YACS::HMI::ADDLINK, YACS::HMI::ADDREF, YACS::HMI::ASSOCIATE, YACS::HMI::CUT, YACS::HMI::DOWN, YACS::HMI::EDIT, YACS::HMI::ENDLOAD, YACS::HMI::GEOMETRY, YACS::HMI::NEWROOT, YACS::HMI::ORDER, YACS::HMI::PASTE, YACS::HMI::REMOVE, YACS::HMI::REMOVECHILDREF, YACS::HMI::RENAME, YACS::HMI::SETCASE, YACS::HMI::SETSELECT, YACS::HMI::SETVALUE, YACS::HMI::SYNCHRO, YACS::HMI::UP, YACS::HMI::UPDATE, and YACS::HMI::UPDATEPROGRESS.

Referenced by YACS::HMI::GenericGui::GenericGui().

update()

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

virtual

Reimplemented in YACS::HMI::EditionBloc, YACS::HMI::EditionComponent, YACS::HMI::EditionContainer, YACS::HMI::EditionDataLink, YACS::HMI::EditionForEachLoop, YACS::HMI::EditionLoop, YACS::HMI::EditionNode, YACS::HMI::EditionOptimizerLoop, YACS::HMI::EditionProc, YACS::HMI::EditionSalomeNode, YACS::HMI::EditionSwitch, YACS::HMI::EditionWhile, YACS::HMI::ItemEditionBase, YACS::HMI::ItemEdition, YACS::HMI::SceneComposedNodeItem, YACS::HMI::SceneDataPortItem, YACS::HMI::SceneElementaryNodeItem, YACS::HMI::RootSceneItem, YACS::HMI::SceneLinkItem, YACS::HMI::SceneNodeItem, YACS::HMI::SceneObserverItem, YACS::HMI::SchemaComponentItem, YACS::HMI::SchemaComposedNodeItem, YACS::HMI::SchemaContainerItem, YACS::HMI::SchemaDataTypeItem, YACS::HMI::SchemaInPortItem, YACS::HMI::SchemaItem, YACS::HMI::SchemaLinkItem, YACS::HMI::SchemaModel, YACS::HMI::SchemaNodeItem, YACS::HMI::SchemaOutPortItem, YACS::HMI::SchemaReferenceItem, and YACS::HMI::SubjectObserver.

Definition at line 357 of file guiObservers.cxx.

{
  //DEBTRACE("GuiObserver::update, event not handled " << eventName(event) << " " << type );
}

Referenced by gui.graph.MyCanvas::customEvent().

Member Data Documentation

_destructible

bool YACS::HMI::GuiObserver::_destructible

protected

Definition at line 170 of file guiObservers.hxx.

_eventNameMap

std::map< int, std::string > GuiObserver::_eventNameMap

staticprotected

Definition at line 171 of file guiObservers.hxx.

Referenced by eventName(), and setEventMap().

_subjectSet

std::set<Subject*> YACS::HMI::GuiObserver::_subjectSet

protected

Definition at line 169 of file guiObservers.hxx.

Referenced by decrementSubjects(), getNbSubjects(), GuiObserver(), incrementSubjects(), ~GuiObserver(), YACS::HMI::ItemEditionRoot::~ItemEditionRoot(), and YACS::HMI::SchemaModel::~SchemaModel().

---

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

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