Class for Study input Ports. More...

#include <StudyPorts.hxx>

Inheritance diagram for YACS::ENGINE::InputStudyPort:

[legend]

Collaboration diagram for YACS::ENGINE::InputStudyPort:

[legend]

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

	InputStudyPort (const InputStudyPort &other, Node *newHelder)

InputPort *	clone (Node *newHelder) const

void	setData (const std::string &data)

std::string	getData ()

virtual std::string	getIOR ()

virtual std::string	splitXML (const std::string &s)

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	putDataInStudy (SALOMEDS::StudyBuilder_var aBuilder)

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

	InputXmlPort (const InputXmlPort &other, Node *newHelder)

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 (const char *data)

void	releaseData () override

InputPort *	clone (Node *newHelder) const

virtual const char *	getXml () const

void *	get () const

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	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
std::string	_storeData

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

std::string	_initData

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

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 Study input Ports.

See also: StudyOutNode

Definition at line 50 of file StudyPorts.hxx.

Constructor & Destructor Documentation

◆ InputStudyPort() [1/2]

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

Definition at line 275 of file StudyPorts.cxx.

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

Referenced by clone().

◆ InputStudyPort() [2/2]

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

Definition at line 282 of file StudyPorts.cxx.

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

Member Function Documentation

◆ clone()

InputPort * YACS::ENGINE::InputStudyPort::clone ( Node * newHelder ) const

virtual

Implements YACS::ENGINE::InputPort.

Definition at line 289 of file StudyPorts.cxx.

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

References InputStudyPort().

◆ dump()

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

virtual

Reimplemented from YACS::ENGINE::InputXmlPort.

Definition at line 330 of file StudyPorts.cxx.

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

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

Referenced by putDataInStudy().

◆ getAsString()

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

{
  return getData();
}

References getData().

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

◆ getData()

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

Definition at line 301 of file StudyPorts.cxx.

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

References _storeData, and DEBTRACE.

Referenced by YACS::ENGINE::StudyOutNode::checkBasicConsistency(), getAsString(), getPyObj(), putDataInStudy(), and YACS::ENGINE::VisitorSaveSalomeSchema::writeStudyOutNodeParameters().

◆ getIOR()

std::string YACS::ENGINE::InputStudyPort::getIOR ( )

virtual

Definition at line 307 of file StudyPorts.cxx.

{
  switch(edGetType()->kind())
   {
   case Objref:
     return splitXML(_data);
   default:
     return _data;
   }
}

References YACS::ENGINE::InputXmlPort::_data, YACS::ENGINE::DataPort::edGetType(), YACS::ENGINE::Objref, and splitXML().

Referenced by putDataInStudy().

◆ getPyObj()

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

virtual

Definition at line 337 of file StudyPorts.cxx.

{
  return getData();
}

References getData().

◆ putDataInStudy()

void YACS::ENGINE::InputStudyPort::putDataInStudy ( SALOMEDS::StudyBuilder_var aBuilder )

virtual

Definition at line 346 of file StudyPorts.cxx.

{
  SALOMEDS::GenericAttribute_var aGAttr;
  SALOMEDS::SObject_var aSO ;
  SALOMEDS::AttributeName_var anAttr ;
  SALOMEDS::AttributeIOR_var iorAttr ;
  SALOMEDS::SComponent_var       aFather;
 
  std::string data = getData();
  DEBTRACE("data: " << data );
  //try to find an existing id (i:j:k...)
  aSO = KERNEL::getStudyServant()->FindObjectID(data.c_str());
  if(CORBA::is_nil(aSO))
    {
      // the id does not exist. Try to create it by id
      aSO=KERNEL::getStudyServant()->CreateObjectID(data.c_str());
      if(!CORBA::is_nil(aSO))
        {
          aGAttr=aBuilder->FindOrCreateAttribute(aSO,"AttributeName");
          anAttr = SALOMEDS::AttributeName::_narrow( aGAttr );
          anAttr->SetValue(getName().c_str());
        }
    }
 
  if(CORBA::is_nil(aSO))
    {
      //try to publish the object with a given path
      std::string name; // the component instance name
      std::string objname; // the object name (eventually with "/")
      std::string::size_type begin = data.find_first_not_of("/");
      std::string::size_type pos=data.find_first_of("/", begin);
      if (pos != std::string::npos)
        {
          name=data.substr(begin,pos-begin);
          objname=data.substr(pos+1);
        }
      else
        {
          name=data.substr(begin);
          objname="";
        }
      std::string pname="/"+name;
      DEBTRACE(pname);
      DEBTRACE(objname);
 
      Proc* proc=getNode()->getProc();
      if(proc->componentInstanceMap.count(name)!=0)
        {
          // There is a component instance with this name. Is it a Salome component or not ?
          ComponentInstance* compo=proc->componentInstanceMap[name];
          if(SalomeComponent* scompo=dynamic_cast<SalomeComponent*>(compo))
            {
                  //It's a Salome component, make it the right way : component name, component instance reference, ...
              CORBA::Object_var compovar= scompo->getCompoPtr();
              SALOMEDS::Driver_var aDriver = SALOMEDS::Driver::_narrow(compovar);
              if ( !CORBA::is_nil( aDriver ) )
                {
                  //It's a Salome component that implements the Driver interface. Use it to publish in study
                  CORBA::ORB_ptr orb;
                  CORBA::Object_var anObject;
                  try
                    {
                          orb = getSALOMERuntime()->getOrb();
                          anObject=orb->string_to_object(getIOR().c_str());
                    }
                  catch ( ... ) 
                    {
                      std::cerr << "Execution problem: can not get the object to publish" << std::endl;
                      return;
                    }
                  if ( aDriver->CanPublishInStudy( anObject ) ) 
                    {
                          //It's fine use the driver to publish
                          SALOMEDS::SObject_var aTmpSO; // initialized to nil
                          try 
                            {
                              aTmpSO = aDriver->PublishInStudy(aTmpSO, anObject,objname.c_str() );
                              return;
                            }
                          catch ( ... ) 
                            {
                              std::cerr << "Execution problem: error in PublishInStudy" << std::endl;
                              return;
                            }
                    }
                }
            }
        }
 
      // Does component entry exist ?
      aSO=KERNEL::getStudyServant()->FindObjectByPath(pname.c_str());
      if(CORBA::is_nil(aSO))
        {
          // We have not been able to publish the object with Salome Driver, make it the light way
          aFather=aBuilder->NewComponent(name.c_str());
          if(CORBA::is_nil(aFather))
            {
              std::cerr << "Execution problem: can not create component: " + name << std::endl;
              return;
            }
          aGAttr=aBuilder->FindOrCreateAttribute(aFather,"AttributeName");
          anAttr = SALOMEDS::AttributeName::_narrow( aGAttr );
          anAttr->SetValue(name.c_str());
          aSO=KERNEL::getStudyServant()->FindObjectByPath(pname.c_str());
        }
 
      begin=data.find_first_not_of("/",pos);
      while (begin != std::string::npos)
        {
          pos = data.find_first_of("/", begin);
          if (pos != std::string::npos)
            name=data.substr(begin,pos-begin);
          else
            name=data.substr(begin);
          aSO=findOrCreateSoWithName(aBuilder,aSO,name);
          begin=data.find_first_not_of("/",pos);
        }
    }
 
  if(CORBA::is_nil(aSO))
    {
      std::cerr << "Execution problem: can not create id or path: " + data + " in study" << std::endl;
      return;
    }
 
  std::string value;
  SALOMEDS::AttributeComment_var commentAttr ;
  SALOMEDS::AttributeReal_var realAttr ;
  SALOMEDS::AttributeInteger_var intAttr ;
  SALOMEDS::AttributeString_var stringAttr ;
  double d;
  long v;
  switch(edGetType()->kind())
    {
      case Objref:
             value=getIOR();
             DEBTRACE(value);
             aGAttr=aBuilder->FindOrCreateAttribute(aSO,"AttributeIOR");
             iorAttr = SALOMEDS::AttributeIOR::_narrow( aGAttr );
             iorAttr->SetValue(value.c_str());
             break;
      case Double:
             value=splitXML(dump());
             DEBTRACE(value);
             aGAttr=aBuilder->FindOrCreateAttribute(aSO,"AttributeReal");
             realAttr = SALOMEDS::AttributeReal::_narrow( aGAttr );
             d=atof(value.c_str());
             realAttr->SetValue(d);
             break;
      case Int:
             value=splitXML(dump());
             DEBTRACE(value);
             aGAttr=aBuilder->FindOrCreateAttribute(aSO,"AttributeInteger");
             intAttr = SALOMEDS::AttributeInteger::_narrow( aGAttr );
             v=atol(value.c_str());
             intAttr->SetValue(v);
             break;
      case String:
      case Bool:
             value=splitXML(dump());
             DEBTRACE(value);
             aGAttr=aBuilder->FindOrCreateAttribute(aSO,"AttributeComment");
             commentAttr = SALOMEDS::AttributeComment::_narrow( aGAttr );
             commentAttr->SetValue(value.c_str());
             break;
      default:
             value=dump();
             DEBTRACE(value);
             aGAttr=aBuilder->FindOrCreateAttribute(aSO,"AttributeComment");
             commentAttr = SALOMEDS::AttributeComment::_narrow( aGAttr );
             commentAttr->SetValue(value.c_str());
    }
}

