YACS::ENGINE::DataPort Class Reference

#include <DataPort.hxx>

Inheritance diagram for YACS::ENGINE::DataPort:

Collaboration diagram for YACS::ENGINE::DataPort:

Public Member Functions
TypeCode *	edGetType () const
void	edSetType (TypeCode *type)
std::string	getName () const
void	setName (std::string theName)
std::string	getNameOfTypeOfCurrentInstance () const
virtual TypeOfChannel	getTypeOfChannel () const =0
	returns type of channel the port will use for data exchange on runtime : DATAFLOW or DATASTREAM. More...
bool	isDifferentTypeOf (const DataPort *other) const
virtual void	edRemoveAllLinksLinkedWithMe ()=0
virtual std::string	typeName ()
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 ()

Static Public Member Functions
static DataPort *	isCrossingType (const std::vector< DataPort * > &historyOfLink)

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

Protected Member Functions
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 Attributes
TypeCode *	_type
std::string	_name
Protected Attributes inherited from YACS::ENGINE::Port
Node *	_node
int	_id

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 41 of file DataPort.hxx.

Constructor & Destructor Documentation

~DataPort()

DataPort::~DataPort ( )

protectedvirtual

Definition at line 29 of file DataPort.cxx.

{
  if(_type)
    _type->decrRef();
}

DataPort() [1/2]

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

protected

Definition at line 41 of file DataPort.cxx.

                                                        :Port(other,newHelder),_name(other._name),_type(other._type)
{
  if(_type)
        _type->incrRef();
}

References _type, and YACS::ENGINE::RefCounter::incrRef().

DataPort() [2/2]

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

protected

Definition at line 35 of file DataPort.cxx.

                                                                   :Port(node),_name(name),_type(type)
{
  if(_type)
        _type->incrRef();
}

References _type, and YACS::ENGINE::RefCounter::incrRef().

Member Function Documentation

edGetType()

TypeCode* YACS::ENGINE::DataPort::edGetType ( ) const

inline

Definition at line 53 of file DataPort.hxx.

{ return _type; }

