YACS::ENGINE::InGate Class Reference

#include <InGate.hxx>

Inheritance diagram for YACS::ENGINE::InGate:

Collaboration diagram for YACS::ENGINE::InGate:

Public Member Functions
	InGate (Node *node)
virtual	~InGate ()
std::string	getNameOfTypeOfCurrentInstance () const
void	exNotifyFromPrecursor (OutGate *fromgate)
	Notify this port that an upstream node connected by a control flow link is finished. More...
std::list< std::pair< OutGate *, bool > > &	edMapOutGate ()
void	edAppendPrecursor (OutGate *fromgate)
void	edRemovePrecursor (OutGate *fromgate)
int	getNumberOfBackLinks () const
void	edDisconnectAllLinksToMe ()
void	exNotifyFailed ()
	Notify this port that an upstream node connected by a control flow link has failed. More...
void	exNotifyDisabled ()
	Notify this port that an upstream node connected by a control flow link has been disabled. More...
void	exReset ()
bool	exIsReady () const
std::list< OutGate * >	getBackLinks ()
void	setPrecursorDone (OutGate *fromgate)
virtual std::string	typeName ()
Public Member Functions inherited from YACS::ENGINE::Port
virtual	~Port ()
Node *	getNode () const
int	getNumId () const
void	modified ()

Static Protected Attributes
static const char	NAME [] ="InGate"
Static Protected Attributes inherited from YACS::ENGINE::Port
static int	_total = 0
static const char	NAME [] ="Port"

Private Attributes
std::list< std::pair< OutGate *, bool > >	_backLinks

Friends
class	Bloc
class	Node

Additional Inherited Members
Protected Member Functions inherited from YACS::ENGINE::Port
	Port (Node *node)
	Port (const Port &other, Node *newHelder)
Protected Attributes inherited from YACS::ENGINE::Port
Node *	_node
int	_id

Detailed Description

Definition at line 35 of file InGate.hxx.

Constructor & Destructor Documentation

InGate::InGate

(

Node *

node

)

Definition at line 33 of file InGate.cxx.

                        :Port(node)
{
}

InGate::~InGate ( )

virtual

Definition at line 37 of file InGate.cxx.

{
}

Member Function Documentation

void InGate::edAppendPrecursor

(

OutGate *

fromgate

)

Definition at line 99 of file InGate.cxx.

References _backLinks.

Referenced by YACS::ENGINE::OutGate::edAddInGate().

{
  list< pair<OutGate *, bool> >::iterator iter(std::find_if(_backLinks.begin(),_backLinks.end(),ItemCmp(from)));
  if(iter!=_backLinks.end())
    (*iter).second=false;
  else
    _backLinks.push_back(pair<OutGate *, bool>(from,false));
}

void InGate::edDisconnectAllLinksToMe

(

)

Definition at line 46 of file InGate.cxx.

References _backLinks.

Referenced by YACS::ENGINE::Node::edDisconnectAllLinksWithMe().

{
  for(list< std::pair<OutGate *, bool> >::iterator iter=_backLinks.begin();iter!=_backLinks.end();iter++)
    ((*iter).first)->edRemoveInGate(this,false);
  _backLinks.clear();
}

std::list< std::pair<OutGate *, bool> >& YACS::ENGINE::InGate::edMapOutGate ( )

inline

Definition at line 48 of file InGate.hxx.

Referenced by YACS::ENGINE::CFDirectionVisTraits< false >::getNexts().

{ return _backLinks; }

void InGate::edRemovePrecursor

(

OutGate *

fromgate

)

Definition at line 108 of file InGate.cxx.

References _backLinks.

Referenced by YACS::ENGINE::OutGate::edRemoveInGateOneWay().

{
  list< pair<OutGate *, bool> >::iterator iter(std::find_if(_backLinks.begin(),_backLinks.end(),ItemCmp(from)));
  if(iter!=_backLinks.end())
    _backLinks.erase(iter);
}

bool InGate::exIsReady

(

)

const

Definition at line 126 of file InGate.cxx.

References _backLinks.

Referenced by YACS::ENGINE::ElementaryNode::connected(), YACS::ENGINE::Node::exIsControlReady(), exNotifyFromPrecursor(), YACS::ENGINE::ForLoop::exUpdateState(), YACS::ENGINE::WhileLoop::exUpdateState(), YACS::ENGINE::Bloc::exUpdateState(), YACS::ENGINE::ElementaryNode::exUpdateState(), YACS::ENGINE::OptimizerLoop::exUpdateState(), YACS::ENGINE::Switch::exUpdateState(), YACS::ENGINE::Node::exUpdateState(), and YACS::ENGINE::ForEachLoop::exUpdateState().

{
  bool isReady(true);
  for(list< std::pair<OutGate *, bool> >::const_iterator iter=_backLinks.begin();iter!=_backLinks.end() && isReady;iter++)
    isReady=(*iter).second;
  return isReady;
}

