#include <AnyInputPort.hxx>

Inheritance diagram for YACS::ENGINE::AnyInputPort:

[legend]

Collaboration diagram for YACS::ENGINE::AnyInputPort:

[legend]

Public Member Functions
	AnyInputPort (const std::string &name, Node node, TypeCode type, bool canBeNull=false)

	AnyInputPort (const AnyInputPort &other, Node *newHelder)

virtual	~AnyInputPort ()

void	exSaveInit ()
	Save the current data value for further reinitialization of the port. More...

void	exRestoreInit ()
	Restore the saved data value to current data value. More...

Any *	getValue () const

int	getIntValue () const

void	releaseData () override

void	put (Any *data)

void *	get () const

virtual std::string	getAsString ()
	returns port value as a string that can be used in a GUI for example More...

virtual bool	isEmpty ()

void	put (const void *data)

InputPort *	clone (Node *newHelder) const

std::string	dump ()

virtual std::string	typeName ()

Public Member Functions inherited from YACS::ENGINE::InputPort
virtual	~InputPort ()

std::string	getNameOfTypeOfCurrentInstance () const

virtual InputPort *	getPublicRepresentant ()
	returns the final physical port behind 'this'. More...

virtual bool	isIntermediate () const

virtual bool	edIsManuallyInitialized () const
	Specifies if this port has been manually set by the call of InputPort::edInit. More...

bool	edIsInitialized () const
	soon deprecated More...

template<class T >
void	edInit (T value)

void	edInit (Any *value)

void	edInit (const std::string &impl, const void *value)
	Initialize the port with an object (value) coming from a world with implementation impl. More...

virtual void	edRemoveManInit ()
	Removes eventually previous manual initialisation. More...

virtual void	checkBasicConsistency () const
	Check basically that this port has one chance to be specified on time. It's a necessary condition not sufficient at all. More...

virtual void	exInit (bool start)

virtual std::string	getHumanRepr ()

virtual void	setStringRef (std::string strRef)

bool	canBeNull () const

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

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::InPort
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 ()

Protected Member Functions
void	releaseDataUnsafe ()

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

	InputPort (const std::string &name, Node node, TypeCode type, bool canBeNull=false)

void	releaseDataUnsafe ()

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::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

Protected Attributes
Any *	_value

Protected Attributes inherited from YACS::ENGINE::InputPort
Any *	_initValue

std::string	_stringRef

bool	_canBeNull

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 Attributes
YACS::BASES::Mutex	_mutex

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

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

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"

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

static const char	NAME [] ="Port"

Detailed Description

Definition at line 33 of file AnyInputPort.hxx.

Constructor & Destructor Documentation

◆ AnyInputPort() [1/2]

AnyInputPort::AnyInputPort	(	const std::string &	name,
		Node *	node,
		TypeCode *	type,
		bool	canBeNull = `false`
	)

Definition at line 35 of file AnyInputPort.cxx.

   : InputPort(name, node, type, canBeNull),
     DataPort(name, node, type),
     Port(node),
     _value(0)
 {
 }

Referenced by clone().

◆ AnyInputPort() [2/2]

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

Definition at line 43 of file AnyInputPort.cxx.

   : InputPort(other, newHelder),
     DataPort(other, newHelder),
     Port(other, newHelder),
     _value(0)
 {
   if(other._value)
     _value=other._value->clone();
 }

References _value, and YACS::ENGINE::Any::clone().

◆ ~AnyInputPort()

AnyInputPort::~AnyInputPort ( )

virtual

Definition at line 53 of file AnyInputPort.cxx.

 {
   if(_value)
     {
       DEBTRACE("_value ref count: " << _value->getRefCnt());
       _value->decrRef();
     }
 }

References _value, DEBTRACE, YACS::ENGINE::RefCounter::decrRef(), and YACS::ENGINE::RefCounter::getRefCnt().

Member Function Documentation

◆ clone()

InputPort * AnyInputPort::clone ( Node * newHelder ) const

virtual

Implements YACS::ENGINE::InputPort.

Reimplemented in YACS::ENGINE::SeqAnyInputPort, and YACS::ENGINE::InterceptorInputPort.

Definition at line 133 of file AnyInputPort.cxx.

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

References AnyInputPort().

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

◆ dump()

std::string AnyInputPort::dump ( )

