Base class for Proxy Input Ports. More...

#include <InputPort.hxx>

Inheritance diagram for YACS::ENGINE::ProxyPort:

Collaboration diagram for YACS::ENGINE::ProxyPort:

Public Member Functions
	ProxyPort (InputPort *p)

	~ProxyPort ()

void	edRemoveAllLinksLinkedWithMe () throw (Exception)

InputPort *	clone (Node *newHelder) const

void	edNotifyReferencedBy (OutPort *fromPort)

void	edNotifyDereferencedBy (OutPort *fromPort)

std::set< OutPort * >	edSetOutPort () const
	Returns physical backlinks NOT user backlinks. More...

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

void *	get () const

virtual void	put (const void *data) throw (ConversionException)

int	edGetNumberOfLinks () const
	Returns number of physical backlinks NOT number of user backlinks. More...

bool	isIntermediate () const

void	exRestoreInit ()

void	exSaveInit ()

void	getAllRepresentants (std::set< InPort * > &repr) const

virtual std::string	typeName ()

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

std::string	getNameOfTypeOfCurrentInstance () 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 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 bool	isEmpty ()

virtual std::string	dump ()

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

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

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

Protected Attributes
InputPort *	_port

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

Base class for Proxy Input Ports.

Definition at line 97 of file InputPort.hxx.

Constructor & Destructor Documentation

ProxyPort::ProxyPort ( InputPort * p )

Definition at line 179 of file InputPort.cxx.

References _port, and p.

                                 :InputPort("Convertor", p->getNode(), p->edGetType()),DataPort("Convertor", p->getNode(), p->edGetType()),
                                    Port( p->getNode())
 {
   _port = p;
 }

ProxyPort::~ProxyPort ( )

Definition at line 185 of file InputPort.cxx.

 {
   //For the moment, there is no case in YACS we have a proxy port in a proxy port
   //So don't test that. _port may be already deleted. The test is not sure.
   /*
   if(_port->isIntermediate())
     delete _port;
     */
 }

Member Function Documentation

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

virtual

Note: : Should never been called because Node clone process does not duplicate data attributes relative to links. This part is done afterwards on relink process.

Implements YACS::ENGINE::InputPort.

Definition at line 204 of file InputPort.cxx.

 {
   throw Exception("ProxyPort::clone : internal error - should never happened");
 }

int ProxyPort::edGetNumberOfLinks ( ) const

virtual

Returns number of physical backlinks NOT number of user backlinks.

Reimplemented from YACS::ENGINE::InPort.

Definition at line 224 of file InputPort.cxx.

References _port, and YACS::ENGINE::InPort::edGetNumberOfLinks().

 {
   return _port->edGetNumberOfLinks();
 }

void ProxyPort::edNotifyDereferencedBy ( OutPort * fromPort )

virtual

Reimplemented from YACS::ENGINE::InPort.

Definition at line 214 of file InputPort.cxx.

References _port, and YACS::ENGINE::InPort::edNotifyDereferencedBy().

 {
   _port->edNotifyDereferencedBy(fromPort);
 }

void ProxyPort::edNotifyReferencedBy ( OutPort * fromPort )

virtual

Reimplemented from YACS::ENGINE::InPort.

Definition at line 209 of file InputPort.cxx.

References _port, and YACS::ENGINE::InPort::edNotifyReferencedBy().

 {
   _port->edNotifyReferencedBy(fromPort);
 }

void ProxyPort::edRemoveAllLinksLinkedWithMe ( ) throw (Exception)

virtual

Reimplemented from YACS::ENGINE::InPort.

Definition at line 195 of file InputPort.cxx.

References _port, and YACS::ENGINE::InPort::edRemoveAllLinksLinkedWithMe().

 {
   _port->edRemoveAllLinksLinkedWithMe();
 }

std::set< OutPort * > ProxyPort::edSetOutPort ( ) const

virtual

Returns physical backlinks NOT user backlinks.

Reimplemented from YACS::ENGINE::InPort.

Definition at line 219 of file InputPort.cxx.

References _port, and YACS::ENGINE::InPort::edSetOutPort().

 {
   return _port->edSetOutPort();
 }

void ProxyPort::exRestoreInit ( )

virtual

Implements YACS::ENGINE::InputPort.

Definition at line 229 of file InputPort.cxx.

References _port, and YACS::ENGINE::InputPort::exRestoreInit().

 {
   _port->exRestoreInit();
 }

void ProxyPort::exSaveInit ( )

virtual

Implements YACS::ENGINE::InputPort.

Definition at line 234 of file InputPort.cxx.

References _port, and YACS::ENGINE::InputPort::exSaveInit().

 {
   _port->exSaveInit();
 }

void * ProxyPort::get ( ) const

virtual

Implements YACS::ENGINE::InputPort.

Definition at line 248 of file InputPort.cxx.

References _port, and YACS::ENGINE::InputPort::get().

 {
   return _port->get();
 }

void ProxyPort::getAllRepresentants ( std::set< InPort * > & repr ) const

virtual

Reimplemented from YACS::ENGINE::InPort.

Definition at line 258 of file InputPort.cxx.

References _port, DEBTRACE, and YACS::ENGINE::InPort::getAllRepresentants().

 {
   DEBTRACE("ProxyPort::getAllRepresentants");
   _port->getAllRepresentants(repr);
 }

InputPort * ProxyPort::getPublicRepresentant ( )

virtual

returns the final physical port behind 'this'.

Reimplemented from YACS::ENGINE::InputPort.

Definition at line 242 of file InputPort.cxx.

References YACS::ENGINE::InputPort::getPublicRepresentant().

 { 
   return _port->getPublicRepresentant();
 }

bool YACS::ENGINE::ProxyPort::isIntermediate ( ) const

inlinevirtual

Reimplemented from YACS::ENGINE::InputPort.

Definition at line 116 of file InputPort.hxx.

116 { return true; }

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

virtual

Implements YACS::ENGINE::InputPort.

Definition at line 253 of file InputPort.cxx.

 {
   _port->put(data);
 }

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

inlinevirtual

Reimplemented from YACS::ENGINE::InputPort.

Definition at line 120 of file InputPort.hxx.

120 {return "YACS__ENGINE__ProxyPort";}

Member Data Documentation

InputPort* YACS::ENGINE::ProxyPort::_port

protected

Definition at line 122 of file InputPort.hxx.

Referenced by edGetNumberOfLinks(), edNotifyDereferencedBy(), edNotifyReferencedBy(), edRemoveAllLinksLinkedWithMe(), edSetOutPort(), exRestoreInit(), exSaveInit(), get(), getAllRepresentants(), and ProxyPort().

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

src/engine/InputPort.hxx
src/engine/InputPort.cxx

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation