Class for Python Ports. More...

#include <PythonPorts.hxx>

Inheritance diagram for YACS::ENGINE::InputPyPort:

Collaboration diagram for YACS::ENGINE::InputPyPort:

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

void	put (PyObject *data) throw (ConversionException)

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

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 throw (Exception)
	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...

virtual	~InPort ()

Protected Attributes
PyObject *	_data

PyObject *	_initData

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

std::string	_stringRef

bool	_canBeNull

Protected Attributes inherited from YACS::ENGINE::InPort
std::set< OutPort * >	_backLinks

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

std::string	_name

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

int	_id

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"

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)

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::InputPyPort	(	const std::string &	name,
		Node *	node,
		TypeCode *	type
	)

Definition at line 108 of file PythonPorts.cxx.

References _data, and _initData.

Referenced by clone().

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

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

Definition at line 126 of file PythonPorts.cxx.

References _data, and _initData.

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

InputPyPort::~InputPyPort ( )

Definition at line 114 of file PythonPorts.cxx.

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

 {
   PyGILState_STATE gstate = PyGILState_Ensure();
   DEBTRACE( "_data refcnt: " << _data->ob_refcnt );
   DEBTRACE( "_initData refcnt: " << _initData->ob_refcnt );
   // 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);
 }

Member Function Documentation

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

virtual

Implements YACS::ENGINE::InputPort.

Definition at line 167 of file PythonPorts.cxx.

References InputPyPort().

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

std::string InputPyPort::dump ( )

virtual

Reimplemented from YACS::ENGINE::InputPort.

Definition at line 243 of file PythonPorts.cxx.

References _data, YACS::ENGINE::InputPort::_stringRef, YACS::ENGINE::convertPyObjectXml(), YACS::ENGINE::DataPort::edGetType(), and YACS::ENGINE::Objref.

Referenced by getHumanRepr().

 {
   if( _data == Py_None)
     return "<value>None</value>";
 
   InterpreterUnlocker l;
   if (edGetType()->kind() != YACS::ENGINE::Objref)
     return convertPyObjectXml(edGetType(), _data);
   if (! _stringRef.empty())
     return _stringRef;
   else 
     return convertPyObjectXml(edGetType(), _data);
 //     {
 //       stringstream msg;
 //       msg << "Cannot retreive init reference string for port " << _name
 //           << " on node " << _node->getName();
 //       throw Exception(msg.str());      
 //     }
 }

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 134 of file PythonPorts.cxx.

References _initData.

 {
   return _initData!=Py_None;
 }

void InputPyPort::edRemoveManInit ( )

virtual

Removes eventually previous manual initialisation.

Reimplemented from YACS::ENGINE::InputPort.

Definition at line 139 of file PythonPorts.cxx.

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

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

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 233 of file PythonPorts.cxx.

References _data, _initData, and DEBTRACE.

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

void InputPyPort::exSaveInit ( )

virtual

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

Implements YACS::ENGINE::InputPort.

Definition at line 217 of file PythonPorts.cxx.

References _data, _initData, and DEBTRACE.

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

void * InputPyPort::get ( ) const throw (Exception)

virtual

Implements YACS::ENGINE::InputPort.

Definition at line 177 of file PythonPorts.cxx.

References _data.

 {
   return (void*) _data;
 }

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 182 of file PythonPorts.cxx.

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

 {
   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;
 }

std::string InputPyPort::getHumanRepr ( )

virtual

Reimplemented from YACS::ENGINE::InputPort.

Definition at line 193 of file PythonPorts.cxx.

References _data, dump(), and PMMLBasicsTestLauncher::ret.

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

PyObject * InputPyPort::getPyObj ( ) const

virtual

Definition at line 172 of file PythonPorts.cxx.

References _data.

Referenced by YACS::ENGINE::SalomePythonNode::execute(), YACS::ENGINE::DistributedPythonNode::execute(), YACS::ENGINE::PythonNode::executeLocal(), YACS::ENGINE::PyFuncNode::executeLocal(), YACS::ENGINE::PythonNode::executeRemote(), YACS::ENGINE::PyFuncNode::executeRemote(), and valToStr().

 {
   return _data;
 }

bool InputPyPort::isEmpty ( )

virtual

Reimplemented from YACS::ENGINE::InputPort.

Definition at line 208 of file PythonPorts.cxx.

References _data.

 {
   return _data == Py_None;
 }

void InputPyPort::put ( const void * data ) throw (ConversionException)

virtual

Implements YACS::ENGINE::InputPort.

Definition at line 150 of file PythonPorts.cxx.

 {
   put((PyObject *)data);
 }

void InputPyPort::put ( PyObject * data ) throw (ConversionException)

Definition at line 155 of file PythonPorts.cxx.

References DEBTRACE, registerPyObj(), and releasePyObj().

 {
   InterpreterUnlocker l;
   releasePyObj(_data);
   Py_XDECREF(_data); 
   _data = data;
   _stringRef="";
   Py_INCREF(_data); 
   registerPyObj(_data);
   DEBTRACE( "_data refcnt: " << _data->ob_refcnt );
 }

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

inlinevirtual

Reimplemented from YACS::ENGINE::InputPort.

Definition at line 93 of file PythonPorts.hxx.

93 {return "YACS__ENGINE__InputPyPort";}

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 277 of file PythonPorts.cxx.

278 {

279 }

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 263 of file PythonPorts.cxx.

References getPyObj().

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

Member Data Documentation

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

protected

Definition at line 98 of file PythonPorts.hxx.

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

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

protected

Definition at line 99 of file PythonPorts.hxx.

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

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

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation