YACS::ENGINE::OutputPort Class Reference

#include <OutputPort.hxx>

Inheritance diagram for YACS::ENGINE::OutputPort:

Collaboration diagram for YACS::ENGINE::OutputPort:

Public Member Functions
virtual	~OutputPort ()
std::set< InPort * >	edSetInPort () const
bool	isAlreadyLinkedWith (InPort *withp) const
bool	isAlreadyInSet (InputPort *inputPort) const
bool	isConnected () const
std::string	getNameOfTypeOfCurrentInstance () const
int	removeInPort (InPort *inPort, bool forward)
virtual bool	edAddInputPort (InputPort *phyPort)
virtual bool	edAddInPropertyPort (InPropertyPort *phyPort)
virtual int	edRemoveInputPort (InputPort *inputPort, bool forward)
bool	addInPort (InPort *inPort)
void	edRemoveAllLinksLinkedWithMe ()
virtual void	exInit ()
virtual void	checkBasicConsistency () const
	Check validity of output port. Nothing on base class. More...
virtual OutputPort *	clone (Node *newHelder) const =0
virtual std::string	dump ()
virtual void	put (const void *data)
virtual std::string	typeName ()
Public Member Functions inherited from YACS::ENGINE::DataFlowPort
TypeOfChannel	getTypeOfChannel () const
	returns type of channel the port will use for data exchange on runtime : DATAFLOW or DATASTREAM. More...
virtual	~DataFlowPort ()
virtual std::string	valToStr ()
	Gives a string representation of the data, for user interfaces. More...
virtual void	valFromStr (std::string valstr)
	Allows to set data from a string representation used in user interface. More...
Public Member Functions inherited from YACS::ENGINE::DataPort
TypeCode *	edGetType () const
void	edSetType (TypeCode *type)
std::string	getName () const
void	setName (std::string theName)
bool	isDifferentTypeOf (const DataPort *other) const
virtual std::string	getAsString ()
	returns port value as a string that can be used in a GUI for example More...
Public Member Functions inherited from YACS::ENGINE::Port
virtual	~Port ()
Node *	getNode () const
int	getNumId () const
void	modified ()
Public Member Functions inherited from YACS::ENGINE::OutPort
virtual void	checkConsistency (LinkInfo &info) const
virtual int	edGetNumberOfOutLinks () const
virtual void	getAllRepresented (std::set< OutPort * > &represented) const
virtual	~OutPort ()
std::vector< DataPort * >	calculateHistoryOfLinkWith (InPort *end)

Static Public Attributes
static const char	NAME [] ="OutputPort"
Static Public Attributes inherited from YACS::ENGINE::DataFlowPort
static const char	NAME [] ="DataFlowPort"
Static Public Attributes inherited from YACS::ENGINE::DataPort
static const char	NAME [] ="DataPort"

Protected Member Functions
	OutputPort (const OutputPort &other, Node *newHelder)
	OutputPort (const std::string &name, Node *node, TypeCode *type)
const std::set< InputPort * > &	getSetOfPhyLinks () const
	Returns physical links linked to this. Contrary to edSetInPort that returns semantic links. More...
Protected Member Functions inherited from YACS::ENGINE::DataFlowPort
	DataFlowPort (const DataFlowPort &other, Node *newHelder)
	DataFlowPort (const std::string &name, Node *node, TypeCode *type)
Protected Member Functions inherited from YACS::ENGINE::DataPort
virtual	~DataPort ()
	DataPort (const DataPort &other, Node *newHelder)
	DataPort (const std::string &name, Node *node, TypeCode *type)
Protected Member Functions inherited from YACS::ENGINE::Port
	Port (Node *node)
	Port (const Port &other, Node *newHelder)
Protected Member Functions inherited from YACS::ENGINE::OutPort
	OutPort (const OutPort &other, Node *newHelder)
	OutPort (const std::string &name, Node *node, TypeCode *type)

Protected Attributes
std::set< InputPort * >	_setOfInputPort
Protected Attributes inherited from YACS::ENGINE::DataPort
TypeCode *	_type
std::string	_name
Protected Attributes inherited from YACS::ENGINE::Port
Node *	_node
int	_id

Friends
class	CollectorSwOutputPort
class	ElementaryNode
class	OptimizerLoop
class	InputPort
class	Runtime
class	ForLoop

Additional Inherited Members
Static Public Member Functions inherited from YACS::ENGINE::DataPort
static DataPort *	isCrossingType (const std::vector< DataPort * > &historyOfLink)
Static Protected Attributes inherited from YACS::ENGINE::Port
static int	_total = 0
static const char	NAME [] ="Port"

Detailed Description

Definition at line 42 of file OutputPort.hxx.

Constructor & Destructor Documentation

~OutputPort()

OutputPort::~OutputPort ( )

virtual

Definition at line 153 of file OutputPort.cxx.

{
  set<InputPort *>::iterator iter;
  for(iter=_setOfInputPort.begin();iter!=_setOfInputPort.end();iter++)
    {
      delete (*iter);
    }
}

References _setOfInputPort.

OutputPort() [1/2]

OutputPort::OutputPort ( const OutputPort &  other, Node *  newHelder  )

protected

Definition at line 38 of file OutputPort.cxx.

                                                              :DataFlowPort(other,newHelder),OutPort(other,newHelder),
                                                                 DataPort(other,newHelder),Port(other,newHelder)
{
}

OutputPort() [2/2]

OutputPort::OutputPort ( const std::string &  name, Node *  node, TypeCode *  type  )

protected

Definition at line 43 of file OutputPort.cxx.

                                                                       :DataFlowPort(name,node,type),OutPort(name,node,type),
                                                                       DataPort(name,node,type),Port(node)
{
}

Member Function Documentation

addInPort()

bool OutputPort::addInPort ( InPort *  inPort )

virtual

check compatibility of port class ( an inputPort ) before trying to create the link.

Implements YACS::ENGINE::OutPort.

Definition at line 205 of file OutputPort.cxx.

{
  DEBTRACE("OutputPort::addInPort");
  if(inPort->getNameOfTypeOfCurrentInstance()!=InputPort::NAME &&
     inPort->getNameOfTypeOfCurrentInstance()!=InPropertyPort::NAME)
    {
      string what="not compatible type of port requested during building of link FROM ";
      what+=NAME; what+=" TO "; what+=inPort->getNameOfTypeOfCurrentInstance();
      throw Exception(what);
    }
  if (inPort->getNameOfTypeOfCurrentInstance() == InputPort::NAME)
  {
    return edAddInputPort(static_cast<InputPort*>(inPort));
  }
  else
  {
    return edAddInPropertyPort(static_cast<InPropertyPort*>(inPort));
  }
}

References DEBTRACE, edAddInPropertyPort(), edAddInputPort(), YACS::ENGINE::DataPort::getNameOfTypeOfCurrentInstance(), YACS::ENGINE::InPropertyPort::NAME, YACS::ENGINE::InputPort::NAME, and NAME.

Referenced by YACS::ENGINE::AnySplitOutputPort::addInPort().

checkBasicConsistency()

void OutputPort::checkBasicConsistency ( ) const

virtual

Check validity of output port. Nothing on base class.

Reimplemented in YACS::ENGINE::OutputPresetPort.

Definition at line 261 of file OutputPort.cxx.

{
}

clone()

virtual OutputPort* YACS::ENGINE::OutputPort::clone ( Node *  newHelder ) const

pure virtual

Implemented in YACS::ENGINE::OutputXmlPort, YACS::ENGINE::OutputStudyPort, YACS::ENGINE::OutputPyPort, YACS::ENGINE::OutputPresetPort, YACS::ENGINE::OutputCppPort, YACS::ENGINE::OutputCorbaPort, YACS::ENGINE::OutputPort4DS2DF, YACS::ENGINE::AnySplitOutputPort, and YACS::ENGINE::AnyOutputPort.

dump()

std::string OutputPort::dump ( )

virtual

Reimplemented in YACS::ENGINE::OutputXmlPort, YACS::ENGINE::OutputStudyPort, YACS::ENGINE::OutputPyPort, YACS::ENGINE::OutputPresetPort, YACS::ENGINE::OutputCppPort, and YACS::ENGINE::OutputCorbaPort.

Definition at line 247 of file OutputPort.cxx.

{
  string xmldump = "<value><error> NO_SERIALISATION_AVAILABLE </error></value>";
  return xmldump;
}

edAddInPropertyPort()

