Class for Python Ports. More...

#include <PythonPorts.hxx>

Inheritance diagram for YACS::ENGINE::InputPyPort:

[legend]

Collaboration diagram for YACS::ENGINE::InputPyPort:

[legend]

Public Member Functions
	InputPyPort (const std::string &name, Node node, TypeCode type)

	InputPyPort (const InputPyPort &other, Node *newHelder)

	~InputPyPort ()

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

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

virtual void	put (const void *data)

void	releaseData () override

void	put (PyObject *data)

InputPort *	clone (Node *newHelder) const

virtual PyObj *	getPyObj () const

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

void *	get () const

virtual std::string	getHumanRepr ()

virtual bool	isEmpty ()

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

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

virtual std::string	dump ()

virtual std::string	typeName ()

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::InputPort
virtual	~InputPort ()

std::string	getNameOfTypeOfCurrentInstance () const

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

virtual bool	isIntermediate () const

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

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
PyObject *	_data

PyObject *	_initData

bool	_isEmpty

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

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

Class for Python Ports.

See also: PythonNode

Definition at line 73 of file PythonPorts.hxx.

Constructor & Destructor Documentation

◆ InputPyPort() [1/2]

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

Definition at line 84 of file PythonPorts.cxx.

   : InputPort(name, node, type)
   , DataPort(name, node, type)
   , Port(node)
   , _data(Py_None)
   ,_initData(nullptr)
   ,_isEmpty(true)
 {
   Py_INCREF(_data);
 }

References _data.

Referenced by clone().

◆ InputPyPort() [2/2]

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

Definition at line 106 of file PythonPorts.cxx.

                                                                  :InputPort(other,newHelder),DataPort(other,newHelder),Port(other,newHelder)
 {
   _initData=other._initData;
   Py_XINCREF(_initData);
   _data=other._data;
   Py_INCREF(_data);
   _isEmpty=other._isEmpty;
 }

References _data, _initData, and _isEmpty.

◆ ~InputPyPort()

InputPyPort::~InputPyPort ( )

Definition at line 94 of file PythonPorts.cxx.

 {
   PyGILState_STATE gstate = PyGILState_Ensure();
   DEBTRACE( "_data refcnt: " << (_data ? _data->ob_refcnt : -1) );
   DEBTRACE( "_initData refcnt: " << (_initData ? _initData->ob_refcnt : -1));
   // Release or not release : all GenericObj are deleted when the input port is deleted
   releasePyObj(_data);
   Py_XDECREF(_data); 
   Py_XDECREF(_initData); 
   PyGILState_Release(gstate);
 }

References _data, _initData, DEBTRACE, and releasePyObj().

Member Function Documentation

◆ clone()

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

virtual

Implements YACS::ENGINE::InputPort.

Definition at line 161 of file PythonPorts.cxx.

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

References InputPyPort().

◆ dump()

std::string InputPyPort::dump ( )

virtual

Reimplemented from YACS::ENGINE::InputPort.

Definition at line 238 of file PythonPorts.cxx.

 {
   if( _isEmpty)
     return "<value>None</value>";
  
   InterpreterUnlocker l;
   return convertPyObjectXml(edGetType(), _data);
 }

References _data, _isEmpty, YACS::ENGINE::convertPyObjectXml(), YACS::ENGINE::DataPort::edGetType(), and testCppPluginInvokation::l.

Referenced by getHumanRepr().

◆ edIsManuallyInitialized()

bool InputPyPort::edIsManuallyInitialized ( ) const

virtual

Specifies if this port has been manually set by the call of InputPort::edInit.

Reimplemented from YACS::ENGINE::InputPort.

Definition at line 115 of file PythonPorts.cxx.

 {
   return _initData!=nullptr;
 }

References _initData.

◆ edRemoveManInit()

void InputPyPort::edRemoveManInit ( )

virtual

Removes eventually previous manual initialisation.

Reimplemented from YACS::ENGINE::InputPort.

