Class for Study output Ports. More...

#include <StudyPorts.hxx>

Inheritance diagram for YACS::ENGINE::OutputStudyPort:

[legend]

Collaboration diagram for YACS::ENGINE::OutputStudyPort:

[legend]

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

	OutputStudyPort (const OutputStudyPort &other, Node *newHelder)

OutputPort *	clone (Node *newHelder) const

void	setData (const std::string &data)

std::string	getData ()

virtual void	putIOR (const std::string &ior)

virtual std::string	dump ()

virtual std::string	getPyObj ()

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

virtual std::string	typeName ()

virtual void	getDataFromStudy ()

Public Member Functions inherited from YACS::ENGINE::OutputXmlPort
	OutputXmlPort (const std::string &name, Node node, TypeCode type)

	OutputXmlPort (const OutputXmlPort &other, Node *newHelder)

virtual void	put (const void *data)

void	put (const char *data)

virtual const char *	get () const

OutputPort *	clone (Node *newHelder) const

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

std::set< InPort * >	edSetInPort () const

bool	isAlreadyLinkedWith (InPort *withp) const

bool	isAlreadyInSet (InputPort *inputPort) const

bool	isConnected () const

std::string	getNameOfTypeOfCurrentInstance () const

int	removeInPort (InPort *inPort, bool forward)

virtual bool	edAddInputPort (InputPort *phyPort)

virtual bool	edAddInPropertyPort (InPropertyPort *phyPort)

virtual int	edRemoveInputPort (InputPort *inputPort, bool forward)

bool	addInPort (InPort *inPort)

void	edRemoveAllLinksLinkedWithMe ()

virtual void	exInit ()

virtual void	checkBasicConsistency () const
	Check validity of output port. Nothing on base class. More...

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::OutPort
virtual void	checkConsistency (LinkInfo &info) const

virtual int	edGetNumberOfOutLinks () const

virtual void	getAllRepresented (std::set< OutPort * > &represented) const

virtual	~OutPort ()

std::vector< DataPort * >	calculateHistoryOfLinkWith (InPort *end)

Protected Attributes
std::string	_storeData

Protected Attributes inherited from YACS::ENGINE::OutputXmlPort
std::string	_data

Protected Attributes inherited from YACS::ENGINE::OutputPort
std::set< InputPort * >	_setOfInputPort

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::OutputPort
static const char	NAME [] ="OutputPort"

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::OutputPort
	OutputPort (const OutputPort &other, Node *newHelder)

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

const std::set< InputPort * > &	getSetOfPhyLinks () const
	Returns physical links linked to this. Contrary to edSetInPort that returns semantic links. More...

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::OutPort
	OutPort (const OutPort &other, Node *newHelder)

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

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

static const char	NAME [] ="Port"

Detailed Description

Class for Study output Ports.

See also: StudyInNode

Definition at line 32 of file StudyPorts.hxx.

Constructor & Destructor Documentation

◆ OutputStudyPort() [1/2]

YACS::ENGINE::OutputStudyPort::OutputStudyPort	(	const std::string &	name,
		Node *	node,
		TypeCode *	type
	)

Definition at line 52 of file StudyPorts.cxx.

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

Referenced by clone().

◆ OutputStudyPort() [2/2]

YACS::ENGINE::OutputStudyPort::OutputStudyPort	(	const OutputStudyPort &	other,
		Node *	newHelder
	)

Definition at line 59 of file StudyPorts.cxx.

   : OutputXmlPort(other,newHelder),
     DataPort(other,newHelder),
     Port(other,newHelder),_storeData(other._storeData)
 {
 }

Member Function Documentation

◆ clone()

OutputPort * YACS::ENGINE::OutputStudyPort::clone ( Node * newHelder ) const

virtual

Implements YACS::ENGINE::OutputPort.

Definition at line 66 of file StudyPorts.cxx.

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

References OutputStudyPort().

◆ dump()