Referenced by YACS::ENGINE::RuntimeSALOME::adaptCorbaToCorba(), YACS::ENGINE::RuntimeSALOME::adaptCorbaToCpp(), YACS::ENGINE::RuntimeSALOME::adaptCorbaToNeutral(), YACS::ENGINE::RuntimeSALOME::adaptCorbaToPython(), YACS::ENGINE::RuntimeSALOME::adaptCorbaToXml(), YACS::ENGINE::RuntimeSALOME::adaptCppToCorba(), YACS::ENGINE::RuntimeSALOME::adaptCppToCpp(), YACS::ENGINE::RuntimeSALOME::adaptCppToNeutral(), YACS::ENGINE::RuntimeSALOME::adaptCppToPython(), YACS::ENGINE::RuntimeSALOME::adaptCppToXml(), YACS::ENGINE::RuntimeSALOME::adaptNeutralToCorba(), YACS::ENGINE::RuntimeSALOME::adaptNeutralToCpp(), YACS::ENGINE::RuntimeSALOME::adaptNeutralToPython(), YACS::ENGINE::RuntimeSALOME::adaptNeutralToXml(), YACS::ENGINE::RuntimeSALOME::adaptPythonToCorba(), YACS::ENGINE::RuntimeSALOME::adaptPythonToCpp(), YACS::ENGINE::RuntimeSALOME::adaptPythonToNeutral(), YACS::ENGINE::RuntimeSALOME::adaptPythonToPython(), YACS::ENGINE::RuntimeSALOME::adaptPythonToXml(), YACS::ENGINE::RuntimeSALOME::adaptXmlToCorba(), YACS::ENGINE::RuntimeSALOME::adaptXmlToCpp(), YACS::ENGINE::RuntimeSALOME::adaptXmlToNeutral(), YACS::ENGINE::RuntimeSALOME::adaptXmlToPython(), YACS::ENGINE::RuntimeSALOME::adaptXmlToXml(), YACS::HMI::SubjectNode::addSubjectIDSPort(), YACS::HMI::SubjectNode::addSubjectInputPort(), YACS::HMI::SubjectNode::addSubjectODSPort(), YACS::HMI::SubjectNode::addSubjectOutputPort(), YACS::ENGINE::Loop::buildDelegateOf(), YACS::ENGINE::ForEachLoopGen::buildDelegateOf(), YACS::HMI::ValueDelegate::createEditor(), YACS::ENGINE::SeqAnyInputPort::dump(), YACS::ENGINE::InputCorbaPort::dump(), YACS::ENGINE::OutputCorbaPort::dump(), YACS::ENGINE::InputCppPort::dump(), YACS::ENGINE::OutputCppPort::dump(), YACS::ENGINE::InputPyPort::dump(), YACS::ENGINE::OutputPyPort::dump(), YACS::ENGINE::OutputDataStreamPort::edAddInputDataStreamPort(), YACS::HMI::EditionForEachLoop::EditionForEachLoop(), YACS::ENGINE::OutputCorbaPort::getAnyOut(), YACS::ENGINE::AnyInputPort::getAsString(), YACS::ENGINE::AnyOutputPort::getAsString(), YACS::ENGINE::OutputPresetPort::getData(), YACS::ENGINE::OutputStudyPort::getDataFromStudy(), YACS::ENGINE::InputStudyPort::getIOR(), YACS::ENGINE::InputCorbaPort::getPyObj(), YACS::ENGINE::OutputCorbaPort::getPyObj(), YACS::ENGINE::OutputPresetPort::getPyObj(), YACS::ENGINE::InputPresetPort::getPyObj(), YACS::HMI::CommandSetInPortValue::localExecute(), YACS::HMI::CommandSetOutPortValue::localExecute(), YACS::HMI::CommandSetInPortValue::localReverse(), YACS::HMI::CommandSetOutPortValue::localReverse(), YACS::HMI::TreeView::onCommitData(), YACS::ENGINE::CppPy::put(), YACS::ENGINE::CppCpp::put(), YACS::ENGINE::CppNeutral::put(), YACS::ENGINE::XmlCorba::put(), YACS::ENGINE::XmlCpp::put(), YACS::ENGINE::XmlNeutral::put(), YACS::ENGINE::XmlPython::put(), YACS::ENGINE::CorbaCorba::put(), YACS::ENGINE::CorbaCpp::put(), YACS::ENGINE::CorbaNeutral::put(), YACS::ENGINE::CorbaPyDouble::put(), YACS::ENGINE::CorbaPyInt::put(), YACS::ENGINE::CorbaPyString::put(), YACS::ENGINE::CorbaPyBool::put(), YACS::ENGINE::CorbaPyObjref::put(), YACS::ENGINE::CorbaPySequence::put(), YACS::ENGINE::CorbaPyStruct::put(), YACS::ENGINE::CorbaXml::put(), YACS::ENGINE::PyCorbaObjref::put(), YACS::ENGINE::PyCorbaSequence::put(), YACS::ENGINE::PyCorbaStruct::put(), YACS::ENGINE::PyInit::put(), YACS::ENGINE::PyNeutral::put(), YACS::ENGINE::PyXml::put(), YACS::ENGINE::CppXml::put(), YACS::ENGINE::NeutralCorbaString::put(), YACS::ENGINE::NeutralCorbaObjref::put(), YACS::ENGINE::NeutralCorbaStruct::put(), YACS::ENGINE::NeutralCpp::put(), YACS::ENGINE::NeutralInit::put(), YACS::ENGINE::NeutralXml::put(), YACS::ENGINE::InputStudyPort::putDataInStudy(), YACS::ENGINE::OutputStudyPort::putIOR(), YACS::ENGINE::DynParaLoop::putValueOnBranch(), YACS::HMI::SubjectDataPort::registerUndoDestroy(), YACS::HMI::SchemaInPortItem::SchemaInPortItem(), YACS::HMI::SchemaOutPortItem::SchemaOutPortItem(), YACS::ENGINE::Proc::setInPortValue(), YACS::HMI::EditionOptimizerLoop::update(), YACS::HMI::SchemaInPortItem::update(), YACS::HMI::SchemaOutPortItem::update(), YACS::ENGINE::VisitorSaveSchema::visitForEachLoop(), and YACS::ENGINE::VisitorSaveSchema::visitForEachLoopDyn().

edRemoveAllLinksLinkedWithMe()

virtual void YACS::ENGINE::DataPort::edRemoveAllLinksLinkedWithMe ( )

pure virtual

Implemented in YACS::ENGINE::CollectorSwOutPort, YACS::ENGINE::OutputPort, YACS::ENGINE::OutputDataStreamPort, YACS::ENGINE::ProxyPort, and YACS::ENGINE::InPort.

edSetType()

