Proc.cxx

Go to the documentation of this file.

// Copyright (C) 2006-2025  CEA, EDF
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
//
// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
//
 
#include "Proc.hxx"
#include "ElementaryNode.hxx"
#include "Runtime.hxx"
#include "Container.hxx"
#include "ComponentInstance.hxx"
#include "InputPort.hxx"
#include "OutputPort.hxx"
#include "TypeCode.hxx"
#include "Logger.hxx"
#include "Visitor.hxx"
#include "VisitorSaveSchema.hxx"
#include "VisitorSaveState.hxx"
#include <sstream>
#include <set>
 
//#define _DEVDEBUG_
#include "YacsTrace.hxx"
 
using namespace std;
using namespace YACS::ENGINE;
 
Proc::Proc(const std::string& name):Bloc(name),_edition(false),_compoinstctr(0)
{
  Runtime *theRuntime=getRuntime();
  DEBTRACE("theRuntime->_tc_double->ref: " << theRuntime->_tc_double->getRefCnt());
  DEBTRACE("theRuntime->_tc_int->ref: " << theRuntime->_tc_int->getRefCnt());
  DEBTRACE("theRuntime->_tc_string->ref: " << theRuntime->_tc_string->getRefCnt());
  DEBTRACE("theRuntime->_tc_bool->ref: " << theRuntime->_tc_bool->getRefCnt());
  DEBTRACE("theRuntime->_tc_file->ref: " << theRuntime->_tc_file->getRefCnt());
  theRuntime->_tc_double->incrRef();
  theRuntime->_tc_string->incrRef();
  theRuntime->_tc_int->incrRef();
  theRuntime->_tc_bool->incrRef();
  theRuntime->_tc_file->incrRef();
  typeMap["double"]=theRuntime->_tc_double;
  typeMap["string"]=theRuntime->_tc_string;
  typeMap["int"]=theRuntime->_tc_int;
  typeMap["bool"]=theRuntime->_tc_bool;
  typeMap["file"]=theRuntime->_tc_file;
}
 
Proc::~Proc()
{
  DEBTRACE("Proc::~Proc");
  //for the moment all nodes are owned, so no need to manage their destruction
  //nodeMap, inlineMap, serviceMap will be cleared automatically
  //but we need to destroy TypeCodes
  std::map<std::string, TypeCode *>::iterator pt;
  for(pt=typeMap.begin();pt!=typeMap.end();pt++)
    ((*pt).second)->decrRef();
 
  removeContainers();
 
  //get rid of loggers in logger map
  std::map<std::string, Logger*>::const_iterator lt;
  for(lt=_loggers.begin();lt!=_loggers.end();lt++)
    delete (*lt).second;
}
 
void Proc::writeDot(std::ostream &os) const
{
  os << "digraph " << getQualifiedName() << " {\n" ;
  os << "node [ style=\"filled\" ];\n" ;
  os << "compound=true;";
  os << "states [label=< <TABLE> <TR> <TD BGCOLOR=\"pink\" > Ready</TD> <TD BGCOLOR=\"magenta\" > Toload</TD> </TR> <TR> <TD BGCOLOR=\"magenta\" > Loaded</TD> <TD BGCOLOR=\"purple\" > Toactivate</TD> </TR> <TR> <TD BGCOLOR=\"blue\" > Activated</TD> <TD BGCOLOR=\"green\" > Done</TD> </TR> <TR> <TD BGCOLOR=\"red\" > Error</TD> <TD BGCOLOR=\"orange\" > Failed</TD> </TR> <TR> <TD BGCOLOR=\"grey\" > Disabled</TD> <TD BGCOLOR=\"white\" > Pause</TD> </TR> </TABLE>> \n shape = plaintext \n style = invis \n ];\n";
 
  Bloc::writeDot(os);
  os << "}\n" ;
}
 
std::ostream& operator<< (std::ostream& os, const Proc& p)
{
  os << "Proc" ;
  return os;
}
 
TypeCode *Proc::createType(const std::string& name, const std::string& kind)
{
  TypeCode* t;
  if(kind=="double")
    t=getRuntime()->_tc_double;
  else if(kind=="string")
    t=getRuntime()->_tc_string;
  else if(kind=="int")
    t=getRuntime()->_tc_int;
  else if(kind=="bool")
    t=getRuntime()->_tc_bool;
  else
    throw Exception("Unknown kind");
 
  if(typeMap.count(name)!=0)
    typeMap[name]->decrRef();
  t->incrRef();
  typeMap[name]=t;
  t->incrRef();
  return t;
}
 
 
TypeCode *Proc::createInterfaceTc(const std::string& id, const std::string& name,
                                  std::list<TypeCodeObjref *> ltc)
{
  TypeCode* t = TypeCode::interfaceTc(id.c_str(),name.c_str(),ltc);
  if(typeMap.count(name)!=0)
    typeMap[name]->decrRef();
  typeMap[name]=t;
  t->incrRef();
  return t;
}
 
 
TypeCode * Proc::createSequenceTc (const std::string& id, const std::string& name,
                                   TypeCode *content)
{
  TypeCode* t = TypeCode::sequenceTc(id.c_str(),name.c_str(),content);
  if(typeMap.count(name)!=0)
    typeMap[name]->decrRef();
  typeMap[name]=t;
  t->incrRef();
  return t;
}
 
TypeCode * Proc::createStructTc (const std::string& id, const std::string& name)
{
  TypeCode* t = TypeCode::structTc(id.c_str(),name.c_str());
  if(typeMap.count(name)!=0)
    typeMap[name]->decrRef();
  typeMap[name]=t;
  t->incrRef();
  return t;
}
 
TypeCode * Proc::getTypeCode (const std::string& name)
{
  TypeCode* aTC=0;
  if(typeMap.count(name)==0)
    aTC=getRuntime()->getTypeCode(name);
  else
    aTC=typeMap[name];
 
  if(!aTC)
    {
      std::stringstream msg;
      msg << "Type " << name << " does not exist" ;
      msg << " (" <<__FILE__ << ":" << __LINE__ << ")";
      throw Exception(msg.str());
    }
 
  return aTC;
}
 
void Proc::setTypeCode (const std::string& name,TypeCode *t)
{
  if(typeMap.count(name)!=0)
    typeMap[name]->decrRef();
  typeMap[name]=t;
  t->incrRef();
}
 
 
void Proc::accept(Visitor *visitor)
{
  visitor->visitProc(this);
}
 
void Proc::setName(const std::string& name)
{
  Node::checkValidityOfNodeName(name);
  _name = name;
}
 
YACS::StatesForNode Proc::getNodeState(int numId)
{
  if(YACS::ENGINE::Node::idMap.count(numId) == 0)
    {
      cerr << "Unknown node id " << numId << endl;
      return YACS::UNDEFINED;
    }
  YACS::ENGINE::Node* node = YACS::ENGINE::Node::idMap[numId];
  YACS::StatesForNode state = node->getEffectiveState();
  return state;
}
 
std::string Proc::getNodeProgress(int numId)
{
  std::string progress = "0";
  if(YACS::ENGINE::Node::idMap.count(numId) == 0)
    {
      cerr << "Unknown node id " << numId << endl;
    }
  else if (YACS::ENGINE::ComposedNode* node = dynamic_cast<YACS::ENGINE::ComposedNode*>(YACS::ENGINE::Node::idMap[numId]))
    progress = node->getProgress();
  return progress;
}
 
int Proc::getGlobalProgressPercent()
{
  list<ProgressWeight> weightList = getProgressWeight();
  int weightDone = 0;
  int weightTotal = 0;
  int progressPercent = 0;
  for(list<ProgressWeight>::const_iterator iter=weightList.begin();iter!=weightList.end();iter++)
    {
      weightDone += (*iter).weightDone;
      weightTotal += (*iter).weightTotal;
    }
  if (weightTotal > 0)
    progressPercent = int(float(weightDone) / float(weightTotal) * 100);
  return progressPercent;
}
 
std::string Proc::getXMLState(int numId)
{
  if(YACS::ENGINE::Node::idMap.count(numId) == 0)
    {
      cerr << "Unknown node id " << numId << endl;
      return "<state>unknown</state>";
    }
  YACS::ENGINE::Node* node = YACS::ENGINE::Node::idMap[numId];
  stringstream msg;
  msg << "<state>" << node->getEffectiveState() << "</state>";
  msg << "<name>" << node->getQualifiedName() << "</name>";
  msg << "<id>" << numId << "</id>";
  return msg.str();
}
 
std::string Proc::getInPortValue(int nodeNumId, std::string portName)
{
  DEBTRACE("Proc::getInPortValue " << nodeNumId << " " << portName);
  stringstream msg;
  if(YACS::ENGINE::Node::idMap.count(nodeNumId) == 0)
    {
      msg << "<value><error>unknown node id: " << nodeNumId << "</error></value>";
      return msg.str();
    }
  try
    {
      YACS::ENGINE::Node* node = YACS::ENGINE::Node::idMap[nodeNumId];
      InputPort * inputPort = node->getInputPort(portName);
      return inputPort->getAsString();
    }
  catch(YACS::Exception& ex)
    {
      DEBTRACE("Proc::getInPortValue " << ex.what());
      msg << "<value><error>" << ex.what() << "</error></value>";
      return msg.str();
    }
}
 
std::string Proc::setInPortValue(std::string nodeName, std::string portName, std::string value)
{
  DEBTRACE("Proc::setInPortValue " << nodeName << " " << portName << " " << value);
 
  try
    {
      YACS::ENGINE::Node* node = YACS::ENGINE::Proc::nodeMap[nodeName];
      YACS::ENGINE::InputPort* inputPort = node->getInputPort(portName);
 
      switch (inputPort->edGetType()->kind())
        {
          case Double:
            {
              double val = atof(value.c_str());
              inputPort->edInit(val);
            }
            break;
          case Int:
            {
              int val = atoi(value.c_str());
              inputPort->edInit(val);
            }
            break;
          case String:
            inputPort->edInit(value.c_str());
            break;
          case Bool:
            {
              if((!value.compare("False")) || (!value.compare("false")))
                inputPort->edInit(false);
              else if ((!value.compare("True")) || (!value.compare("true")))
                inputPort->edInit(true);
              else
              {
                int val = atoi(value.c_str());
                inputPort->edInit(val);
              }
            }
            break;
          default:
            DEBTRACE("Proc::setInPortValue: filtered type: " << inputPort->edGetType()->kind());
        }
      return value;
    }
  catch(YACS::Exception& ex)
    {
      DEBTRACE("Proc::setInPortValue " << ex.what());
      stringstream msg;
      msg << "<value><error>" << ex.what() << "</error></value>";
      return msg.str();
    }
}
 
std::string Proc::getOutPortValue(int nodeNumId, std::string portName)
{
  DEBTRACE("Proc::getOutPortValue " << nodeNumId << " " << portName);
  stringstream msg;
  if(YACS::ENGINE::Node::idMap.count(nodeNumId) == 0)
    {
      msg << "<value><error>unknown node id: " << nodeNumId << "</error></value>";
      return msg.str();
    }
  try
    {
      YACS::ENGINE::Node* node = YACS::ENGINE::Node::idMap[nodeNumId];
      OutputPort * outputPort = node->getOutputPort(portName);
      return outputPort->getAsString();
    }
  catch(YACS::Exception& ex)
    {
      DEBTRACE("Proc::getOutPortValue " << ex.what());
      msg << "<value><error>" << ex.what() << "</error></value>";
      return msg.str();
    }
}
 
std::string Proc::getNodeErrorDetails(int nodeNumId)
{
  DEBTRACE("Proc::getNodeErrorDetails " << nodeNumId);
  stringstream msg;
  if(YACS::ENGINE::Node::idMap.count(nodeNumId) == 0)
    {
      msg << "Unknown node id " << nodeNumId;
      return msg.str();
    }
  YACS::ENGINE::Node* node = YACS::ENGINE::Node::idMap[nodeNumId];
  return node->getErrorDetails();
}
 
std::string Proc::getNodeErrorReport(int nodeNumId)
{
  DEBTRACE("Proc::getNodeErrorReport " << nodeNumId);
  stringstream msg;
  if(YACS::ENGINE::Node::idMap.count(nodeNumId) == 0)
    {
      msg << "Unknown node id " << nodeNumId;
      return msg.str();
    }
  YACS::ENGINE::Node* node = YACS::ENGINE::Node::idMap[nodeNumId];
  return node->getErrorReport();
}
 
std::string Proc::getNodeContainerLog(int nodeNumId)
{
  DEBTRACE("Proc::getNodeContainerLog " << nodeNumId);
  stringstream msg;
  if(YACS::ENGINE::Node::idMap.count(nodeNumId) == 0)
    {
      msg << "Unknown node id " << nodeNumId;
      return msg.str();
    }
  YACS::ENGINE::Node* node = YACS::ENGINE::Node::idMap[nodeNumId];
  return node->getContainerLog();
}
 
std::list<int> Proc::getNumIds()
{
  list<YACS::ENGINE::Node *> nodes = getAllRecursiveConstituents();
  int len = nodes.size();
  list<int> numids;
  for( list<YACS::ENGINE::Node *>::const_iterator iter = nodes.begin();
       iter != nodes.end(); iter++)
    {
      numids.push_back((*iter)->getNumId());
    }
  numids.push_back(this->getNumId());
  return numids;
}
 
std::list<std::string> Proc::getIds()
{
  list<YACS::ENGINE::Node *> nodes = getAllRecursiveConstituents();
  int len = nodes.size();
  list<string> ids;
  for( list<YACS::ENGINE::Node *>::const_iterator iter = nodes.begin();
       iter != nodes.end(); iter++)
    {
      ids.push_back(getChildName(*iter));
    }
  ids.push_back("_root_");
  return ids;
}
 
Logger *Proc::getLogger(const std::string& name)
{
  Logger* logger;
  LoggerMap::const_iterator it = _loggers.find(name);
 
  if (it != _loggers.end())
  {
    logger = it->second;
  }
  else
  {
    logger = new Logger(name);
    _loggers[name]=logger;
  }
  return logger;
}
 
