#include <OutputDataStreamPort.hxx>

Inheritance diagram for YACS::ENGINE::OutputDataStreamPort:

[legend]

Collaboration diagram for YACS::ENGINE::OutputDataStreamPort:

[legend]

Public Member Functions
	OutputDataStreamPort (const OutputDataStreamPort &other, Node *newHelder)

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

virtual	~OutputDataStreamPort ()

virtual OutputDataStreamPort *	clone (Node *newHelder) const

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

bool	isAlreadyLinkedWith (InPort *withp) const

virtual std::string	getNameOfTypeOfCurrentInstance () const

virtual bool	addInPort (InPort *inPort)

virtual bool	edAddInputDataStreamPort (InputDataStreamPort *port)

int	edRemoveInputDataStreamPort (InputDataStreamPort *inPort, bool forward)

void	edRemoveAllLinksLinkedWithMe ()

int	removeInPort (InPort *inPort, bool forward)

virtual std::string	typeName ()

Public Member Functions inherited from YACS::ENGINE::DataStreamPort
TypeOfChannel	getTypeOfChannel () const
	returns type of channel the port will use for data exchange on runtime : DATAFLOW or DATASTREAM. More...

virtual void	setProperty (const std::string &name, const std::string &value)
	Set a new value for a property of the port. More...

virtual void	setProperties (std::map< std::string, std::string > properties)
	Set the values of all properties of the port. More...

virtual std::string	getProperty (const std::string &name)
	Get the value of a property of the port. More...

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

virtual void	initPortProperties ()
	Initialize port properties at the start of calculation phase. More...

virtual	~DataStreamPort ()

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 [] ="OutputDataStreamPort"

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

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

Protected Attributes
std::set< InputDataStreamPort * >	_setOfInputDataStreamPort

Protected Attributes inherited from YACS::ENGINE::DataStreamPort
std::map< std::string, std::string >	_propertyMap

Protected Attributes inherited from YACS::ENGINE::DataPort
TypeCode *	_type

std::string	_name

Protected Attributes inherited from YACS::ENGINE::Port
Node *	_node

int	_id

Private Member Functions
bool	isAlreadyInSet (InputDataStreamPort *inPort) const

Friends
class	ElementaryNode

Additional Inherited Members
Static Public Member Functions inherited from YACS::ENGINE::DataPort
static DataPort *	isCrossingType (const std::vector< DataPort * > &historyOfLink)

Protected Member Functions inherited from YACS::ENGINE::DataStreamPort
	DataStreamPort (const DataStreamPort &other, Node *newHelder)

	DataStreamPort (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)

Static Protected Attributes inherited from YACS::ENGINE::Port
static int	_total = 0

static const char	NAME [] ="Port"

Detailed Description

Definition at line 37 of file OutputDataStreamPort.hxx.

Constructor & Destructor Documentation

◆ OutputDataStreamPort() [1/2]

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

Definition at line 35 of file OutputDataStreamPort.cxx.

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

Referenced by clone().

◆ OutputDataStreamPort() [2/2]

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

Definition at line 42 of file OutputDataStreamPort.cxx.

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

◆ ~OutputDataStreamPort()

OutputDataStreamPort::~OutputDataStreamPort ( )

virtual

Definition at line 49 of file OutputDataStreamPort.cxx.

50 {

51 }

Member Function Documentation

◆ addInPort()

bool OutputDataStreamPort::addInPort ( InPort * inPort )

virtual

Implements YACS::ENGINE::OutPort.

Reimplemented in YACS::ENGINE::OutputCalStreamPort.

Definition at line 132 of file OutputDataStreamPort.cxx.

 {
   DEBTRACE("OutputDataStreamPort::addInPort");
   if(inPort->getNameOfTypeOfCurrentInstance()!=InputDataStreamPort::NAME)
     {
       string what="not compatible type of port requested during building of link FROM ";
       what+=NAME; what+=" TO "; what+=inPort->getNameOfTypeOfCurrentInstance();
       throw Exception(what);
     }
   return edAddInputDataStreamPort(static_cast<InputDataStreamPort*>(inPort));
 }

References DEBTRACE, edAddInputDataStreamPort(), YACS::ENGINE::DataPort::getNameOfTypeOfCurrentInstance(), YACS::ENGINE::InputDataStreamPort::NAME, and NAME.

◆ clone()

OutputDataStreamPort * OutputDataStreamPort::clone ( Node * newHelder ) const

virtual

Reimplemented in YACS::ENGINE::OutputCalStreamPort.

Definition at line 53 of file OutputDataStreamPort.cxx.

 {
   return new OutputDataStreamPort(*this,newHelder);
 }

References OutputDataStreamPort().

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

◆ edAddInputDataStreamPort()

bool OutputDataStreamPort::edAddInputDataStreamPort ( InputDataStreamPort * port )

virtual

Definition at line 86 of file OutputDataStreamPort.cxx.

 {
   DEBTRACE("OutputDataStreamPort::edAddInputDataStreamPort");
   if(!isAlreadyInSet(port))
     {
       if(!port->edGetType()->isAdaptable(edGetType()))
         {
           string what="Can not connect 2 ports with incompatible types : ";
           what=what+ port->edGetType()->id();
           what=what+" is not a ";
           what=what+ edGetType()->id();
           throw ConversionException(what);
         }
       _setOfInputDataStreamPort.insert(port);
       port->edAddOutputDataStreamPort(this);
       return true;
     }
   else
     return false;
 }

References _setOfInputDataStreamPort, DEBTRACE, YACS::ENGINE::InputDataStreamPort::edAddOutputDataStreamPort(), YACS::ENGINE::DataPort::edGetType(), YACS::ENGINE::TypeCode::id(), YACS::ENGINE::TypeCode::isAdaptable(), and isAlreadyInSet().

Referenced by addInPort(), and YACS::ENGINE::OutputCalStreamPort::addInPort().

◆ edRemoveAllLinksLinkedWithMe()

void OutputDataStreamPort::edRemoveAllLinksLinkedWithMe ( )

virtual

Implements YACS::ENGINE::DataPort.

Definition at line 144 of file OutputDataStreamPort.cxx.

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

References _setOfInputDataStreamPort, and edRemoveInputDataStreamPort().

◆ edRemoveInputDataStreamPort()

int OutputDataStreamPort::edRemoveInputDataStreamPort	(	InputDataStreamPort *	inPort,
		bool	forward
	)

Definition at line 107 of file OutputDataStreamPort.cxx.

 {
   if(forward)
     {
       set<InPort *> s;
       inPort->getAllRepresentants(s);
       for(set<InPort *>::iterator iter=s.begin();iter!=s.end();iter++)
         _node->getRootNode()->edRemoveLink(this,*iter);
       return -1;
     }
   else    
     {
       set<InputDataStreamPort *>::iterator iter=_setOfInputDataStreamPort.find(inPort);
       if(iter!=_setOfInputDataStreamPort.end())
         {
           (*iter)->modified();
           _setOfInputDataStreamPort.erase(iter);
           modified();
           return edGetNumberOfOutLinks();
         }
       else
         throw Exception("OutputDataStreamPort::edRemoveInputPort : link does not exist, unable to remove it");
     }
 }

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

Referenced by edRemoveAllLinksLinkedWithMe(), removeInPort(), and YACS::ENGINE::OutputCalStreamPort::removeInPort().

◆ edSetInPort()

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

virtual

Implements YACS::ENGINE::OutPort.

Definition at line 58 of file OutputDataStreamPort.cxx.

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

References _setOfInputDataStreamPort.

Referenced by YACS::ENGINE::ElementaryNode::ensureLoading(), YACS::ENGINE::InputPort4DF2DS::getAllRepresentants(), YACS::ENGINE::ElementaryNode::getCoupledNodes(), and YACS::ENGINE::VisitorSaveSchema::writeSimpleStreamLinks().

◆ getNameOfTypeOfCurrentInstance()

string OutputDataStreamPort::getNameOfTypeOfCurrentInstance ( ) const

virtual

Reimplemented from YACS::ENGINE::DataStreamPort.

Reimplemented in YACS::ENGINE::OutputCalStreamPort.

Definition at line 81 of file OutputDataStreamPort.cxx.

 {
   return NAME;
 }

References NAME.

◆ isAlreadyInSet()

bool OutputDataStreamPort::isAlreadyInSet ( InputDataStreamPort * inPort ) const

private

Definition at line 165 of file OutputDataStreamPort.cxx.

 {
   return _setOfInputDataStreamPort.find(inPort)!=_setOfInputDataStreamPort.end();
 }

References _setOfInputDataStreamPort.

Referenced by edAddInputDataStreamPort().

◆ isAlreadyLinkedWith()

bool OutputDataStreamPort::isAlreadyLinkedWith ( InPort * withp ) const

virtual

Implements YACS::ENGINE::OutPort.

Definition at line 66 of file OutputDataStreamPort.cxx.

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

References _setOfInputDataStreamPort.

◆ removeInPort()

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

virtual

Implements YACS::ENGINE::OutPort.

Reimplemented in YACS::ENGINE::OutputCalStreamPort.

Definition at line 153 of file OutputDataStreamPort.cxx.

 {
   DEBTRACE("OutputDataStreamPort::removeInPort");
   if(inPort->getNameOfTypeOfCurrentInstance()!=InputDataStreamPort::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 edRemoveInputDataStreamPort(static_cast<InputDataStreamPort *>(inPort),forward);
 }

References DEBTRACE, edRemoveInputDataStreamPort(), YACS::ENGINE::DataPort::getNameOfTypeOfCurrentInstance(), YACS::ENGINE::InputDataStreamPort::NAME, and NAME.

◆ typeName()

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

inlinevirtual

Reimplemented from YACS::ENGINE::DataStreamPort.

Definition at line 57 of file OutputDataStreamPort.hxx.

57 {return "YACS__ENGINE__OutputDataStreamPort";}

Friends And Related Function Documentation

◆ ElementaryNode

friend class ElementaryNode

friend

Definition at line 39 of file OutputDataStreamPort.hxx.

Member Data Documentation

◆ _setOfInputDataStreamPort

std::set<InputDataStreamPort *> YACS::ENGINE::OutputDataStreamPort::_setOfInputDataStreamPort

protected

Definition at line 41 of file OutputDataStreamPort.hxx.

Referenced by edAddInputDataStreamPort(), edRemoveAllLinksLinkedWithMe(), edRemoveInputDataStreamPort(), edSetInPort(), YACS::ENGINE::ElementaryNode::getReadyTasks(), isAlreadyInSet(), and isAlreadyLinkedWith().

◆ NAME

const char OutputDataStreamPort::NAME ="OutputDataStreamPort"

static

Definition at line 43 of file OutputDataStreamPort.hxx.

Referenced by addInPort(), getNameOfTypeOfCurrentInstance(), and removeInPort().

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

src/engine/OutputDataStreamPort.hxx
src/engine/OutputDataStreamPort.cxx

Public Member Functions

Static Public Attributes

Protected Attributes

Private Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OutputDataStreamPort() [1/2]

◆ OutputDataStreamPort() [2/2]

◆ ~OutputDataStreamPort()

Member Function Documentation

◆ addInPort()

◆ clone()

◆ edAddInputDataStreamPort()

◆ edRemoveAllLinksLinkedWithMe()

◆ edRemoveInputDataStreamPort()

◆ edSetInPort()

◆ getNameOfTypeOfCurrentInstance()

◆ isAlreadyInSet()

◆ isAlreadyLinkedWith()

◆ removeInPort()

◆ typeName()

Friends And Related Function Documentation

◆ ElementaryNode

Member Data Documentation

◆ _setOfInputDataStreamPort

◆ NAME