Definition at line 120 of file PythonPorts.cxx.

 {
   Py_XDECREF(_initData);
   _initData=nullptr;
   Py_XDECREF(_data);
   _data=Py_None;
   Py_INCREF(_data);
   _isEmpty=true;
   InputPort::edRemoveManInit();
 }

References _data, _initData, _isEmpty, and YACS::ENGINE::InputPort::edRemoveManInit().

◆ exRestoreInit()

void InputPyPort::exRestoreInit ( )

virtual

Restore the saved data value to current data value.

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

Implements YACS::ENGINE::InputPort.

Definition at line 227 of file PythonPorts.cxx.

 {
   if(!_initData)return;
   Py_XDECREF(_data); 
   _data=_initData;
   Py_XINCREF(_data);
   _isEmpty = false;
   DEBTRACE( "_initData.ob refcnt: " << _initData->ob_refcnt );
   DEBTRACE( "_data.ob refcnt: " << _data->ob_refcnt );
 }

References _data, _initData, _isEmpty, and DEBTRACE.

◆ exSaveInit()

void InputPyPort::exSaveInit ( )

virtual

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

Implements YACS::ENGINE::InputPort.

Definition at line 211 of file PythonPorts.cxx.

 {
   // Interpreter lock seems necessary when deleting lists in Python 2.7
   PyGILState_STATE gstate = PyGILState_Ensure();
   Py_XDECREF(_initData);
   _initData=_data;
   Py_INCREF(_initData); 
   PyGILState_Release(gstate);
   DEBTRACE( "_initData.ob refcnt: " << (_initData ? _initData->ob_refcnt : -1));
   DEBTRACE( "_data.ob refcnt: " << _data->ob_refcnt );
 }

References _data, _initData, and DEBTRACE.

◆ get()

void * InputPyPort::get ( ) const

virtual

Implements YACS::ENGINE::InputPort.

Definition at line 171 of file PythonPorts.cxx.

 {
   return (void*) _data;
 }

References _data.

◆ getAsString()

std::string InputPyPort::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 176 of file PythonPorts.cxx.

 {
   std::string ret;
   //protect _data against modification or delete in another thread
   PyObject* data=_data;
   Py_INCREF(data);
   ret = convertPyObjectToString(data);
   Py_XDECREF(data);
   return ret;
 }

References _data, and YACS::ENGINE::convertPyObjectToString().

◆ getHumanRepr()

std::string InputPyPort::getHumanRepr ( )

virtual

Reimplemented from YACS::ENGINE::InputPort.

Definition at line 187 of file PythonPorts.cxx.

 {
   if(!_data)
     return dump();
   PyObject *ret(PyObject_Str(_data));
   if(!ret)
     return dump();
   std::string retCpp;
   char *val(PyBytes_AsString(ret));
   if(val)
     retCpp=val;
   Py_XDECREF(ret);
   return retCpp;
 }

References _data, and dump().

◆ getPyObj()

PyObject * InputPyPort::getPyObj ( ) const

virtual

Definition at line 166 of file PythonPorts.cxx.

 {
   return _data;
 }

References _data.

Referenced by valToStr().

◆ isEmpty()

bool InputPyPort::isEmpty ( )

virtual

Reimplemented from YACS::ENGINE::InputPort.

Definition at line 202 of file PythonPorts.cxx.

 {
   return _isEmpty;
 }

References _isEmpty.

◆ put() [1/2]

void InputPyPort::put ( const void * data )

virtual

Implements YACS::ENGINE::InputPort.

Definition at line 131 of file PythonPorts.cxx.

 {
   put((PyObject *)data);
 }

Referenced by YACS::ENGINE::PythonNode::squeezeMemory(), and YACS::ENGINE::PythonNode::squeezeMemoryRemote().

◆ put() [2/2]

void InputPyPort::put ( PyObject * data )

Definition at line 149 of file PythonPorts.cxx.

 {
   InterpreterUnlocker l;
   InputPyPort::releaseDataUnsafe();
   _data = data;
   _stringRef="";
   Py_INCREF(_data); 
   registerPyObj(_data);
   _isEmpty=false;
   DEBTRACE( "_data refcnt: " << _data->ob_refcnt );
 }

References _data, _isEmpty, YACS::ENGINE::InputPort::_stringRef, DEBTRACE, testCppPluginInvokation::l, registerPyObj(), and releaseDataUnsafe().

◆ releaseData()

void InputPyPort::releaseData ( )

overridevirtual

Implements YACS::ENGINE::InputPort.

Definition at line 143 of file PythonPorts.cxx.

 {
   InterpreterUnlocker l;
   InputPyPort::releaseDataUnsafe();
 }

References testCppPluginInvokation::l, and releaseDataUnsafe().

◆ releaseDataUnsafe()

void InputPyPort::releaseDataUnsafe ( )

protected

Definition at line 136 of file PythonPorts.cxx.

 {
   releasePyObj(_data);
   Py_XDECREF(_data); 
   _data = nullptr;
 }

References _data, and releasePyObj().

Referenced by put(), and releaseData().

◆ typeName()

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

inlinevirtual

Reimplemented from YACS::ENGINE::InputPort.

Definition at line 94 of file PythonPorts.hxx.

94 {return "YACS__ENGINE__InputPyPort";}

◆ valFromStr()

void InputPyPort::valFromStr ( std::string valstr )

virtual

Allows to set data from a string representation used in user interface.

Implemented in derived classes, depending on runtime, to set the data from its user interface representation. Typical use, a Python string representation that can be used in edition or restitution.

Reimplemented from YACS::ENGINE::DataFlowPort.

Definition at line 261 of file PythonPorts.cxx.

262 {

263 }

◆ valToStr()

std::string InputPyPort::valToStr ( )

virtual

Gives a string representation of the data, for user interfaces.

Implemented in derived classes, depending on runtime, to provide the data representation for user interfaces. Typical use, a Python string representation that can be used in edition or restitution.

Reimplemented from YACS::ENGINE::DataFlowPort.

Definition at line 247 of file PythonPorts.cxx.

 {
   int isString = PyBytes_Check(getPyObj());
   //DEBTRACE("isString=" << isString);
   PyObject *strPyObj = PyObject_Str(getPyObj());
   //DEBTRACE(PyString_Size(strPyObj));
   string val = PyBytes_AsString(strPyObj);
   if (isString)
     val = "\"" + val + "\"";
   //DEBTRACE(val);
   Py_DECREF(strPyObj);
   return val;
 }

References getPyObj().

Member Data Documentation

◆ _data

PyObject* YACS::ENGINE::InputPyPort::_data

protected

Definition at line 100 of file PythonPorts.hxx.

Referenced by dump(), edRemoveManInit(), exRestoreInit(), exSaveInit(), get(), getAsString(), getHumanRepr(), getPyObj(), InputPyPort(), put(), releaseDataUnsafe(), and ~InputPyPort().

◆ _initData

PyObject* YACS::ENGINE::InputPyPort::_initData

protected

Definition at line 101 of file PythonPorts.hxx.

Referenced by edIsManuallyInitialized(), edRemoveManInit(), exRestoreInit(), exSaveInit(), InputPyPort(), and ~InputPyPort().

◆ _isEmpty

bool YACS::ENGINE::InputPyPort::_isEmpty

protected

Definition at line 102 of file PythonPorts.hxx.

Referenced by dump(), edRemoveManInit(), exRestoreInit(), InputPyPort(), isEmpty(), and put().

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

src/runtime/PythonPorts.hxx
src/runtime/PythonPorts.cxx

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ InputPyPort() [1/2]

◆ InputPyPort() [2/2]

◆ ~InputPyPort()

Member Function Documentation

◆ clone()

◆ dump()

◆ edIsManuallyInitialized()

◆ edRemoveManInit()

◆ exRestoreInit()

◆ exSaveInit()

◆ get()

◆ getAsString()

◆ getHumanRepr()

◆ getPyObj()

◆ isEmpty()

◆ put() [1/2]

◆ put() [2/2]

◆ releaseData()

◆ releaseDataUnsafe()

◆ typeName()

◆ valFromStr()

◆ valToStr()

Member Data Documentation

◆ _data

◆ _initData

◆ _isEmpty