void Proc::setEdition(bool edition)
{
  DEBTRACE("Proc::setEdition: " << edition);
  _edition=edition;
  if(_edition)
    edUpdateState();
}
 
void Proc::modified()
{
  DEBTRACE("Proc::modified() " << _edition);
  _modified=1;
  if(_edition)
    edUpdateState();
}
 
 
void Proc::saveSchema(const std::string& xmlSchemaFile)
{
  VisitorSaveSchema vss(this);
  vss.openFileSchema(xmlSchemaFile);
  accept(&vss);
  vss.closeFileSchema();
}
 
 
void Proc::saveState(const std::string& xmlStateFile)
{
  VisitorSaveState vst(this);
  vst.openFileDump(xmlStateFile);
  accept(&vst);
  vst.closeFileDump();
}
 
void Proc::removeContainers()
{
  //get rid of containers in container map
  std::map<std::string, Container*>::const_iterator it;
  for(it=containerMap.begin();it!=containerMap.end();it++)
    ((*it).second)->decrRef();
  containerMap.clear();
}
 
 
Container *Proc::createContainer(const std::string& name, const std::string& kind)
{
  Container *co(getRuntime()->createContainer(kind));
  co->setName(name);
  if(containerMap.count(name)!=0)
    containerMap[name]->decrRef();
  containerMap[name]=co;
  co->incrRef();
  co->setProc(this);
  return co;
}
 
 
void Proc::addComponentInstance(ComponentInstance* inst, const std::string& name, bool resetCtr)
{
  if(name != "")
    {
      inst->setName(name);
      inst->setAnonymous(false);
      if(componentInstanceMap.count(name)!=0)
        componentInstanceMap[name]->decrRef();
      componentInstanceMap[name]=inst;
      inst->incrRef();
    }
  else
    {
      //automatic naming : componame_<_compoinstctr>
      std::string instname;
      std::string componame=inst->getCompoName();
      if (resetCtr)
        _compoinstctr = 0;        
      while(1)
        {
          std::ostringstream buffer;
          buffer << ++_compoinstctr;
          instname=componame+"_"+buffer.str();
          if(componentInstanceMap.count(instname)==0)
            {
              inst->setName(instname);
              componentInstanceMap[instname]=inst;
              inst->incrRef();
              break;
            }
        }
    }
}
 
 
void Proc::removeComponentInstance(ComponentInstance* inst)
{
  if (componentInstanceMap.count(inst->getInstanceName()))
    {
      componentInstanceMap.erase(inst->getInstanceName());
      inst->decrRef();
    }
}
 
 
void Proc::removeContainer(Container* cont)
{
  if (containerMap.count(cont->getName()))
    {
      containerMap.erase(cont->getName());
      cont->decrRef();
    }
}
 
 
ComponentInstance* Proc::createComponentInstance(const std::string& componame, const std::string& name,const std::string& kind)
{
  ComponentInstance* inst=  getRuntime()->createComponentInstance(componame,kind);
  addComponentInstance(inst,name);
  return inst;
}
 
Proc* Proc::getProc()
{
  return this;
}
 
const Proc * Proc::getProc() const
{
  return this;
}
 
void Proc::updateContainersAndComponents()
{
  std::map<std::string, Container*> myContainerMap;
  std::map<std::string, ComponentInstance*> myComponentInstanceMap;
  DeploymentTree treeToDup(getDeploymentTree());
  vector<Container *> conts(treeToDup.getAllContainers());
  for(vector<Container *>::const_iterator iterCt=conts.begin();iterCt!=conts.end();iterCt++)
    {
      Container *tmp(*iterCt);
      if(tmp)
        {
          if(myContainerMap.find(tmp->getName())!=myContainerMap.end())
            {
              std::ostringstream oss; oss << "Proc::updateContainersAndComponents : more than one container instance with name \"" << tmp->getName() << "\" !";
              throw YACS::Exception(oss.str());
            }
          myContainerMap[tmp->getName()]=tmp;
          tmp->incrRef();
        }
      vector<ComponentInstance *> comps=treeToDup.getComponentsLinkedToContainer(*iterCt);
      for(vector<ComponentInstance *>::iterator iterCp=comps.begin();iterCp!=comps.end();iterCp++)
        {
          ComponentInstance *tmp2(*iterCp);
          if(tmp2)
            {
              if(myComponentInstanceMap.find(tmp2->getCompoName())!=myComponentInstanceMap.end())
                {
                  std::ostringstream oss; oss << "Proc::updateContainersAndComponents : more than one component instance with name \"" << tmp2->getCompoName() << "\" !";
                  throw YACS::Exception(oss.str());
                }
            }
          myComponentInstanceMap[tmp2->getCompoName()]=tmp2;
          tmp2->incrRef();
        }
    }
  removeContainers();
  containerMap=myContainerMap;
  componentInstanceMap=myComponentInstanceMap;
}