void InGate::exNotifyDisabled

(

)

Notify this port that an upstream node connected by a control flow link has been disabled.

Definition at line 93 of file InGate.cxx.

References YACS::ENGINE::Port::_node, and YACS::ENGINE::Node::exDisabledState().

{
  if(_node)
    _node->exDisabledState();
}

void InGate::exNotifyFailed

(

)

Notify this port that an upstream node connected by a control flow link has failed.

Definition at line 83 of file InGate.cxx.

References YACS::ENGINE::Port::_node, and YACS::ENGINE::Node::exFailedState().

{
  if(_node)
    _node->exFailedState();
}

void InGate::exNotifyFromPrecursor

(

OutGate *

from

)

Notify this port that an upstream node connected by a control flow link is finished.

Calls the node's gate method : Node::exUpdateState

Called by OutGate::exNotifyDone

Definition at line 68 of file InGate.cxx.

References _backLinks, YACS::ENGINE::Port::_node, DEBTRACE, exIsReady(), and YACS::ENGINE::Node::exUpdateState().

Referenced by YACS::ENGINE::ElementaryNode::getReadyTasks().

{
  DEBTRACE("InGate::exNotifyFromPrecursor");
  list< pair<OutGate *, bool> >::iterator iter(std::find_if(_backLinks.begin(),_backLinks.end(),ItemCmp(from)));
  if(iter==_backLinks.end())
    throw YACS::Exception("InGate::exNotifyFromPrecursor : precursor not found !");
  (*iter).second=true;
  if(exIsReady())
    _node->exUpdateState();
}

void InGate::exReset

(

)

Definition at line 120 of file InGate.cxx.

References _backLinks.

Referenced by YACS::ENGINE::Node::init(), and YACS::ENGINE::ElementaryNode::initCommonPartWithoutStateManagement().

{
  for(list< std::pair<OutGate *, bool> >::iterator iter=_backLinks.begin();iter!=_backLinks.end();iter++)
    (*iter).second=false;
}

std::list< OutGate * > InGate::getBackLinks

(

)

Definition at line 134 of file InGate.cxx.

References _backLinks.

Referenced by YACS::ENGINE::ElementaryNode::getReadyTasks(), YACS::ENGINE::AbstractPoint::isBegin(), YACS::ENGINE::AbstractPoint::IsGatherB4Ext(), YACS::ENGINE::AbstractPoint::IsNoLinksBefore(), YACS::ENGINE::AbstractPoint::IsSimplyLinkedBeforeExt(), YACS::ENGINE::graphParser::onEnd(), YACS::ENGINE::Node::resetState(), and YACS::HMI::SubjectNode::saveLinks().

{
  list<OutGate *> listo;
  for(list< std::pair<OutGate *, bool> >::const_iterator iter=_backLinks.begin();iter!=_backLinks.end();iter++)
    listo.push_back(iter->first);
  return listo;
}

string InGate::getNameOfTypeOfCurrentInstance ( ) const

virtual

Reimplemented from YACS::ENGINE::Port.

Definition at line 41 of file InGate.cxx.

References NAME.

{
  return NAME;
}

int InGate::getNumberOfBackLinks

(

)

const

Definition at line 115 of file InGate.cxx.

References _backLinks.

{
  return _backLinks.size();
}

void InGate::setPrecursorDone

(

OutGate *

fromgate

)

Definition at line 142 of file InGate.cxx.

References _backLinks.

Referenced by YACS::ENGINE::graphParser::onEnd(), and YACS::ENGINE::Node::resetState().

{
  list< std::pair<OutGate *, bool> >::iterator iter(std::find_if(_backLinks.begin(),_backLinks.end(),ItemCmp(from)));
  if(iter!=_backLinks.end())
    (*iter).second=true;
  else
    throw YACS::Exception("InGate::setPrecursorDone : precursor not found !");
}

virtual std::string YACS::ENGINE::InGate::typeName ( )

inlinevirtual

Reimplemented from YACS::ENGINE::Port.

Definition at line 59 of file InGate.hxx.

{return "YACS__ENGINE__InGate";}

Friends And Related Function Documentation

friend class Bloc

friend

Definition at line 37 of file InGate.hxx.

friend class Node

friend

Definition at line 38 of file InGate.hxx.

Member Data Documentation

std::list< std::pair<OutGate *, bool> > YACS::ENGINE::InGate::_backLinks

private

Definition at line 42 of file InGate.hxx.

Referenced by edAppendPrecursor(), edDisconnectAllLinksToMe(), edRemovePrecursor(), exIsReady(), exNotifyFromPrecursor(), exReset(), getBackLinks(), getNumberOfBackLinks(), and setPrecursorDone().

const char InGate::NAME ="InGate"

staticprotected

Definition at line 40 of file InGate.hxx.

Referenced by getNameOfTypeOfCurrentInstance().

---

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

• src/engine/InGate.hxx
• src/engine/InGate.cxx