virtual

Reimplemented from YACS::ENGINE::InputPort.

Reimplemented in YACS::ENGINE::SeqAnyInputPort.

Definition at line 138 of file AnyInputPort.cxx.

 {
   if(!_value)
     {
       std::string what="AnyInputPort::get : no value currently in input port with name \""; what+=_name; what+="\"";
       throw Exception(what);
     }
   stringstream xmldump;
   switch (_value->getType()->kind())
     {
     case Double:
       xmldump << "<value><double>" << setprecision(16) << _value->getDoubleValue() << "</double></value>" << endl;
       break;
     case Int:
       xmldump << "<value><int>" << _value->getIntValue() << "</int></value>" << endl;
       break;
     case Bool:
       xmldump << "<value><boolean>" << _value->getBoolValue() << "</boolean></value>" << endl;
       break;
     case String:
       xmldump << "<value><string>" << _value->getStringValue() << "</string></value>" << endl;
       break;
     default:
       xmldump << "<value><error> NO_SERIALISATION_AVAILABLE </error></value>" << endl;
       break;
     }
   return xmldump.str();
 }

References YACS::ENGINE::DataPort::_name, _value, YACS::ENGINE::Bool, YACS::ENGINE::Double, YACS::ENGINE::Any::getBoolValue(), YACS::ENGINE::Any::getDoubleValue(), YACS::ENGINE::Any::getIntValue(), YACS::ENGINE::Any::getStringValue(), YACS::ENGINE::Any::getType(), YACS::ENGINE::Int, YACS::ENGINE::TypeCode::kind(), and YACS::ENGINE::String.

◆ exRestoreInit()

void AnyInputPort::exRestoreInit ( )

virtual

Restore the saved data value to current data value.

If no data has been saved (_initValue == 0) don't restore

Implements YACS::ENGINE::InputPort.

Definition at line 77 of file AnyInputPort.cxx.

 {
   if(!_initValue)
     return;
   if(_value)
     _value->decrRef();
   _value=_initValue;
   _value->incrRef();
 }

References YACS::ENGINE::InputPort::_initValue, _value, YACS::ENGINE::RefCounter::decrRef(), and YACS::ENGINE::RefCounter::incrRef().

◆ exSaveInit()

void AnyInputPort::exSaveInit ( )

virtual

Save the current data value for further reinitialization of the port.

Implements YACS::ENGINE::InputPort.

Definition at line 66 of file AnyInputPort.cxx.

 {
   if(_initValue) _initValue->decrRef();
   _initValue=_value;
   _initValue->incrRef();
 }

References YACS::ENGINE::InputPort::_initValue, _value, YACS::ENGINE::RefCounter::decrRef(), and YACS::ENGINE::RefCounter::incrRef().

◆ get()

void * AnyInputPort::get ( ) const

virtual

Implements YACS::ENGINE::InputPort.

Definition at line 117 of file AnyInputPort.cxx.

 {
   return (void *)_value;
 }

References _value.

◆ getAsString()

std::string AnyInputPort::getAsString ( )

virtual

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

Do nothing here. To subclass

Reimplemented from YACS::ENGINE::DataPort.

Definition at line 122 of file AnyInputPort.cxx.

 {
   YACS::BASES::AutoLocker<YACS::BASES::Mutex> lock(&_mutex);
   return getRuntime()->convertNeutralAsString(edGetType(),_value);
 }

References _mutex, _value, YACS::ENGINE::Runtime::convertNeutralAsString(), YACS::ENGINE::DataPort::edGetType(), and YACS::ENGINE::getRuntime().

◆ getIntValue()

int YACS::ENGINE::AnyInputPort::getIntValue ( ) const

inline

Definition at line 42 of file AnyInputPort.hxx.

42 { return _value ? _value->getIntValue():0; }

Referenced by YACS::ENGINE::ForLoop::exUpdateState(), YACS::ENGINE::Switch::exUpdateState(), YACS::ENGINE::ForLoop::getNbSteps(), YACS::ENGINE::Switch::getReadyTasks(), YACS::ENGINE::NbBranches::isMultiplicitySpecified(), YACS::ENGINE::ForLoop::updateStateOnFinishedEventFrom(), YACS::ENGINE::VisitorSaveSchema::visitForEachLoop(), YACS::ENGINE::VisitorSaveSchema::visitForLoop(), YACS::ENGINE::VisitorSaveSchema::visitOptimizerLoop(), and YACS::ENGINE::VisitorSaveSchema::visitSwitch().

◆ getValue()

Any* YACS::ENGINE::AnyInputPort::getValue ( ) const

inline

Definition at line 41 of file AnyInputPort.hxx.

41 { return _value; }

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

◆ isEmpty()

bool AnyInputPort::isEmpty ( )

virtual

Reimplemented from YACS::ENGINE::InputPort.

Definition at line 112 of file AnyInputPort.cxx.

 {
   return !_value;
 }

References _value.

Referenced by YACS::ENGINE::ForLoop::exUpdateState(), YACS::ENGINE::Switch::exUpdateState(), YACS::ENGINE::ForLoop::getNbSteps(), YACS::ENGINE::VisitorSaveSchema::visitForEachLoop(), YACS::ENGINE::VisitorSaveSchema::visitForLoop(), YACS::ENGINE::VisitorSaveSchema::visitOptimizerLoop(), and YACS::ENGINE::VisitorSaveSchema::visitSwitch().

◆ put() [1/2]

void AnyInputPort::put ( Any * data )

Definition at line 100 of file AnyInputPort.cxx.

 {
   YACS::BASES::AutoLocker<YACS::BASES::Mutex> lock(&_mutex);
   releaseDataUnsafe();
   _value=data;
   if (_value)
     {
       _value->incrRef();
       DEBTRACE("value ref count: " << _value->getRefCnt());
     }
 }

References _mutex, _value, DEBTRACE, YACS::ENGINE::RefCounter::getRefCnt(), YACS::ENGINE::RefCounter::incrRef(), and releaseDataUnsafe().

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

◆ put() [2/2]

void AnyInputPort::put ( const void * data )

virtual

Implements YACS::ENGINE::InputPort.

Definition at line 128 of file AnyInputPort.cxx.

 {
   put((Any *)data);
 }

References put().

◆ releaseData()

void AnyInputPort::releaseData ( )

overridevirtual

Implements YACS::ENGINE::InputPort.

Definition at line 94 of file AnyInputPort.cxx.

 {
   YACS::BASES::AutoLocker<YACS::BASES::Mutex> lock(&_mutex);
   releaseDataUnsafe();
 }

References _mutex, and releaseDataUnsafe().

◆ releaseDataUnsafe()

void AnyInputPort::releaseDataUnsafe ( )

protected

Definition at line 87 of file AnyInputPort.cxx.

 {
   if(_value)
     _value->decrRef();
   _value = nullptr;
 }

References _value, and YACS::ENGINE::RefCounter::decrRef().

Referenced by put(), and releaseData().

◆ typeName()

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

inlinevirtual

Reimplemented from YACS::ENGINE::InputPort.

Definition at line 51 of file AnyInputPort.hxx.

51 {return "YACS__ENGINE__AnyInputPort";}

Member Data Documentation

◆ _mutex

YACS::BASES::Mutex YACS::ENGINE::AnyInputPort::_mutex

private

Definition at line 57 of file AnyInputPort.hxx.

Referenced by getAsString(), put(), and releaseData().

◆ _value

Any* YACS::ENGINE::AnyInputPort::_value

protected

Definition at line 55 of file AnyInputPort.hxx.

Referenced by AnyInputPort(), dump(), exRestoreInit(), exSaveInit(), get(), getAsString(), YACS::ENGINE::SeqAnyInputPort::getNumberOfElements(), YACS::ENGINE::SeqAnyInputPort::getValueAtRank(), isEmpty(), put(), releaseDataUnsafe(), and ~AnyInputPort().

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

src/engine/AnyInputPort.hxx
src/engine/AnyInputPort.cxx

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AnyInputPort() [1/2]

◆ AnyInputPort() [2/2]

◆ ~AnyInputPort()

Member Function Documentation

◆ clone()

◆ dump()

◆ exRestoreInit()

◆ exSaveInit()

◆ get()

◆ getAsString()

◆ getIntValue()

◆ getValue()

◆ isEmpty()

◆ put() [1/2]

◆ put() [2/2]

◆ releaseData()

◆ releaseDataUnsafe()

◆ typeName()

Member Data Documentation

◆ _mutex

◆ _value