bool OutputPort::edAddInPropertyPort ( InPropertyPort *  phyPort )

virtual

Definition at line 92 of file OutputPort.cxx.

{
  DEBTRACE("OutputPort::edAddInPropertyPort");
  if(!isAlreadyInSet(phyPort))
    {
      InputPort *pwrap = getRuntime()->adapt(phyPort,
                                             _node->getImplementation(),
                                             this->edGetType());
      _setOfInputPort.insert(pwrap);
      modified();
      phyPort->modified();
      return true;
    }
  else
    return false;
}

References YACS::ENGINE::Port::_node, _setOfInputPort, YACS::ENGINE::Runtime::adapt(), DEBTRACE, YACS::ENGINE::Node::getImplementation(), YACS::ENGINE::getRuntime(), isAlreadyInSet(), and YACS::ENGINE::Port::modified().

Referenced by addInPort().

edAddInputPort()

bool OutputPort::edAddInputPort ( InputPort *  phyPort )

virtual

check if output type is an input type and if a data converter exists before link

Definition at line 75 of file OutputPort.cxx.

{
  DEBTRACE("OutputPort::edAddInputPort");
  if(!isAlreadyInSet(phyPort))
    {
      InputPort *pwrap = getRuntime()->adapt(phyPort,
                                             _node->getImplementation(),
                                             this->edGetType());
      _setOfInputPort.insert(pwrap);
      modified();
      phyPort->modified();
      return true;
    }
  else
    return false;
}

References YACS::ENGINE::Port::_node, _setOfInputPort, YACS::ENGINE::Runtime::adapt(), DEBTRACE, YACS::ENGINE::Node::getImplementation(), YACS::ENGINE::getRuntime(), isAlreadyInSet(), and YACS::ENGINE::Port::modified().

Referenced by addInPort(), and YACS::ENGINE::OptimizerLoop::initInterceptors().

edRemoveAllLinksLinkedWithMe()

void OutputPort::edRemoveAllLinksLinkedWithMe ( )

virtual

Implements YACS::ENGINE::DataPort.

Definition at line 53 of file OutputPort.cxx.

{
  set<InputPort *>::iterator iter;
  set<InputPort *> vec(_setOfInputPort);
  for( set<InputPort *>::iterator iter2=vec.begin();iter2!=vec.end();iter2++)
    edRemoveInputPort(*iter2,true);
  _setOfInputPort.clear();
}

References _setOfInputPort, and edRemoveInputPort().

edRemoveInputPort()

int OutputPort::edRemoveInputPort ( InputPort *  inputPort, bool  forward  )

virtual

Remove a link by performing not only the deletion in _setOfInputPort but also dereference to the target inputPort. If 'forward' == true the forward deletion If 'forward' == false no forward deletion performed, oneway deletion without update 'inputPort' side.

Definition at line 114 of file OutputPort.cxx.

{
  if(forward)
    {
      set<InPort *> s;
      inputPort->getAllRepresentants(s);
      DEBTRACE("+++");
      for(set<InPort *>::iterator iter=s.begin();iter!=s.end();iter++)
        {
          DEBTRACE("---");
          _node->getRootNode()->edRemoveLink(this,*iter);
        }
      return -1;
    }
  else
    {
#ifdef NOCOVARIANT
      InPort *publicRepr=inputPort->getPublicRepresentant();
#else
      InputPort *publicRepr=inputPort->getPublicRepresentant();
#endif
      set<InputPort *>::iterator iter;
      for(iter=_setOfInputPort.begin();iter!=_setOfInputPort.end();iter++)
        if((*iter)->getPublicRepresentant()==publicRepr)
          break;
      if(iter!=_setOfInputPort.end())
        {
          (*iter)->modified();
          if((*iter)->isIntermediate())
            delete (*iter);
          _setOfInputPort.erase(iter);
          modified();
          return edGetNumberOfOutLinks();
        }
      else
        throw Exception("OutputPort::edRemoveInputPort : link does not exist, unable to remove it");
    }
}

References YACS::ENGINE::Port::_node, _setOfInputPort, DEBTRACE, YACS::ENGINE::OutPort::edGetNumberOfOutLinks(), YACS::ENGINE::ComposedNode::edRemoveLink(), YACS::ENGINE::InPort::getAllRepresentants(), YACS::ENGINE::InputPort::getPublicRepresentant(), YACS::ENGINE::Node::getRootNode(), and YACS::ENGINE::Port::modified().

