Class for CORBA Input Ports. More...

#include <CORBAPorts.hxx>

Inheritance diagram for YACS::ENGINE::InputCorbaPort:

[legend]

Collaboration diagram for YACS::ENGINE::InputCorbaPort:

[legend]

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

	InputCorbaPort (const InputCorbaPort &other, Node *newHelder)

virtual	~InputCorbaPort ()

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	put (CORBA::Any *data)

void	releaseData () override

InputPort *	clone (Node *newHelder) const

void *	get () const

virtual bool	isEmpty ()

virtual CORBA::Any *	getAny ()

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

virtual PyObject *	getPyObj ()

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

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 void	exSaveInit ()=0

virtual void	exRestoreInit ()=0

virtual InputPort *	clone (Node *newHelder) const =0

virtual bool	isEmpty ()

virtual void *	get () const =0

virtual void	releaseData ()=0

virtual void	put (const void *data)=0

virtual std::string	dump ()

virtual std::string	getHumanRepr ()

virtual void	setStringRef (std::string strRef)

virtual std::string	typeName ()

bool	canBeNull () const

Public Member Functions inherited from YACS::ENGINE::DataFlowPort
std::string	getNameOfTypeOfCurrentInstance () const

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

virtual std::string	getNameOfTypeOfCurrentInstance () const

int	getNumId () const

virtual std::string	typeName ()

void	modified ()

Public Member Functions inherited from YACS::ENGINE::InPort
virtual InPort *	getPublicRepresentant ()

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

virtual std::string	typeName ()

Protected Attributes
CORBA::Any	_data

CORBA::Any *	_initData

CORBA::ORB_ptr	_orb

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"

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

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

static const char	NAME [] ="Port"

Detailed Description

Class for CORBA Input Ports.

See also: CORBANode

Definition at line 44 of file CORBAPorts.hxx.

Constructor & Destructor Documentation

◆ InputCorbaPort() [1/2]

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

Definition at line 100 of file CORBAPorts.cxx.

  : InputPort(name, node, type), DataPort(name, node, type), Port(node), _initData(0)
{
  _orb = getSALOMERuntime()->getOrb();
}

References _orb, YACS::ENGINE::RuntimeSALOME::getOrb(), and YACS::ENGINE::getSALOMERuntime().

Referenced by clone().

◆ InputCorbaPort() [2/2]

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

Definition at line 108 of file CORBAPorts.cxx.

                                                                          :InputPort(other,newHelder),DataPort(other,newHelder),Port(other,newHelder),
                                                                             _initData(0)
{
  _orb = getSALOMERuntime()->getOrb();
  if(other._initData)
    {
      _initData=new CORBA::Any;
      *_initData=*(other._initData);
    }
  _data=other._data;
}

References _data, _initData, _orb, YACS::ENGINE::RuntimeSALOME::getOrb(), and YACS::ENGINE::getSALOMERuntime().

◆ ~InputCorbaPort()

InputCorbaPort::~InputCorbaPort ( )

virtual

Definition at line 120 of file CORBAPorts.cxx.

{
  delete _initData;
  // Release or not release : all GenericObj are deleted when the input port is deleted
  releaseObj(_data);
}

References _data, _initData, and releaseObj().

Member Function Documentation

◆ clone()

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

virtual

Implements YACS::ENGINE::InputPort.

Definition at line 191 of file CORBAPorts.cxx.

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

References InputCorbaPort().

◆ dump()

std::string InputCorbaPort::dump ( )

virtual

Reimplemented from YACS::ENGINE::InputPort.

Definition at line 258 of file CORBAPorts.cxx.

{
  CORBA::TypeCode_var tc=_data.type();
  if (tc->equivalent(CORBA::_tc_null))
    return "<value>nil</value>";
  if (edGetType()->kind() != YACS::ENGINE::Objref)
    return convertCorbaXml(edGetType(), &_data);
  if (! _stringRef.empty())
    return _stringRef;
  else 
    return convertCorbaXml(edGetType(), &_data);
//     {
//       stringstream msg;
//       msg << "Cannot retreive init string reference string for port " << _name
//           << " on node " << _node->getName();
//       throw Exception(msg.str());      
//     }
}

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

◆ edIsManuallyInitialized()

bool InputCorbaPort::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 127 of file CORBAPorts.cxx.

{
  return _initData!=0;
}

References _initData.

◆ edRemoveManInit()

void InputCorbaPort::edRemoveManInit ( )

virtual

Removes eventually previous manual initialisation.

Reimplemented from YACS::ENGINE::InputPort.

Definition at line 132 of file CORBAPorts.cxx.

{
  delete _initData;
  _initData=0;
  InputPort::edRemoveManInit();
}

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

◆ exRestoreInit()

void InputCorbaPort::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 252 of file CORBAPorts.cxx.

{
  if(!_initData)return;
  put(_initData);
}

References _initData, and put().

◆ exSaveInit()

void InputCorbaPort::exSaveInit ( )

virtual

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

Implements YACS::ENGINE::InputPort.

Definition at line 240 of file CORBAPorts.cxx.

{
  if(_initData)
    delete _initData;
  _initData=new CORBA::Any;
  *_initData=_data;
}

References _data, and _initData.

◆ get()

void * InputCorbaPort::get ( ) const

virtual

Implements YACS::ENGINE::InputPort.