std::string YACS::ENGINE::OutputStudyPort::dump ( )

virtual

Reimplemented from YACS::ENGINE::OutputXmlPort.

Definition at line 122 of file StudyPorts.cxx.

 {
   DEBTRACE( "OutputStudyPort::dump " << _storeData );
   DEBTRACE( "OutputStudyPort::dump " << _data );
   //return "<value><string>"+_storeData+"</string></value>";
   return _data;
 }

References YACS::ENGINE::OutputXmlPort::_data, _storeData, and DEBTRACE.

◆ getAsString()

std::string YACS::ENGINE::OutputStudyPort::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 134 of file StudyPorts.cxx.

 {
   return getData();
 }

References getData().

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

◆ getData()

std::string YACS::ENGINE::OutputStudyPort::getData ( )

Definition at line 78 of file StudyPorts.cxx.

 {
   DEBTRACE("OutputStudyPort::getData " << _storeData);
   return _storeData;
 }

References _storeData, and DEBTRACE.

Referenced by YACS::ENGINE::StudyInNode::checkBasicConsistency(), getAsString(), getDataFromStudy(), getPyObj(), and YACS::ENGINE::VisitorSaveSalomeSchema::writeStudyInNodeParameters().

◆ getDataFromStudy()

void YACS::ENGINE::OutputStudyPort::getDataFromStudy ( )

virtual

Definition at line 139 of file StudyPorts.cxx.

 {
       std::string data = getData();
       DEBTRACE("data: " << data );
       //try an id
       SALOMEDS::SObject_var aSO = KERNEL::getStudyServant()->FindObjectID(data.c_str());
       if(CORBA::is_nil(aSO))
         {
           //try a path
           aSO=KERNEL::getStudyServant()->FindObjectByPath(data.c_str());
           if(CORBA::is_nil(aSO))
             {
               std::stringstream msg;
               msg << "Execution problem: no id or path: " << data << " in study";
               throw Exception(msg.str());
             }
         }
  
       CORBA::String_var path=KERNEL::getStudyServant()->GetObjectPath(aSO);
       DEBTRACE(path);
       CORBA::String_var id=aSO->GetID();
       DEBTRACE(id);
       //CORBA::Object_var sobj=aSO->GetObject();
  
       SALOMEDS::GenericAttribute_var aGAttr;
       CORBA::String_var value;
  
       if(edGetType()->kind()==Objref)
         {
           if ( aSO->FindAttribute( aGAttr, "AttributeIOR" ) )
             {
               SALOMEDS::AttributeIOR_var anAttr = SALOMEDS::AttributeIOR::_narrow( aGAttr );
               value=anAttr->Value();
               putIOR((const char*)value);
             }
           else
             {
               //Problem !!!
               std::string error="Execution problem: no AttributeIOR in study object: ";
               error=error+data;
               throw Exception(error);
             }
         }
       else if(edGetType()->kind()==Double )
         {
           if ( aSO->FindAttribute( aGAttr, "AttributeReal" ) )
             {
               SALOMEDS::AttributeReal_var anAttr = SALOMEDS::AttributeReal::_narrow( aGAttr );
               CORBA::Double d=anAttr->Value();
               std::stringstream msg;
               msg << "<value><double>" << std::setprecision(16) << d << "</double></value>";
               put(msg.str().c_str());
             }
           else
             {
               std::string error="Execution problem: no AttributeReal in study object: ";
               throw Exception(error+data);
             }
         }
       else if(edGetType()->kind()== Int)
         {
           if ( aSO->FindAttribute( aGAttr, "AttributeInteger" ) )
             {
               SALOMEDS::AttributeInteger_var anAttr = SALOMEDS::AttributeInteger::_narrow( aGAttr );
               CORBA::Long l=anAttr->Value();
               std::stringstream msg;
               msg << "<value><int>" << l << "</int></value>";
               put(msg.str().c_str());
             }
           else
             {
               std::string error="Execution problem: no AttributeInteger in study object: ";
               throw Exception(error+data);
             }
         }
       else
         {
           if ( aSO->FindAttribute( aGAttr, "AttributeComment" ) )
             {
               SALOMEDS::AttributeComment_var anAttr = SALOMEDS::AttributeComment::_narrow( aGAttr );
               value=anAttr->Value();
               DEBTRACE(value);
               putIOR((const char*)value);
             }
           else
             {
               std::string error="Execution problem: no AttributeComment in study object: ";
               throw Exception(error+data);
             }
         }
 }

References DEBTRACE, YACS::ENGINE::Double, YACS::ENGINE::DataPort::edGetType(), getData(), YACS::ENGINE::Int, testCppPluginInvokation::l, YACS::ENGINE::Objref, YACS::ENGINE::OutputXmlPort::put(), and putIOR().

Referenced by YACS::ENGINE::StudyInNode::execute().

◆ getPyObj()

std::string YACS::ENGINE::OutputStudyPort::getPyObj ( )

virtual

Definition at line 130 of file StudyPorts.cxx.

 {
   return getData();
 }

References getData().

◆ putIOR()

void YACS::ENGINE::OutputStudyPort::putIOR ( const std::string & ior )

virtual

Definition at line 84 of file StudyPorts.cxx.

 {
   DEBTRACE("OutputStudyPort::putIOR " << ior);
   if(ior.substr(0,7) == "<value>")
     {
       put(ior.c_str());
     }
   else
     {
       int tk=edGetType()->kind();
       std::string value;
       switch(tk)
         {
         case Double:
           value="<value><double>"+ior+"</double></value>";
           break;
         case Int:
           value="<value><int>"+ior+"</int></value>";
           break;
         case String:
           value="<value><string>"+ior+"</string></value>";
           break;
         case Bool:
           value="<value><boolean>"+ior+"</boolean></value>";
           break;
         case Objref:
           value="<value><objref>"+ior+"</objref></value>";
           break;
         case Sequence:
         case Array:
         case Struct:
         default:
           break;
         }
       put(value.c_str());
     }
 }

References YACS::ENGINE::Array, YACS::ENGINE::Bool, DEBTRACE, YACS::ENGINE::Double, YACS::ENGINE::DataPort::edGetType(), YACS::ENGINE::Int, YACS::ENGINE::TypeCode::kind(), YACS::ENGINE::Objref, YACS::ENGINE::OutputXmlPort::put(), YACS::ENGINE::Sequence, YACS::ENGINE::String, and YACS::ENGINE::Struct.

Referenced by getDataFromStudy().

◆ setData()

void YACS::ENGINE::OutputStudyPort::setData ( const std::string & data )

Definition at line 71 of file StudyPorts.cxx.

 {
   _storeData = data;
   DEBTRACE( "OutputStudyPort::setData " << _storeData );
   modified();
 }

References _storeData, DEBTRACE, and YACS::ENGINE::Port::modified().

Referenced by YACS::ENGINE::StudyInNode::setData().

◆ typeName()

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

inlinevirtual

Reimplemented from YACS::ENGINE::OutputPort.

Definition at line 44 of file StudyPorts.hxx.

44 {return "YACS__ENGINE__OutputStudyPort";}

Member Data Documentation

◆ _storeData

std::string YACS::ENGINE::OutputStudyPort::_storeData

protected

Definition at line 47 of file StudyPorts.hxx.

Referenced by dump(), getData(), and setData().

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

src/runtime/StudyPorts.hxx
src/runtime/StudyPorts.cxx

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OutputStudyPort() [1/2]

◆ OutputStudyPort() [2/2]

Member Function Documentation

◆ clone()

◆ dump()

◆ getAsString()

◆ getData()

◆ getDataFromStudy()

◆ getPyObj()

◆ putIOR()

◆ setData()

◆ typeName()

Member Data Documentation

◆ _storeData