References YACS::ENGINE::Bool, YACS::ENGINE::Proc::componentInstanceMap, DEBTRACE, YACS::ENGINE::Double, dump(), YACS::ENGINE::DataPort::edGetType(), YACS::ENGINE::findOrCreateSoWithName(), getData(), getIOR(), YACS::ENGINE::DataPort::getName(), YACS::ENGINE::Port::getNode(), YACS::ENGINE::RuntimeSALOME::getOrb(), YACS::ENGINE::Node::getProc(), YACS::ENGINE::getSALOMERuntime(), YACS::ENGINE::Int, YACS::ENGINE::Objref, orb, splitXML(), and YACS::ENGINE::String.

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

◆ setData()

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

Definition at line 294 of file StudyPorts.cxx.

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

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

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

◆ splitXML()

std::string YACS::ENGINE::InputStudyPort::splitXML ( const std::string & s )

virtual

Definition at line 318 of file StudyPorts.cxx.

{
  // <value><tag>content</tag></value>
  std::string::size_type begin = s.find_first_of("<"); // <value>
  begin = s.find_first_of(">",begin); // end of <value>
  begin = s.find_first_of("<",begin); // beginning of <tag>
  begin = s.find_first_of(">",begin); // end of <tag>
  begin = s.find_first_not_of("> ",begin); // beginning of content
  std::string::size_type last = s.find_first_of("<",begin); // beginning of </tag>
  return s.substr(begin,last-begin);
}

Referenced by getIOR(), and putDataInStudy().

◆ typeName()

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

inlinevirtual

Reimplemented from YACS::ENGINE::InputPort.

Definition at line 63 of file StudyPorts.hxx.

63{return "YACS__ENGINE__InputStudyPort";}

Member Data Documentation

◆ _storeData

std::string YACS::ENGINE::InputStudyPort::_storeData

protected

Definition at line 66 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

◆ InputStudyPort() [1/2]

◆ InputStudyPort() [2/2]

Member Function Documentation

◆ clone()

◆ dump()

◆ getAsString()

◆ getData()

◆ getIOR()

◆ getPyObj()

◆ putDataInStudy()

◆ setData()

◆ splitXML()

◆ typeName()

Member Data Documentation

◆ _storeData