Referenced by edRemoveAllLinksLinkedWithMe(), and removeInPort().

edSetInPort()

std::set< InPort * > OutputPort::edSetInPort ( ) const

virtual

Implements YACS::ENGINE::OutPort.

Definition at line 239 of file OutputPort.cxx.

{
  set<InPort *> s;
  for(set<InputPort *>::const_iterator iter=_setOfInputPort.begin();iter!=_setOfInputPort.end();iter++)
    (*iter)->getAllRepresentants(s);
  return s;
}

References _setOfInputPort.

Referenced by YACS::ENGINE::DynParaLoop::DynParaLoop(), YACS::ENGINE::InterceptorInputPort::getAllRepresentants(), YACS::ENGINE::InputDataStreamPort4DS2DF::getAllRepresentants(), YACS::ENGINE::DynParaLoop::putValueOnBranch(), and YACS::ENGINE::VisitorSaveSchema::writeSimpleDataLinks().

exInit()

void OutputPort::exInit ( )

virtual

Definition at line 62 of file OutputPort.cxx.

{
}

Referenced by YACS::ENGINE::DynParaLoop::init(), YACS::ENGINE::ForLoop::init(), and YACS::ENGINE::OptimizerLoop::init().

getNameOfTypeOfCurrentInstance()

string OutputPort::getNameOfTypeOfCurrentInstance ( ) const

virtual

Reimplemented from YACS::ENGINE::DataFlowPort.

Definition at line 48 of file OutputPort.cxx.

{
  return NAME;
}

References NAME.

getSetOfPhyLinks()

const std::set< InputPort * > & OutputPort::getSetOfPhyLinks ( ) const

protected

Returns physical links linked to this. Contrary to edSetInPort that returns semantic links.

Definition at line 255 of file OutputPort.cxx.

{
  return _setOfInputPort;
}

References _setOfInputPort.

Referenced by YACS::ENGINE::OptimizerLoop::initInterceptors().

isAlreadyInSet()

bool OutputPort::isAlreadyInSet

(

InputPort *

inputPort

)

const

Definition at line 182 of file OutputPort.cxx.

{
#ifdef NOCOVARIANT
  InPort *publicRepr=inputPort->getPublicRepresentant();
#else
  InputPort *publicRepr=inputPort->getPublicRepresentant();
#endif
  for(set<InputPort *>::const_iterator iter=_setOfInputPort.begin();iter!=_setOfInputPort.end();iter++)
    if((*iter)->getPublicRepresentant()==publicRepr)
      return true;
  return false;
}

References _setOfInputPort, and YACS::ENGINE::InputPort::getPublicRepresentant().

Referenced by edAddInPropertyPort(), and edAddInputPort().

isAlreadyLinkedWith()

bool OutputPort::isAlreadyLinkedWith ( InPort *  withp ) const

virtual

Implements YACS::ENGINE::OutPort.

Definition at line 162 of file OutputPort.cxx.

{
  InPort *publicRepr=with->getPublicRepresentant();
  set<InPort *> s;
  set<InputPort *>::const_iterator iter;
  for(iter=_setOfInputPort.begin();iter!=_setOfInputPort.end();iter++)
    {
    if((*iter)->getPublicRepresentant() == publicRepr)
      return true;
    }
  for(iter=_setOfInputPort.begin();iter!=_setOfInputPort.end();iter++)
    (*iter)->getAllRepresentants(s);
  for(set<InPort *>::iterator iter2=s.begin();iter2!=s.end();iter2++)
    {
    if((*iter2)->getPublicRepresentant() == publicRepr)
      return true;
    }
  return false;
}

References _setOfInputPort, YACS::ENGINE::InPort::getAllRepresentants(), and YACS::ENGINE::InPort::getPublicRepresentant().

isConnected()

bool OutputPort::isConnected

(

)

const

Definition at line 196 of file OutputPort.cxx.

{
  return !_setOfInputPort.empty();
}

References _setOfInputPort.

put()

void OutputPort::put ( const void *  data )

virtual