Definition at line 196 of file CORBAPorts.cxx.

{
  return (void *)&_data;
}

References _data.

◆ getAny()

CORBA::Any * InputCorbaPort::getAny ( )

virtual

Definition at line 207 of file CORBAPorts.cxx.

{
  // --- return a pointer to internal any
  return &_data;
}

References _data.

Referenced by getPyObj().

◆ getAsString()

std::string InputCorbaPort::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 226 of file CORBAPorts.cxx.

{
  InterpreterUnlocker loc;
  PyObject* ob=getPyObj();
  std::string s=convertPyObjectToString(ob);
  Py_DECREF(ob);
  return s;
}

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

◆ getPyObj()

PyObject * InputCorbaPort::getPyObj ( )

virtual

Definition at line 213 of file CORBAPorts.cxx.

{
  YACS::BASES::AutoLocker<YACS::BASES::Mutex> lock(&_mutex);
  CORBA::TypeCode_var tc=getAny()->type();
  if (!tc->equivalent(CORBA::_tc_null))
    return convertCorbaPyObject(edGetType(),getAny());
  else
    {
      Py_INCREF(Py_None);
      return Py_None;
    }
}

References _mutex, YACS::ENGINE::convertCorbaPyObject(), YACS::ENGINE::DataPort::edGetType(), and getAny().

Referenced by getAsString(), and valToStr().

◆ isEmpty()

bool InputCorbaPort::isEmpty ( )

virtual

Reimplemented from YACS::ENGINE::InputPort.

Definition at line 201 of file CORBAPorts.cxx.

{
  CORBA::TypeCode_var tc=_data.type();
  return tc->equivalent(CORBA::_tc_null);
}

References _data.

◆ put() [1/2]

void InputCorbaPort::put ( const void * data )

virtual

Implements YACS::ENGINE::InputPort.

Definition at line 139 of file CORBAPorts.cxx.

{
  put((CORBA::Any *)data);
}

References put().

Referenced by exRestoreInit(), and put().

◆ put() [2/2]

void InputCorbaPort::put ( CORBA::Any * data )

Definition at line 168 of file CORBAPorts.cxx.

{
#ifdef REFCNT
  DEBTRACE("refcount CORBA : " << ((omni::TypeCode_base*)data->pd_tc.in())->pd_ref_count);
#endif
  YACS::BASES::AutoLocker<YACS::BASES::Mutex> lock(&_mutex);
#ifdef _DEVDEBUG_
  display(data);
#endif
 
  releaseObj(_data);
 
  // make a copy of the any (protect against deletion of any source)
  _data=*data;
  _stringRef="";
 
  registerObj(_data);
 
#ifdef REFCNT
  DEBTRACE("refcount CORBA : " << ((omni::TypeCode_base*)_data.pd_tc.in())->pd_ref_count);
#endif
}

References _data, _mutex, YACS::ENGINE::InputPort::_stringRef, DEBTRACE, display(), registerObj(), and releaseObj().

◆ releaseData()

void InputCorbaPort::releaseData ( )

overridevirtual

Implements YACS::ENGINE::InputPort.

Definition at line 164 of file CORBAPorts.cxx.

165{//do nothing - to be implemented

166}

◆ typeName()

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

inlinevirtual

Reimplemented from YACS::ENGINE::InputPort.

Definition at line 64 of file CORBAPorts.hxx.

64{return "YACS__ENGINE__InputCorbaPort";}

◆ valFromStr()

void InputCorbaPort::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 288 of file CORBAPorts.cxx.

289{

290}

◆ valToStr()

std::string InputCorbaPort::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 277 of file CORBAPorts.cxx.

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

References getPyObj().

Member Data Documentation

◆ _data

CORBA::Any YACS::ENGINE::InputCorbaPort::_data

protected

Definition at line 68 of file CORBAPorts.hxx.

Referenced by dump(), exSaveInit(), get(), getAny(), InputCorbaPort(), isEmpty(), put(), and ~InputCorbaPort().

◆ _initData

CORBA::Any* YACS::ENGINE::InputCorbaPort::_initData

protected

Definition at line 69 of file CORBAPorts.hxx.

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

◆ _mutex

YACS::BASES::Mutex YACS::ENGINE::InputCorbaPort::_mutex

private

Definition at line 72 of file CORBAPorts.hxx.

Referenced by getPyObj(), and put().

◆ _orb

CORBA::ORB_ptr YACS::ENGINE::InputCorbaPort::_orb

protected

Definition at line 70 of file CORBAPorts.hxx.

Referenced by InputCorbaPort().

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

src/runtime/CORBAPorts.hxx
src/runtime/CORBAPorts.cxx

Public Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ InputCorbaPort() [1/2]

◆ InputCorbaPort() [2/2]

◆ ~InputCorbaPort()

Member Function Documentation

◆ clone()

◆ dump()

◆ edIsManuallyInitialized()

◆ edRemoveManInit()

◆ exRestoreInit()

◆ exSaveInit()

◆ get()

◆ getAny()

◆ getAsString()

◆ getPyObj()

◆ isEmpty()

◆ put() [1/2]

◆ put() [2/2]

◆ releaseData()

◆ typeName()

◆ valFromStr()

◆ valToStr()

Member Data Documentation

◆ _data

◆ _initData

◆ _mutex

◆ _orb