General KERNEL Documentation

End User KERNEL Services

---

idl/SALOME_Component.idl

Go to the documentation of this file.

//  Copyright (C) 2003  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
//  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS 
// 
//  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. 
// 
//  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
//
//
//
//  File   : SALOME_Component.idl
//  Author : Paul RASCLE, EDF
//  $Header: 

#ifndef _SALOME_COMPONENT_IDL_
#define _SALOME_COMPONENT_IDL_

module Engines
{
  typedef sequence<octet> TMPFile;  
  
  struct KeyValuePair
  {
    string key;
    any value;
  };

  typedef sequence<KeyValuePair> FieldsDict;

  interface Component ;
  interface fileRef ;
  interface fileTransfer ;

  interface Container
  {

    boolean load_component_Library(in string componentName);

    Component create_component_instance(in string componentName,
                         in long studyId);

    Component find_component_instance(in string registeredName,
                          in long studyId);

    Component load_impl(in string nameToRegister,
               in string componentName);

    void remove_impl(in Component component_i);

    void finalize_removal() ;

    void ping();

    readonly attribute string name ;

    oneway void Shutdown();

    string getHostName();

    long getPID();

    boolean Kill_impl() ;

    fileRef createFileRef(in string origFileName);

    fileTransfer getFileTransfer();

  };



  interface Component
  {
    readonly attribute string instanceName ;

    readonly attribute string interfaceName ;

    void ping();

//     /*!
//       Set study associated to component instance
//       \param studyId
//       (=0:  multistudy component instance,
//        >0: study id associated to this instance
//       \return false if already set with a different value (change not possible)
//     */
//     boolean setStudyId(in long studyId);

    long getStudyId();

    void destroy() ;

    Container GetContainerRef() ;

    void setProperties(in FieldsDict dico);

    FieldsDict getProperties();

    void Names( in string aGraphName , in string aNodeName ) ;

    boolean Kill_impl() ;

    boolean Stop_impl() ;

    boolean Suspend_impl() ;

    boolean Resume_impl() ;

    long CpuUsed_impl() ;
    
    TMPFile DumpPython(in Object theStudy,
                 in boolean isPublished, 
                 out boolean isValidScript); 

  } ;

  typedef sequence<octet> fileBlock;

  interface fileTransfer
  {
    long open(in string fileName);

    void close(in long fileId);

    fileBlock getBlock(in long fileId);
  };

  interface fileRef
  {
    readonly attribute string origFileName;
    readonly attribute string refMachine;

    Container getContainer();

    boolean addRef(in string machine,
          in string fileName);

    string getRef(in string machine);
  };

} ;

#endif

---

General KERNEL Documentation

End User KERNEL Services

Generated on Mon Sep 18 14:18:45 2006 for SALOME v.3.2.2 by  1.4.6