YACS::ENGINE::OutGate Class Reference

#include <OutGate.hxx>

Inheritance diagram for YACS::ENGINE::OutGate:

Collaboration diagram for YACS::ENGINE::OutGate:

Public Member Functions
	OutGate (Node *node)
std::string	getNameOfTypeOfCurrentInstance () const
void	exReset ()
void	exNotifyDone ()
	Notify this port that its node is finished. More...
void	exNotifyFailed ()
	Notify this port that its node has failed. More...
void	exNotifyDisabled ()
	Notify this port that its node has been disabled. More...
void	edDisconnectAllLinksFromMe ()
bool	edAddInGate (InGate *inGate)
std::list< std::pair< InGate *, bool > > &	edMapInGate ()
std::list< InGate * >	edSetInGate () const
void	edRemoveInGate (InGate *inGate, bool coherenceWithInGate=true)
int	getNbOfInGatesConnected () const
bool	isAlreadyInSet (InGate *inGate) const
virtual std::string	typeName ()
Public Member Functions inherited from YACS::ENGINE::Port
virtual	~Port ()
Node *	getNode () const
int	getNumId () const
void	modified ()

Static Public Attributes
static const char	NAME [] ="OutGate"

Protected Member Functions
void	edRemoveInGateOneWay (InGate *inGate)
Protected Member Functions inherited from YACS::ENGINE::Port
	Port (Node *node)
	Port (const Port &other, Node *newHelder)

Protected Attributes
std::list< std::pair< InGate *, bool > >	_setOfInGate
Protected Attributes inherited from YACS::ENGINE::Port
Node *	_node
int	_id

Friends
class	ElementaryNode

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

Detailed Description

Definition at line 36 of file OutGate.hxx.

Constructor & Destructor Documentation

OutGate()

OutGate::OutGate

(

Node *

node

)

Definition at line 33 of file OutGate.cxx.

                          :Port(node)
{
}

Member Function Documentation

edAddInGate()

bool OutGate::edAddInGate

(

InGate *

inGate

)

Definition at line 98 of file OutGate.cxx.

{
  if(!isAlreadyInSet(inGate))
    {
      inGate->edAppendPrecursor(this);
      _setOfInGate.push_back(std::pair<InGate *,bool>(inGate,false));
      modified();
      inGate->modified();
      return true;
    }
  else
    return false;
}

References _setOfInGate, YACS::ENGINE::InGate::edAppendPrecursor(), isAlreadyInSet(), and YACS::ENGINE::Port::modified().

Referenced by YACS::ENGINE::ComposedNode::edAddLink(), and YACS::ENGINE::AbstractPoint::Rewire().

edDisconnectAllLinksFromMe()

void OutGate::edDisconnectAllLinksFromMe

(

)

Definition at line 82 of file OutGate.cxx.

{
  for(list< pair<InGate *, bool> >::iterator iter=_setOfInGate.begin();iter!=_setOfInGate.end();iter++)
    (*iter).first->edRemovePrecursor(this);
  _setOfInGate.clear();
}

References _setOfInGate.

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

edMapInGate()

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

inline

Definition at line 52 of file OutGate.hxx.

{ return _setOfInGate; }

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

edRemoveInGate()

void OutGate::edRemoveInGate	(	InGate *	inGate,
		bool	coherenceWithInGate = true
	)

Definition at line 120 of file OutGate.cxx.

{
  std::list< pair<InGate* , bool> >::iterator iter(std::find_if(_setOfInGate.begin(),_setOfInGate.end(),ItemCmp(inGate)));
  if(iter==_setOfInGate.end())
    throw Exception("InGate not already connected to OutGate");
  else
    {
      if(coherenceWithInGate)
        inGate->edRemovePrecursor(this);
      _setOfInGate.erase(iter);
      inGate->modified();
      modified();
    }
}

References _setOfInGate, YACS::ENGINE::InGate::edRemovePrecursor(), and YACS::ENGINE::Port::modified().

Referenced by YACS::ENGINE::ComposedNode::edRemoveLink().

edRemoveInGateOneWay()

void OutGate::edRemoveInGateOneWay ( InGate *  inGate )

protected

Definition at line 136 of file OutGate.cxx.

{
  bool found=false;
  for(list< pair<InGate *, bool> >::iterator iter=_setOfInGate.begin();iter!=_setOfInGate.end() && !found;iter++)
    if((*iter).first==inGate)
      {
        _setOfInGate.erase(iter);
        inGate->edRemovePrecursor(this);
        found=true;
        modified();
        inGate->modified();
      }
}

References _setOfInGate, YACS::ENGINE::InGate::edRemovePrecursor(), and YACS::ENGINE::Port::modified().

edSetInGate()

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

(

)

const

Definition at line 112 of file OutGate.cxx.

{
  list<InGate *> ret;
  for(list< pair<InGate *, bool> >::const_iterator iter=_setOfInGate.begin();iter!=_setOfInGate.end();iter++)
    ret.push_back((*iter).first);
  return ret;
}

References _setOfInGate.

Referenced by YACS::ENGINE::AbstractPoint::GetNodeAfter(), YACS::ENGINE::BlocPoint::getNodeAfter(), YACS::HMI::SceneBlocItem::getNodesInfo(), YACS::ENGINE::Node::getOutNodes(), YACS::ENGINE::AbstractPoint::isLast(), YACS::ENGINE::AbstractPoint::IsNoLinksAfter(), YACS::ENGINE::AbstractPoint::IsScatterAfterExt(), YACS::ENGINE::AbstractPoint::isSimplyLinkedAfter(), YACS::ENGINE::AbstractPoint::IsSimplyLinkedAfterExt(), YACS::HMI::SubjectComposedNode::loadLinks(), YACS::ENGINE::Bloc::performCFComputationsOnlyOneLevel(), YACS::ENGINE::AbstractPoint::Rewire(), YACS::HMI::SubjectNode::saveLinks(), and YACS::ENGINE::Bloc::splitIntoIndependantGraph().

exNotifyDisabled()

void OutGate::exNotifyDisabled

(

)

Notify this port that its node has been disabled.

Definition at line 76 of file OutGate.cxx.

{
  for(list< pair<InGate *, bool> >::iterator iter=_setOfInGate.begin();iter!=_setOfInGate.end();iter++)
    (*iter).first->exNotifyDisabled();
}

References _setOfInGate.

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

exNotifyDone()

void OutGate::exNotifyDone

(

)

Notify this port that its node is finished.

Calls (notify) all the connected ingates : InGate::exNotifyFromPrecursor

Called by Bloc::updateStateOnFinishedEventFrom

Definition at line 55 of file OutGate.cxx.

{
  DEBTRACE("OutGate::exNotifyDone");
  for(list< pair<InGate *, bool> >::iterator iter=_setOfInGate.begin();iter!=_setOfInGate.end();iter++)
    (*iter).first->exNotifyFromPrecursor(this);
}

References _setOfInGate, and DEBTRACE.

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

exNotifyFailed()

void OutGate::exNotifyFailed

(

)

Notify this port that its node has failed.

Definition at line 66 of file OutGate.cxx.

{
  for(list< pair<InGate *, bool> >::iterator iter=_setOfInGate.begin();iter!=_setOfInGate.end();iter++)
    (*iter).first->exNotifyFailed();
}

References _setOfInGate.

Referenced by YACS::ENGINE::Node::exFailedState(), and YACS::ENGINE::Node::exForwardFailed().

exReset()

void OutGate::exReset

(

)

Definition at line 42 of file OutGate.cxx.

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

References _setOfInGate.

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

getNameOfTypeOfCurrentInstance()

string OutGate::getNameOfTypeOfCurrentInstance ( ) const

virtual

Reimplemented from YACS::ENGINE::Port.

Definition at line 37 of file OutGate.cxx.

{
  return NAME;
}

References NAME.

getNbOfInGatesConnected()

int OutGate::getNbOfInGatesConnected

(

)

const

Definition at line 155 of file OutGate.cxx.

{
  return _setOfInGate.size();
}

References _setOfInGate.

isAlreadyInSet()

bool OutGate::isAlreadyInSet

(

InGate *

inGate

)

const

Definition at line 150 of file OutGate.cxx.

{
  return find_if(_setOfInGate.begin(),_setOfInGate.end(),ItemCmp(inGate))!=_setOfInGate.end();
}

References _setOfInGate.

Referenced by edAddInGate(), YACS::HMI::CommandAddLink::localExecute(), YACS::HMI::SubjectNode::restoreLinks(), and YACS::HMI::SubjectNode::saveLinks().

typeName()

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

inlinevirtual

Reimplemented from YACS::ENGINE::Port.

Definition at line 57 of file OutGate.hxx.

{return "YACS__ENGINE__OutGate";}

Friends And Related Function Documentation

ElementaryNode

friend class ElementaryNode

friend

Definition at line 38 of file OutGate.hxx.

Member Data Documentation

_setOfInGate

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

protected

Definition at line 40 of file OutGate.hxx.

Referenced by edAddInGate(), edDisconnectAllLinksFromMe(), edRemoveInGate(), edRemoveInGateOneWay(), edSetInGate(), exNotifyDisabled(), exNotifyDone(), exNotifyFailed(), exReset(), getNbOfInGatesConnected(), and isAlreadyInSet().

NAME

const char OutGate::NAME ="OutGate"

static

Definition at line 42 of file OutGate.hxx.

Referenced by getNameOfTypeOfCurrentInstance().

---

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

• src/engine/OutGate.hxx
• src/engine/OutGate.cxx