Reimplemented in YACS::ENGINE::OutputXmlPort, YACS::ENGINE::OutputPyPort, YACS::ENGINE::OutputCppPort, YACS::ENGINE::OutputCorbaPort, YACS::ENGINE::OutputPort4DS2DF, and YACS::ENGINE::AnyOutputPort.

Definition at line 66 of file OutputPort.cxx.

{
  for(set<InputPort *>::iterator iter = _setOfInputPort.begin(); iter != _setOfInputPort.end(); iter++)
    (*iter)->put(data);
}

References _setOfInputPort.

Referenced by YACS::ENGINE::AnyOutputPort::put(), YACS::ENGINE::OutputXmlPort::put(), YACS::ENGINE::OutputPort4DS2DF::put(), YACS::ENGINE::OutputCorbaPort::put(), YACS::ENGINE::OutputPyPort::put(), and YACS::ENGINE::OutputCppPort::put().

removeInPort()

int OutputPort::removeInPort ( InPort *  inPort, bool  forward  )

virtual

check compatibility of port class ( an inputPort ) before trying to remove link WITHOUT forward.

Implements YACS::ENGINE::OutPort.

Definition at line 228 of file OutputPort.cxx.

{
  if(inPort->getNameOfTypeOfCurrentInstance()!=InputPort::NAME && !forward)
    {
      string what="not compatible type of port requested during destruction of for link FROM ";
      what+=NAME; what+=" TO "; what+=inPort->getNameOfTypeOfCurrentInstance();
      throw Exception(what);
    }
  return edRemoveInputPort(static_cast<InputPort*>(inPort),forward);
}

References edRemoveInputPort(), YACS::ENGINE::DataPort::getNameOfTypeOfCurrentInstance(), YACS::ENGINE::InputPort::NAME, and NAME.

Referenced by YACS::ENGINE::AnySplitOutputPort::removeInPort().

typeName()

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

inlinevirtual

Reimplemented from YACS::ENGINE::DataFlowPort.

Reimplemented in YACS::ENGINE::OutputStudyPort, YACS::ENGINE::OutputPyPort, YACS::ENGINE::OutputPresetPort, YACS::ENGINE::OutputCorbaPort, and YACS::ENGINE::AnyOutputPort.

Definition at line 69 of file OutputPort.hxx.

{return "YACS__ENGINE__OutputPort";}

Friends And Related Function Documentation

CollectorSwOutputPort

friend class CollectorSwOutputPort

friend

Definition at line 44 of file OutputPort.hxx.

ElementaryNode

friend class ElementaryNode

friend

Definition at line 45 of file OutputPort.hxx.

ForLoop

friend class ForLoop

friend

Definition at line 49 of file OutputPort.hxx.

InputPort

friend class InputPort

friend

Definition at line 47 of file OutputPort.hxx.

OptimizerLoop

friend class OptimizerLoop

friend

Definition at line 46 of file OutputPort.hxx.

Runtime

friend class Runtime

friend

Definition at line 48 of file OutputPort.hxx.

Member Data Documentation

_setOfInputPort

std::set<InputPort *> YACS::ENGINE::OutputPort::_setOfInputPort

protected

Definition at line 77 of file OutputPort.hxx.

Referenced by edAddInPropertyPort(), edAddInputPort(), edRemoveAllLinksLinkedWithMe(), edRemoveInputPort(), edSetInPort(), getSetOfPhyLinks(), isAlreadyInSet(), isAlreadyLinkedWith(), isConnected(), put(), YACS::ENGINE::AnySplitOutputPort::removeInPort(), and ~OutputPort().

NAME

const char OutputPort::NAME ="OutputPort"

static

Definition at line 79 of file OutputPort.hxx.

Referenced by addInPort(), YACS::ENGINE::Loop::buildDelegateOf(), YACS::ENGINE::ForEachLoopGen::buildDelegateOf(), YACS::ENGINE::OptimizerLoop::buildDelegateOf(), YACS::ENGINE::Loop::getDelegateOf(), YACS::ENGINE::ForEachLoopGen::getDelegateOf(), getNameOfTypeOfCurrentInstance(), YACS::ENGINE::Loop::releaseDelegateOf(), YACS::ENGINE::ForEachLoopGen::releaseDelegateOf(), and removeInPort().

---

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

• src/engine/OutputPort.hxx
• src/engine/OutputPort.cxx