void DataPort::edSetType

(

TypeCode *

type

)

Definition at line 47 of file DataPort.cxx.

{
  if(_type)
    _type->decrRef();
  _type=type;
  if(_type)
    _type->incrRef();
}

References _type, YACS::ENGINE::RefCounter::decrRef(), and YACS::ENGINE::RefCounter::incrRef().

Referenced by YACS::ENGINE::Switch::buildDelegateOf(), and YACS::ENGINE::OptimizerLoop::setAlgorithm().

getAsString()

std::string DataPort::getAsString ( )

virtual

returns port value as a string that can be used in a GUI for example

Do nothing here. To subclass

Reimplemented in YACS::ENGINE::InputStudyPort, YACS::ENGINE::OutputStudyPort, YACS::ENGINE::OutputPyPort, YACS::ENGINE::InputPyPort, YACS::ENGINE::InputPresetPort, YACS::ENGINE::OutputPresetPort, YACS::ENGINE::OutputCorbaPort, YACS::ENGINE::InputCorbaPort, YACS::ENGINE::ConditionInputPort, YACS::ENGINE::AnyOutputPort, and YACS::ENGINE::AnyInputPort.

Definition at line 84 of file DataPort.cxx.

{
  return "";
}

Referenced by YACS::ENGINE::Proc::getInPortValue(), YACS::ENGINE::Proc::getOutPortValue(), YACS::HMI::SubjectForLoop::getValue(), YACS::HMI::SubjectWhileLoop::getValue(), YACS::HMI::SubjectSwitch::getValue(), YACS::HMI::SubjectDynParaLoop::getValue(), YACS::HMI::CommandSetInPortValue::localExecute(), YACS::HMI::CommandSetSwitchSelect::localExecute(), YACS::HMI::CommandSetForLoopSteps::localExecute(), YACS::HMI::CommandSetWhileCondition::localExecute(), YACS::HMI::CommandSetForEachBranch::localExecute(), YACS::HMI::CommandSetInPortValue::localReverse(), YACS::HMI::SchemaInPortItem::SchemaInPortItem(), YACS::HMI::SchemaOutPortItem::SchemaOutPortItem(), YACSPMMLBasicsTest1::testYACSdriver_LRANN(), YACSPMMLBasicsTest1::testYACSdriver_PmmlDoesNotExist(), YACSPMMLBasicsTest1::testYACSdriverLinearRegression(), YACSPMMLBasicsTest1::testYACSdriverNeuralNetwork(), YACS::HMI::EditionForEachLoop::update(), YACS::HMI::EditionOptimizerLoop::update(), YACS::HMI::SchemaInPortItem::update(), and YACS::HMI::SchemaOutPortItem::update().

getName()

std::string YACS::ENGINE::DataPort::getName ( ) const

inline

Definition at line 55 of file DataPort.hxx.

{ return _name; }

Referenced by YACS::ENGINE::RuntimeSALOME::adaptCorbaToCorba(), YACS::ENGINE::RuntimeSALOME::adaptCorbaToCpp(), YACS::ENGINE::RuntimeSALOME::adaptCorbaToNeutral(), YACS::ENGINE::RuntimeSALOME::adaptCorbaToPython(), YACS::ENGINE::RuntimeSALOME::adaptCorbaToXml(), YACS::ENGINE::RuntimeSALOME::adaptCppToCorba(), YACS::ENGINE::RuntimeSALOME::adaptCppToCpp(), YACS::ENGINE::RuntimeSALOME::adaptCppToNeutral(), YACS::ENGINE::RuntimeSALOME::adaptCppToPython(), YACS::ENGINE::RuntimeSALOME::adaptCppToXml(), YACS::ENGINE::RuntimeSALOME::adaptNeutralToCorba(), YACS::ENGINE::RuntimeSALOME::adaptNeutralToCpp(), YACS::ENGINE::RuntimeSALOME::adaptNeutralToPython(), YACS::ENGINE::RuntimeSALOME::adaptNeutralToXml(), YACS::ENGINE::RuntimeSALOME::adaptPythonToCorba(), YACS::ENGINE::RuntimeSALOME::adaptPythonToCpp(), YACS::ENGINE::RuntimeSALOME::adaptPythonToNeutral(), YACS::ENGINE::RuntimeSALOME::adaptPythonToPython(), YACS::ENGINE::RuntimeSALOME::adaptPythonToXml(), YACS::ENGINE::RuntimeSALOME::adaptXmlToCorba(), YACS::ENGINE::RuntimeSALOME::adaptXmlToCpp(), YACS::ENGINE::RuntimeSALOME::adaptXmlToPython(), YACS::ENGINE::RuntimeSALOME::adaptXmlToXml(), YACS::ENGINE::CollectorSwOutPort::addPotentialProducerForMaster(), YACS::HMI::SubjectNode::addSubjectIDSPort(), YACS::HMI::SubjectNode::addSubjectInputPort(), YACS::HMI::SubjectNode::addSubjectODSPort(), YACS::HMI::SubjectNode::addSubjectOutputPort(), YACS::ENGINE::Loop::buildDelegateOf(), YACS::ENGINE::OptimizerLoop::buildDelegateOf(), YACS::ENGINE::DynParaLoop::buildDelegateOf(), YACS::ENGINE::OutputPresetPort::checkBasicConsistency(), YACS::ENGINE::ForEachLoopPassedData::checkLevel2(), YACS::ENGINE::DynParaLoop::checkLinkPossibility(), YACS::ENGINE::OptimizerLoop::checkLinkPossibility(), YACS::ENGINE::DynParaLoop::cloneAndPlaceNodesCoherently(), YACS::ENGINE::CollectorSwOutPort::CollectorSwOutPort(), YACS::ENGINE::ElementaryNode::createMultiDatastreamPorts(), YACS::ENGINE::ForEachLoopGen::createOutputOutOfScopeInterceptors(), YACS::ENGINE::ComposedNode::edAddDFLink(), YACS::ENGINE::ComposedNode::edRemoveLink(), YACS::ENGINE::Loop::getDelegateOf(), YACS::ENGINE::Switch::getDelegateOf(), YACS::ENGINE::CollectorSwOutPort::getHumanReprOfIncompleteCases(), YACS::ENGINE::ElementaryNode::getInPortName(), YACS::HMI::SubjectDataPort::getName(), YACS::ENGINE::ElementaryNode::getOutPortName(), YACS::HMI::SubjectComposedNode::loadLinks(), YACS::HMI::CommandOrderInputPorts::localExecute(), YACS::HMI::CommandOrderOutputPorts::localExecute(), YACS::HMI::CommandOrderInputPorts::localReverse(), YACS::HMI::CommandOrderOutputPorts::localReverse(), YACS::ENGINE::CorbaCpp::put(), YACS::ENGINE::CorbaNeutral::put(), YACS::ENGINE::CppXml::put(), YACS::ENGINE::InputStudyPort::putDataInStudy(), YACS::HMI::SubjectLink::registerUndoDestroy(), YACS::ENGINE::Loop::releaseDelegateOf(), YACS::HMI::SubjectComposedNode::removeLink(), YACS::HMI::SubjectNode::saveLinks(), YACS::HMI::GuiExecutor::setInPortValue(), YACS::HMI::SubjectDataPort::setName(), YACS::HMI::SubjectInputPort::SubjectInputPort(), YACS::ENGINE::VisitorSaveSchema::writeSimpleDataLinks(), YACS::ENGINE::VisitorSaveSchema::writeSimpleStreamLinks(), and YACS::ENGINE::OutputCorbaPort::~OutputCorbaPort().

getNameOfTypeOfCurrentInstance()

string DataPort::getNameOfTypeOfCurrentInstance ( ) const

virtual

Reimplemented from YACS::ENGINE::Port.

Reimplemented in YACS::ENGINE::OutputCalStreamPort, YACS::ENGINE::InputCalStreamPort, YACS::ENGINE::CollectorSwOutPort, YACS::ENGINE::OutputPort, YACS::ENGINE::OutputDataStreamPort, YACS::ENGINE::InputPort, YACS::ENGINE::InputDataStreamPort, YACS::ENGINE::InPropertyPort, and YACS::ENGINE::DataStreamPort.

Definition at line 56 of file DataPort.cxx.

{
  return NAME;
}

References NAME.

Referenced by YACS::ENGINE::OutputDataStreamPort::addInPort(), YACS::ENGINE::OutputPort::addInPort(), YACS::ENGINE::OutputCalStreamPort::addInPort(), YACS::ENGINE::CollectorSwOutPort::addPotentialProducerForMaster(), YACS::ENGINE::DynParaLoop::buildDelegateOf(), YACS::ENGINE::Loop::buildDelegateOf(), YACS::ENGINE::Loop::getDelegateOf(), YACS::ENGINE::Loop::releaseDelegateOf(), YACS::ENGINE::ForEachLoopGen::releaseDelegateOf(), YACS::ENGINE::OutputDataStreamPort::removeInPort(), YACS::ENGINE::OutputPort::removeInPort(), and YACS::ENGINE::OutputCalStreamPort::removeInPort().

