Version: 9.15.0
YACS::ENGINE::InputDataStreamPort Class Reference

#include <InputDataStreamPort.hxx>

Inheritance diagram for YACS::ENGINE::InputDataStreamPort:
Collaboration diagram for YACS::ENGINE::InputDataStreamPort:

Public Member Functions

 InputDataStreamPort (const InputDataStreamPort &other, Node *newHelder)
 
 InputDataStreamPort (const std::string &name, Node *node, TypeCode *type)
 
virtual ~InputDataStreamPort ()
 
virtual std::string getNameOfTypeOfCurrentInstance () const
 
virtual InputDataStreamPortclone (Node *newHelder) const
 
virtual std::string typeName ()
 
virtual void edAddOutputDataStreamPort (OutputDataStreamPort *port)
 
std::set< OutputDataStreamPort * > getConnectedOutputDataStreamPort ()
 
- 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
TypeCodeedGetType () 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 ()
 
NodegetNode () const
 
int getNumId () const
 
void modified ()
 
- Public Member Functions inherited from YACS::ENGINE::InPort
virtual InPortgetPublicRepresentant ()
 
virtual int edGetNumberOfLinks () const
 Returns number of physical backlinks NOT number of user backlinks. More...
 
virtual std::set< OutPort * > edSetOutPort () const
 Returns physical backlinks NOT user backlinks. More...
 
bool canSafelySqueezeMemory () const
 
bool isBackLinked () const
 
virtual ~InPort ()
 

Static Public Attributes

static const char NAME [] ="InputDataStreamPort"
 
- 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< OutputDataStreamPort * > _setOfOutputDataStreamPort
 
- 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
 
- Protected Attributes inherited from YACS::ENGINE::InPort
std::set< std::pair< OutPort *, bool > > _backLinks
 

Private Member Functions

bool isAlreadyInSet (OutputDataStreamPort *inPort) const
 

Additional Inherited Members

- Static Public Member Functions inherited from YACS::ENGINE::DataPort
static DataPortisCrossingType (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::InPort
 InPort (const InPort &other, Node *newHelder)
 
 InPort (const std::string &name, Node *node, TypeCode *type)
 
void edRemoveAllLinksLinkedWithMe ()
 
virtual void edNotifyReferencedBy (OutPort *fromPort, bool isLoopProof=true)
 
virtual void edNotifyDereferencedBy (OutPort *fromPort)
 
virtual void getAllRepresentants (std::set< InPort * > &repr) const
 
- 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 InputDataStreamPort.hxx.

Constructor & Destructor Documentation

◆ InputDataStreamPort() [1/2]

InputDataStreamPort::InputDataStreamPort ( const InputDataStreamPort other,
Node newHelder 
)

Definition at line 32 of file InputDataStreamPort.cxx.

32  :
33  DataStreamPort(other,newHelder),
34  InPort(other,newHelder),
35  DataPort(other,newHelder),
36  Port(other,newHelder)
37 {
38 }
DataPort(const DataPort &other, Node *newHelder)
Definition: DataPort.cxx:41
DataStreamPort(const DataStreamPort &other, Node *newHelder)
InPort(const InPort &other, Node *newHelder)
Definition: InPort.cxx:30
Port(Node *node)
Definition: Port.cxx:34

Referenced by clone().

◆ InputDataStreamPort() [2/2]

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

Definition at line 40 of file InputDataStreamPort.cxx.

40  :
41  DataStreamPort(name,node,type),
42  InPort(name,node,type),
43  DataPort(name,node,type),
44  Port(node)
45 {
46 }

◆ ~InputDataStreamPort()

InputDataStreamPort::~InputDataStreamPort ( )
virtual

Definition at line 48 of file InputDataStreamPort.cxx.

49 {
50 }

Member Function Documentation

◆ clone()

InputDataStreamPort * InputDataStreamPort::clone ( Node newHelder) const
virtual

Reimplemented in YACS::ENGINE::InputCalStreamPort.

Definition at line 57 of file InputDataStreamPort.cxx.

58 {
59  return new InputDataStreamPort(*this,newHelder);
60 }
InputDataStreamPort(const InputDataStreamPort &other, Node *newHelder)

References InputDataStreamPort().

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

◆ edAddOutputDataStreamPort()

void InputDataStreamPort::edAddOutputDataStreamPort ( OutputDataStreamPort port)
virtual

Definition at line 62 of file InputDataStreamPort.cxx.

63 {
64  DEBTRACE("InputDataStreamPort::edAddOutputDataStreamPort");
65  if(!isAlreadyInSet(port))
66  _setOfOutputDataStreamPort.insert(port);
67 }
#define DEBTRACE(msg)
Definition: YacsTrace.hxx:31
bool isAlreadyInSet(OutputDataStreamPort *inPort) const
std::set< OutputDataStreamPort * > _setOfOutputDataStreamPort

References _setOfOutputDataStreamPort, DEBTRACE, and isAlreadyInSet().

Referenced by YACS::ENGINE::OutputDataStreamPort::edAddInputDataStreamPort().

◆ getConnectedOutputDataStreamPort()

std::set<OutputDataStreamPort *> YACS::ENGINE::InputDataStreamPort::getConnectedOutputDataStreamPort ( )
inline

◆ getNameOfTypeOfCurrentInstance()

string InputDataStreamPort::getNameOfTypeOfCurrentInstance ( ) const
virtual

Reimplemented from YACS::ENGINE::DataStreamPort.

Reimplemented in YACS::ENGINE::InputCalStreamPort.

Definition at line 52 of file InputDataStreamPort.cxx.

53 {
54  return NAME;
55 }

References NAME.

◆ isAlreadyInSet()

bool InputDataStreamPort::isAlreadyInSet ( OutputDataStreamPort inPort) const
private

Definition at line 69 of file InputDataStreamPort.cxx.

70 {
71  return _setOfOutputDataStreamPort.find(outPort)!=_setOfOutputDataStreamPort.end();
72 }

References _setOfOutputDataStreamPort.

Referenced by edAddOutputDataStreamPort().

◆ typeName()

virtual std::string YACS::ENGINE::InputDataStreamPort::typeName ( )
inlinevirtual

Reimplemented from YACS::ENGINE::DataStreamPort.

Definition at line 49 of file InputDataStreamPort.hxx.

49 {return "YACS__ENGINE__InputDataStreamPort";}

Member Data Documentation

◆ _setOfOutputDataStreamPort

std::set<OutputDataStreamPort *> YACS::ENGINE::InputDataStreamPort::_setOfOutputDataStreamPort
protected

Definition at line 42 of file InputDataStreamPort.hxx.

Referenced by edAddOutputDataStreamPort(), and isAlreadyInSet().

◆ NAME

const char InputDataStreamPort::NAME ="InputDataStreamPort"
static

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