#include <DataStreamPort.hxx>

Inheritance diagram for YACS::ENGINE::DataStreamPort:

Collaboration diagram for YACS::ENGINE::DataStreamPort:

Public Member Functions
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 void	setProperty (const std::string &name, const std::string &value)
	Set a new value for a property of the port. More...

virtual void	setProperties (std::map< std::string, std::string > properties)
	Set the values of all properties of the port. More...

virtual std::string	getProperty (const std::string &name)
	Get the value of a property of the port. More...

std::map< std::string, std::string >	getProperties () const

virtual void	initPortProperties ()
	Initialize port properties at the start of calculation phase. More...

virtual	~DataStreamPort ()

virtual std::string	typeName ()

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 void	edRemoveAllLinksLinkedWithMe ()=0 throw (Exception)

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

Static Public Attributes
static const char	NAME [] ="DataStreamPort"

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

Protected Member Functions
	DataStreamPort (const DataStreamPort &other, Node *newHelder)

	DataStreamPort (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 Attributes
std::map< std::string, std::string >	_propertyMap

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 Protected Attributes inherited from YACS::ENGINE::Port
static int	_total = 0

static const char	NAME [] ="Port"

Detailed Description

Definition at line 33 of file DataStreamPort.hxx.

Constructor & Destructor Documentation

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

protected

Definition at line 28 of file DataStreamPort.cxx.

                                                                           :DataPort(other,newHelder),Port(other,newHelder),_propertyMap(other._propertyMap)
 {
 }

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

protected

Definition at line 32 of file DataStreamPort.cxx.

                                                                                :DataPort(name,node,type),Port(node)
 {
 }

DataStreamPort::~DataStreamPort ( )

virtual

Definition at line 36 of file DataStreamPort.cxx.

37 {

38 }

Member Function Documentation

string DataStreamPort::getNameOfTypeOfCurrentInstance ( ) const

virtual

Reimplemented from YACS::ENGINE::DataPort.

Reimplemented in YACS::ENGINE::OutputCalStreamPort, YACS::ENGINE::OutputDataStreamPort, YACS::ENGINE::InputCalStreamPort, and YACS::ENGINE::InputDataStreamPort.

Definition at line 40 of file DataStreamPort.cxx.

References NAME.

 {
   return NAME;
 }

std::map<std::string,std::string> YACS::ENGINE::DataStreamPort::getProperties ( ) const

inline

Definition at line 47 of file DataStreamPort.hxx.

Referenced by YACS::HMI::SubjectInputDataStreamPort::getProperties(), YACS::HMI::SubjectOutputDataStreamPort::getProperties(), YACS::HMI::CommandSetDSPortProperties::localExecute(), and YACS::HMI::CommandSetLinkProperties::localExecute().

47 { return _propertyMap; }

std::string DataStreamPort::getProperty ( const std::string & name )

virtual

Get the value of a property of the port.

Parameters

name	: the name property

Returns: the value property

Definition at line 60 of file DataStreamPort.cxx.

References _propertyMap.

 {
   return _propertyMap[name];
 }

TypeOfChannel YACS::ENGINE::DataStreamPort::getTypeOfChannel ( ) const

inlinevirtual

returns type of channel the port will use for data exchange on runtime : DATAFLOW or DATASTREAM.

Implements YACS::ENGINE::DataPort.

Definition at line 43 of file DataStreamPort.hxx.

References YACS::ENGINE::DATASTREAM.

43 { return DATASTREAM; }

void DataStreamPort::initPortProperties ( )

virtual

Initialize port properties at the start of calculation phase.

This method is called before the execution of the parent node. It is not used when the user sets properties

Definition at line 84 of file DataStreamPort.cxx.

85 {

86 }

void DataStreamPort::setProperties ( std::map< std::string, std::string > properties )

virtual

Set the values of all properties of the port.

Parameters

properties : a map containing the values of properties

Definition at line 69 of file DataStreamPort.cxx.

References _propertyMap, and setProperty().

Referenced by YACS::HMI::CommandSetDSPortProperties::localExecute(), YACS::HMI::CommandSetLinkProperties::localExecute(), YACS::HMI::CommandSetDSPortProperties::localReverse(), and YACS::HMI::CommandSetLinkProperties::localReverse().

 {
   _propertyMap.clear();
   std::map<std::string,std::string>::iterator it;
   for (it = properties.begin(); it != properties.end(); ++it)
     {
       setProperty((*it).first, (*it).second); // setProperty virtual and derived
     }
 }