getTypeOfChannel()

virtual TypeOfChannel YACS::ENGINE::DataPort::getTypeOfChannel ( ) const

pure virtual

returns type of channel the port will use for data exchange on runtime : DATAFLOW or DATASTREAM.

Implemented in YACS::ENGINE::CollectorSwOutPort, YACS::ENGINE::DataStreamPort, and YACS::ENGINE::DataFlowPort.

Referenced by isDifferentTypeOf().

isCrossingType()

DataPort * DataPort::isCrossingType ( const std::vector< DataPort * > &  historyOfLink )

static

If in historyOfLink different type of Port are detected : The first one (by starting from the end of 'historyOfLink') is returned. Else 0 is returned if they are all of the same type.

Definition at line 70 of file DataPort.cxx.

{
  vector<DataPort *>::const_reverse_iterator iter=historyOfLink.rbegin()+1;
  const DataPort *base=historyOfLink.back();
  for(;iter!=historyOfLink.rend();iter++)
    if(base->isDifferentTypeOf(*iter))
      return *iter;
  return 0;
}

References isDifferentTypeOf().

isDifferentTypeOf()

bool DataPort::isDifferentTypeOf

(

const DataPort *

other

)

const

Definition at line 61 of file DataPort.cxx.

{
  return getTypeOfChannel()!=other->getTypeOfChannel();
}

References getTypeOfChannel().

Referenced by isCrossingType().

setName()

void YACS::ENGINE::DataPort::setName ( std::string  theName )

inline

Definition at line 56 of file DataPort.hxx.

{ _name = theName; }

Referenced by YACS::ENGINE::ElementaryNode::createMultiDatastreamPorts(), YACS::HMI::CommandRenameInDataPort::localExecute(), YACS::HMI::CommandRenameOutDataPort::localExecute(), YACS::HMI::CommandRenameInDataPort::localReverse(), and YACS::HMI::CommandRenameOutDataPort::localReverse().

typeName()

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

inlinevirtual

Reimplemented from YACS::ENGINE::Port.

Reimplemented in YACS::ENGINE::InputStudyPort, YACS::ENGINE::OutputStudyPort, YACS::ENGINE::OutputPyPort, YACS::ENGINE::InputPyPort, YACS::ENGINE::InputPresetPort, YACS::ENGINE::OutputPresetPort, YACS::ENGINE::OutputCorbaPort, YACS::ENGINE::InputCorbaPort, YACS::ENGINE::OutputPort, YACS::ENGINE::OutputDataStreamPort, YACS::ENGINE::OutPort, YACS::ENGINE::ProxyPort, YACS::ENGINE::InputPort, YACS::ENGINE::InputDataStreamPort, YACS::ENGINE::InPropertyPort, YACS::ENGINE::InPort, YACS::ENGINE::DataStreamPort, YACS::ENGINE::DataFlowPort, YACS::ENGINE::ConditionInputPort, YACS::ENGINE::AnyOutputPort, and YACS::ENGINE::AnyInputPort.

Definition at line 62 of file DataPort.hxx.

{return "YACS__ENGINE__DataPort";}

Member Data Documentation

_name

std::string YACS::ENGINE::DataPort::_name

protected

Definition at line 45 of file DataPort.hxx.

Referenced by YACS::ENGINE::InputPort::checkBasicConsistency(), YACS::ENGINE::CollectorSwOutPort::CollectorSwOutPort(), YACS::ENGINE::AnyInputPort::dump(), and YACS::ENGINE::InputPort4DF2DS::get().

_type

TypeCode* YACS::ENGINE::DataPort::_type

protected

Definition at line 44 of file DataPort.hxx.

Referenced by DataPort(), YACS::ENGINE::InputPort::edInit(), edSetType(), and YACS::ENGINE::SeqAnyInputPort::SeqAnyInputPort().

NAME

const char DataPort::NAME ="DataPort"

static

Definition at line 47 of file DataPort.hxx.

Referenced by getNameOfTypeOfCurrentInstance().

---

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

• src/engine/DataPort.hxx
• src/engine/DataPort.cxx