+++ /dev/null
-// 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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
-//
-//
-//
-// File : AddComponent.idl
-// Author :
-// $Header$
-
-#ifndef _ADDCOMPONENT_IDL
-#define _ADDCOMPONENT_IDL
-
-#include "SALOME_Component.idl"
-
-module SuperVisionTest {
-
- interface Adder ;
-
- interface AddComponent : Engines::Component {
- Adder Addition() ;
- double Add( in double x , in double y , out double z ) ;
- double LastResult() ;
- };
-
- interface Adder : Engines::Component {
- double Add( in double x , in double y , out double z ) ;
- double AddAndCompare( in double x , in double y , in Adder anOtherAdder,
- out double z ) ;
- void SetLastResult( in double z ) ;
- void LastResult( out double z ) ;
- };
-
-} ;
-
-#endif
+++ /dev/null
-// 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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
-//
-//
-//
-// File : Calculator.idl
-// Author : Laurent DADA CEA
-// $Header$
-
-#ifndef CALCULATOR_IDL
-#define CALCULATOR_IDL
-
-#include "SALOME_Component.idl"
-#include "MED.idl"
-
-
-module Engines {
-
-interface Calculator : Component
-{
-
- SALOME_MED::FIELDDOUBLE PutToStudy(in SALOME_MED::FIELDDOUBLE field1, in long theStudyId);
- SALOME_MED::FIELDDOUBLE Add(in SALOME_MED::FIELDDOUBLE field1, in SALOME_MED::FIELDDOUBLE field2);
- SALOME_MED::FIELDDOUBLE Mul(in SALOME_MED::FIELDDOUBLE field1, in double x1);
- SALOME_MED::FIELDDOUBLE Constant(in SALOME_MED::FIELDDOUBLE field1, in double x1);
- void writeMEDfile(in SALOME_MED::FIELDDOUBLE field1, in string fileName);
-
-};
-};
-
-
-
-#endif
+++ /dev/null
-// 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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
-//
-//
-//
-// File : DivComponent.idl
-// Author :
-// $Header$
-
-#ifndef _DIVCOMPONENT_IDL
-#define _DIVCOMPONENT_IDL
-
-#include "SALOME_Component.idl"
-
-module SuperVisionTest {
-
- interface DivComponent : Engines::Component {
- void Div( in double x , in double y , out double z ) ;
- };
-};
-
-
-#endif
+++ /dev/null
-// 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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
-//
-//
-//
-// File : FactorialComponent.idl
-// Author :
-// $Header$
-
-#include "SALOME_Component.idl"
-
-module SuperVisionTest {
-
- interface FactorialComponent : Engines::Component {
- long eval(in long n);
- };
-
-};
+++ /dev/null
-// 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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
-//
-//
-//
-// File : GEOM_Gen.idl
-// Author : Lucien PIGNOLONI
-
-#ifndef __GEOM_GEN__
-#define __GEOM_GEN__
-
-#include "SALOME_Exception.idl"
-#include "SALOME_Component.idl"
-#include "SALOMEDS.idl"
-#include "GEOM_Shape.idl"
-
-module GEOM
-{
- interface GEOM_Gen : Engines::Component,SALOMEDS::Driver
- {
- typedef sequence<string> ListOfIOR ;
- typedef sequence<GEOM_Shape> ListOfGeomShapes ;
-
- //--------------------------------------------------------------//
- // Studies Management //
- //--------------------------------------------------------------//
- void GetCurrentStudy(in long StudyID) ;
-
- short NbLabels();
-
- //--------------------------------------------------------------//
- // Shapes Management //
- //--------------------------------------------------------------//
- GEOM_Shape GetIORFromString (in string ior);
- ListOfIOR GetReferencedObjects(in GEOM_Shape shape);
- ListOfIOR GetObjects (in GEOM_Shape shape);
-
- //--------------------------------------------------------------//
- // Structures //
- //--------------------------------------------------------------//
- PointStruct MakePointStruct(in double x,
- in double y,
- in double z) ;
- DirStruct MakeDirection (in PointStruct p) ;
- AxisStruct MakeAxisStruct(in double x,
- in double y,
- in double z,
- in double vx,
- in double vy,
- in double vz) ;
-
- //------------------------------------------------------------//
- // Boolean Operations //
- //------------------------------------------------------------//
- GEOM_Shape MakeBoolean (in GEOM_Shape shape1,
- in GEOM_Shape shape2,
- in long operation) raises (SALOME::SALOME_Exception) ;
-
- GEOM_Shape MakeFuse( in GEOM_Shape shape1,
- in GEOM_Shape shape2) raises (SALOME::SALOME_Exception) ;
-
- //-----------------------------------------------------------//
- // Advanced Operations //
- //-----------------------------------------------------------//
- GEOM_Shape Partition (in ListOfIOR ListShapes,
- in ListOfIOR ListTools,
- in ListOfIOR ListKeepInside,
- in ListOfIOR ListRemoveInside,
- in short Limit)
- raises (SALOME::SALOME_Exception) ;
-
-
- GEOM_Shape MakeFilling(in GEOM_Shape shape,
- in short mindeg,
- in short maxdeg,
- in double tol3d,
- in double tol2d,
- in short nbiter) raises (SALOME::SALOME_Exception) ;
- GEOM_Shape MakeSewing (in ListOfIOR ListShape,
- in double precision) raises (SALOME::SALOME_Exception) ;
- GEOM_Shape MakeSewingShape( in GEOM_Shape aShape,
- in double precision ) raises (SALOME::SALOME_Exception);
-
- GEOM_Shape OrientationChange(in GEOM_Shape shape) raises (SALOME::SALOME_Exception) ;
-
- GEOM_Shape MakePlacedBox(in double x1, in double y1, in double z1,
- in double delta1, in double delta2, in double delta3) raises (SALOME::SALOME_Exception) ;
- GEOM_Shape MakePanel(in GEOM_Shape shape,
- in short directiontype,
- in double delta) raises (SALOME::SALOME_Exception) ;
- GEOM_Shape MakeGlueFaces(in GEOM_Shape shape,
- in double tol3d) raises (SALOME::SALOME_Exception) ;
-
- //-----------------------------------------------------------//
- // Transformations Operations //
- //-----------------------------------------------------------//
- GEOM_Shape MakeCopy(in GEOM_Shape shape) raises (SALOME::SALOME_Exception) ;
-
- GEOM_Shape MakeTranslation(in GEOM_Shape shape,
- in double x,
- in double y,
- in double z) raises (SALOME::SALOME_Exception) ;
- GEOM_Shape MakeRotation(in GEOM_Shape shape,
- in AxisStruct axis,
- in double angle) raises (SALOME::SALOME_Exception) ;
- GEOM_Shape MakeScaleTransform(in GEOM_Shape shape,
- in PointStruct theCenterofScale,
- in double factor) raises (SALOME::SALOME_Exception) ;
- GEOM_Shape MakeMirrorByPlane(in GEOM_Shape shape,
- in GEOM_Shape shapePlane) raises (SALOME::SALOME_Exception) ;
- GEOM_Shape MakeRevolution(in GEOM_Shape shape,
- in AxisStruct axis,
- in double angle) raises (SALOME::SALOME_Exception) ;
- GEOM_Shape MakePrism(in GEOM_Shape baseShape,
- in PointStruct P1,
- in PointStruct P2) raises (SALOME::SALOME_Exception) ;
- GEOM_Shape MakePipe(in GEOM_Shape pathShape,
- in GEOM_Shape baseShape) raises (SALOME::SALOME_Exception) ;
-
- //-----------------------------------------------------------//
- // Patterns Construction //
- //-----------------------------------------------------------//
- GEOM_Shape MakeMultiTranslation1D(in GEOM_Shape shape,
- in DirStruct dir,
- in double step,
- in short nbtimes) raises (SALOME::SALOME_Exception) ;
- GEOM_Shape MakeMultiTranslation2D(in GEOM_Shape shape,
- in DirStruct dir1,
- in double step1,
- in short nbtimes1,
- in DirStruct dir2,
- in double step2,
- in short nbtimes2) raises (SALOME::SALOME_Exception) ;
- GEOM_Shape MakeMultiRotation1D(in GEOM_Shape shape,
- in DirStruct dir,
- in PointStruct loc,
- in short nbtimes) raises (SALOME::SALOME_Exception) ;
- GEOM_Shape MakeMultiRotation2D(in GEOM_Shape shape,
- in DirStruct dir,
- in PointStruct loc,
- in double ang,
- in short nbtimes1,
- in double step,
- in short nbtimes2) raises (SALOME::SALOME_Exception) ;
-
- //-----------------------------------------------------------//
- // Mesures Construction //
- //-----------------------------------------------------------//
- GEOM_Shape MakeCDG(in GEOM_Shape shape) raises (SALOME::SALOME_Exception) ;
-
-
- //-----------------------------------------------------------//
- // Primitives Construction //
- //-----------------------------------------------------------//
-
- GEOM_Shape MakeVertex(in double x,
- in double y,
- in double z) raises (SALOME::SALOME_Exception) ;
- GEOM_Shape MakeVector (in PointStruct pstruct1,
- in PointStruct pstruct2) raises (SALOME::SALOME_Exception) ;
- GEOM_Shape MakeLine (in PointStruct pstruct,
- in DirStruct dstruct) raises (SALOME::SALOME_Exception) ;
- GEOM_Shape MakePlane (in PointStruct pstruct,
- in DirStruct dstruct,
- in double trimsize) raises (SALOME::SALOME_Exception) ;
- GEOM_Shape MakeCircle(in PointStruct pstruct,
- in DirStruct dstruct,
- in double radius) raises (SALOME::SALOME_Exception) ;
- GEOM_Shape MakeArc(in PointStruct pInit,
- in PointStruct pCircle,
- in PointStruct pEnd) raises (SALOME::SALOME_Exception) ;
-
- //-----------------------------------------------------------//
- // Primitives Construction //
- //-----------------------------------------------------------//
- GEOM_Shape MakeBox (in double x1,
- in double y1,
- in double z1,
- in double x2,
- in double y2,
- in double z2) raises (SALOME::SALOME_Exception) ;
- GEOM_Shape MakeCylinder(in PointStruct pstruct,
- in DirStruct dstruct,
- in double radius,
- in double height) raises (SALOME::SALOME_Exception) ;
-
- GEOM_Shape MakeSphere (in double x1,
- in double y1,
- in double z1,
- in double radius) raises (SALOME::SALOME_Exception) ;
-
- GEOM_Shape MakeTorus(in PointStruct pstruct,
- in DirStruct dstruct,
- in double major_radius,
- in double minor_radius) raises (SALOME::SALOME_Exception) ;
-
- GEOM_Shape MakeCone(in PointStruct pstruct,
- in DirStruct dstruct,
- in double radius1,
- in double radius2,
- in double height) raises (SALOME::SALOME_Exception) ;
-
- //-----------------------------------------------------------//
- // Archimede //
- //-----------------------------------------------------------//
- GEOM_Shape Archimede(in GEOM_Shape shape,
- in double Weight,
- in double WaterDensity,
- in double MeshingDeflection) raises (SALOME::SALOME_Exception);
-
- //-----------------------------------------------------------//
- // Build //
- //-----------------------------------------------------------//
- GEOM_Shape MakeEdge (in PointStruct pstruct1,
- in PointStruct pstruct2) raises (SALOME::SALOME_Exception) ;
- GEOM_Shape MakeWire (in ListOfIOR ListShape) raises (SALOME::SALOME_Exception) ;
- GEOM_Shape MakeCompound (in ListOfIOR ListShape) raises (SALOME::SALOME_Exception) ;
- GEOM_Shape MakeFace (in GEOM_Shape shapeWire,
- in boolean wantplanarface ) raises (SALOME::SALOME_Exception) ;
-
-
- //-----------------------------------------------------------//
- // Subshapes Construction for GUI only //
- //-----------------------------------------------------------//
- GEOM_Shape SubShape(in GEOM_Shape shape,
- in short ShapeType,
- in GEOM_Shape::ListOfSubShapeID ListOfID) raises (SALOME::SALOME_Exception) ;
-
- //-----------------------------------------------------------//
- // Subshapes Construction for TUI or GUI //
- //-----------------------------------------------------------//
- ListOfGeomShapes SubShapeAll(in GEOM_Shape shape,
- in short ShapeType) raises (SALOME::SALOME_Exception) ;
-
- //-----------------------------------------------------------//
- // Subshapes Construction
- // Use it to have the same order of subshapes if their
- // order may change as a result of <shape> reconstruction using
- // boolean operations, fillet etc.
- //-----------------------------------------------------------//
- GEOM_Shape SubShapeSorted(in GEOM_Shape shape,
- in short ShapeType,
- in GEOM_Shape::ListOfSubShapeID ListOfID) raises (SALOME::SALOME_Exception) ;
-
- ListOfGeomShapes SubShapeAllSorted(in GEOM_Shape shape,
- in short ShapeType) raises (SALOME::SALOME_Exception) ;
-
- //-----------------------------------------------------------//
- // Fillet and Chamfer construction //
- //-----------------------------------------------------------//
- GEOM_Shape MakeFillet(in GEOM_Shape shape,
- in double radius,
- in short ShapeType,
- in GEOM_Shape::ListOfSubShapeID ListOfID) raises (SALOME::SALOME_Exception) ;
-
- GEOM_Shape MakeChamfer(in GEOM_Shape shape,
- in double d1,
- in double d2,
- in short ShapeType,
- in GEOM_Shape::ListOfSubShapeID ListOfID) raises (SALOME::SALOME_Exception) ;
-
- //-----------------------------------------------------------//
- // Suppress faces in a shape //
- //-----------------------------------------------------------//
- ListOfGeomShapes SuppressFaces(in GEOM_Shape shape,
- in GEOM_Shape::ListOfSubShapeID ListOfID) raises (SALOME::SALOME_Exception) ;
-
- //-----------------------------------------------------------//
- // Suppress a single hole in topology (face) shell or solid //
- // : ListOfIdEndFace may be an empty list //
- // : used only when hole traverses the topology //
- //-----------------------------------------------------------//
- GEOM_Shape SuppressHole(in GEOM_Shape shape,
- in GEOM_Shape::ListOfSubShapeID ListOfIdFace,
- in GEOM_Shape::ListOfSubShapeID ListOfIdWire,
- in GEOM_Shape::ListOfSubShapeID ListOfIdEndFace ) raises (SALOME::SALOME_Exception) ;
-
- //-----------------------------------------------------------//
- // Suppress one or more holes in a face or a shell //
- //-----------------------------------------------------------//
- GEOM_Shape SuppressHolesInFaceOrShell(in GEOM_Shape shapeFaceShell,
- in GEOM_Shape::ListOfSubShapeID ListOfIdWires ) raises (SALOME::SALOME_Exception) ;
-
- //-----------------------------------------------------------//
- // Import/Export //
- //-----------------------------------------------------------//
- GEOM_Shape ImportIGES(in string filename) raises (SALOME::SALOME_Exception) ;
- GEOM_Shape ImportBREP(in string filename) raises (SALOME::SALOME_Exception) ;
- GEOM_Shape ImportSTEP(in string filename) raises (SALOME::SALOME_Exception) ;
-
- void ExportIGES(in string filename,in GEOM_Shape theShape) raises (SALOME::SALOME_Exception) ;
- void ExportBREP(in string filename,in GEOM_Shape theShape) raises (SALOME::SALOME_Exception) ;
- void ExportSTEP(in string filename,in GEOM_Shape theShape) raises (SALOME::SALOME_Exception) ;
- //-----------------------------------------------------------//
- // Check Shape //
- //-----------------------------------------------------------//
- boolean CheckShape(in GEOM_Shape shape) raises (SALOME::SALOME_Exception) ;
-
- };
-};
-
-#endif
+++ /dev/null
-// 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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
-//
-//
-//
-// File : GEOM_Shape.idl
-// Author : Lucien PIGNOLONI
-
-#ifndef __GEOM_Shape__
-#define __GEOM_Shape__
-
-module GEOM
-{
- //-----------------------------------------------------------------//
- // Topological types for shapes (like Open Cascade types) //
- //-----------------------------------------------------------------//
-
- enum shape_type { COMPOUND, COMPSOLID, SOLID, SHELL,
- FACE, WIRE, EDGE, VERTEX, SHAPE } ;
-
- //----------------------------------------------------------------//
- // Structures //
- //--------------------------------------------------- ------------//
- struct PointStruct { double x;
- double y;
- double z; } ;
- struct DirStruct { PointStruct PS ; } ; // analog to Occ Direction
-
- struct AxisStruct { double x;
- double y;
- double z;
- double vx;
- double vy;
- double vz; } ;
-
- //----------------------------------------------------------------//
- // interface GEOM_Shape methods //
- //----------------------------------------------------------------//
-
- interface GEOM_Gen;
-
- interface GEOM_Shape
- {
- typedef sequence<long> ListOfSubShapeID ;
- typedef sequence<octet> TMPFile;
-
- attribute string Name; // (to set and get) the name of shape (= CORBA IOR converted into a string)
- attribute string MainName; // (to set and get) the name of mainshape (= CORBA IOR converted into a string)
-
- attribute boolean IsMainShape; // (...) true if this is a main shape (not a sub shape)
- attribute string ShapeId; // (...) the entry of the shape in geom/OCAF document
- attribute string StudyShapeId; // (...) the entry of the shape in the study/OCAF when added
- attribute ListOfSubShapeID Index; // (...) list of references (number) identifing the sub shapes in the main shape
- attribute shape_type ShapeType; // (...) a topological type of the shape
-
- attribute string NameType; // (...) a topological/geometrical name of the shape
-
- //Transfer resulting shape to client as sequence of bytes
- //client can extract shape from stream using BrepTools::Read function
- TMPFile GetShapeStream();
-
- // the generator engine
- GEOM_Gen Engine();
-
- };
-};
-#endif
+++ /dev/null
-// 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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
-//
-//
-//
-// File : GEOM_Gen.idl
-// Author : Lucien PIGNOLONI
-
-#ifndef __GEOM_GEN__
-#define __GEOM_GEN__
-
-#include "SALOME_Exception.idl"
-#include "SALOME_Component.idl"
-#include "SALOMEDS.idl"
-#include "GEOM_Shape.idl"
-
-module GEOM
-{
- interface GEOM_Gen : Engines::Component,SALOMEDS::Driver
- {
- typedef sequence<string> ListOfIOR ;
- typedef sequence<GEOM_Shape> ListOfGeomShapes ;
-
- //--------------------------------------------------------------//
- // Studies Management //
- //--------------------------------------------------------------//
- void GetCurrentStudy(in long StudyID) ;
-
- short NbLabels();
-
- //--------------------------------------------------------------//
- // Shapes Management //
- //--------------------------------------------------------------//
- GEOM_Shape GetIORFromString (in string ior);
- ListOfIOR GetReferencedObjects(in GEOM_Shape shape);
- ListOfIOR GetObjects (in GEOM_Shape shape);
-
- //--------------------------------------------------------------//
- // Structures //
- //--------------------------------------------------------------//
- PointStruct MakePointStruct(in double x,
- in double y,
- in double z) ;
- DirStruct MakeDirection (in PointStruct p) ;
- AxisStruct MakeAxisStruct(in double x,
- in double y,
- in double z,
- in double vx,
- in double vy,
- in double vz) ;
-
- //------------------------------------------------------------//
- // Boolean Operations //
- //------------------------------------------------------------//
- GEOM_Shape MakeBoolean (in GEOM_Shape shape1,
- in GEOM_Shape shape2,
- in long operation) raises (SALOME::SALOME_Exception) ;
-
- GEOM_Shape MakeFuse( in GEOM_Shape shape1,
- in GEOM_Shape shape2) raises (SALOME::SALOME_Exception) ;
-
- //-----------------------------------------------------------//
- // Advanced Operations //
- //-----------------------------------------------------------//
- GEOM_Shape Partition (in ListOfIOR ListShapes,
- in ListOfIOR ListTools,
- in ListOfIOR ListKeepInside,
- in ListOfIOR ListRemoveInside,
- in short Limit)
- raises (SALOME::SALOME_Exception) ;
-
-
- GEOM_Shape MakeFilling(in GEOM_Shape shape,
- in short mindeg,
- in short maxdeg,
- in double tol3d,
- in double tol2d,
- in short nbiter) raises (SALOME::SALOME_Exception) ;
- GEOM_Shape MakeSewing (in ListOfIOR ListShape,
- in double precision) raises (SALOME::SALOME_Exception) ;
- GEOM_Shape MakeSewingShape( in GEOM_Shape aShape,
- in double precision ) raises (SALOME::SALOME_Exception);
-
- GEOM_Shape OrientationChange(in GEOM_Shape shape) raises (SALOME::SALOME_Exception) ;
-
- GEOM_Shape MakePlacedBox(in double x1, in double y1, in double z1,
- in double delta1, in double delta2, in double delta3) raises (SALOME::SALOME_Exception) ;
- GEOM_Shape MakePanel(in GEOM_Shape shape,
- in short directiontype,
- in double delta) raises (SALOME::SALOME_Exception) ;
- GEOM_Shape MakeGlueFaces(in GEOM_Shape shape,
- in double tol3d) raises (SALOME::SALOME_Exception) ;
-
- //-----------------------------------------------------------//
- // Transformations Operations //
- //-----------------------------------------------------------//
- GEOM_Shape MakeCopy(in GEOM_Shape shape) raises (SALOME::SALOME_Exception) ;
-
- GEOM_Shape MakeTranslation(in GEOM_Shape shape,
- in double x,
- in double y,
- in double z) raises (SALOME::SALOME_Exception) ;
- GEOM_Shape MakeRotation(in GEOM_Shape shape,
- in AxisStruct axis,
- in double angle) raises (SALOME::SALOME_Exception) ;
- GEOM_Shape MakeScaleTransform(in GEOM_Shape shape,
- in PointStruct theCenterofScale,
- in double factor) raises (SALOME::SALOME_Exception) ;
- GEOM_Shape MakeMirrorByPlane(in GEOM_Shape shape,
- in GEOM_Shape shapePlane) raises (SALOME::SALOME_Exception) ;
- GEOM_Shape MakeRevolution(in GEOM_Shape shape,
- in AxisStruct axis,
- in double angle) raises (SALOME::SALOME_Exception) ;
- GEOM_Shape MakePrism(in GEOM_Shape baseShape,
- in PointStruct P1,
- in PointStruct P2) raises (SALOME::SALOME_Exception) ;
- GEOM_Shape MakePipe(in GEOM_Shape pathShape,
- in GEOM_Shape baseShape) raises (SALOME::SALOME_Exception) ;
-
- //-----------------------------------------------------------//
- // Patterns Construction //
- //-----------------------------------------------------------//
- GEOM_Shape MakeMultiTranslation1D(in GEOM_Shape shape,
- in DirStruct dir,
- in double step,
- in short nbtimes) raises (SALOME::SALOME_Exception) ;
- GEOM_Shape MakeMultiTranslation2D(in GEOM_Shape shape,
- in DirStruct dir1,
- in double step1,
- in short nbtimes1,
- in DirStruct dir2,
- in double step2,
- in short nbtimes2) raises (SALOME::SALOME_Exception) ;
- GEOM_Shape MakeMultiRotation1D(in GEOM_Shape shape,
- in DirStruct dir,
- in PointStruct loc,
- in short nbtimes) raises (SALOME::SALOME_Exception) ;
- GEOM_Shape MakeMultiRotation2D(in GEOM_Shape shape,
- in DirStruct dir,
- in PointStruct loc,
- in double ang,
- in short nbtimes1,
- in double step,
- in short nbtimes2) raises (SALOME::SALOME_Exception) ;
-
- //-----------------------------------------------------------//
- // Mesures Construction //
- //-----------------------------------------------------------//
- GEOM_Shape MakeCDG(in GEOM_Shape shape) raises (SALOME::SALOME_Exception) ;
-
-
- //-----------------------------------------------------------//
- // Primitives Construction //
- //-----------------------------------------------------------//
-
- GEOM_Shape MakeVertex(in double x,
- in double y,
- in double z) raises (SALOME::SALOME_Exception) ;
- GEOM_Shape MakeVector (in PointStruct pstruct1,
- in PointStruct pstruct2) raises (SALOME::SALOME_Exception) ;
- GEOM_Shape MakeLine (in PointStruct pstruct,
- in DirStruct dstruct) raises (SALOME::SALOME_Exception) ;
- GEOM_Shape MakePlane (in PointStruct pstruct,
- in DirStruct dstruct,
- in double trimsize) raises (SALOME::SALOME_Exception) ;
- GEOM_Shape MakeCircle(in PointStruct pstruct,
- in DirStruct dstruct,
- in double radius) raises (SALOME::SALOME_Exception) ;
- GEOM_Shape MakeArc(in PointStruct pInit,
- in PointStruct pCircle,
- in PointStruct pEnd) raises (SALOME::SALOME_Exception) ;
-
- //-----------------------------------------------------------//
- // Primitives Construction //
- //-----------------------------------------------------------//
- GEOM_Shape MakeBox (in double x1,
- in double y1,
- in double z1,
- in double x2,
- in double y2,
- in double z2) raises (SALOME::SALOME_Exception) ;
- GEOM_Shape MakeCylinder(in PointStruct pstruct,
- in DirStruct dstruct,
- in double radius,
- in double height) raises (SALOME::SALOME_Exception) ;
-
- GEOM_Shape MakeSphere (in double x1,
- in double y1,
- in double z1,
- in double radius) raises (SALOME::SALOME_Exception) ;
-
- GEOM_Shape MakeTorus(in PointStruct pstruct,
- in DirStruct dstruct,
- in double major_radius,
- in double minor_radius) raises (SALOME::SALOME_Exception) ;
-
- GEOM_Shape MakeCone(in PointStruct pstruct,
- in DirStruct dstruct,
- in double radius1,
- in double radius2,
- in double height) raises (SALOME::SALOME_Exception) ;
-
- //-----------------------------------------------------------//
- // Archimede //
- //-----------------------------------------------------------//
- GEOM_Shape Archimede(in GEOM_Shape shape,
- in double Weight,
- in double WaterDensity,
- in double MeshingDeflection) raises (SALOME::SALOME_Exception);
-
- //-----------------------------------------------------------//
- // Build //
- //-----------------------------------------------------------//
- GEOM_Shape MakeEdge (in PointStruct pstruct1,
- in PointStruct pstruct2) raises (SALOME::SALOME_Exception) ;
- GEOM_Shape MakeWire (in ListOfIOR ListShape) raises (SALOME::SALOME_Exception) ;
- GEOM_Shape MakeCompound (in ListOfIOR ListShape) raises (SALOME::SALOME_Exception) ;
- GEOM_Shape MakeFace (in GEOM_Shape shapeWire,
- in boolean wantplanarface ) raises (SALOME::SALOME_Exception) ;
-
-
- //-----------------------------------------------------------//
- // Subshapes Construction for GUI only //
- //-----------------------------------------------------------//
- GEOM_Shape SubShape(in GEOM_Shape shape,
- in short ShapeType,
- in GEOM_Shape::ListOfSubShapeID ListOfID) raises (SALOME::SALOME_Exception) ;
-
- //-----------------------------------------------------------//
- // Subshapes Construction for TUI or GUI //
- //-----------------------------------------------------------//
- ListOfGeomShapes SubShapeAll(in GEOM_Shape shape,
- in short ShapeType) raises (SALOME::SALOME_Exception) ;
-
- //-----------------------------------------------------------//
- // Subshapes Construction
- // Use it to have the same order of subshapes if their
- // order may change as a result of <shape> reconstruction using
- // boolean operations, fillet etc.
- //-----------------------------------------------------------//
- GEOM_Shape SubShapeSorted(in GEOM_Shape shape,
- in short ShapeType,
- in GEOM_Shape::ListOfSubShapeID ListOfID) raises (SALOME::SALOME_Exception) ;
-
- ListOfGeomShapes SubShapeAllSorted(in GEOM_Shape shape,
- in short ShapeType) raises (SALOME::SALOME_Exception) ;
-
- //-----------------------------------------------------------//
- // Fillet and Chamfer construction //
- //-----------------------------------------------------------//
- GEOM_Shape MakeFillet(in GEOM_Shape shape,
- in double radius,
- in short ShapeType,
- in GEOM_Shape::ListOfSubShapeID ListOfID) raises (SALOME::SALOME_Exception) ;
-
- GEOM_Shape MakeChamfer(in GEOM_Shape shape,
- in double d1,
- in double d2,
- in short ShapeType,
- in GEOM_Shape::ListOfSubShapeID ListOfID) raises (SALOME::SALOME_Exception) ;
-
- //-----------------------------------------------------------//
- // Suppress faces in a shape //
- //-----------------------------------------------------------//
- ListOfGeomShapes SuppressFaces(in GEOM_Shape shape,
- in GEOM_Shape::ListOfSubShapeID ListOfID) raises (SALOME::SALOME_Exception) ;
-
- //-----------------------------------------------------------//
- // Suppress a single hole in topology (face) shell or solid //
- // : ListOfIdEndFace may be an empty list //
- // : used only when hole traverses the topology //
- //-----------------------------------------------------------//
- GEOM_Shape SuppressHole(in GEOM_Shape shape,
- in GEOM_Shape::ListOfSubShapeID ListOfIdFace,
- in GEOM_Shape::ListOfSubShapeID ListOfIdWire,
- in GEOM_Shape::ListOfSubShapeID ListOfIdEndFace ) raises (SALOME::SALOME_Exception) ;
-
- //-----------------------------------------------------------//
- // Suppress one or more holes in a face or a shell //
- //-----------------------------------------------------------//
- GEOM_Shape SuppressHolesInFaceOrShell(in GEOM_Shape shapeFaceShell,
- in GEOM_Shape::ListOfSubShapeID ListOfIdWires ) raises (SALOME::SALOME_Exception) ;
-
- //-----------------------------------------------------------//
- // Import/Export //
- //-----------------------------------------------------------//
- GEOM_Shape ImportIGES(in string filename) raises (SALOME::SALOME_Exception) ;
- GEOM_Shape ImportBREP(in string filename) raises (SALOME::SALOME_Exception) ;
- GEOM_Shape ImportSTEP(in string filename) raises (SALOME::SALOME_Exception) ;
-
- void ExportIGES(in string filename,in GEOM_Shape theShape) raises (SALOME::SALOME_Exception) ;
- void ExportBREP(in string filename,in GEOM_Shape theShape) raises (SALOME::SALOME_Exception) ;
- void ExportSTEP(in string filename,in GEOM_Shape theShape) raises (SALOME::SALOME_Exception) ;
- //-----------------------------------------------------------//
- // Check Shape //
- //-----------------------------------------------------------//
- boolean CheckShape(in GEOM_Shape shape) raises (SALOME::SALOME_Exception) ;
-
- };
-};
-
-#endif
+++ /dev/null
-// 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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
-//
-//
-//
-// File : GEOM_Shape.idl
-// Author : Lucien PIGNOLONI
-
-#ifndef __GEOM_Shape__
-#define __GEOM_Shape__
-
-module GEOM
-{
- //-----------------------------------------------------------------//
- // Topological types for shapes (like Open Cascade types) //
- //-----------------------------------------------------------------//
-
- enum shape_type { COMPOUND, COMPSOLID, SOLID, SHELL,
- FACE, WIRE, EDGE, VERTEX, SHAPE } ;
-
- //----------------------------------------------------------------//
- // Structures //
- //--------------------------------------------------- ------------//
- struct PointStruct { double x;
- double y;
- double z; } ;
- struct DirStruct { PointStruct PS ; } ; // analog to Occ Direction
-
- struct AxisStruct { double x;
- double y;
- double z;
- double vx;
- double vy;
- double vz; } ;
-
- //----------------------------------------------------------------//
- // interface GEOM_Shape methods //
- //----------------------------------------------------------------//
-
- interface GEOM_Gen;
-
- interface GEOM_Shape
- {
- typedef sequence<long> ListOfSubShapeID ;
- typedef sequence<octet> TMPFile;
-
- attribute string Name; // (to set and get) the name of shape (= CORBA IOR converted into a string)
- attribute string MainName; // (to set and get) the name of mainshape (= CORBA IOR converted into a string)
-
- attribute boolean IsMainShape; // (...) true if this is a main shape (not a sub shape)
- attribute string ShapeId; // (...) the entry of the shape in geom/OCAF document
- attribute string StudyShapeId; // (...) the entry of the shape in the study/OCAF when added
- attribute ListOfSubShapeID Index; // (...) list of references (number) identifing the sub shapes in the main shape
- attribute shape_type ShapeType; // (...) a topological type of the shape
-
- attribute string NameType; // (...) a topological/geometrical name of the shape
-
- //Transfer resulting shape to client as sequence of bytes
- //client can extract shape from stream using BrepTools::Read function
- TMPFile GetShapeStream();
-
- // the generator engine
- GEOM_Gen Engine();
-
- };
-};
-#endif
+++ /dev/null
-// Copyright (C) 2003 CEA/DEN, EDF R&D
-//
-//
-//
-// File : Logger.idl
-// Author : Vasily Rusyaev
-
-#ifndef SALOME_LOGGER_IDL
-#define SALOME_LOGGER_IDL
-
-#pragma prefix "opencascade.com"
-
-module SALOME_Logger
-{
- interface Logger
- {
- //put message into one special place for all servers using Logger
- oneway void putMessage (in string message);
- };
-};
-
-
-
-#endif
+++ /dev/null
-// 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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
-//
-//
-//
-// File : MED.idl
-// $Header$
-
-/*!
-This file contains the main IDL difinitions of the %MED component in %SALOME application.
-*/
-#ifndef MED_IDL
-#define MED_IDL
-/*!
- \defgroup MED SALOME MED component
-*/
-
-#include "SALOME_Exception.idl"
-#include "SALOME_Component.idl"
-#include "SALOMEDS.idl"
-
-module Engines {
- /*!
- An array of long
- */
- typedef sequence<long> long_array;
- /*!
- An array of double
- */
- typedef sequence<double> double_array;
- /*!
- An array of string
- */
- typedef sequence<string> string_array;
- /*!
- An array of boolean
- */
- typedef sequence<boolean> boolean_array;
-
-};
-/*! \ingroup MED
-This package contains a set of interfaces used for %SALOME %MED component.
-*/
-
-module SALOME_MED {
-
- // interface FIELD;
- interface FIELD;
- interface FAMILY;
- interface GROUP;
- interface MESH;
- interface SUPPORT;
-
-/*!
-This enumeration conatains a set of elements difining the type of geometrical elements which constitue
-a %Mesh.
-*/
- enum medGeometryElement {
- MED_NONE,
- MED_POINT1,
- MED_SEG2,
- MED_SEG3,
- MED_TRIA3,
- MED_QUAD4,
- MED_TRIA6,
- MED_QUAD8,
- MED_TETRA4,
- MED_PYRA5,
- MED_PENTA6,
- MED_HEXA8,
- MED_TETRA10,
- MED_PYRA13,
- MED_PENTA15,
- MED_HEXA20,
- MED_ALL_ELEMENTS
- };
-/*!
-This enumeration conatains a set of elements difining the structural elements (entities) which constitue
-a %Mesh.
-*/
-
- enum medEntityMesh {
- MED_CELL,
- MED_FACE,
- MED_EDGE,
- MED_NODE,
- MED_ALL_ENTITIES
- };
-
- enum medModeSwitch {
- MED_FULL_INTERLACE,
- MED_NO_INTERLACE
- };
-
- enum medConnectivity {
- MED_NODAL,
- MED_DESCENDING
- };
-/*!
-This enumeration conatains a set of elements difining the type of driver.
-*/
-
- enum medDriverTypes {
- MED_DRIVER , /*!<This driver is used for reading into memory of the mesh from %MED file.*/
- VTK_DRIVER , /*!<This driver is used for visualization of the mesh imported from %MED file.*/
- NO_DRIVER
- };
-
- /*!
- An array of <VAR>medGeometryElement</VAR>
- */
- typedef sequence<medGeometryElement> medGeometryElement_array;
- /*!
- An array of %FAMILY
- */
- typedef sequence<FAMILY> Family_array;
- /*!
- An array of %GROUP
- */
- typedef sequence<GROUP> Group_array;
-
- // ----------------------
- // mesh interface
- // ----------------------
-
- interface MESH {
- // Index range begins from 1
-
- // General Informations
- //---------------------
-
- /*!
- Returns the name of the mesh .
- */
- string getName() raises (SALOME::SALOME_Exception);
-
- /*!
- Returns space dimension.
- */
- long getSpaceDimension() raises (SALOME::SALOME_Exception);
-
- /*!
- Returns mesh dimension.
-
- Example :
- - we have only MED_TETRA4 in MED_CELL : MeshDimension = 3D
- - we have only MED_QUAD4 in MED_CELL : MeshDimension = 2D
- - we have both MED_SEG2 and MED_TRIA3 in MED_CELL : MeshDimension = 2D
- */
- long getMeshDimension() raises (SALOME::SALOME_Exception);
-
- // Coordinates
- //------------
-
- /*!
- Returns coordinate system :
- - "CARTESIAN"
- - "CYLINDRICAL"
- - "SPHERICAL"
- */
- string getCoordinateSystem() raises (SALOME::SALOME_Exception);
-
- /*!
- Returns the number of nodes defined in the mesh.
- */
- long getNumberOfNodes() raises (SALOME::SALOME_Exception);
-
- /*!
- Returns an array of coordinates :
- - X1,Y1,Z1,X2,Y2,...,Zn if MED_FULL_INTERLACE
- - X1,X2,...Xn,Y1,Y2,...Zn if MED_NO_INTERLACE
- */
- Engines::double_array getCoordinates(in medModeSwitch typeSwitch)
- raises (SALOME::SALOME_Exception);
-
- /*!
- Returns an array containing the names of coordinates.
-
- Example :
- - x,y,z
- - r,teta,phi
- - ...
-
- It could be empty.
- */
- Engines::string_array getCoordinatesNames()
- raises (SALOME::SALOME_Exception);
-
- /*!
- Returns an array containing the units of coordinates (cm, m, mm, ...)
-
- It could be empty. By defult IS is used (meter).
- */
- Engines::string_array getCoordinatesUnits()
- raises (SALOME::SALOME_Exception);
-
- // Connectivity
- // ------------
-
- /*!
- Returns the number of different <VAR>medGeometryElement</VAR> types existing
- in the specified entity.
-
- \note
- Not implemented for MED_ALL_ENTITIES.
- */
- long getNumberOfTypes(in medEntityMesh entity)
- raises (SALOME::SALOME_Exception);
-
- /*!
- Returns an array of all <VAR>medGeometryElement</VAR> types existing
- in the mesh.
-
- \note
- Not implemented for MED_ALL_ENTITIES.
- */
- medGeometryElement_array getTypes(in medEntityMesh entity)
- raises (SALOME::SALOME_Exception);
-
- /*!
- Returns the number of elements of type <VAR>medGeometryElement</VAR>.
-
- Note :
- - Implemented for MED_ALL_ELEMENTS
- - Not implemented for MED_ALL_ENTITIES
- */
- long getNumberOfElements(in medEntityMesh entity,
- in medGeometryElement geomElement)
- raises (SALOME::SALOME_Exception);
-
- /*!
- Give, in full or no interlace mode (for nodal connectivity),
- descending or nodal connectivity.
-
- You must give a <VAR>medEntityMesh</VAR> (ie:MED_EDGE) and a
- <VAR>medGeometryElement</VAR> (ie:MED_SEG3).
- */
- Engines::long_array getConnectivity(in medModeSwitch typeSwitch,
- in medConnectivity mode,
- in medEntityMesh entity,
- in medGeometryElement geomElement)
- raises (SALOME::SALOME_Exception);
-
- /*!
- Give morse index array to use with
- getConnectivity(MED_FULL_INTERLACE,mode,entity,MED_ALL_ELEMENTS).
-
- Each value give start index for corresponding entity in
- connectivity array.
-
- Example : i-th element, j-th node of it :
- - In C mode : Connectivity[ConnectivityIndex[i]-1+j-1]
- - In fortran mode : Connectivity[ConnectivityIndex[i]+j]
- */
- Engines::long_array getConnectivityIndex(in medConnectivity mode,
- in medEntityMesh entity)
- raises (SALOME::SALOME_Exception);
-
- /*!
- Gets a global number of the element which have the same connectivity as the
- connectivity argument.
- */
- long getElementNumber(in medConnectivity mode,
- in medEntityMesh entity,
- in medGeometryElement type,
- in Engines::long_array connectivity)
- raises (SALOME::SALOME_Exception);
-
- /*!
- Returns a reverse connectivity to MED_CELL.
-
- If mode=MED_NODAL, the array contains, for each node, all cells
- arround it.
-
- If mode=MED_DESCENDING, the array contains, for each face (or edge),
- the 2 cells of each side. First is cell which face normal is outgoing.
- */
- Engines::long_array getReverseConnectivity(in medConnectivity mode)
- raises (SALOME::SALOME_Exception);
-
- /*!
- Give index array to use with getReverseConnectivity(MED_NODAL).
-
- This method is not used with MED_DESCENDING mode,
- because we have allways two cells.
-
- See getConnectivityIndex for details.
- */
- Engines::long_array getReverseConnectivityIndex(in medConnectivity mode)
- raises (SALOME::SALOME_Exception);
-
- // Families and Groups
- // -------------------
-
- /*!
- Returns the number of all families.
- */
- long getNumberOfFamilies(in medEntityMesh entity)
- raises (SALOME::SALOME_Exception);
-
- /*!
- Returns the number of all groups.
- */
- long getNumberOfGroups(in medEntityMesh entity)
- raises (SALOME::SALOME_Exception);
-
- /*!
- Returns an array of all families.
- */
- Family_array getFamilies(in medEntityMesh entity)
- raises (SALOME::SALOME_Exception);
-
- /*!
- Returns the reference to i-th family.
-
- \note
- i is bounded by 1 and NumberOfFamilies.
- */
- FAMILY getFamily(in medEntityMesh entity,in long familyNumber)
- raises (SALOME::SALOME_Exception);
-
- /*!
- Returns an array of all groups.
- */
- Group_array getGroups(in medEntityMesh entity)
- raises (SALOME::SALOME_Exception);
-
- /*!
- Returns the reference to i-th group.
-
- \note
- i is bounded by 1 and NumberOfGroups.
- */
- GROUP getGroup(in medEntityMesh entity,in long groupNumber)
- raises (SALOME::SALOME_Exception);
-
- // Others
- // ------
-
- /*!
- Returns a field on mySupport containing volume.
-
- \note
- mySupport must be on MED_CELL entity and MeshDimension must be 3D.
- */
- FIELD getVolume(in SUPPORT mySupport)
- raises (SALOME::SALOME_Exception);
-
- /*!
- Returns a field on mySupport containing area.
-
- \note
- mySupport must be on MED_FACE entity.
- */
- FIELD getArea(in SUPPORT mySupport)
- raises (SALOME::SALOME_Exception);
-
- /*!
- Returns a field on mySupport containing length.
-
- \note
- mySupport must be on MED_EDGE entity.
- */
- FIELD getLength(in SUPPORT mySupport)
- raises (SALOME::SALOME_Exception);
-
- /*!
- Returns a field on mySupport containing normal.
-
- \note
- mySupport must be on MED_FACE entity if MeshDimension and
- SpaceDimension=3D and on MED_EDGE if MeshDimension and SpaceDimension=2D.
- */
- FIELD getNormal(in SUPPORT mySupport)
- raises (SALOME::SALOME_Exception);
-
- /*!
- Returns a field on mySupport containing barycenter.
- */
- FIELD getBarycenter(in SUPPORT mySupport)
- raises (SALOME::SALOME_Exception);
-
- /*
- Returns a field on mySupport containing neighbourhood.
- */
- // FIELD getNeighbourhood(in SUPPORT mySupport)
- // raises (SALOME::SALOME_Exception);
-
- // Read & Write
- // -----------
-
- /*!
- Adds the Mesh in the StudyManager.
- */
- void addInStudy(in SALOMEDS::Study myStudy, in MESH myIor )
- raises (SALOME::SALOME_Exception, SALOMEDS::StudyBuilder::LockProtection);
-
- // Add a MED/VTK/... driver
- // Multiple drivers can be added whatever the type
- long addDriver (in medDriverTypes driverType, in string fileName, in string meshName)
- raises (SALOME::SALOME_Exception);
- // Remove a driver
- void rmDriver (in long i) raises (SALOME::SALOME_Exception);
-
- //
- void read (in long i) raises (SALOME::SALOME_Exception);
- void write (in long i, in string driverMeshName)
- raises (SALOME::SALOME_Exception);
-
-/*!
-Internal Corba method.
-*/
- long getCorbaIndex() raises (SALOME::SALOME_Exception);
- };
-
-
- // ----------------------
- // Support interface
- // ----------------------
-
- interface SUPPORT {
-
- /*!
- Returns the name of the support.
- */
- string getName() raises (SALOME::SALOME_Exception);
-
- /*!
- Returns the description of the support.
- */
- string getDescription() raises (SALOME::SALOME_Exception);
-
- /*!
- Returns a reference to the mesh.
- */
- MESH getMesh() raises (SALOME::SALOME_Exception);
-
- /*!
- Returns the type of <VAR>medEntityMesh</VAR> used by the support.
-
- \note
- A support deals only with one entity's type
- (for example : MED_FACE or MED_NODE)
- */
- medEntityMesh getEntity() raises (SALOME::SALOME_Exception);
-
- /*!
- Returns True if all elements of this entity are
- engaged, False otherwise.
-
- If True, you must use mesh reference (getMesh) to get more information.
- */
- boolean isOnAllElements() raises (SALOME::SALOME_Exception);
-
- /*!
- If the method <VAR>isOnAllElements</VAR> returns False, this method
- returns the number of elements in the support.
-
- Example : number of MED_TRIA3 or MED_ALL_ELEMETNS elements
- in entity of support.
-
- \note
- If %SUPPORT is defined on MED_NODE, use MED_NONE <VAR>medGeometryElement</VAR> type.
- */
- long getNumberOfElements(in medGeometryElement geomElement)
- raises (SALOME::SALOME_Exception);
-
- /*!
- If isOnAllElements is False, returns an array of <VAR>medGeometryElement</VAR>
- types used by the support.
-
- <VAR>medEntityMesh</VAR> is given by getEntity.
- */
- medGeometryElement_array getTypes() raises (SALOME::SALOME_Exception);
-
- /*!
- If the method <VAR>isOnAllElements</VAR> returns False, this method returns an array which
- contains all numbers of given <VAR>medGeometryElement</VAR>.
-
- Numbering is global, ie numbers are bounded by 1 and
- MESH::getNumberOfElement(entity,MED_ALL_ELEMENTS) and not by 1 and
- MESH::getNumberOfElement(entity,geomElement).
-
- \note
- If %SUPPORT is defined on MED_NODE, use MED_NONE <VAR>medGeometryElement</VAR> type.
- */
- Engines::long_array getNumber(in medGeometryElement geomElement)
- raises (SALOME::SALOME_Exception);
-
- /*!
- If the method <VAR>isOnAllElements</VAR> returns False, this method returns the index
- of element number.
-
- Use it with getNumber(MED_ALL_ELEMENTS).
-
- \note
- See the method <VAR>getConnectivityIndex</VAR> for more details.
- */
- Engines::long_array getNumberIndex()
- raises (SALOME::SALOME_Exception);
- /*!
- Returns the number of Gauss points for this <VAR>medGeometryElement</VAR>.
-
- \note
- - Not defined if %SUPPORT is on MED_NODE.
- - Not defined for MED_ALL_ELEMENTS <VAR>medGeometryElement</VAR> type.
- */
- long getNumberOfGaussPoints(in medGeometryElement geomElement)
- raises (SALOME::SALOME_Exception);
-/*!
-Internal Corba method.
-*/
- long getCorbaIndex() raises (SALOME::SALOME_Exception);
- };
-
-
- //-----------------
- // Family interface
- //-----------------
-
- interface FAMILY : SUPPORT
- {
-
- /*!
- Returns Family identifier (Identifier
- of the family in the mesh).
-
- \note
- There is precisely only one indentifier for each family.
- */
- long getIdentifier() raises (SALOME::SALOME_Exception);
-
- /*!
- Returns number of attributes.
- */
- long getNumberOfAttributes() raises (SALOME::SALOME_Exception);
-
- /*!
- Returns an array of all attributes' identifiers.
- There is one for each attribute.
- */
- Engines::long_array getAttributesIdentifiers()
- raises (SALOME::SALOME_Exception);
-
- /*!
- Returns identifier of i-th attribute.
-
- \note
- i is bounded by 1 and NumberOfAttributes.
- */
- long getAttributeIdentifier(in long i) raises (SALOME::SALOME_Exception);
-
- /*!
- Returns an array of all values of the attributes .
- There is one value for each attribute.
- */
- Engines::long_array getAttributesValues()
- raises (SALOME::SALOME_Exception);
-
- /*!
- Returns the value of i-th attribute.
-
- \note
- i is bounded by 1 and NumberOfAttributes.
- */
- long getAttributeValue(in long i) raises (SALOME::SALOME_Exception);
-
- /*!
- Returns an array of all descriptions of the attributes .
- There is one description for each attribute.
- */
- Engines::string_array getAttributesDescriptions()
- raises (SALOME::SALOME_Exception);
-
- /*!
- Returns the description of i-th attribute.
-
- \note
- i is bounded by 1 and NumberOfAttributes.
- */
- string getAttributeDescription(in long i)
- raises (SALOME::SALOME_Exception);
- };
-
-
- //----------------
- // Group interface
- //----------------
- interface GROUP : SUPPORT
- {
-
- /*!
- Returns the number of families in this group.
- */
- long getNumberOfFamilies() raises (SALOME::SALOME_Exception);
-
- /*!
- Returns an array of all families.
- */
- Family_array getFamilies() raises (SALOME::SALOME_Exception);
-
- /*!
- Returns a reference to the i-th family.
-
- \note
- i is bounded by 1 and NumberOfFamilies.
- */
- FAMILY getFamily(in long i) raises (SALOME::SALOME_Exception);
-
- };
-
-
- //----------------
- // Field interface
- //----------------
-
- interface FIELD
- {
-
- /*!
- Returns the field name.
- */
- string getName() raises (SALOME::SALOME_Exception);
-
- /*!
- Returns the field description.
- */
- string getDescription() raises (SALOME::SALOME_Exception);
-
- /*!
- Returns a reference to the support
- on which the field is defined.
- */
- SUPPORT getSupport() raises (SALOME::SALOME_Exception);
-
- /*!
- Returns the number of field's components.
- */
- long getNumberOfComponents() raises (SALOME::SALOME_Exception);
-
- /*!
- Returns an array containing components names.
- */
- Engines::string_array getComponentsNames()
- raises (SALOME::SALOME_Exception);
-
- /*!
- Returns the name of i-th component.
-
- \note
- - i is bounded by 1 and NumberOfComponents.
- - Name is mandatory for each field's component.
- */
- string getComponentName(in long i) raises (SALOME::SALOME_Exception);
-
- /*!
- Returns an array containing components units.
- */
- Engines::string_array getComponentsUnits()
- raises (SALOME::SALOME_Exception);
-
- /*!
- Returns the unit of i-th component.
-
- \note
- i is bounded by 1 and NumberOfComponents.
- */
- string getComponentUnit(in long i) raises (SALOME::SALOME_Exception);
-
-
- long getIterationNumber() raises (SALOME::SALOME_Exception);
-
- /*!
- Returns time for this iteration.
- */
- double getTime() raises (SALOME::SALOME_Exception);
-
- /*!
- Returns order number use for
- internal step in this iteration.
- */
- long getOrderNumber() raises (SALOME::SALOME_Exception);
-
- // Read & Write
- // -----------
-
- long addDriver (in medDriverTypes driverType, in string fileName, in string fieldName)
- raises (SALOME::SALOME_Exception);
-
- /*!
- Removes a driver
- */
- void rmDriver (in long i)
- raises (SALOME::SALOME_Exception);
-
- //
- void read (in long i)
- raises (SALOME::SALOME_Exception);
-
- /*!
- Writes a field.
- */
- void write (in long i, in string driverFieldName)
- raises (SALOME::SALOME_Exception);
-
- /*!
- Adds the Field in the StudyManager.
- */
- void addInStudy(in SALOMEDS::Study myStudy, in FIELD myIor )
- raises (SALOME::SALOME_Exception, SALOMEDS::StudyBuilder::LockProtection);
-
-/*!
-Internal Corba method.
-*/
- long getCorbaIndex()
- raises (SALOME::SALOME_Exception);
-
- };
-
-
- interface FIELDDOUBLE : FIELD {
-
- /*!
- Returns an array of values of the field
- */
- Engines::double_array getValue(in medModeSwitch mode)
- raises (SALOME::SALOME_Exception);
- };
-
- interface FIELDINT : FIELD {
-
- /*!
- Returns an array of values of the field
- */
- Engines::long_array getValue(in medModeSwitch mode)
- raises (SALOME::SALOME_Exception);
-
- };
-
- // MED interface
-
- interface MED {
-
-
- long getNumberOfMeshes () raises (SALOME::SALOME_Exception);
- long getNumberOfFields () raises (SALOME::SALOME_Exception);
- Engines::string_array getMeshNames () raises (SALOME::SALOME_Exception);
- Engines::string_array getFieldNames () raises (SALOME::SALOME_Exception);
- MESH getMeshByName ( in string meshName) raises (SALOME::SALOME_Exception);
- MESH getMesh ( in FIELD fieldPtr) raises (SALOME::SALOME_Exception);
- FIELD getField ( in string fieldName,
- in long pasTemps,
- in long numOrdre ) raises (SALOME::SALOME_Exception);
-
-
- // Add a MED/VTK/... driver to a MED'GEN' object to
- // be able to read/write files preserving meshes<-->fields association
- // Multiple drivers can be added whatever the type.
- // The access point in the <long> returned
- long addDriver (in medDriverTypes driverType, in string fileName)
- raises (SALOME::SALOME_Exception);
- /*!
- Removes the driver
- */
- void rmDriver (in long i) raises (SALOME::SALOME_Exception);
- /*!
- Reads the structure of the %MED file
- */
- void readFileStruct(in long i) raises (SALOME::SALOME_Exception);
- void writeFrom (in long i) raises (SALOME::SALOME_Exception);
- void write (in long i) raises (SALOME::SALOME_Exception);
-
- void addMesh (in MESH ptrMesh ) raises (SALOME::SALOME_Exception);
- void addField (in FIELD ptrField ) raises (SALOME::SALOME_Exception);
-
- void addInStudy (in SALOMEDS::Study myStudy, in MED medPtr) raises (SALOME::SALOME_Exception, SALOMEDS::StudyBuilder::LockProtection);
- };
-};
-
-#endif /* MED_IDL */
+++ /dev/null
-// 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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
-//
-//
-//
-// File : MPIContainer.idl
-
-#ifndef _SALOME_MPICONTAINER_IDL_
-#define _SALOME_MPICONTAINER_IDL_
-
-#include "SALOME_Component.idl"
-#include "MPIObject.idl"
-
-module Engines
-{
- interface MPIContainer:Container,MPIObject
- {
- } ;
-} ;
-
-#endif
-
+++ /dev/null
-// 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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
-//
-//
-//
-// File : MPIObject.idl
-
-#ifndef _SALOME_MPIOBJECT_IDL_
-#define _SALOME_MPIOBJECT_IDL_
-
-module Engines
-{
- typedef sequence<Object> IORTab;
- interface MPIObject
- {
- attribute IORTab tior;
- } ;
-} ;
-
-#endif
+++ /dev/null
-// 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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
-//
-//
-//
-// File : Med_Gen.idl
-
-#ifndef _Med_GEN_IDL_
-#define _Med_GEN_IDL_
-
-
-#include "SALOME_Exception.idl"
-#include "SALOME_Component.idl"
-#include "SALOMEDS.idl"
-#include "MED.idl"
-
-module Engines
-{
- interface Med_Gen : Engines::Component, SALOMEDS::Driver
- {
- SALOME_MED::MESH readMeshInFile(in string fileName,
- in string studyName,
- in string meshName )
- raises (SALOME::SALOME_Exception);
- SALOME_MED::FIELD readFieldInFile(in string fileName,
- in string studyName,
- in string fieldName,
- in long ordre,
- in long iter )
- raises (SALOME::SALOME_Exception);
- SALOME_MED::MED readStructFile(in string fileName,
- in string studyName )
- raises (SALOME::SALOME_Exception);
-
- void readStructFileWithFieldType(in string fileName,
- in string studyName )
- raises (SALOME::SALOME_Exception);
- };
-
-};
-
-#endif
+++ /dev/null
-// 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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
-//
-//
-//
-// File : MulComponent.idl
-// Author :
-// $Header$
-
-#ifndef _MULCOMPONENT_IDL
-#define _MULCOMPONENT_IDL
-
-#include "SALOME_Component.idl"
-
-module SuperVisionTest {
-
- interface MulComponent : Engines::Component {
- void Mul( in double x , in double y , out double z ) ;
- } ;
-};
-
-
-#endif
+++ /dev/null
-// 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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
-//
-//
-//
-// File : NPMatComponent.idl
-
-#ifndef _SALOME_NPMATCOMPONENT_IDL_
-#define _SALOME_NPMATCOMPONENT_IDL_
-
-#include "SALOME_Component.idl"
-#include "TypeData.idl"
-#include "MPIObject.idl"
-
-module Engines
-{
- interface PCSRMat : MPIObject
- {
- readonly attribute CSRMatStruct csrmat;
-
- unsigned long NbRows();
- unsigned long NbCols();
- void LMat(out unsigned long start, out unsigned long end);
- CSRMatStruct ncsrmat(in unsigned long start, in unsigned long end);
- };
-
- interface NPMatComponent:Component,MPIObject
- {
-
- readonly attribute PCSRMat dmat;
-
- void SetFileName(in string filename);
-
- oneway void ReadDataFromFile(in string id_callback);
- oneway void SaveDataToFile(in string id_callback);
-
- oneway void SPGetData(in string id_callback);
- } ;
-} ;
-
-#endif
-
+++ /dev/null
-// 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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
-//
-//
-//
-// File : NPSolveComponent.idl
-
-#ifndef _SALOME_NPSOLVECOMPONENT_IDL_
-#define _SALOME_NPSOLVECOMPONENT_IDL_
-
-#include "SALOME_Component.idl"
-#include "TypeData.idl"
-#include "MPIObject.idl"
-#include "NPVecComponent.idl"
-#include "NPMatComponent.idl"
-
-module Engines
-{
- interface NPSolveComponent:Component,MPIObject
- {
- void Solve( in PCSRMat A, in PVec b, out PVec x );
- oneway void SPSolve( in PCSRMat A, in PVec b, in string id_callback );
- } ;
-} ;
-
-#endif
-
+++ /dev/null
-// 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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
-//
-//
-//
-// File : NPVecComponent.idl
-
-#ifndef _SALOME_NPVECCOMPONENT_IDL_
-#define _SALOME_NPVECCOMPONENT_IDL_
-
-#include "SALOME_Component.idl"
-#include "TypeData.idl"
-#include "MPIObject.idl"
-
-module Engines
-{
- interface PVec : MPIObject
- {
- readonly attribute DoubleVec vec;
-
- unsigned long Size();
- void LVec(out unsigned long start, out unsigned long end);
- DoubleVec nvec(in unsigned long start, in unsigned long end);
- };
-
- interface NPVecComponent:Component,MPIObject
- {
-
- attribute PVec dvec;
-
- void SetFileName(in string filename);
-
- oneway void ReadDataFromFile(in string id_callback);
- oneway void SaveDataToFile(in string id_callback);
-
- oneway void SPGetData(in string id_callback);
- oneway void SPPutData(in PVec vec,in string id_callback);
- } ;
-} ;
-
-#endif
-
+++ /dev/null
-// Copyright (C) 2003 CEA/DEN, EDF R&D
-//
-//
-//
-// File : Logger.idl
-// Author : Vasily Rusyaev
-
-#ifndef SALOME_LOGGER_IDL
-#define SALOME_LOGGER_IDL
-
-#pragma prefix "opencascade.com"
-
-module SALOME_Logger
-{
- interface Logger
- {
- //put message into one special place for all servers using Logger
- oneway void putMessage (in string message);
- };
-};
-
-
-
-#endif
+++ /dev/null
-// 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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
-//
-//
-//
-// File : MPIContainer.idl
-
-#ifndef _SALOME_MPICONTAINER_IDL_
-#define _SALOME_MPICONTAINER_IDL_
-
-#include "SALOME_Component.idl"
-#include "MPIObject.idl"
-
-module Engines
-{
- interface MPIContainer:Container,MPIObject
- {
- } ;
-} ;
-
-#endif
-
+++ /dev/null
-// 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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
-//
-//
-//
-// File : MPIObject.idl
-
-#ifndef _SALOME_MPIOBJECT_IDL_
-#define _SALOME_MPIOBJECT_IDL_
-
-module Engines
-{
- typedef sequence<Object> IORTab;
- interface MPIObject
- {
- attribute IORTab tior;
- } ;
-} ;
-
-#endif
+++ /dev/null
-// 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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
-//
-//
-//
-// File : SALOMEDS.idl
-// Author : Yves FRICAUD
-// $Header$
-
-/*! \mainpage
- \image html Application-About.png
-
-*/
-/*! \page page1 Mapping of IDL definitions to Python language.
-\section Intro Introduction
-%SALOME PRO is a distributed client/server application using the Common Object Request Broker Architecture (CORBA).
-CORBA architecture uses the Interface Definition Language (IDL), which specifies interfaces between CORBA objects. So with help of IDL
-CORBA's language independence is ensured . Because interfaces described in IDL can be mapped to the most of currently used programming languages, CORBA applications and components are thus
-independent of the language(s) used to implement them. In other words, a client written in C++ can communicate with a server written in Java, which in turn can communicate with
-another server written in COBOL, and so forth.
-
-One important thing to remember about IDL is that it is not an implementation language. That is, applications can't be written in IDL. The sole purpose of IDL is to define interfaces;
-providing implementations for these interfaces is performed using some other language.
-
-This page contains an abridged reference manual for mapping of IDL definitions to Python language. It will be useful for Python programmers who are not familiar
-with IDL language. All examples are taken from %SALOME PRO source files.
-The complete version of Python Language Mapping Specification can be found <A HREF="http://www.omg.org">here.</A>
-
-<BR><STRONG>CONTENTS:</STRONG>
-- \ref subsection1
-- \ref subsection2
-- \ref subsection3
-- \ref subsection4
-- \ref subsection5
-- \ref subsection6
-- \ref subsection7
-
-\subsection subsection1 Using Scoped Names
-
-Python implements a module concept that is similar to the IDL scoping mechanisms,
-except that it does not allow for nested modules. In addition, Python requires each
-object to be implemented in a module; globally visible objects are not supported.
-
-Because of these constraints, scoped names are translated into Python using the
-following rules:
-
-\95 An IDL module mapped into a Python module. Modules containing modules are
-mapped to packages (i.e., directories with an <STRONG>__init__</STRONG> module containing all
-definitions excluding the nested modules). An implementation can chose to map toplevel
-definitions (including the module CORBA) to modules in an implementationdefined
-package, to allow concurrent installations of different CORBA runtime
-libraries. In that case, the implementation must provide additional modules so that
-toplevel modules can be used without importing them from a package.
-
-\95 For all other scopes, a Python class is introduced that contains all the definitions
-inside this scope.
-
-\95 Other global definitions (except modules) appear in a module whose name is
-implementation dependent. Implementations are encouraged to use the name of the
-IDL file when defining the name of that module.
-
-For instance,
-
-\verbatim
-module SALOMEDS {
- interface StudyManager {
- void Close(in Study aStudy);
- };
-};
-\endverbatim
-
-would introduce a module SALOMEDS.py, which contains the following definitions:
-
-\verbatim
-# module SALOMEDS.py
-class StudyManager:
- def _Close(self,aStudy):
- pass #interfaces are discussed later
-\endverbatim
-
-To avoid conflicts, IDL names that are also Python identifiers are prefixed with an underscore (\91_\92).
-
-\subsection subsection2 Mapping for Template and Array Types
-
-Both the bounded and the unbounded string type of IDL are mapped to the Python
-string type. Wide strings are represented by an implementation-defined type with the
-following properties:
-
-\95 For the wide string X and the integer n, X[n] returns the nth character, which is a
-wide string of length 1.
-
-\95 len(X) returns the number of characters of wide string X.
-
-\95 CORBA.wstr(c) returns a wide character with the code point c in an
-implementation-defined encoding.
-
-\95 X+Y returns the concatenation of wide strings X and Y.
-
-\95 CORBA.word(CORBA.wstr(c)) == c
-
-The sequence template is mapped to sequence objects (e.g., tuples or lists).
-Applications should not assume that values of a sequence type are mutable. Sequences
-and arrays of octets and characters are mapped to the string type for efficiency reasons.
-
-For example, given the IDL definitions
-
-\verbatim
-module SALOMEDS {
- typedef sequence <string> StringSeq;
-
- interface AttributeTableOfInteger : GenericAttribute {
-
- void SetRowTitles(in StringSeq theTitles) raises(IncorrectArgumentLength);
- };
-};
-\endverbatim
-
-a client could invoke the operation
-
-\verbatim
-print My_AttributeTableOfInteger.SetRowTitles(["X","F"])
-\endverbatim
-
-Array types are mapped like sequence templates. The application in this example also expects an
-IncorrectArgumentLength exception if it passes sequences that violate the bounds constraint or
-arrays of wrong size.
-
-Another example with arrays. The following IDL definition
-
-\verbatim
-module SALOMEDS {
- typedef sequence<GenericAttribute> ListOfAttributes;
- interface SObject {
- ListOfAttributes GetAllAttributes();
- };
-};
-\endverbatim
-
-is equal to
-
-\verbatim
-import SALOMEDS
-
-attributes=[]
-
-attributes = My_SObject.GetAllAttributes()
-
-length = len(attributes)
-
-print "Attributes number = ", length
-print attributes
-\endverbatim
-
-\subsection subsection3 Mapping for Objects and Operations
-
-A CORBA object reference is represented as a Python object at run-time. This object
-provides all the operations that are available on the interface of the object. Although
-this specification does not mandate the use of classes for stub objects, the following
-discussion uses classes to indicate the interface.
-
-The nil object is represented by <STRONG>None</STRONG>.
-
-If an operation expects parameters of the IDL Object type, any Python object
-representing an object reference might be passed as actual argument.
-
-If an operation expects a parameter of an abstract interface, either an object
-implementing that interface, or a value supporting this interface may be passed as
-actual argument. The semantics of abstract values then define whether the argument is
-passed by value or by reference.
-
-Operations of an interface map to methods available on the object references.
-Parameters with a parameter attribute of <STRONG>in</STRONG> or <STRONG>inout</STRONG>
-are passed from left to right tothe method, skipping <STRONG>out</STRONG> parameters.
-The return value of a method depends on the number of <STRONG>out</STRONG> parameters
-and the return type. If the operation returns a value, this
-value forms the first <VAR>result value</VAR>. All <STRONG>inout</STRONG> or <STRONG>out</STRONG>
-parameters form consecutive <VAR>result values</VAR>. The method result depends then on the number
-of <VAR>result values</VAR>:
-
-\95 If there is no <VAR>result value</VAR>, the method returns None.
-
-\95 If there is exactly one <VAR>result value</VAR>, it is returned as a single value.
-
-\95 If there is more than one <VAR>result value</VAR>, all of them are packed into a tuple, and this
-tuple is returned.
-
-Assuming the IDL definition
-
-\verbatim
-module SALOMEDS{
- interface StudyBuilder{
- boolean FindAttribute ( in SObject anObject,
- out GenericAttribute anAttribute,
- in string aTypeOfAttribute );
- };
-};
-\endverbatim
-
-a client could write
-
-\verbatim
-from SALOMEDS import StudyBuilder;
-my_StudyBuilder=...
-
- res,A=my_StudyBuilder.FindAttribute(Sobj, "AttributeSequenceOfReal")
-\endverbatim
-
-In this example <STRONG>A</STRONG> corresponds to the return value <STRONG>anAttribute</STRONG> and
-<STRONG>res</STRONG> to the <STRONG>boolean</STRONG> return value.
-
-If an interface defines an <STRONG>attribute name</STRONG>, for example, the attribute is mapped into an
-operation <STRONG>_get_name</STRONG>. If the attribute is not <STRONG>readonly</STRONG>, there is an
-additional operation <STRONG>_set_name</STRONG>.
-
-The IDL definition
-
-\verbatim
-module SALOMEDS{
- interface Study{
- attribute string Name;
- };
-};
-\endverbatim
-
-is equal to the following
-
-\verbatim
-from SALOMEDS import Study
-My_Study=...
- Name=My_Study._get_name();
- Name=My_Study._set_name();
-\endverbatim
-
-\subsection subsection4 Narrowing Object References
-
-Python objects returned from CORBA operations or pseudo-operations (such as
-string_to_object) might have a dynamic type, which is more specific than the
-static type as defined in the operation signature.
-
-Since there is no efficient and reliable way of automatically creating the most specific
-type, explicit narrowing is necessary. To narrow an object reference <STRONG>A</STRONG> to an interface
-class <STRONG>AttributeSequenceOfReal</STRONG>, the client can use the following operation
-
-\verbatim
-A = A._narrow(SALOMEDS.AttributeSequenceOfReal)
-\endverbatim
-
-\subsection subsection5 Mapping for Exceptions
-
-An IDL exception is translated into a Python class derived from
-CORBA.UserException. System exceptions are derived from CORBA.SystemException.
-Both base classes are derived from CORBA.Exception. The parameters of the
-exception are mapped in the same way as the fields of a struct definition. When
-raising an exception, a new instance of the class is created; the constructor
-expects the exception parameters. For example, the definition
-
-\verbatim
-module SALOMEDS{
- interface StudyBuilder{
- exception LockProtection {};
- void CommitCommand() raises(LockProtection);
- };
-};
-\endverbatim
-
-could be used caught as
-
-\verbatim
-from SALOMEDS import StudyBuilder;
-my_StudyBuilder=...
-try:
- my_StudyBuilder.CommitCommand();
-except StudyBuilder.LockProtection,value:
- print "Error! Study is locked for modifications"
-\endverbatim
-
-
-\subsection subsection6 Mapping for Enumeration Types
-
-An enumeration is mapped into a number of constant objects in the name space where
-the enumeration is defined. An application may only test for equivalence of two
-enumeration values, and not assume that they behave like numbers.
-For example, the definition
-
-\verbatim
-module VISU {
- interface PrsObject{
-
- enum PrsObjType{ TCURVE, TTABLE, TMESH, TCONTAINER,
- TSCALARMAP, TISOSURFACE, TDEFORMEDSHAPE,
- TCUTPLANES, TVECTORS };
- };
-};
-\endverbatim
-
-introduces the objects
-
-\verbatim
-from VISU import PrsObject
-VISU.PrsObjType.TCURVE,VISU.PrsObjType.TTABLE,VISU.PrsObjType.TMESH,VISU.PrsObjType.TCONTAINER,
-VISU.PrsObjType.TSCALARMAP,VISU.PrsObjType.TISOSURFACE,VISU.PrsObjType.TDEFORMEDSHAPE,VISU.PrsObjType.TCUTPLANES,
-VISU.PrsObjType.TVECTORS
-\endverbatim
-
-\subsection subsection7 Mapping for Structured Types
-
-An IDL struct definition is mapped into a Python class or type. For each field in the
-struct, there is a corresponding attribute in the class with the same name as the field.
-The constructor of the class expects the field values, from left to right.
-For example, the IDL definition
-
-\verbatim
-struct SDate {
- short Second;
- short Minute;
- short Hour;
- short Day;
- short Month;
- short Year;
- };
-\endverbatim
-
-could be used in the Python statements
-
-\verbatim
-Date=SDate(30, 12, 15, 26, 1, 79)
-print Date.Second,Date.Minute,Date.Hour,Date.Day,Date.Month,Date.Year
-\endverbatim
-*/
-/*! \page page2 Mapping of SALOME IDL definitions to Python language.
-
-
- - <B>%SALOME STUDY module</B>
- - <A href=HTML/SALOMEDS.html>Mapping of %SALOMEDS functions</A>
- - <A href=HTML/SALOMEDS_Attributes.html>Mapping of SALOMEDS_Attributes functions</A>
- - <B>%SAlOME KERNEL module</B>
- - <A href=HTML/Med_Gen.html>Mapping of %Med_Gen functions</A>
- - <A href=HTML/SALOME_Session.html>Mapping of %SALOME_Session functions</A>
- - <A href=HTML/SALOME_ModuleCatalog.html>Mapping of %SALOME_ModuleCatalog functions</A>
- - <A href=HTML/SALOME_Exception.html>Mapping of %SALOME_Exception functions</A>
- - <A href=HTML/SALOME_Component.html>Mapping of %SALOME_Component functions</A>
- - <B>%SALOME MED component</B>
- - <A href=HTML/MED.html>Mapping of %Med functions</A>
- - <B>%SALOME SUPERVISION module</B>
- - <A href=HTML/SUPERV.html>Mapping of %SUPERV functions</A>
- - <B>%SALOME %VISU module</B>
- - <A href=HTML/VISU_Gen.html>Mapping of %VISU_Gen functions</A>
-
-*/
-
-/*! \defgroup Study SALOME STUDY module
-*/
-
-/*!
- \file SALOMEDS.idl This file contains a set of interfaces used for creation, managment
- and modification of the %Study
-*/
-
-#ifndef _SALOMEDS_IDL_
-#define _SALOMEDS_IDL_
-
-#include "SALOME_Exception.idl"
-
-/*! \ingroup Study
- This package contains the interfaces used for creation, managment
- and modification of the %Study
-*/
-module SALOMEDS
-{
-/*! \typedef URL
- Name of the file in which the %Study is saved.
-
-*/
- typedef string URL;
-
-/*! Main identifier of an object in %SALOME application
-*/
- typedef string ID;
-
-/*! While saving the data, IOR is transformed into persistent reference
-*/
- typedef string PersistentReference;
-
-/*! IOR of the study in %SALOME application
-*/
- typedef string SalomeReference;
-/*! List of names of open studies in a %SALOME session
-*/
- typedef sequence<string> ListOfOpenStudies;
-/*! List of file names
-*/
- typedef sequence<string> ListOfFileNames;
-/*! List of modification dates of the study
-*/
- typedef sequence<string> ListOfDates ;
-/*! An unbounded sequence of strings
-*/
- typedef sequence<string> ListOfStrings ;
-/*! A byte stream which is used for binary data transfer between components
-*/
- typedef sequence<octet> TMPFile;
-
- // Reference to other objects is treated with function AddReference
- // and ReferencedObject
- // All other type of attributes defined in AttributeType enum are
- // treated with AddAdttribute and GetAttribute
- // The difference is made because Reference attribute don't contain
- // strings but reference to ID of other objects
-
- interface GenericAttribute;
- interface Study;
- interface StudyManager;
- interface StudyBuilder;
- interface SObject;
- interface SComponent;
- interface SComponentIterator;
- interface ChildIterator;
- interface Driver;
- interface AttributeStudyProperties;
- interface UseCaseIterator;
- interface UseCaseBuilder;
- interface Callback;
-/*! List of attributes
-*/
- typedef sequence<GenericAttribute> ListOfAttributes;
-/*! Exception indicating that this feature hasn't been implemented
-*/
- exception NotImplemented {};
-
-
- //===========================================================================
- /*! \brief %Study Interface
-
- The purpose of the %Study is to manage the data produced by various components of %SALOME platform.
- Most of the %Study operations are handled by the StudyManager and the StudyBuilder.
- What is left in the %Study interface are elementary inquiries.
- (Incidentally, we recall that a CORBA attribute is implemented as a pair of get
- and set methods.) A %Study is explored by a set of tools, mainly iterators
- , which are described further. Nevertheless, the %Study
- interface allows the search of an object by name or by ID.
- \note
- <BR><VAR>The Path </VAR>of an object in %SALOME application is much alike a standard path of a file.
- In general it's a string of names of directories divided by a slash '/'.
- <BR><VAR>The Context</VAR> is the current directory of an object.</P>
-*/
-
- interface Study
- {
- exception StudyInvalidContext {};
- exception StudyInvalidComponent {};
-/*! Invalid directory of the %study exception
-*/
- exception StudyInvalidDirectory {};
-/*! Exception pointing that this name of the study has already been used.
-*/
- exception StudyNameAlreadyUsed {};
- exception StudyObjectAlreadyExists {};
-/*! Invalid name of the %study exception
-*/
- exception StudyNameError {};
- exception StudyCommentError {};
-/*! \brief The name of the %Study
-
- This is equivalent to the methods setName() & getName()
-*/
- attribute string Name; // equivalent to setName() & getName()
-/*! \brief The ID of the %Study
-
- This is equivalent to the methods setID() & getID()
-*/
- attribute short StudyId;
-/*! Sequence containing %SObjects
-*/
- typedef sequence<SObject> ListOfSObject;
-/*!
- Gets a persistent reference to the %Study.
-*/
- PersistentReference GetPersistentReference();
-/*!
- Gets a transient reference to the %Study.
-*/
- SalomeReference GetTransientReference();
-
-/*!
- Returns True if the %Study is empty
-*/
- boolean IsEmpty();
-/*!
- Allows to find a %SComponent by its name.
- \param aComponentName It's a string value in the Comment Attribute of the Component,
- which is looked for, defining the data type of this Component.
-
-<BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-*/
- SComponent FindComponent (in string aComponentName);
-/*!
- Allows to find a %SComponent by ID of the according %SObject
-*/
- SComponent FindComponentID(in ID aComponentID);
-/*!
- Allows to find a %SObject by the Name Attribute of this %SObject
-<BR><VAR>See also <A href=exemple/Example19.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- SObject FindObject (in string anObjectName);
-/*!
- Allows to find a %SObject by its ID
-*/
- SObject FindObjectID (in ID aObjectID);
-/*!
- Allows to find a %SObject by IOR of the object belonging to this %SObject.
-*/
- SObject FindObjectIOR (in ID aObjectIOR);
-/*!
- Returns a list of %SObjects belonging to this %Component. The Name Attribute
- of these %SObjects should correspond to <VAR>anObjectName</VAR>.
-*/
- ListOfSObject FindObjectByName(in string anObjectName, in string aComponentName);
-/*!
- Allows to find a %SObject by the path to it.
-*/
- SObject FindObjectByPath(in string thePath);
-/*!
- Returns the path to the %SObject.
-*/
- string GetObjectPath(in Object theObject);
-
-/*!
- Sets the context of the %Study.
-<BR><VAR>See also <A href=exemple/Example23.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- void SetContext(in string thePath);
-/*!
- Gets the context of the %Study
-<BR><VAR>See also <A href=exemple/Example23.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- string GetContext();
-/*!
- Returns a list of names of objects corresponding to the context.
- \note If the parameter <VAR>theContext</VAR> is empty, then the current context will be used.
-*/
- ListOfStrings GetObjectNames(in string theContext);
-/*!
- Returns a list of names of directories and subdirectories corresponding to the context.
- \note If the parameter <VAR>theContext</VAR> is empty, then the current context will be used.
-*/
- ListOfStrings GetDirectoryNames(in string theContext);
-/*!
- Returns a list of names of Files corresponding to the context.
- \note If the parameter <VAR>theContext</VAR> is empty, then the current context will be used.
-*/
- ListOfStrings GetFileNames(in string theContext);
-/*!
- Returns a list of names of Components corresponding to the context.
- \note If the parameter <VAR>theContext</VAR> is empty, then the current context will be used.
-*/
- ListOfStrings GetComponentNames(in string theContext);
-/*! \brief Creation of a new iterator of child levels
-
- Creates a new iterator of child levels of the %SObject
-*/
- ChildIterator NewChildIterator(in SObject aSO);
-/*! \brief Creation of a new iterator of the %SComponent
-
- Creates a new iterator of the %SComponent.
-*/
- SComponentIterator NewComponentIterator();
-/*! \brief Creation of a %StudyBuilder
-
- Creates a new %StudyBuilder to add or modify an object in the study.
-<BR><VAR>See also <A href=exemple/Example20.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- StudyBuilder NewBuilder() ;
-/*! \brief Labels dependency
-
- Updates the map with IOR attribute. It's an inner method used for optimization.
-*/
- void UpdateIORLabelMap(in string anIOR, in string anEntry);
-
-/*! \brief Getting properties of the study
-
- Returns the attriubte, which contains the properties of this study.
-<BR><VAR>See also <A href=exemple/Example20.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- AttributeStudyProperties GetProperties();
-/*!
- Determines whether the %study has been saved
-*/
- attribute boolean IsSaved;
-/*!
- Returns True if the %study has been modified and not saved.
-*/
- boolean IsModified();
-/*!
- Determines the file where the %study has been saved
-*/
- attribute string URL;
-
-/*! \brief List of %SObjects
-
- Returns the list of %SObjects which refers to %anObject.
-*/
- ListOfSObject FindDependances(in SObject anObject);
-
-/*! \brief The date of the last saving of the study
-
- Returns the date of the last saving of study with format: "DD/MM/YYYY HH:MM"
-*/
- string GetLastModificationDate();
-/*! \brief The list of modification dates of the study
-
- Returns the list of modification dates (without creation date) with format "DD/MM/YYYY HH:MM".
- Note : the first modification begins the list.
-*/
- ListOfDates GetModificationsDate();
-/*! \brief Object conversion.
-
- Converts an object into IOR.
- \return IOR
-*/
- string ConvertObjectToIOR(in Object theObject);
-/*! \brief Object conversion.
-
- Converts IOR into an object.
- \return An object
-*/
- Object ConvertIORToObject(in string theIOR);
-/*!
- Gets a new %UseCaseBuilder.
-*/
- UseCaseBuilder GetUseCaseBuilder();
-
-/*!
- Closes the components in the study, removes itself from the %StudyManager.
-*/
- void Close();
-
-/*!
- Enables(if isEnabled = True)/disables automatic addition of new %SObjects to the use case.
-*/
- void EnableUseCaseAutoFilling(in boolean isEnabled);
- };
-
- //==========================================================================
-/*! \brief %Study Builder Interface
-
- The purpose of the Builder is to add and/or remove objects and attributes.
- A %StudyBuilder is linked to a %Study. A
- command management is provided for the undo/redo functionalities.
- \note
- <BR><VAR>The Tag</VAR> of an item in %SALOME application is a symbolic description of
- item's position in the tree-type structure of the browser. In general it has the following
- form: <TT>0:2:1:1</TT>
-*/
- //==========================================================================
-
- interface StudyBuilder
- {
-/*! \brief %LockProtection Exception
-
- This exception is raised while attempting to modify a locked %study.
-*/
- exception LockProtection {};
-/*! \brief Creation of a new %SComponent.
-
- Creates a new %SComponent
- \param ComponentDataType Data type of the %SComponent which will be created.
-
-<BR><VAR>See also <A href=exemple/Example17.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- SComponent NewComponent(in string ComponentDataType);
-/*! \brief Definition of the instance to the %SComponent
-
- Defines the instance to the %SComponent.
-*/
- void DefineComponentInstance (in SComponent aComponent,in Object ComponentIOR);
-/*! \brief Deletion of the %SComponent
-
- Removes the %SComponent.
-*/
- void RemoveComponent(in SComponent aComponent);
-
-/*! \brief Creation of a new %SObject
-
- Creates a new %SObject.
-<BR><VAR>See also <A href=exemple/Example18.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- SObject NewObject (in SObject theFatherObject);
-/*! \brief Creation of a new %SObject with a definite %tag
-
- Creates a new %SObject with a definite %tag.
-*/
- SObject NewObjectToTag (in SObject theFatherObject, in long atag);
-/*! \brief Deletion of the %SObject
-
- Removes a %SObject from the %StudyBuilder.
-*/
- void RemoveObject (in SObject anObject);
-/*! \brief Deletion of the %SObject with all his child objects.
-
- Removes the %SObject with all his child objects.
-*/
- void RemoveObjectWithChildren(in SObject anObject);
-
-/*!
- Loads a %SComponent.
-<BR><VAR>See also <A href=exemple/Example19.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- void LoadWith (in SComponent sco, in Driver Engine) raises (SALOME::SALOME_Exception);
-/*!
- Loads a %SObject.
-*/
- void Load (in SObject sco);
-
-/*! \brief Looking for or creating an attribute assigned to the %SObject
-
- Allows to find or create an attribute of a specific type which is assigned to the object.
- \param anObject The %SObject corresponding to the attribute which is looked for.
- \param aTypeOfAttribute Type of the attribute.
-
- <BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-*/
-
- GenericAttribute FindOrCreateAttribute(in SObject anObject,
- in string aTypeOfAttribute);
-
-/*! \brief Looking for an attribute assigned to %SObject
-
- Allows to find an attribute of a specific type which is assigned to the object.
- \param anObject The %SObject corresponding to the attribute which is looked for.
- \param aTypeOfAttribute Type of the attribute.
- \param anAttribute Where the attribute is placed if it's found.
- \return True if it finds an attribute.
- */
-
- boolean FindAttribute(in SObject anObject,
- out GenericAttribute anAttribute,
- in string aTypeOfAttribute);
-/*! \brief Deleting the attribute assigned to the %SObject
-
- Removes the attribute of a specific type which is assigned to the object.
- \param anObject The %SObject corresponding to the attribute.
- \param aTypeOfAttribute Type of the attribute.
-
-<BR><VAR>See also <A href=exemple/Example17.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-*/
- void RemoveAttribute(in SObject anObject,
- in string aTypeOfAttribute);
-/*! \brief Addition of a reference
-
- Adds a reference between %anObject and %theReferencedObject.
-*/
-
- void Addreference(in SObject anObject,
- in SObject theReferencedObject) ;
-/*!
- Adds a directory in the %Study.
-<BR><VAR>See also <A href=exemple/Example23.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- void AddDirectory(in string theName);
-
-/*! \brief Identification of the %SObject's substructure.
-
- Identification of the %SObject's substructure by GUID.
- It has the following format "00000000-0000-0000-0000-000000000000"
-*/
-
- void SetGUID(in SObject anObject, in string theGUID);
-/*!
-
- Returns True if the %SObject has GUID.
-*/
- boolean IsGUID(in SObject anObject, in string theGUID);
-
-/*! \brief Creation of a new command
-
- Creates a new command which can contain several different actions.
-<BR><VAR>See also <A href=exemple/Example3.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- void NewCommand(); // command management
-/*! \brief Execution of the command
-
- Commits all actions declared within this command.
-<BR><VAR>See also <A href=exemple/Example16.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- void CommitCommand() raises(LockProtection); // command management
-/*!
- Returns True if at this moment there is a command under execution.
-*/
- boolean HasOpenCommand();
-/*! \brief Cancelation of the command
-
- Cancels all actions declared within the command.
-<BR><VAR>See also <A href=exemple/Example17.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-*/
- void AbortCommand(); // command management
-/*! \brief Undolimit
-
- The number of actions which can be undone
-*/
- attribute long UndoLimit;
-/*! \brief Undo method
-
- Cancels all actions of the last command.
-<BR><VAR>See also <A href=exemple/Example16.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- void Undo() raises (LockProtection);
-/*! \brief Redo method
-
- Redoes all actions of the last command.
- <BR><VAR>See also <A href=exemple/Example16.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- void Redo() raises (LockProtection);
-/*!
- Returns True if at this moment there are any actions which can be canceled.
- <BR><VAR>See also <A href=exemple/Example16.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- boolean GetAvailableUndos();
-/*!
- Returns True if at this moment there are any actions which can be redone.
- <BR><VAR>See also <A href=exemple/Example3.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- boolean GetAvailableRedos();
-/*!
- Sets the callback for addition of the given %SObject. Returns the previous callback.
-*/
- Callback SetOnAddSObject(in Callback theCallback);
-/*!
- Sets the callback for removal of the given %SObject. Returns the previous callback.
-*/
- Callback SetOnRemoveSObject(in Callback theCallback);
-
- };
-
- //==========================================================================
-/*! \brief %Study Manager interface
-
- The purpose of the Manager is to manipulate the %Studies. You will find in this
- interface the methods to create, open,
- close, and save a %Study. Since a %SALOME session is multi-document, you will
- also find the methods allowing to navigate
- through the collection of studies present in a session.
-*/
- //==========================================================================
-
- interface StudyManager
- {
-/*!
- Determines whether the server has already been loaded or not.
-*/
- void ping();
-
-/*! \brief Creation of a new %Study
-
- Creates a new %Study with a definite name.
-<BR><VAR>See also <A href=exemple/Example17.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- Study NewStudy(in string study_name);
-
-/*! \brief Open a study
-
- Reads and activates the structure of the study %Objects.
- \warning This method doesn't activate the corba objects. Only a component can do it.
-<BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-*/
- Study Open (in URL aStudyUrl) raises (SALOME::SALOME_Exception);
-
-/*! \brief Closing the study
-
- Closes the study.
-*/
- void Close(in Study aStudy);
-/*! \brief Saving the study
-
- Saves the study.
-<BR><VAR>See also <A href=exemple/Example19.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- void Save(in Study aStudy, in boolean theMultiFile);
-
- void SaveASCII(in Study aStudy, in boolean theMultiFile);
-/*! \brief Saving the study in a file
-
- Saves the study in a specified file.
- <BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-*/
- void SaveAs(in URL aUrl, // if the file already exists
- in Study aStudy,
- in boolean theMultiFile); // overwrite (as option)
-
- void SaveAsASCII(in URL aUrl, // if the file already exists
- in Study aStudy,
- in boolean theMultiFile); // overwrite (as option)
-
-
-/*! \brief List of open studies.
-
- Returns the list of open studies in the current session.
-*/
- ListOfOpenStudies GetOpenStudies();
-
-/*! \brief Getting a particular %Study picked by name
-
- Activates a particular %Study
- amongst the session collection picking it by name.
-*/
- Study GetStudyByName (in string aStudyName);
-
-/*! \brief Getting a particular %Study picked by ID
-
- Activates a particular %Study
- amongst the session collection picking it by ID.
-*/
- Study GetStudyByID (in short aStudyID);
-
- // copy/paste methods
-
-/*!
- Returns True, if the given %SObject can be copied to the clipboard.
-*/
- boolean CanCopy(in SObject theObject);
-/*!
- Returns True, if the given %SObject is copied to the clipboard.
-*/
- boolean Copy(in SObject theObject);
-/*!
- Returns True, if the object from the clipboard can be pasted to the given %SObject.
-*/
- boolean CanPaste(in SObject theObject);
-/*!
- Returns the %SObject in which the object from the clipboard was pasted to.
-*/
- SObject Paste(in SObject theObject) raises (SALOMEDS::StudyBuilder::LockProtection);
- };
-
-
- //==========================================================================
-/*! \brief %SObject interface
-
- The objects in the %study are built by the %StudyBuilder. The %SObject interface
- provides methods for elementary inquiries, like getting an object %ID or its attribuites.
- \note
- <BR><VAR>Tag</VAR> of an item in %SALOME application is an integer value uniquely defining an item
- in the tree-type data structure.
- <BR><VAR>ID</VAR> of an item is a description of item's position in the tree-type data structure.
- ID is a list of tags and it has the following form: <TT>0:2:1:1</TT>.
-*/
- //==========================================================================
-
- interface SObject
- {
-/*! Name of the %SObject
-*/
- attribute string Name; // equivalent to setName() & getName()
-/*! \brief Getting an object %ID
-
- Returns ID of the %SObject.
-*/
- ID GetID();
-/*! \brief Acquisition of the father %Component of the %SObject
-
- Returns the father %Component of the %SObject.
-*/
- SComponent GetFatherComponent();
-/*! \brief Acquisition of the father %SObject of the %SObject
-
- Returns the father %SObject of the given %SObject.
-*/
- SObject GetFather();
-/*! \brief %Tag of %SObject
-
- Returns the %tag of the %SObject.
-*/
- short Tag();
-/*! \brief Looking for subobjects of an object.
-
- Returns True if it finds a subobject of the %SObject with a definite tag.
-*/
-
- boolean FindSubObject (in long atag, out SObject obj);
-/*! \brief Looking for attributes of the %SObject
-
- Returns True if it finds an attribute of a definite type of the %SObject.
-<BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-*/
- boolean FindAttribute(out GenericAttribute anAttribute,
- in string aTypeOfAttribute);
-/*!
- Returns the object which this %SObject refers to. It also returns True if it finds
- this object.
-*/
- boolean ReferencedObject(out SObject obj); // A REVOIR
-/*! \brief Getting all attributes of the %SObject
-
- Returns the list of all attributes of the %SObject.
-<BR><VAR>See also <A href=exemple/Example17.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- ListOfAttributes GetAllAttributes();
-/*! \brief Returning the study
-
- Returns the study containing the given %SObject.
-*/
- Study GetStudy();
- };
-
-
- //==========================================================================
-/*! \brief %Generic attribute interface
-
- %Generic attribute is a base interface for all attributes which inherit
- its methods.
-*/
- //==========================================================================
- interface GenericAttribute
- {
-/*! \brief Exception locking all changes
-
- This exception locks all modifications in attributes.
-*/
- exception LockProtection {};
-/*! \brief Method CheckLocked
-
- Checks whether the %Study is protected for modifications.
- \note <BR>This exception is raised only outside the transaction.
-*/
- void CheckLocked() raises (LockProtection);
- };
-
-
-
- //==========================================================================
-/*! \brief %SComponent interface
-
- The %SComponent interface is a specialization of the %SObject interface.
- It inherits the most of its methods from the %SObject interface.
-*/
- //==========================================================================
- interface SComponent : SObject
- {
-/*! \brief Data type of the %SComponent
-
- Returns the data type of the %SComponent.
-*/
- string ComponentDataType();
-/*!
- Returns IOR of the according component.
-*/
- boolean ComponentIOR (out ID theID); //returns True if there is an instance
- //In this case ID identifies this one
- };
-
-
- //==========================================================================
-/*! \brief %SComponentIterator interface
-
- This interface contains the methods allowing to iterate over all components in the list.
- The search is started from the first %SComponent in the list.
-*/
- //==========================================================================
- interface SComponentIterator
- {
-/*! \brief Initialization of the Iterator
-
-Activates the %SComponentIterator.
-*/
- void Init();
-/*! \brief Method More
-
- Returns True if there is one more %SComponent in the list.
-*/
- boolean More();
-/*! \brief Moving the iterator to the next %SComponent
-
-Moves the iterator to the next %SComponent in the list.
-*/
- void Next();
-/*!
- Returns the %SComponent corresponding to the current %SComponent found by the iterator.
- <BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- SComponent Value();
- };
-
- //==========================================================================
-/*! \brief %ChildIterator interface
-
- This interface contains methods which allow to iterate over all child
- levels.
-*/
- //==========================================================================
- interface ChildIterator
- {
-/*! \brief Initialization of the Iterator.
-
-Activates the %ChildIterator.
-*/
- void Init();
-/*! \brief Initialization of the Iterator for all child levels.
-
-Activates the %ChildIterator (if True) for all child levels.
-*/
- void InitEx(in boolean allLevels);
-/*! \brief Method More
-
- Returns True if the %ChildIterator finds one more child level.
-*/
- boolean More();
-/*!
- Passes the iterator to the next level.
-*/
- void Next();
-/*!
- Returns the %SObject corresponding to the current object found by the iterator.
-*/
- SObject Value();
- };
-
- //==========================================================================
- //==========================================================================
-/*! \brief Interface of the %UseCaseIterator.
-
- This interface contains a set of methods used for iteration over the objects in the use case.
-*/
- interface UseCaseIterator
- {
-/*! \brief Initialization of the Iterator.
-
-Activates the %UseCaseIterator. If <VAR>allLevels</VAR> is True the Iterator is activated for all subobjects.
-*/
- void Init(in boolean allLevels);
-/*! \brief Method More
-
- Returns True if the %UseCaseIterator finds one more object.
-*/
- boolean More();
-/*!
- Passes the iterator to the next object.
-*/
- void Next();
-/*!
- Returns the %SObject corresponding to the current object found by the Iterator.
-*/
- SObject Value();
- };
-
- //==========================================================================
- //==========================================================================
-/*! \brief Interface of the %UseCaseBuilder
-
- Use case in the study represents a user-managed subtree, containing all or some of the objects which exist in the study.
- The %UseCaseBuilder interface contains a set of methods used for management of the use case in the study.
-*/
- interface UseCaseBuilder
- {
-/*!
- Adds to the use case an object <VAR>theObject</VAR> as a child of the current object of the use case.
-*/
- boolean Append(in SObject theObject);
-/*!
- Removes an object <VAR>theObject</VAR> from the use case.
-*/
- boolean Remove(in SObject theObject);
-/*!
- Adds a child object <VAR>theObject</VAR> to the given father <VAR>theFather</VAR> object in the use case.
-*/
- boolean AppendTo(in SObject theFather, in SObject theObject);
-/*!
- Inserts in the use case the object <VAR>theFirst</VAR> before the object <VAR>theNext</VAR>.
-*/
- boolean InsertBefore(in SObject theFirst, in SObject theNext);
-/*!
- Sets the current object of the use case.
-*/
- boolean SetCurrentObject(in SObject theObject);
-/*!
- Makes the root object to be the current object of the use case.
-*/
- boolean SetRootCurrent();
-/*!
- Returns True if the given object <VAR>theObject</VAR> of the use case has child objects.
-*/
- boolean HasChildren(in SObject theObject);
-/*!
- Sets the name of the use case.
-*/
- boolean SetName(in string theName);
-/*!
- Gets the name of the use case.
-*/
- string GetName();
-/*!
- Returns True if the given object <VAR>theObject</VAR> represents a use case.
-*/
- boolean IsUseCase(in SObject theObject);
-/*!
- Gets the current object of the use case.
-*/
- SObject GetCurrentObject();
-/*!
- Creates a new use case in the use case browser.
-*/
- SObject AddUseCase(in string theName);
-/*!
- Returns the %UseCaseIterator for the given object <VAR>theObject</VAR> in the use case.
-*/
- UseCaseIterator GetUseCaseIterator(in SObject theObject);
- };
- //==========================================================================
- //==========================================================================
-/*! \brief The callback interface
-
- The %StudyBuilder can be created with the method <VAR>NewBuilder</VAR>. While invocation of this method a new object of the class <VAR>Callback</VAR> is created
- and this object is assigned to the newly created Builder as callback which should be called when adding and removing of the ojects.
-*/
- interface Callback
- {
-/*!
- Invokes the corresponding method <VAR>Append</VAR> of the %UseCaseBuilder.
-*/
- void OnAddSObject(in SObject theObject);
-/*!
- Invokes the corresponding method <VAR>Remove</VAR> of the %UseCaseBuilder.
-*/
- void OnRemoveSObject(in SObject theObject);
- };
-
- //==========================================================================
-/*! \brief %Driver interface
-
- This interface contains a set of methods used for the management
- of the object produced in the %study by a component.
-*/
- //==========================================================================
- interface Driver
- {
-
- /*! \brief Saving the data.
-
- This method is called by the StudyManager when saving a study.
- \param theComponent %SComponent corresponding to this Component
- \return A byte stream TMPFile that contains all saved data
-
-<BR><VAR>See also <A href=exemple/Example19.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
- */
-
-
- TMPFile Save(in SComponent theComponent, in string theURL, in boolean isMultiFile);
-
- TMPFile SaveASCII(in SComponent theComponent, in string theURL, in boolean isMultiFile);
-
- /*! \brief Loading the data.
-
- This method is called by the StudyManager when opening a study.
- \param theComponent %SComponent corresponding to this Component
- \param theStream The file which contains all data saved by the component on Save method
- */
-
- boolean Load(in SComponent theComponent, in TMPFile theStream, in string theURL, in boolean isMultiFile);
-
- boolean LoadASCII(in SComponent theComponent, in TMPFile theStream, in string theURL, in boolean isMultiFile);
-
- /*! \brief Closing of the study
-
- This method Close is called by the StudyManager when closing a study.
-
- */
-
- void Close (in SComponent aSComponent);
- //void Close ( in string aIORSComponent);
-
- /*! \brief The type of the data
-
- Returns the type of data produced by the Component in the study.
- */
-
- string ComponentDataType();
-
- // Driver Transient -> persistent called for each object in study
-/*!
- Transforms IOR into PersistentID of the object. It is called for each
- object in the %study.
-*/
- string IORToLocalPersistentID (in SObject theSObject,
- in string IORString,
- in boolean isMultiFile,
- in boolean isASCII);
-/*!
- Transforms PersistentID into IOR of the object. It is called for each
- object in the %study.
-*/
- string LocalPersistentIDToIOR (in SObject theSObject,
- in string aLocalPersistentID,
- in boolean isMultiFile,
- in boolean isASCII)
- raises (SALOME::SALOME_Exception);
-
- // Publishing in the study
-/*! \brief Publishing in the study
-
- Returns True if the given %Component can publish the %object in the %study.
-*/
- boolean CanPublishInStudy(in Object theIOR) raises (SALOME::SALOME_Exception);
-/*! \brief Publishing in the study
-
- Publishes the given object in the %study, using the algorithm of this component.
- \param theStudy The %study in which the object is published
- \param theSObject If this parameter is null the object is published for the first time. Otherwise
- this parameter should contain a reference to the object published earlier
- \param theObject The object which is published
- \param theName The name of the published object. If this parameter is empty, the name is generated
- automatically by the component.
-*/
- SObject PublishInStudy(in Study theStudy, in SObject theSObject, in Object theObject, in string theName);
-
- // copy/paste methods
-
-/*!
- Returns True, if the given %SObject can be copied to the clipboard.
-*/
- boolean CanCopy(in SObject theObject);
-/*!
- Returns the object %ID and the %TMPFile of the object from the given %SObject.
-*/
- TMPFile CopyFrom(in SObject theObject, out long theObjectID);
-/*!
- Returns True, if the component can paste the object with given %ID of the component with name <VAR>theComponentName</VAR>.
-*/
- boolean CanPaste(in string theComponentName, in long theObjectID);
-/*!
- Returns the %SObject of the pasted object.
-*/
- SObject PasteInto(in TMPFile theStream, in long theObjectID, in SObject theObject);
-
- };
-};
-
-#endif
+++ /dev/null
-// 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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
-//
-//
-//
-// File : SALOMEDS.idl
-// Author : Yves FRICAUD
-// $Header$
-
-/*! \file SALOMEDS_Attributes.idl This file contains a set of interfaces
- for the attributes which can be assigned to %SObject
-*/
-#ifndef _SALOMEDS_AttributesIDL_
-#define _SALOMEDS_AttributesIDL_
-
-#include "SALOMEDS.idl"
-
-module SALOMEDS
-{
-/*! Sequence of double values
-*/
- typedef sequence <double> DoubleSeq;
-/*! Sequence of long values
-*/
- typedef sequence <long> LongSeq;
-/*! Sequence of string values
-*/
- typedef sequence <string> StringSeq;
-/*! \struct Color
- This structure stores a set of elements defining the color based on RGB.
-*/
- struct Color {
-/*! Red color
-*/
- double R;
-/*! Green color
-*/
- double G;
-/*! Blue color
-*/
- double B;
- };
- //==========================================================================
-/*! \brief Attribute allowing to store a real value
-
- Attribute allowing to store a real value
-*/
- //==========================================================================
- interface AttributeReal : GenericAttribute
- {
-/*!
- Returns the value of this attribute.
-<BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-*/
- double Value();
-/*!
- Sets the value of this attribute.
-<BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-*/
- void SetValue(in double value);
- };
- //==========================================================================
-/*! \brief Attribute allowing to store an integer value
-
- Attribute allowing to store an integer value
-*/
- //==========================================================================
- interface AttributeInteger : GenericAttribute
- {
-/*!
- Returns the value of this attribute
-<BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-*/
- long Value();
-/*!
- Sets the value of this attribute
-<BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-*/
- void SetValue(in long value);
- };
- //==========================================================================
-/*! \brief Attribute - sequence of real values
-
- Attribute - sequence of real values, indexing from 1 (like in CASCADE).
-*/
- //==========================================================================
- interface AttributeSequenceOfReal : GenericAttribute
- {
-/*!
- Initialization of the attribute with initial data.
- \param other Initially assigned sequence of real numbers.
-*/
- void Assign (in DoubleSeq other);
-/*!
- Returns the sequence of real numbers stored in the attribute.
-*/
- DoubleSeq CorbaSequence();
-/*!
- Adds to the end of the sequence a real number.
- \param value A real number added to the sequence.
-
-<BR><VAR>See also <A href=exemple/Example3.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-*/
- void Add (in double value);
-/*!
- Removes a real number with a definite index
- from the sequence of real numbers stored in the Attribute.
-*/
- void Remove(in long index);
-/*!
- Substitutes a real number with a definite index for another real number.
-<BR><VAR>See also <A href=exemple/Example3.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- void ChangeValue(in long index, in double value);
-/*!
- Returns a real number with a definite index
- in the sequence of real numbers stored in the Attribute.
-<BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-*/
- double Value(in short index);
-/*!
- Returns the length of the sequence of real numbers stored in the Attribute.
-<BR><VAR>See also <A href=exemple/Example3.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- long Length();
- };
- //==========================================================================
-/*! \brief Attribute - sequence of integer
-
- Attribute - sequence of integer, indexing from 1 (like in CASCADE)
-*/
- //==========================================================================
- interface AttributeSequenceOfInteger : GenericAttribute
- {
-/*!
- Initialization of the attribute with initial data.
- \param other Initially assigned sequence of integer numbers.
-*/
- void Assign (in LongSeq other);
-/*!
- Returns the sequence of integer numbers stored in the Attribute.
-*/
- LongSeq CorbaSequence();
-/*!
- Adds to the end of the sequence an integer number.
- \param value An integer number added to the sequence.
-
-<BR><VAR>See also <A href=exemple/Example3.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- void Add (in long value);
-/*!
- Removes an integer number with a definite index
- from the sequence of integer numbers stored in the Attribute.
-<BR><VAR>See also <A href=exemple/Example3.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- void Remove(in long index);
-/*!
- Substitutes an integer number with a definite index for another integer number.
-*/
- void ChangeValue(in long index, in long value);
-/*!
- Returns an integer number with a definite index
- in the sequence of integer numbers stored in the Attribute.
-<BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-*/
- long Value(in short index);
-/*!
- Returns the length of the sequence of integer numbers stored in the Attribute.
-<BR><VAR>See also <A href=exemple/Example3.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- long Length();
- };
-
- //==========================================================================
-/*! \brief Name attribute
-
- This attribute stores a string value, which corresponds to the name of the %SObject
- or to the name of corresponding object.
-*/
- //==========================================================================
-
- interface AttributeName : GenericAttribute
- {
-/*!
- Returns the value of this attribute
-<BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-*/
- string Value();
-/*!
- Sets the value of this attribute
-<BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-*/
- void SetValue(in string value);
- };
-
- //==========================================================================
-/*! \brief Comment attribute
-
- This attribute stores a string value containing supplementary information about
- the %SObject. In particular it contains the data type of the %SComponent.
-*/
- //==========================================================================
- interface AttributeComment : GenericAttribute
- {
-/*!
- Returns the value of this attribute
-<BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-*/
- string Value();
-/*!
- Sets the value of this attribute
-<BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-*/
- void SetValue(in string value);
- };
- //==========================================================================
-/*! \brief IOR attribute
-
- This attribute stores a string value identifying a runtime object.In particular
- it contains CORBA Interoperable Object Reference.
-*/
- //==========================================================================
- interface AttributeIOR : GenericAttribute
- {
-/*!
- Returns the value of this attribute
-<BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-*/
- string Value();
-/*!
- Sets the value of this attribute
-<BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-*/
- void SetValue(in string value);
- };
-
- //==========================================================================
-/*! \brief Persistent reference attribute
-
- This attribute stores a persistent identifier of the object.
-*/
- //==========================================================================
- interface AttributePersistentRef : GenericAttribute
- {
-/*!
- Returns the value of this attribute
-<BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-*/
- string Value();
-/*!
- Sets the value of this attribute
-<BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-*/
- void SetValue(in string value);
- };
-
- //==========================================================================
- //Below the list of presentation attributes for display study tree in browser
- //==========================================================================
-
-
- //==========================================================================
-/*! \brief Drawable flag Attribute.
-
- This is a presentation attribute necessary for display of the study tree in the browser.
- The item associated to SObject is created/displayed if TRUE.
-*/
- //==========================================================================
- interface AttributeDrawable : GenericAttribute
- {
-/*!
- Returns TRUE if the item is drawable (as it is by default) and FALSE if it isn't.
-<BR><VAR>See also <A href=exemple/Example8.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- boolean IsDrawable();
-/*!
-Sets the items to be drawable if <VAR>value</VAR> is TRUE (the default) or not to be selectable if <VAR>value</VAR>is FALSE.
-<BR><VAR>See also <A href=exemple/Example8.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- void SetDrawable(in boolean value);
- };
-
- //==========================================================================
-/*! \brief Selectable flag Attribute.
-
- This is a presentation attribute necessary for display of the study tree in the browser.
- The item is selectable by %SALOME selection mechanism if TRUE.
-*/
- //==========================================================================
- interface AttributeSelectable : GenericAttribute
- {
-/*!
- Returns TRUE if the item is selectable (as it is by default) and FALSE if it isn't.
-<BR><VAR>See also <A href=exemple/Example9.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- boolean IsSelectable();
-/*!
-Sets the items to be selectable if <VAR>value</VAR> is TRUE (the default) or not to be selectable if <VAR>value</VAR>is FALSE.
-<BR><VAR>See also <A href=exemple/Example9.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- void SetSelectable(in boolean value);
- };
-
- //==========================================================================
-/*! \brief Expandable flag Attribute.
-
- This is a presentation attribute necessary for display of the study tree in the browser.
- It sets this item to be expandable even if it has no children if value is TRUE. If value is FALSE
- expandable only if it has children.
-*/
- //==========================================================================
- interface AttributeExpandable : GenericAttribute
- {
-/*!
- Returns TRUE if this item is expandable even when it has no children.
-<BR><VAR>See also <A href=exemple/Example10.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- boolean IsExpandable();
-/*!
- Sets this item to be expandable even if it has no children if <VAR>value</VAR> is TRUE, and to be
- expandable only if it has children if <VAR>value</VAR> is FALSE (the default).
-<BR><VAR>See also <A href=exemple/Example10.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- void SetExpandable(in boolean value);
- };
-
- //==========================================================================
-/*! \brief Opened flag Attribute.
-
- This is a presentation attribute necessary for display of the study tree in the browser.
- It sets this item to be open (its children are visible) if bool is TRUE, and to be closed (its children
- are not visible) if bool is FALSE.
-*/
- //==========================================================================
- interface AttributeOpened : GenericAttribute
- {
-/*!
- Returns TRUE if this item is open (its children are visible) and FALSE if it isn't.
-<BR><VAR>See also <A href=exemple/Example11.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- boolean IsOpened();
-/*!
- Sets this item to be open (its children are visible) if <VAR>value</VAR> is TRUE, and to be closed
-(its children are not visible) if <VAR>value</VAR> is FALSE.
-<BR><VAR>See also <A href=exemple/Example11.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- void SetOpened(in boolean value);
- };
- //==========================================================================
-/*! \brief TextColorAttribute.
-
- This attribute sets the color of an item.
-*/
- //==========================================================================
- interface AttributeTextColor : GenericAttribute
- {
-/*!
- Returns the color of an item.
-<BR><VAR>See also <A href=exemple/Example12.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- Color TextColor();
-/*!
- Sets the color of an item.
-<BR><VAR>See also <A href=exemple/Example12.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- void SetTextColor(in Color value);
- };
-
- //==========================================================================
- /*! \brief TextHighlightColorAttribute.
-
- This attribute sets the highlight color of an item.
-*/
- //==========================================================================
- interface AttributeTextHighlightColor : GenericAttribute
- {
-/*!
- Returns the highlight color of an item.
-<BR><VAR>See also <A href=exemple/Example13.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- Color TextHighlightColor();
-/*!
- Sets the highlight color of an item.
-<BR><VAR>See also <A href=exemple/Example13.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- void SetTextHighlightColor(in Color value);
- };
- //==========================================================================
-/*! \brief PixMapAttribute.
-
- This attribute stores an icon which is put before the name of an item.
-*/
- //==========================================================================
- interface AttributePixMap : GenericAttribute
- {
-/*!
- Returns True if there is an icon before the name of the item.
-*/
- boolean HasPixMap();
-/*!
- Returns the name of the icon.
-<BR><VAR>See also <A href=exemple/Example14.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- string GetPixMap();
-/*!
- Sets the name of the icon.
-<BR><VAR>See also <A href=exemple/Example14.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- void SetPixMap(in string value);
- };
-
- //==========================================================================
-/*! \brief TreeNodeAttribute.
-
- A set of these attributes on the %SObjects of the %study forms an inner auxiliary
- tree whith its own structure and identifier. The quantity of such trees with different
- identifiers can be arbitrary.
-<BR><VAR>See also <A href=exemple/Example18.html> an example </A> of usage of the methods of this interface in batchmode of %SALOME application.</VAR>
-
-*/
- //==========================================================================
- interface AttributeTreeNode : GenericAttribute
- {
-/*!
- Sets the father TreeNode to this TreeNode.
-*/
- void SetFather(in AttributeTreeNode value);
-/*!
- Returns True if there is the father TreeNode of this TreeNode.
-*/
- boolean HasFather();
-/*!
- Returns the father Treenode of this TreeNode.
-*/
- AttributeTreeNode GetFather();
-/*!
- Sets the previous brother TreeNode to this treeNode.
-*/
- void SetPrevious(in AttributeTreeNode value);
-/*!
- Returns True if there is the previous brother TreeNode of this TreeNode.
-*/
- boolean HasPrevious();
-/*!
- Returns the previous brother TreeNode of this TreeNode.
-*/
- AttributeTreeNode GetPrevious();
-/*!
- Sets the next brother TreeNode to this treeNode.
-*/
- void SetNext(in AttributeTreeNode value);
-/*!
- Returns True if there is the next brother TreeNode of this TreeNode.
-*/
- boolean HasNext();
-/*!
- Returns the previous brother TreeNode of this TreeNode.
-*/
- AttributeTreeNode GetNext();
-/*!
- Sets the first child TreeNode to this treeNode.
-*/
- void SetFirst(in AttributeTreeNode value);
-/*!
- Returns True if there is the first child TreeNode of this TreeNode.
-*/
- boolean HasFirst();
-/*!
- Returns the first child TreeNode of this TreeNode.
-*/
- AttributeTreeNode GetFirst();
-/*!
- Sets ID of the tree. TreeNodes of one tree have the same ID.
-*/
- void SetTreeID(in string value);
-/*!
- Gets ID of the tree.
-*/
- string GetTreeID();
-
-/*!
- Adds a child TreeNode to the end of the list of children of this Treenode.
-*/
- void Append(in AttributeTreeNode value);
-/*!
- Adds a child TreeNode to the beginning of the list of children of this Treenode.
-
-*/
- void Prepend(in AttributeTreeNode value);
-/*!
- Adds a brother TreeNode before this Treenode.
- In this case the both TreeNodes will belong to the same father.
-*/
- void InsertBefore(in AttributeTreeNode value);
-/*!
- Adds a brother TreeNode after this Treenode.
- In this case the both TreeNodes will belong to the same father.
-*/
- void InsertAfter(in AttributeTreeNode value);
-/*!
- Deletes a TreeNode.
-<BR><VAR>See also <A href=exemple/Example3.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- void Remove();
-
-/*!
- Returns the depth of the TreeNode in the
- structure, it means the number of fathers of the given TreeNode.
- (i.e.: the depth of the root TreeNode is 0).
-*/
- long Depth();
-/*!
- Returns True if it is a root TreeNode.
-*/
- boolean IsRoot();
-/*!
- Returns True if this TreeNode is a descendant of the TreeNode.
-*/
- boolean IsDescendant(in AttributeTreeNode value);
-/*!
- Returns True if this TreeNode is the father of the TreeNode.
-*/
- boolean IsFather(in AttributeTreeNode value);
-/*!
- Returns True if this TreeNode is a child of the TreeNode.
-*/
- boolean IsChild(in AttributeTreeNode value);
-/*!
- Returns ID of the according %SObject.
-*/
- string Label();
- };
- //==========================================================================
-/*! \brief LocalID attribute
-
- Attribute describing the link between a %SObject and a local object in the component.
-*/
- //==========================================================================
- interface AttributeLocalID : GenericAttribute
- {
-/*!
- Returns the value of this attribute.
-<BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-*/
- long Value();
-/*!
- Sets the value of this attribute.
-<BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-*/
- void SetValue(in long value);
- };
-
- //==========================================================================
-/*! \brief Attribute storing GUID
-
- Attribute allowing to store GUID
-*/
- //==========================================================================
- interface AttributeUserID : GenericAttribute
- {
-/*!
- Returns the value of this attribute
-<BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-*/
- string Value();
-/*!
- Sets the value of this attribute
-<BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-*/
- void SetValue(in string value);
- };
-
- //==========================================================================
-/*! \brief %AttributeTarget iterface
-
- This attribute stores the list of all %SObjects that refer
- to this %SObject. This attribute is used for inner purposes of the application.
- It is also needed for optimization.
-*/
- //==========================================================================
-
- interface AttributeTarget : GenericAttribute
- {
-/*!
- Adds a %SObject to the list of %SObjects which refer to this %SObject.
-
-<BR><VAR>See also <A href=exemple/Example3.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- void Add(in SObject anObject);
-/*!
- Returns the list of %SObjects which refer to this %SObject.
-*/
- SALOMEDS::Study::ListOfSObject Get();
-/*!
- Deletes a %SObject from the list of %SObjects which refer to this %SObject.
-
-<BR><VAR>See also <A href=exemple/Example3.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- void Remove(in SObject anObject);
- };
- //==========================================================================
- /*! \brief %AttributeTableOfInteger interface
-
- This attribute allows to store a table of integers (indexing from 1 like in CASCADE)
- and string titles of this table, of each row, of each column.
-<BR><VAR>See also <A href=exemple/Example21.html> an example </A> of usage of these methods in batchmode of %SALOME application.</VAR>
-
-*/
- //==========================================================================
-
- interface AttributeTableOfInteger : GenericAttribute
- {
-/*!
- This exception is raised when an incorrect index is passed as parameter.
-*/
- exception IncorrectIndex {};
-/*!
- This exception is raised when an incorrect length of the argument is passed as parameter.
-*/
- exception IncorrectArgumentLength {};
-
- // titles: for table, for each row, for each column
-/*!
- Sets the title of the table.
-*/
- void SetTitle(in string theTitle);
-/*!
- Returns the title of the table.
-*/
- string GetTitle();
-/*!
- Sets the title of a row with a definite index.
-*/
- void SetRowTitle(in long theIndex, in string theTitle) raises(IncorrectIndex);
-/*!
- Sets the titles for all rows of the table.
-*/
- void SetRowTitles(in StringSeq theTitles) raises(IncorrectArgumentLength);
-/*!
- Returns the titles of all rows of the table.
-*/
- StringSeq GetRowTitles();
-/*!
- Sets the title of a column with a definite index.
-*/
- void SetColumnTitle(in long theIndex, in string theTitle) raises(IncorrectIndex);
-/*!
- Sets the titles for all columns of the table.
-*/
- void SetColumnTitles(in StringSeq theTitles) raises(IncorrectArgumentLength);
-/*!
- Returns the titles of all columns of the table.
-*/
- StringSeq GetColumnTitles();
-
- //Rows units
-/*!
- Sets the unit of a row with a definite index.
-*/
- void SetRowUnit(in long theIndex, in string theUnit) raises(IncorrectIndex);
-/*!
- Sets the units for all rows of the table.
-*/
- void SetRowUnits(in StringSeq theUnits) raises(IncorrectArgumentLength);
-/*!
- Returns the units of all rows of the table.
-*/
- StringSeq GetRowUnits();
-
- // table information
-/*!
- Returns the number of rows of the table.
-*/
- long GetNbRows();
-/*!
- Returns the number of columns of the table.
-*/
- long GetNbColumns();
-
- // operations with rows
-/*!
- Adds a row to the end of the table.
-*/
- void AddRow(in LongSeq theData) raises(IncorrectArgumentLength);
-/*!
- Sets the values of all elements of the row.
-*/
- void SetRow(in long theRow, in LongSeq theData) raises(IncorrectArgumentLength, IncorrectIndex);
-/*!
- Returns the row of the table.
-*/
- LongSeq GetRow(in long theRow) raises(IncorrectIndex);
-
- // operations with columns
-/*!
- Adds a column to the end of the table.
-*/
- void AddColumn(in LongSeq theData) raises(IncorrectArgumentLength);
-/*!
- Sets the values of all elements of the column.
-*/
- void SetColumn(in long theColumn, in LongSeq theData) raises(IncorrectArgumentLength, IncorrectIndex);
-/*!
- Returns the column of the table.
-*/
- LongSeq GetColumn(in long theColumn) raises(IncorrectIndex);
-
- // operations with elements
-/*!
- Puts a value in the table.
- \param theRow The row, where the value will be placed.
- \param theColumn The column, where the value will be placed.
-*/
- void PutValue(in long theValue, in long theRow, in long theColumn) raises(IncorrectIndex);
-/*!
- Returns True if there is a value in the table.
- \param theRow The row containing the value
- \param theColumn The column containing the value
-*/
- boolean HasValue(in long theRow, in long theColumn);
-/*!
- Returns the value from the table.
- \param theRow The row containing the value
- \param theColumn The column containing the value
-*/
- long GetValue(in long theRow, in long theColumn) raises(IncorrectIndex);
-
-/*!
- Sets the max number of colums in the table.
- \note It'd better to set it before filling the table.
-*/
- void SetNbColumns(in long theNbColumns);
-
-/*!
- Returns the indices of the row where the values are defined.
-*/
- LongSeq GetRowSetIndices(in long theRow) raises(IncorrectIndex);
- // operations with files
-/*!
- Reads a table from a file.
-*/
- boolean ReadFromFile(in SALOMEDS::TMPFile theStream);
-/*!
- Saves a table into a file.
-*/
- SALOMEDS::TMPFile SaveToFile();
- };
-
- //==========================================================================
-/*! \brief %AttributeTableOfReal interface
-
- This attribute allows to store a table of reals (indexing from 1 like in CASCADE)
- and string titles of this table, of each row, of each column.
-<BR><VAR>See also <A href=exemple/Example21.html> an example </A> of usage of these methods in batchmode of %SALOME application.</VAR>
-
-*/
- //==========================================================================
-
- interface AttributeTableOfReal : GenericAttribute
- {
-/*!
- This exception is raised when an incorrect index is passed as parameter.
-*/
- exception IncorrectIndex {};
-/*!
- This exception is raised when an incorrect length of the argument is passed as parameter.
-*/
- exception IncorrectArgumentLength {};
-
- // titles: for table, for each row, for each column
-/*!
- Sets the title of the table.
-*/
- void SetTitle(in string theTitle);
-/*!
- Returns the title of the table.
-*/
- string GetTitle();
-/*!
- Sets the title of a row with a definite index.
-*/
- void SetRowTitle(in long theIndex, in string theTitle) raises(IncorrectIndex);
-/*!
- Sets the titles for all rows of the table.
-*/
- void SetRowTitles(in StringSeq theTitles) raises(IncorrectArgumentLength);
-/*!
- Returns the titles of all rows of the table.
-*/
- StringSeq GetRowTitles();
-/*!
- Sets the title of a column with a definite index.
-*/
- void SetColumnTitle(in long theIndex, in string theTitle) raises(IncorrectIndex);
-/*!
- Sets the titles for all columns of the table.
-*/
- void SetColumnTitles(in StringSeq theTitles) raises(IncorrectArgumentLength);
-/*!
- Returns the titles of all columns of the table.
-*/
- StringSeq GetColumnTitles();
-
- //Rows units
-/*!
- Sets the unit of a row with a definite index.
-*/
- void SetRowUnit(in long theIndex, in string theUnit) raises(IncorrectIndex);
-/*!
- Sets the units for all rows of the table.
-*/
- void SetRowUnits(in StringSeq theUnits) raises(IncorrectArgumentLength);
-/*!
- Returns the units of all rows of the table.
-*/
- StringSeq GetRowUnits();
-
- // table information
-/*!
- Returns the number of rows of the table.
-*/
- long GetNbRows();
-/*!
- Returns the number of columns of the table.
-*/
- long GetNbColumns();
-
- // operations with rows
-/*!
- Adds a row to the end of the table.
-*/
- void AddRow(in DoubleSeq theData) raises(IncorrectArgumentLength);
-/*!
- Sets the values of all elements of the row.
-*/
- void SetRow(in long theRow, in DoubleSeq theData) raises(IncorrectArgumentLength, IncorrectIndex);
-/*!
- Returns the row of the table.
-*/
- DoubleSeq GetRow(in long theRow) raises(IncorrectIndex);
-
- // operations with columns
-/*!
- Adds a column to the end of the table.
-*/
- void AddColumn(in DoubleSeq theData) raises(IncorrectArgumentLength);
-/*!
- Sets the values of all elements of the column.
-*/
- void SetColumn(in long theColumn, in DoubleSeq theData) raises(IncorrectArgumentLength, IncorrectIndex);
-/*!
- Returns the column of the table.
-*/
- DoubleSeq GetColumn(in long theColumn) raises(IncorrectIndex);
-
- // operations with elements
-/*!
- Puts a value in the table.
- \param theRow The row, where the value will be placed.
- \param theColumn The column, where the value will be placed.
-*/
- void PutValue(in double theValue, in long theRow, in long theColumn) raises(IncorrectIndex);
-/*!
- Returns True if there is a value in the table.
- \param theRow The row containing the value
- \param theColumn The column containing the value
-*/
- boolean HasValue(in long theRow, in long theColumn);
-/*!
- Returns the value from the table.
- \param theRow The row containing the value
- \param theColumn The column containing the value
-*/
- double GetValue(in long theRow, in long theColumn) raises(IncorrectIndex);
-
-/*!
- Sets the max number of colums in the table.
- \note It'd better to set it before filling the table.
-*/
- void SetNbColumns(in long theNbColumns);
-
-/*!
- Returns the indices of the row where the values are defined.
-*/
- LongSeq GetRowSetIndices(in long theRow) raises(IncorrectIndex);
- // operations with files
-/*!
- Reads a table from a file.
-*/
- boolean ReadFromFile(in SALOMEDS::TMPFile theStream);
-/*!
- Saves a table into a file.
-*/
- SALOMEDS::TMPFile SaveToFile();
- };
-
-
-
- //==========================================================================
-/*! \brief %AttributeTableOfString interface
-
- This attribute allows to store a table of strings (indexing from 1 like in CASCADE)
- and string titles of this table, of each row, of each column.
-<BR><VAR>See also <A href=exemple/Example21.html> an example </A> of usage of these methods in batchmode of %SALOME application.</VAR>
-
-*/
- //==========================================================================
-
- interface AttributeTableOfString : GenericAttribute
- {
-/*!
- This exception is raised when an incorrect index is passed as parameter.
-*/
- exception IncorrectIndex {};
-/*!
- This exception is raised when an incorrect length of the argument is passed as parameter.
-*/
- exception IncorrectArgumentLength {};
-
- // titles: for table, for each row, for each column
-/*!
- Sets the title of the table.
-*/
- void SetTitle(in string theTitle);
-/*!
- Returns the title of the table.
-*/
- string GetTitle();
-/*!
- Sets the title of a row with a definite index.
-*/
- void SetRowTitle(in long theIndex, in string theTitle) raises(IncorrectIndex);
-/*!
- Sets the titles for all rows of the table.
-*/
- void SetRowTitles(in StringSeq theTitles) raises(IncorrectArgumentLength);
-/*!
- Returns the titles of all rows of the table.
-*/
- StringSeq GetRowTitles();
-/*!
- Sets the title of a column with a definite index.
-*/
- void SetColumnTitle(in long theIndex, in string theTitle) raises(IncorrectIndex);
-/*!
- Sets the titles for all columns of the table.
-*/
- void SetColumnTitles(in StringSeq theTitles) raises(IncorrectArgumentLength);
-/*!
- Returns the titles of all columns of the table.
-*/
- StringSeq GetColumnTitles();
-
- //Rows units
-/*!
- Sets the unit of a row with a definite index.
-*/
- void SetRowUnit(in long theIndex, in string theUnit) raises(IncorrectIndex);
-/*!
- Sets the units for all rows of the table.
-*/
- void SetRowUnits(in StringSeq theUnits) raises(IncorrectArgumentLength);
-/*!
- Returns the units of all rows of the table.
-*/
- StringSeq GetRowUnits();
-
- // table information
-/*!
- Returns the number of rows of the table.
-*/
- long GetNbRows();
-/*!
- Returns the number of columns of the table.
-*/
- long GetNbColumns();
-
- // operations with rows
-/*!
- Adds a row to the end of the table.
-*/
- void AddRow(in StringSeq theData) raises(IncorrectArgumentLength);
-/*!
- Sets the values of all elements of the row.
-*/
- void SetRow(in long theRow, in StringSeq theData) raises(IncorrectArgumentLength, IncorrectIndex);
-/*!
- Returns the row of the table.
-*/
- StringSeq GetRow(in long theRow) raises(IncorrectIndex);
-
- // operations with columns
-/*!
- Adds a column to the end of the table.
-*/
- void AddColumn(in StringSeq theData) raises(IncorrectArgumentLength);
-/*!
- Sets the values of all elements of the column.
-*/
- void SetColumn(in long theColumn, in StringSeq theData) raises(IncorrectArgumentLength, IncorrectIndex);
-/*!
- Returns the column of the table.
-*/
- StringSeq GetColumn(in long theColumn) raises(IncorrectIndex);
-
- // operations with elements
-/*!
- Puts a value in the table.
- \param theRow The row, where the value will be placed.
- \param theColumn The column, where the value will be placed.
-*/
- void PutValue(in string theValue, in long theRow, in long theColumn) raises(IncorrectIndex);
-/*!
- Returns True if there is a value in the table.
- \param theRow The row containing the value
- \param theColumn The column containing the value
-*/
- boolean HasValue(in long theRow, in long theColumn);
-/*!
- Returns the value from the table.
- \param theRow The row containing the value
- \param theColumn The column containing the value
-*/
- string GetValue(in long theRow, in long theColumn) raises(IncorrectIndex);
-
-/*!
- Sets the max number of colums in the table.
- \note It'd better to set it before filling the table.
-*/
- void SetNbColumns(in long theNbColumns);
-
-/*!
- Returns the indices of the row where the values are defined.
-*/
- LongSeq GetRowSetIndices(in long theRow) raises(IncorrectIndex);
- // operations with files
-/*!
- Reads a table from a file.
-*/
- boolean ReadFromFile(in SALOMEDS::TMPFile theStream);
-/*!
- Saves a table into a file.
-*/
- SALOMEDS::TMPFile SaveToFile();
- };
-
-
- //==========================================================================
-/*! \brief %AttributeStudyProperties interface
-
- This attribute allows to store study properties: user name, creation date, creation
- mode, modified flag, locked flag.
-<BR><VAR>See also <A href=exemple/Example20.html> an example </A> of usage of these methods in batchmode of %SALOME application.</VAR>
-
-*/
- //==========================================================================
-
- interface AttributeStudyProperties : GenericAttribute
- {
-/*!
- Sets the name of the author of the %Study
-*/
- void SetUserName(in string theName);
-/*!
- Returns the name of the user of the %Study.
- \note <BR>It returns a null string, if user name is not set
-*/
- string GetUserName();
-/*!
- Sets creation date of the %Study.
-*/
- void SetCreationDate(in long theMinute, in long theHour, in long theDay, in long theMonth, in long theYear);
-/*!
- Returns creation date of the %Study and True if creation date is set.
-*/
- boolean GetCreationDate(out long theMinute, out long theHour, out long theDay, out long theMonth, out long theYear);
-/*!
- Sets creation mode of the %Study.
- \note <BR>Creation mode must be: "from scratch" or "copy from".
-*/
- void SetCreationMode(in string theMode);
-/*!
- Returns creation mode: "from scratch", "copy from", or null string
- if creation mode is not set
-*/
- string GetCreationMode();
-/*!
- Sets the number of transactions executed after the last saving of the document.
-*/
- void SetModified(in long theModified);
-/*!
- Returns True, if the document has been modified and not saved.
-*/
- boolean IsModified();
-/*!
- Returns the number of transactions executed after the last saving of the document.
-*/
- long GetModified();
-/*!
- Sets the document locked for modifications if <VAR>theLocked</VAR> is True.
-*/
- void SetLocked(in boolean theLocked);
-/*!
- Returns True if the document is locked for modifications.
-*/
- boolean IsLocked();
-/*!
- Appends modification parameters to the modifications list.
-*/
- void SetModification(in string theName, in long theMinute, in long theHour, in long theDay, in long theMonth, in long theYear);
-/*!
- Returns a list of mosdifiers user names, modification dates.
- /note <BR>If <VAR>theWithCreator</VAR> is True, then the output list will also contain the name of the author and the date of creation.
-*/
- void GetModificationsList(out StringSeq theNames, out LongSeq theMinutes, out LongSeq theHours, out LongSeq theDays, out LongSeq theMonths, out LongSeq theYears, in boolean theWithCreator);
- };
- //==========================================================================
-/*! \brief %AttributePythonObject interface
-
- Attribute allowing to store pyton objects as a sequence of chars.
-*/
- //==========================================================================
-
- interface AttributePythonObject : GenericAttribute
- {
-/*!
- Sets in the attribute a Python object converted into a sequence of chars.
- \param theSequence A sequence of chars.
- \param IsScript Defines (if True) whether this sequence of chars is a Python script.
-*/
- void SetObject(in string theSequence, in boolean IsScript);
-/*!
- Returns a Python object stored in the attribute as a sequence of chars.
-*/
- string GetObject();
-/*!
- Returns True if the sequence of bytes stored in the attribute corresponds
- to a Python script.
-*/
- boolean IsScript();
- };
-};
-#endif
+++ /dev/null
-// 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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
-//
-//
-//
-// File : SALOME_Component.idl
-// Author : Paul RASCLE, EDF
-// $Header: /dn05/salome/CVS/SALOME_ROOT/idl/SALOME_Component.idl
-
-#ifndef _SALOME_COMPONENT_IDL_
-#define _SALOME_COMPONENT_IDL_
-/*! \ingroup Kernel
-
-This is a package of interfaces used for connecting new components to %SALOME application. It also contains a set of interfaces used
-for management of %MED component in %SALOME application.
-*/
-module Engines
-{
- interface Component ;
-
-/*! \brief Interface of the %Container
-
- This interface defines the process of loading and registration
- of new components in SALOME application
-*/
- interface Container
- {
-/*!
- Initializes the %container with a definite name.
-*/
- Container start_impl( in string ContainerName ) ;
-
-/*!
- Loads into the container a new component, registers it and starts it's CORBA servant.
- \param nameToRegister Name of the component which will be registered in Registry (or Name Service)
- \param componentName Name of the constructed library of the %component
-*/
- Component load_impl(in string nameToRegister, in string componentName);
-
-/*!
- Stops the component servant, and deletes all related objects
-*/
- void remove_impl(in Component component_i);
-
-/*!
- Discharges all components from the container.
-*/
- void finalize_removal() ;
-/*!
- Determines whether the server has been loaded or not.
-*/
-
- void ping();
-/*!
- Name of the %container
-*/
- readonly attribute string name ;
-/*!
- Name of the machine containing this container (location of the container).
-*/
- readonly attribute string machineName ;
-/*!
- Returns True if the %container has been killed
-*/
- boolean Kill_impl() ;
- };
-/*! \brief Interface of the %component
-
- This interface is used for interaction between the %container and the %component and between
- the components inside the container.
-*/
- interface Component
- {
-/*!
- The name of the instance of the %Component
-*/
- readonly attribute string instanceName ;
-/*!
- The name of the interface of the %Component
-*/
- readonly attribute string interfaceName ;
-/*!
- Determines whether the server has already been loaded or not.
-*/
- void ping();
-/*!
- Deactivates the %Component.
-*/
- void destroy() ;
-/*!
- Returns the container that the %Component refers to.
-*/
- Container GetContainerRef() ;
-/*!
- This method is used by the %SUPERVISOR component. It sets the names of the graph and of the node.
-*/
- void Names( in string aGraphName , in string aNodeName ) ;
-/*!
- Returns True if the %Component has been killed.
-*/
- boolean Kill_impl() ;
-/*!
- Returns True if the activity of the %Component has been stopped. (It's action can't be resumed)
-*/
- boolean Stop_impl() ;
-/*!
- Returns True if the activity of the %Component has been suspended. (It's action can be resumed)
-*/
- boolean Suspend_impl() ;
-/*!
- Returns True if the activity of the %Component has been resumed.
-*/
- boolean Resume_impl() ;
-/*!
- Returns the Cpu used (long does not run with python !...)
-*/
- long CpuUsed_impl() ;
- } ;
-} ;
-
-#endif
+++ /dev/null
-// 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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
-//
-//
-//
-// File : SALOME_DataTypeCatalog.idl
-// Author : Estelle Deville, Paul Rascle
-// $Header$
-
-module SALOME_DataTypeCatalog{
-// Type definitions
-
-// List of Data Type Names
- typedef sequence<string> ListOfDataTypeName ;
-
- // Exception thrown if a DataType is not found in the catalog
- exception NotFound {};
-//--------------------------------------------------------------------------
-// Interfaces
-
-// Catalog interface :
-// methods to :
-// - obtain the data type names of the catalog
-// - test the compatibility between two type names
-interface DataCatalog
-{
- ListOfDataTypeName GetDataTypeList() ;
- boolean isDerivedFrom(in string type_in, in string type_out) raises(NotFound);
- string GetDataInterfaceRead(in string type) raises(NotFound);
- string GetDataInterfaceWrite(in string type)raises(NotFound);
- ListOfDataTypeName GetDataTypeParents(in string type) raises(NotFound);
-} ;
-};
+++ /dev/null
-// 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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
-//
-//
-//
-// File : SALOME_Exception.idl
-// Author : Paul RASCLE, EDF
-// $Header$
-
-/*! \file SALOME_Exception.idl This file contains the objects defining the main exception used
-in %SALOME application.
-*/
-#ifndef _SALOME_EXCEPTION_IDL_
-#define _SALOME_EXCEPTION_IDL_
-
-/*!
-Module SALOME regroups all idl definitions for SALOME Kernel
-*/
-
-module SALOME
-{
-/*!
-This enumeration contains the elements indicating the type of the exception.
-*/
- enum ExceptionType
- {
- COMM, /*!< Communication problem */
- BAD_PARAM, /*!< Bad User parameters */
- INTERNAL_ERROR /*!< SALOME Bug, irrecoverable */
- };
-/*!
-This struct contains a set of fields defining the structure of the exception.
-*/
- struct ExceptionStruct
- {
- ExceptionType type; /*!<Type of the exception.*/
- string text; /*!<Message which is shown when the exception is raised.*/
- string sourceFile; /*!<The source file where the exception is raised.*/
- unsigned long lineNumber; /*!<Number of the line of the source file where the exception is raised.*/
- };
-/*!
-The main exception in %SALOME application.
-*/
- exception SALOME_Exception
- {
- ExceptionStruct details;
- };
-
-};
-
-#endif
+++ /dev/null
-// 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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
-//
-//
-//
-// File : SALOME_ModuleCatalog.idl
-// Author : Estelle Deville
-// $Header$
-
-/*! \file SALOME_ModuleCatalog.idl This file conatins a set of interfaces used for
- creation of the catalog of components in %SALOME application
-*/
-
-/*! \ingroup Kernel
-The main package of interfaces used for creation of the module catalog in %SALOME application.
-*/
-module SALOME_ModuleCatalog
-{
- // Type Definitions
-/*!
-This enumeration contains a set of definitions of %SALOME modules.
-*/
- enum ComponentType { GEOM, /*!<Module %GEOM */
- MESH, /*!<Module %MESH */
- Med, /*!<Module %Med*/
- SOLVER, /*!<Module of %SOLVER type */
- DATA, /*!<Module %DATA */
- VISU, /*!<Module %VISU */
- SUPERV, /*!<Module %SUPERVISION */
- OTHER /*!<Any other type of module */
- } ;
-/*!
-This struct contains fields defining the parameters of the services.
-*/
-
- struct ServicesParameter
- {
- string Parametertype; /*!<Type of the parameter.*/
- string Parametername; /*!<Name of the parameter.*/
- } ;
-
- typedef sequence<ServicesParameter> ListOfServicesParameter;
-/*!
-This struct contains fields completely defining each service.
-*/
-
- struct Service
- {
- string ServiceName; /*!<Name of the service.*/
- ListOfServicesParameter ServiceinParameter; /*!< List of input parameters of the services.*/
- ListOfServicesParameter ServiceoutParameter; /*!< List of input parameters of the services.*/
- boolean Servicebydefault; /*!<True if the service is taken with its defult fields.*/
- } ;
-/*!
-List of services of the interface.
-*/
- typedef sequence<Service> ListOfInterfaceService;
-/*!
-List of services.
-*/
- typedef sequence<string> ListOfServices ;
-/*!
-This struct contains fields defining each interface.
-*/
- struct DefinitionInterface
- {
- string interfacename ; /*!<Name of the interface.*/
- ListOfInterfaceService interfaceservicelist ; /*!<List of services of the interface.*/
- } ;
-/*!
-List of interface definitions.
-*/
- typedef sequence<DefinitionInterface> ListOfDefInterface ;
-/*!
-List of interfaces.
-*/
- typedef sequence<string> ListOfInterfaces ;
-/*!
-List of names of components.
-*/
- typedef sequence<string> ListOfComponents ;
-/*!
-List of names of computers.
-*/
- typedef sequence<string> ListOfComputers ;
-/*!
-This struct contains GUI elements used for representation of the module in %IAPP component.
-*/
- struct IAPP_Affich
- {
- string modulename; /*!<Name of the module.*/
- string moduleicone; /*!<Icone representing the module.*/
- };
-/*!
-List of pair GUI elements (component name, component icone)
- used for representation of the module in %IAPP component.
-*/
- typedef sequence<IAPP_Affich> ListOfIAPP_Affich ;
-
-/*!
- This exception is raised when a %component, a %service or a % pathPrefix is not found.
-*/
- exception NotFound
- {
- string what ; /*!<Indicates if it's a %component, a %service or a % pathPrefix.*/
- } ;
-
- interface Acomponent
- {
- // GetInterfaceList : operation to get a list of the interfaces name of
- // a component
- /*!
- Gets a list of names of interfaces of the component
- \return a list of interfaces of the component
- */
- ListOfInterfaces GetInterfaceList() ;
-
- // GetInterface : operation to get one interface of a component
-
- /*!
- Gets a definite interface of the component
- \note <BR>If the specified interface doesn't exist, Notfound exception is thrown
- \param interfacename Name of the interface
- \return Required interface
- */
- DefinitionInterface GetInterface(in string interfacename) raises(NotFound);
-
- // GetServiceList : operation to get a list of the services name of
- // an interface of a component
- /*!
- Gets a list of names of services of a definite interface belonging to the component.
- \note <BR>If the specified interface doesn't exist, Notfound exception is thrown.
- \param interfacename Name of the interface
- \return List of services of the required interface
- */
- ListOfServices GetServiceList(in string interfacename) raises(NotFound);
-
-
- // GetService : operation to get one service of an interface of a component
-
- /*!
- Gets a definite service of an interface of the component.
- \note <BR>If the required service or the specified interface don't exist, Notfound exception is thrown.
- \param interfacename Name of the interface
- \param servicename Name of the service
- \return Required service
- */
-
- Service GetService(in string interfacename,
- in string servicename) raises(NotFound);
-
- // GetDefaultService : operation to get the default service
- // of an interface of a component
-/*!
- Gets the default service of an interface of the component.
- \note <BR>If the required service or the specified interface don't exist, Notfound exception is thrown.
- \param interfacename Name of the interface
- \return Required service
- */
-
- Service GetDefaultService(in string interfacename) raises(NotFound);
-
- // GetPathPrefix : operation to get the PathPrefix of a computer
- /*!
- Gets the prefix path of the computer containing the %component.
- \note <BR>If the required computer doesn't exist, Notfound exception is thrown
- \param machinename Name of the machine
- \return Prefix path
- */
-
- string GetPathPrefix(in string machinename) raises(NotFound);
-
-/*!
- Sets/gets the constraint affected to the component
- (to be resolved by LifeCycle for the computer choice)
-*/
- readonly attribute string constraint ;
-
-/*!
-Sets/gets the name of the component
-*/
- readonly attribute string componentname;
-
-/*!
-Defines whether the component can be multistudy or not
-*/
- readonly attribute boolean multistudy;
-
-/*!
-Defines the type of the component
-*/
- readonly attribute ComponentType component_type ;
-
-/*!
-Sets/gets the icone of the component (for IAPP)
-*/
- readonly attribute string component_icone;
- } ;
-/*! \brief %Module catalog interface
-
-This interface is used for creation of the module catalog in %SALOME application.
-*/
- interface ModuleCatalog
- {
- void ping();
-
-/*!
- Gets a list of names of computers of the catalog
-*/
- ListOfComputers GetComputerList();
-
-/*!
-Gets the %PathPrefix of a computer
-*/
- string GetPathPrefix(in string machinename) raises(NotFound);
-/*!
- Gets a list of names of components of the catalog
-*/
- ListOfComponents GetComponentList();
-/*!
-Gets a list of pair GUI elements (component name, component icone)
-used for representation of the module in %IAPP component.
-*/
-
- ListOfIAPP_Affich GetComponentIconeList();
-/*!
-Gets a list of names of components of a particular type, which belong to this catalog.
-*/
- // GetComponentList : operation to get a list of the components name of
- // a particular type of the catalog
- ListOfComponents GetTypedComponentList(in ComponentType _component_type);
-
-/*!
-Gets one component of the catalog.
-*/
- Acomponent GetComponent(in string componentname) raises(NotFound);
- } ;
-};
+++ /dev/null
-// 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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
-//
-//
-//
-// File : SALOME_Registry.idl
-
-# ifndef __registry_idl__
-# define __registry_idl__
-
-module Registry
-{
- struct Infos
- {
- string name;
- long pid;
- string machine;
- string adip;
- long uid;
- string pwname;
- long tc_start;
- long tc_hello;
- long tc_end;
- long difftime;
- string cdir;
- long status;
- string ior; // client
- };
-
- typedef sequence<Infos> AllInfos;
-
- interface Components
- {
- void ping();
- unsigned long add ( in Infos lesInfos ) ;
- void remove ( in unsigned long id ) ;
- unsigned long size() ;
- AllInfos getall () ;
- AllInfos history () ;
- oneway void end() ;
- oneway void hello( in unsigned long id ) ;
- } ;
-} ;
-
-# endif
+++ /dev/null
-// 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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
-//
-//
-//
-// File : SALOME_RessourcesCatalog.idl
-// Author : Estelle Deville
-// $Header$
-
-module SALOME_RessourcesCatalog{
- // Type Definitions
-
- //Proc_info : information about a processor
- struct proc_info{
- long number;
- string model_name;
- float cpu_mhz;
- float cache_size;
- };
-
- typedef sequence<proc_info> ListOfProc;
-
- //Computer_info : information about a computer
- // Os and informations about processors
- struct computer_info{
- string name;
- string OS;
- string OS_version;
- ListOfProc procs;
- };
-
- enum ContainerType {Cpp, python, NP};
- typedef sequence<ContainerType> ListOfContainerType;
-
- typedef sequence<string> ListOfComputer;
-
- // exception thrown if a computer is not found in the catalog
-
- exception NotFound {};
-
- //------------------------------------------------------------------
- //Interface
- interface RessourcesCatalog {
- ListOfComputer GetComputerList();
- ListOfContainerType GetContainerTypeList (in string computer) raises(NotFound);
- computer_info GetComputerInfo(in string computer) raises(NotFound);
- };
-};
+++ /dev/null
-// 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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
-//
-//
-//
-// File : SALOME_Session.idl
-// Author : Paul RASCLE, EDF
-// $Header$
-
-#include "SALOME_Component.idl"
-/*! \defgroup Kernel SALOME KERNEL module
-*/
-
-/*! \ingroup Kernel
-
- This package contains interfaces used for management of the session in %SALOME application.
-*/
-module SALOME
-{
-/*! \brief State of the session
-
- This enumeration contains values defining the state of the session
-
-*/
- enum SessionState {asleep, running} ;
-
-/*! \brief %Session State and Statistics
-
-
- This struct contains a field list with general information about the session
-*/
-
- struct StatSession
- {
-/*! \brief State of the session
-
- It can be:
- * -# asleep : no running study
- * -# running : one or more running studies
-*/
- SessionState state ;
-/*! Number of running studies
-*/
- short runningStudies ;
-/*! It is True if GUI is active in the session
-*/
- boolean activeGUI ;
- } ;
-/*! \brief Interface of the session
-
- The %session Server launches and stops GUI (Graphical User Interface).
- The %session can be active without GUI (It can contain one or more running studies)
-*/
-
- interface Session
- {
-/*!
- This exception is raised when trying to stop the %session with active GUI
-*/
- exception GUIActive {} ;
-/*!
- This exception is raised when trying to stop the %session with a number of running studies.
-*/
- exception RunningStudies {} ;
-
-/*!
- Launches GUI in the session
-*/
- void GetInterface();
- Engines::Component GetVisuGen();
-
-/*!
- Stops the %Session (It must be idle)
-*/
- void StopSession() raises(GUIActive, RunningStudies) ;
-
-/*!
- Gets Session State
-*/
- StatSession GetStatSession() ;
-/*!
- Determines whether the server has already been loaded or not.
-*/
- void ping();
- } ;
-
-} ;
+++ /dev/null
-// 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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
-//
-//
-//
-// File : SALOME_TestComponent.idl
-// Author : Paul RASCLE, EDF - MARC TAJCHMAN, CEA
-// $Header$
-
-#include "SALOME_Component.idl"
-
-module Engines
-{
-
- interface TestComponent : Component
- {
- string Coucou(in long L);
- };
-
-};
+++ /dev/null
-// 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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
-//
-//
-//
-// File : TestNotif.idl
-
-# ifndef __TESTNOTIF_IDL_
-# define __TESTNOTIF_IDL_
-
-interface Solver
-{
- boolean Connect();
- oneway void Start() ;
- oneway void ReStart() ;
-} ;
-# endif
+++ /dev/null
-// 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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
-//
-//
-//
-// File : TypeData.idl
-
-#ifndef _SALOME_TYPEDATA_IDL_
-#define _SALOME_TYPEDATA_IDL_
-
-module Engines
-{
-
- typedef sequence<double> DoubleVec ;
- typedef sequence<long> IntVec;
-
- typedef struct CSR {
- unsigned long nbpos;
- unsigned long nbval;
- IntVec pos;
- IntVec col;
- DoubleVec data;
- } CSRMatStruct;
-
-} ;
-
-#endif
-
+++ /dev/null
-// 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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
-//
-//
-//
-// File : SALOMEDS.idl
-// Author : Yves FRICAUD
-// $Header$
-
-/*! \mainpage
- \image html Application-About.png
-
-*/
-/*! \page page1 Mapping of IDL definitions to Python language.
-\section Intro Introduction
-%SALOME PRO is a distributed client/server application using the Common Object Request Broker Architecture (CORBA).
-CORBA architecture uses the Interface Definition Language (IDL), which specifies interfaces between CORBA objects. So with help of IDL
-CORBA's language independence is ensured . Because interfaces described in IDL can be mapped to the most of currently used programming languages, CORBA applications and components are thus
-independent of the language(s) used to implement them. In other words, a client written in C++ can communicate with a server written in Java, which in turn can communicate with
-another server written in COBOL, and so forth.
-
-One important thing to remember about IDL is that it is not an implementation language. That is, applications can't be written in IDL. The sole purpose of IDL is to define interfaces;
-providing implementations for these interfaces is performed using some other language.
-
-This page contains an abridged reference manual for mapping of IDL definitions to Python language. It will be useful for Python programmers who are not familiar
-with IDL language. All examples are taken from %SALOME PRO source files.
-The complete version of Python Language Mapping Specification can be found <A HREF="http://www.omg.org">here.</A>
-
-<BR><STRONG>CONTENTS:</STRONG>
-- \ref subsection1
-- \ref subsection2
-- \ref subsection3
-- \ref subsection4
-- \ref subsection5
-- \ref subsection6
-- \ref subsection7
-
-\subsection subsection1 Using Scoped Names
-
-Python implements a module concept that is similar to the IDL scoping mechanisms,
-except that it does not allow for nested modules. In addition, Python requires each
-object to be implemented in a module; globally visible objects are not supported.
-
-Because of these constraints, scoped names are translated into Python using the
-following rules:
-
-\95 An IDL module mapped into a Python module. Modules containing modules are
-mapped to packages (i.e., directories with an <STRONG>__init__</STRONG> module containing all
-definitions excluding the nested modules). An implementation can chose to map toplevel
-definitions (including the module CORBA) to modules in an implementationdefined
-package, to allow concurrent installations of different CORBA runtime
-libraries. In that case, the implementation must provide additional modules so that
-toplevel modules can be used without importing them from a package.
-
-\95 For all other scopes, a Python class is introduced that contains all the definitions
-inside this scope.
-
-\95 Other global definitions (except modules) appear in a module whose name is
-implementation dependent. Implementations are encouraged to use the name of the
-IDL file when defining the name of that module.
-
-For instance,
-
-\verbatim
-module SALOMEDS {
- interface StudyManager {
- void Close(in Study aStudy);
- };
-};
-\endverbatim
-
-would introduce a module SALOMEDS.py, which contains the following definitions:
-
-\verbatim
-# module SALOMEDS.py
-class StudyManager:
- def _Close(self,aStudy):
- pass #interfaces are discussed later
-\endverbatim
-
-To avoid conflicts, IDL names that are also Python identifiers are prefixed with an underscore (\91_\92).
-
-\subsection subsection2 Mapping for Template and Array Types
-
-Both the bounded and the unbounded string type of IDL are mapped to the Python
-string type. Wide strings are represented by an implementation-defined type with the
-following properties:
-
-\95 For the wide string X and the integer n, X[n] returns the nth character, which is a
-wide string of length 1.
-
-\95 len(X) returns the number of characters of wide string X.
-
-\95 CORBA.wstr(c) returns a wide character with the code point c in an
-implementation-defined encoding.
-
-\95 X+Y returns the concatenation of wide strings X and Y.
-
-\95 CORBA.word(CORBA.wstr(c)) == c
-
-The sequence template is mapped to sequence objects (e.g., tuples or lists).
-Applications should not assume that values of a sequence type are mutable. Sequences
-and arrays of octets and characters are mapped to the string type for efficiency reasons.
-
-For example, given the IDL definitions
-
-\verbatim
-module SALOMEDS {
- typedef sequence <string> StringSeq;
-
- interface AttributeTableOfInteger : GenericAttribute {
-
- void SetRowTitles(in StringSeq theTitles) raises(IncorrectArgumentLength);
- };
-};
-\endverbatim
-
-a client could invoke the operation
-
-\verbatim
-print My_AttributeTableOfInteger.SetRowTitles(["X","F"])
-\endverbatim
-
-Array types are mapped like sequence templates. The application in this example also expects an
-IncorrectArgumentLength exception if it passes sequences that violate the bounds constraint or
-arrays of wrong size.
-
-Another example with arrays. The following IDL definition
-
-\verbatim
-module SALOMEDS {
- typedef sequence<GenericAttribute> ListOfAttributes;
- interface SObject {
- ListOfAttributes GetAllAttributes();
- };
-};
-\endverbatim
-
-is equal to
-
-\verbatim
-import SALOMEDS
-
-attributes=[]
-
-attributes = My_SObject.GetAllAttributes()
-
-length = len(attributes)
-
-print "Attributes number = ", length
-print attributes
-\endverbatim
-
-\subsection subsection3 Mapping for Objects and Operations
-
-A CORBA object reference is represented as a Python object at run-time. This object
-provides all the operations that are available on the interface of the object. Although
-this specification does not mandate the use of classes for stub objects, the following
-discussion uses classes to indicate the interface.
-
-The nil object is represented by <STRONG>None</STRONG>.
-
-If an operation expects parameters of the IDL Object type, any Python object
-representing an object reference might be passed as actual argument.
-
-If an operation expects a parameter of an abstract interface, either an object
-implementing that interface, or a value supporting this interface may be passed as
-actual argument. The semantics of abstract values then define whether the argument is
-passed by value or by reference.
-
-Operations of an interface map to methods available on the object references.
-Parameters with a parameter attribute of <STRONG>in</STRONG> or <STRONG>inout</STRONG>
-are passed from left to right tothe method, skipping <STRONG>out</STRONG> parameters.
-The return value of a method depends on the number of <STRONG>out</STRONG> parameters
-and the return type. If the operation returns a value, this
-value forms the first <VAR>result value</VAR>. All <STRONG>inout</STRONG> or <STRONG>out</STRONG>
-parameters form consecutive <VAR>result values</VAR>. The method result depends then on the number
-of <VAR>result values</VAR>:
-
-\95 If there is no <VAR>result value</VAR>, the method returns None.
-
-\95 If there is exactly one <VAR>result value</VAR>, it is returned as a single value.
-
-\95 If there is more than one <VAR>result value</VAR>, all of them are packed into a tuple, and this
-tuple is returned.
-
-Assuming the IDL definition
-
-\verbatim
-module SALOMEDS{
- interface StudyBuilder{
- boolean FindAttribute ( in SObject anObject,
- out GenericAttribute anAttribute,
- in string aTypeOfAttribute );
- };
-};
-\endverbatim
-
-a client could write
-
-\verbatim
-from SALOMEDS import StudyBuilder;
-my_StudyBuilder=...
-
- res,A=my_StudyBuilder.FindAttribute(Sobj, "AttributeSequenceOfReal")
-\endverbatim
-
-In this example <STRONG>A</STRONG> corresponds to the return value <STRONG>anAttribute</STRONG> and
-<STRONG>res</STRONG> to the <STRONG>boolean</STRONG> return value.
-
-If an interface defines an <STRONG>attribute name</STRONG>, for example, the attribute is mapped into an
-operation <STRONG>_get_name</STRONG>. If the attribute is not <STRONG>readonly</STRONG>, there is an
-additional operation <STRONG>_set_name</STRONG>.
-
-The IDL definition
-
-\verbatim
-module SALOMEDS{
- interface Study{
- attribute string Name;
- };
-};
-\endverbatim
-
-is equal to the following
-
-\verbatim
-from SALOMEDS import Study
-My_Study=...
- Name=My_Study._get_name();
- Name=My_Study._set_name();
-\endverbatim
-
-\subsection subsection4 Narrowing Object References
-
-Python objects returned from CORBA operations or pseudo-operations (such as
-string_to_object) might have a dynamic type, which is more specific than the
-static type as defined in the operation signature.
-
-Since there is no efficient and reliable way of automatically creating the most specific
-type, explicit narrowing is necessary. To narrow an object reference <STRONG>A</STRONG> to an interface
-class <STRONG>AttributeSequenceOfReal</STRONG>, the client can use the following operation
-
-\verbatim
-A = A._narrow(SALOMEDS.AttributeSequenceOfReal)
-\endverbatim
-
-\subsection subsection5 Mapping for Exceptions
-
-An IDL exception is translated into a Python class derived from
-CORBA.UserException. System exceptions are derived from CORBA.SystemException.
-Both base classes are derived from CORBA.Exception. The parameters of the
-exception are mapped in the same way as the fields of a struct definition. When
-raising an exception, a new instance of the class is created; the constructor
-expects the exception parameters. For example, the definition
-
-\verbatim
-module SALOMEDS{
- interface StudyBuilder{
- exception LockProtection {};
- void CommitCommand() raises(LockProtection);
- };
-};
-\endverbatim
-
-could be used caught as
-
-\verbatim
-from SALOMEDS import StudyBuilder;
-my_StudyBuilder=...
-try:
- my_StudyBuilder.CommitCommand();
-except StudyBuilder.LockProtection,value:
- print "Error! Study is locked for modifications"
-\endverbatim
-
-
-\subsection subsection6 Mapping for Enumeration Types
-
-An enumeration is mapped into a number of constant objects in the name space where
-the enumeration is defined. An application may only test for equivalence of two
-enumeration values, and not assume that they behave like numbers.
-For example, the definition
-
-\verbatim
-module VISU {
- interface PrsObject{
-
- enum PrsObjType{ TCURVE, TTABLE, TMESH, TCONTAINER,
- TSCALARMAP, TISOSURFACE, TDEFORMEDSHAPE,
- TCUTPLANES, TVECTORS };
- };
-};
-\endverbatim
-
-introduces the objects
-
-\verbatim
-from VISU import PrsObject
-VISU.PrsObjType.TCURVE,VISU.PrsObjType.TTABLE,VISU.PrsObjType.TMESH,VISU.PrsObjType.TCONTAINER,
-VISU.PrsObjType.TSCALARMAP,VISU.PrsObjType.TISOSURFACE,VISU.PrsObjType.TDEFORMEDSHAPE,VISU.PrsObjType.TCUTPLANES,
-VISU.PrsObjType.TVECTORS
-\endverbatim
-
-\subsection subsection7 Mapping for Structured Types
-
-An IDL struct definition is mapped into a Python class or type. For each field in the
-struct, there is a corresponding attribute in the class with the same name as the field.
-The constructor of the class expects the field values, from left to right.
-For example, the IDL definition
-
-\verbatim
-struct SDate {
- short Second;
- short Minute;
- short Hour;
- short Day;
- short Month;
- short Year;
- };
-\endverbatim
-
-could be used in the Python statements
-
-\verbatim
-Date=SDate(30, 12, 15, 26, 1, 79)
-print Date.Second,Date.Minute,Date.Hour,Date.Day,Date.Month,Date.Year
-\endverbatim
-*/
-/*! \page page2 Mapping of SALOME IDL definitions to Python language.
-
-
- - <B>%SALOME STUDY module</B>
- - <A href=HTML/SALOMEDS.html>Mapping of %SALOMEDS functions</A>
- - <A href=HTML/SALOMEDS_Attributes.html>Mapping of SALOMEDS_Attributes functions</A>
- - <B>%SAlOME KERNEL module</B>
- - <A href=HTML/Med_Gen.html>Mapping of %Med_Gen functions</A>
- - <A href=HTML/SALOME_Session.html>Mapping of %SALOME_Session functions</A>
- - <A href=HTML/SALOME_ModuleCatalog.html>Mapping of %SALOME_ModuleCatalog functions</A>
- - <A href=HTML/SALOME_Exception.html>Mapping of %SALOME_Exception functions</A>
- - <A href=HTML/SALOME_Component.html>Mapping of %SALOME_Component functions</A>
- - <B>%SALOME MED component</B>
- - <A href=HTML/MED.html>Mapping of %Med functions</A>
- - <B>%SALOME SUPERVISION module</B>
- - <A href=HTML/SUPERV.html>Mapping of %SUPERV functions</A>
- - <B>%SALOME %VISU module</B>
- - <A href=HTML/VISU_Gen.html>Mapping of %VISU_Gen functions</A>
-
-*/
-
-/*! \defgroup Study SALOME STUDY module
-*/
-
-/*!
- \file SALOMEDS.idl This file contains a set of interfaces used for creation, managment
- and modification of the %Study
-*/
-
-#ifndef _SALOMEDS_IDL_
-#define _SALOMEDS_IDL_
-
-#include "SALOME_Exception.idl"
-
-/*! \ingroup Study
- This package contains the interfaces used for creation, managment
- and modification of the %Study
-*/
-module SALOMEDS
-{
-/*! \typedef URL
- Name of the file in which the %Study is saved.
-
-*/
- typedef string URL;
-
-/*! Main identifier of an object in %SALOME application
-*/
- typedef string ID;
-
-/*! While saving the data, IOR is transformed into persistent reference
-*/
- typedef string PersistentReference;
-
-/*! IOR of the study in %SALOME application
-*/
- typedef string SalomeReference;
-/*! List of names of open studies in a %SALOME session
-*/
- typedef sequence<string> ListOfOpenStudies;
-/*! List of file names
-*/
- typedef sequence<string> ListOfFileNames;
-/*! List of modification dates of the study
-*/
- typedef sequence<string> ListOfDates ;
-/*! An unbounded sequence of strings
-*/
- typedef sequence<string> ListOfStrings ;
-/*! A byte stream which is used for binary data transfer between components
-*/
- typedef sequence<octet> TMPFile;
-
- // Reference to other objects is treated with function AddReference
- // and ReferencedObject
- // All other type of attributes defined in AttributeType enum are
- // treated with AddAdttribute and GetAttribute
- // The difference is made because Reference attribute don't contain
- // strings but reference to ID of other objects
-
- interface GenericAttribute;
- interface Study;
- interface StudyManager;
- interface StudyBuilder;
- interface SObject;
- interface SComponent;
- interface SComponentIterator;
- interface ChildIterator;
- interface Driver;
- interface AttributeStudyProperties;
- interface UseCaseIterator;
- interface UseCaseBuilder;
- interface Callback;
-/*! List of attributes
-*/
- typedef sequence<GenericAttribute> ListOfAttributes;
-/*! Exception indicating that this feature hasn't been implemented
-*/
- exception NotImplemented {};
-
-
- //===========================================================================
- /*! \brief %Study Interface
-
- The purpose of the %Study is to manage the data produced by various components of %SALOME platform.
- Most of the %Study operations are handled by the StudyManager and the StudyBuilder.
- What is left in the %Study interface are elementary inquiries.
- (Incidentally, we recall that a CORBA attribute is implemented as a pair of get
- and set methods.) A %Study is explored by a set of tools, mainly iterators
- , which are described further. Nevertheless, the %Study
- interface allows the search of an object by name or by ID.
- \note
- <BR><VAR>The Path </VAR>of an object in %SALOME application is much alike a standard path of a file.
- In general it's a string of names of directories divided by a slash '/'.
- <BR><VAR>The Context</VAR> is the current directory of an object.</P>
-*/
-
- interface Study
- {
- exception StudyInvalidContext {};
- exception StudyInvalidComponent {};
-/*! Invalid directory of the %study exception
-*/
- exception StudyInvalidDirectory {};
-/*! Exception pointing that this name of the study has already been used.
-*/
- exception StudyNameAlreadyUsed {};
- exception StudyObjectAlreadyExists {};
-/*! Invalid name of the %study exception
-*/
- exception StudyNameError {};
- exception StudyCommentError {};
-/*! \brief The name of the %Study
-
- This is equivalent to the methods setName() & getName()
-*/
- attribute string Name; // equivalent to setName() & getName()
-/*! \brief The ID of the %Study
-
- This is equivalent to the methods setID() & getID()
-*/
- attribute short StudyId;
-/*! Sequence containing %SObjects
-*/
- typedef sequence<SObject> ListOfSObject;
-/*!
- Gets a persistent reference to the %Study.
-*/
- PersistentReference GetPersistentReference();
-/*!
- Gets a transient reference to the %Study.
-*/
- SalomeReference GetTransientReference();
-
-/*!
- Returns True if the %Study is empty
-*/
- boolean IsEmpty();
-/*!
- Allows to find a %SComponent by its name.
- \param aComponentName It's a string value in the Comment Attribute of the Component,
- which is looked for, defining the data type of this Component.
-
-<BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-*/
- SComponent FindComponent (in string aComponentName);
-/*!
- Allows to find a %SComponent by ID of the according %SObject
-*/
- SComponent FindComponentID(in ID aComponentID);
-/*!
- Allows to find a %SObject by the Name Attribute of this %SObject
-<BR><VAR>See also <A href=exemple/Example19.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- SObject FindObject (in string anObjectName);
-/*!
- Allows to find a %SObject by its ID
-*/
- SObject FindObjectID (in ID aObjectID);
-/*!
- Allows to find a %SObject by IOR of the object belonging to this %SObject.
-*/
- SObject FindObjectIOR (in ID aObjectIOR);
-/*!
- Returns a list of %SObjects belonging to this %Component. The Name Attribute
- of these %SObjects should correspond to <VAR>anObjectName</VAR>.
-*/
- ListOfSObject FindObjectByName(in string anObjectName, in string aComponentName);
-/*!
- Allows to find a %SObject by the path to it.
-*/
- SObject FindObjectByPath(in string thePath);
-/*!
- Returns the path to the %SObject.
-*/
- string GetObjectPath(in Object theObject);
-
-/*!
- Sets the context of the %Study.
-<BR><VAR>See also <A href=exemple/Example23.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- void SetContext(in string thePath);
-/*!
- Gets the context of the %Study
-<BR><VAR>See also <A href=exemple/Example23.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- string GetContext();
-/*!
- Returns a list of names of objects corresponding to the context.
- \note If the parameter <VAR>theContext</VAR> is empty, then the current context will be used.
-*/
- ListOfStrings GetObjectNames(in string theContext);
-/*!
- Returns a list of names of directories and subdirectories corresponding to the context.
- \note If the parameter <VAR>theContext</VAR> is empty, then the current context will be used.
-*/
- ListOfStrings GetDirectoryNames(in string theContext);
-/*!
- Returns a list of names of Files corresponding to the context.
- \note If the parameter <VAR>theContext</VAR> is empty, then the current context will be used.
-*/
- ListOfStrings GetFileNames(in string theContext);
-/*!
- Returns a list of names of Components corresponding to the context.
- \note If the parameter <VAR>theContext</VAR> is empty, then the current context will be used.
-*/
- ListOfStrings GetComponentNames(in string theContext);
-/*! \brief Creation of a new iterator of child levels
-
- Creates a new iterator of child levels of the %SObject
-*/
- ChildIterator NewChildIterator(in SObject aSO);
-/*! \brief Creation of a new iterator of the %SComponent
-
- Creates a new iterator of the %SComponent.
-*/
- SComponentIterator NewComponentIterator();
-/*! \brief Creation of a %StudyBuilder
-
- Creates a new %StudyBuilder to add or modify an object in the study.
-<BR><VAR>See also <A href=exemple/Example20.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- StudyBuilder NewBuilder() ;
-/*! \brief Labels dependency
-
- Updates the map with IOR attribute. It's an inner method used for optimization.
-*/
- void UpdateIORLabelMap(in string anIOR, in string anEntry);
-
-/*! \brief Getting properties of the study
-
- Returns the attriubte, which contains the properties of this study.
-<BR><VAR>See also <A href=exemple/Example20.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- AttributeStudyProperties GetProperties();
-/*!
- Determines whether the %study has been saved
-*/
- attribute boolean IsSaved;
-/*!
- Returns True if the %study has been modified and not saved.
-*/
- boolean IsModified();
-/*!
- Determines the file where the %study has been saved
-*/
- attribute string URL;
-
-/*! \brief List of %SObjects
-
- Returns the list of %SObjects which refers to %anObject.
-*/
- ListOfSObject FindDependances(in SObject anObject);
-
-/*! \brief The date of the last saving of the study
-
- Returns the date of the last saving of study with format: "DD/MM/YYYY HH:MM"
-*/
- string GetLastModificationDate();
-/*! \brief The list of modification dates of the study
-
- Returns the list of modification dates (without creation date) with format "DD/MM/YYYY HH:MM".
- Note : the first modification begins the list.
-*/
- ListOfDates GetModificationsDate();
-/*! \brief Object conversion.
-
- Converts an object into IOR.
- \return IOR
-*/
- string ConvertObjectToIOR(in Object theObject);
-/*! \brief Object conversion.
-
- Converts IOR into an object.
- \return An object
-*/
- Object ConvertIORToObject(in string theIOR);
-/*!
- Gets a new %UseCaseBuilder.
-*/
- UseCaseBuilder GetUseCaseBuilder();
-
-/*!
- Closes the components in the study, removes itself from the %StudyManager.
-*/
- void Close();
-
-/*!
- Enables(if isEnabled = True)/disables automatic addition of new %SObjects to the use case.
-*/
- void EnableUseCaseAutoFilling(in boolean isEnabled);
- };
-
- //==========================================================================
-/*! \brief %Study Builder Interface
-
- The purpose of the Builder is to add and/or remove objects and attributes.
- A %StudyBuilder is linked to a %Study. A
- command management is provided for the undo/redo functionalities.
- \note
- <BR><VAR>The Tag</VAR> of an item in %SALOME application is a symbolic description of
- item's position in the tree-type structure of the browser. In general it has the following
- form: <TT>0:2:1:1</TT>
-*/
- //==========================================================================
-
- interface StudyBuilder
- {
-/*! \brief %LockProtection Exception
-
- This exception is raised while attempting to modify a locked %study.
-*/
- exception LockProtection {};
-/*! \brief Creation of a new %SComponent.
-
- Creates a new %SComponent
- \param ComponentDataType Data type of the %SComponent which will be created.
-
-<BR><VAR>See also <A href=exemple/Example17.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- SComponent NewComponent(in string ComponentDataType);
-/*! \brief Definition of the instance to the %SComponent
-
- Defines the instance to the %SComponent.
-*/
- void DefineComponentInstance (in SComponent aComponent,in Object ComponentIOR);
-/*! \brief Deletion of the %SComponent
-
- Removes the %SComponent.
-*/
- void RemoveComponent(in SComponent aComponent);
-
-/*! \brief Creation of a new %SObject
-
- Creates a new %SObject.
-<BR><VAR>See also <A href=exemple/Example18.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- SObject NewObject (in SObject theFatherObject);
-/*! \brief Creation of a new %SObject with a definite %tag
-
- Creates a new %SObject with a definite %tag.
-*/
- SObject NewObjectToTag (in SObject theFatherObject, in long atag);
-/*! \brief Deletion of the %SObject
-
- Removes a %SObject from the %StudyBuilder.
-*/
- void RemoveObject (in SObject anObject);
-/*! \brief Deletion of the %SObject with all his child objects.
-
- Removes the %SObject with all his child objects.
-*/
- void RemoveObjectWithChildren(in SObject anObject);
-
-/*!
- Loads a %SComponent.
-<BR><VAR>See also <A href=exemple/Example19.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- void LoadWith (in SComponent sco, in Driver Engine) raises (SALOME::SALOME_Exception);
-/*!
- Loads a %SObject.
-*/
- void Load (in SObject sco);
-
-/*! \brief Looking for or creating an attribute assigned to the %SObject
-
- Allows to find or create an attribute of a specific type which is assigned to the object.
- \param anObject The %SObject corresponding to the attribute which is looked for.
- \param aTypeOfAttribute Type of the attribute.
-
- <BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-*/
-
- GenericAttribute FindOrCreateAttribute(in SObject anObject,
- in string aTypeOfAttribute);
-
-/*! \brief Looking for an attribute assigned to %SObject
-
- Allows to find an attribute of a specific type which is assigned to the object.
- \param anObject The %SObject corresponding to the attribute which is looked for.
- \param aTypeOfAttribute Type of the attribute.
- \param anAttribute Where the attribute is placed if it's found.
- \return True if it finds an attribute.
- */
-
- boolean FindAttribute(in SObject anObject,
- out GenericAttribute anAttribute,
- in string aTypeOfAttribute);
-/*! \brief Deleting the attribute assigned to the %SObject
-
- Removes the attribute of a specific type which is assigned to the object.
- \param anObject The %SObject corresponding to the attribute.
- \param aTypeOfAttribute Type of the attribute.
-
-<BR><VAR>See also <A href=exemple/Example17.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-*/
- void RemoveAttribute(in SObject anObject,
- in string aTypeOfAttribute);
-/*! \brief Addition of a reference
-
- Adds a reference between %anObject and %theReferencedObject.
-*/
-
- void Addreference(in SObject anObject,
- in SObject theReferencedObject) ;
-/*!
- Adds a directory in the %Study.
-<BR><VAR>See also <A href=exemple/Example23.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- void AddDirectory(in string theName);
-
-/*! \brief Identification of the %SObject's substructure.
-
- Identification of the %SObject's substructure by GUID.
- It has the following format "00000000-0000-0000-0000-000000000000"
-*/
-
- void SetGUID(in SObject anObject, in string theGUID);
-/*!
-
- Returns True if the %SObject has GUID.
-*/
- boolean IsGUID(in SObject anObject, in string theGUID);
-
-/*! \brief Creation of a new command
-
- Creates a new command which can contain several different actions.
-<BR><VAR>See also <A href=exemple/Example3.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- void NewCommand(); // command management
-/*! \brief Execution of the command
-
- Commits all actions declared within this command.
-<BR><VAR>See also <A href=exemple/Example16.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- void CommitCommand() raises(LockProtection); // command management
-/*!
- Returns True if at this moment there is a command under execution.
-*/
- boolean HasOpenCommand();
-/*! \brief Cancelation of the command
-
- Cancels all actions declared within the command.
-<BR><VAR>See also <A href=exemple/Example17.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-*/
- void AbortCommand(); // command management
-/*! \brief Undolimit
-
- The number of actions which can be undone
-*/
- attribute long UndoLimit;
-/*! \brief Undo method
-
- Cancels all actions of the last command.
-<BR><VAR>See also <A href=exemple/Example16.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- void Undo() raises (LockProtection);
-/*! \brief Redo method
-
- Redoes all actions of the last command.
- <BR><VAR>See also <A href=exemple/Example16.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- void Redo() raises (LockProtection);
-/*!
- Returns True if at this moment there are any actions which can be canceled.
- <BR><VAR>See also <A href=exemple/Example16.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- boolean GetAvailableUndos();
-/*!
- Returns True if at this moment there are any actions which can be redone.
- <BR><VAR>See also <A href=exemple/Example3.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- boolean GetAvailableRedos();
-/*!
- Sets the callback for addition of the given %SObject. Returns the previous callback.
-*/
- Callback SetOnAddSObject(in Callback theCallback);
-/*!
- Sets the callback for removal of the given %SObject. Returns the previous callback.
-*/
- Callback SetOnRemoveSObject(in Callback theCallback);
-
- };
-
- //==========================================================================
-/*! \brief %Study Manager interface
-
- The purpose of the Manager is to manipulate the %Studies. You will find in this
- interface the methods to create, open,
- close, and save a %Study. Since a %SALOME session is multi-document, you will
- also find the methods allowing to navigate
- through the collection of studies present in a session.
-*/
- //==========================================================================
-
- interface StudyManager
- {
-/*!
- Determines whether the server has already been loaded or not.
-*/
- void ping();
-
-/*! \brief Creation of a new %Study
-
- Creates a new %Study with a definite name.
-<BR><VAR>See also <A href=exemple/Example17.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- Study NewStudy(in string study_name);
-
-/*! \brief Open a study
-
- Reads and activates the structure of the study %Objects.
- \warning This method doesn't activate the corba objects. Only a component can do it.
-<BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-*/
- Study Open (in URL aStudyUrl) raises (SALOME::SALOME_Exception);
-
-/*! \brief Closing the study
-
- Closes the study.
-*/
- void Close(in Study aStudy);
-/*! \brief Saving the study
-
- Saves the study.
-<BR><VAR>See also <A href=exemple/Example19.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- void Save(in Study aStudy, in boolean theMultiFile);
-
- void SaveASCII(in Study aStudy, in boolean theMultiFile);
-/*! \brief Saving the study in a file
-
- Saves the study in a specified file.
- <BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-*/
- void SaveAs(in URL aUrl, // if the file already exists
- in Study aStudy,
- in boolean theMultiFile); // overwrite (as option)
-
- void SaveAsASCII(in URL aUrl, // if the file already exists
- in Study aStudy,
- in boolean theMultiFile); // overwrite (as option)
-
-
-/*! \brief List of open studies.
-
- Returns the list of open studies in the current session.
-*/
- ListOfOpenStudies GetOpenStudies();
-
-/*! \brief Getting a particular %Study picked by name
-
- Activates a particular %Study
- amongst the session collection picking it by name.
-*/
- Study GetStudyByName (in string aStudyName);
-
-/*! \brief Getting a particular %Study picked by ID
-
- Activates a particular %Study
- amongst the session collection picking it by ID.
-*/
- Study GetStudyByID (in short aStudyID);
-
- // copy/paste methods
-
-/*!
- Returns True, if the given %SObject can be copied to the clipboard.
-*/
- boolean CanCopy(in SObject theObject);
-/*!
- Returns True, if the given %SObject is copied to the clipboard.
-*/
- boolean Copy(in SObject theObject);
-/*!
- Returns True, if the object from the clipboard can be pasted to the given %SObject.
-*/
- boolean CanPaste(in SObject theObject);
-/*!
- Returns the %SObject in which the object from the clipboard was pasted to.
-*/
- SObject Paste(in SObject theObject) raises (SALOMEDS::StudyBuilder::LockProtection);
- };
-
-
- //==========================================================================
-/*! \brief %SObject interface
-
- The objects in the %study are built by the %StudyBuilder. The %SObject interface
- provides methods for elementary inquiries, like getting an object %ID or its attribuites.
- \note
- <BR><VAR>Tag</VAR> of an item in %SALOME application is an integer value uniquely defining an item
- in the tree-type data structure.
- <BR><VAR>ID</VAR> of an item is a description of item's position in the tree-type data structure.
- ID is a list of tags and it has the following form: <TT>0:2:1:1</TT>.
-*/
- //==========================================================================
-
- interface SObject
- {
-/*! Name of the %SObject
-*/
- attribute string Name; // equivalent to setName() & getName()
-/*! \brief Getting an object %ID
-
- Returns ID of the %SObject.
-*/
- ID GetID();
-/*! \brief Acquisition of the father %Component of the %SObject
-
- Returns the father %Component of the %SObject.
-*/
- SComponent GetFatherComponent();
-/*! \brief Acquisition of the father %SObject of the %SObject
-
- Returns the father %SObject of the given %SObject.
-*/
- SObject GetFather();
-/*! \brief %Tag of %SObject
-
- Returns the %tag of the %SObject.
-*/
- short Tag();
-/*! \brief Looking for subobjects of an object.
-
- Returns True if it finds a subobject of the %SObject with a definite tag.
-*/
-
- boolean FindSubObject (in long atag, out SObject obj);
-/*! \brief Looking for attributes of the %SObject
-
- Returns True if it finds an attribute of a definite type of the %SObject.
-<BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-*/
- boolean FindAttribute(out GenericAttribute anAttribute,
- in string aTypeOfAttribute);
-/*!
- Returns the object which this %SObject refers to. It also returns True if it finds
- this object.
-*/
- boolean ReferencedObject(out SObject obj); // A REVOIR
-/*! \brief Getting all attributes of the %SObject
-
- Returns the list of all attributes of the %SObject.
-<BR><VAR>See also <A href=exemple/Example17.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- ListOfAttributes GetAllAttributes();
-/*! \brief Returning the study
-
- Returns the study containing the given %SObject.
-*/
- Study GetStudy();
- };
-
-
- //==========================================================================
-/*! \brief %Generic attribute interface
-
- %Generic attribute is a base interface for all attributes which inherit
- its methods.
-*/
- //==========================================================================
- interface GenericAttribute
- {
-/*! \brief Exception locking all changes
-
- This exception locks all modifications in attributes.
-*/
- exception LockProtection {};
-/*! \brief Method CheckLocked
-
- Checks whether the %Study is protected for modifications.
- \note <BR>This exception is raised only outside the transaction.
-*/
- void CheckLocked() raises (LockProtection);
- };
-
-
-
- //==========================================================================
-/*! \brief %SComponent interface
-
- The %SComponent interface is a specialization of the %SObject interface.
- It inherits the most of its methods from the %SObject interface.
-*/
- //==========================================================================
- interface SComponent : SObject
- {
-/*! \brief Data type of the %SComponent
-
- Returns the data type of the %SComponent.
-*/
- string ComponentDataType();
-/*!
- Returns IOR of the according component.
-*/
- boolean ComponentIOR (out ID theID); //returns True if there is an instance
- //In this case ID identifies this one
- };
-
-
- //==========================================================================
-/*! \brief %SComponentIterator interface
-
- This interface contains the methods allowing to iterate over all components in the list.
- The search is started from the first %SComponent in the list.
-*/
- //==========================================================================
- interface SComponentIterator
- {
-/*! \brief Initialization of the Iterator
-
-Activates the %SComponentIterator.
-*/
- void Init();
-/*! \brief Method More
-
- Returns True if there is one more %SComponent in the list.
-*/
- boolean More();
-/*! \brief Moving the iterator to the next %SComponent
-
-Moves the iterator to the next %SComponent in the list.
-*/
- void Next();
-/*!
- Returns the %SComponent corresponding to the current %SComponent found by the iterator.
- <BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- SComponent Value();
- };
-
- //==========================================================================
-/*! \brief %ChildIterator interface
-
- This interface contains methods which allow to iterate over all child
- levels.
-*/
- //==========================================================================
- interface ChildIterator
- {
-/*! \brief Initialization of the Iterator.
-
-Activates the %ChildIterator.
-*/
- void Init();
-/*! \brief Initialization of the Iterator for all child levels.
-
-Activates the %ChildIterator (if True) for all child levels.
-*/
- void InitEx(in boolean allLevels);
-/*! \brief Method More
-
- Returns True if the %ChildIterator finds one more child level.
-*/
- boolean More();
-/*!
- Passes the iterator to the next level.
-*/
- void Next();
-/*!
- Returns the %SObject corresponding to the current object found by the iterator.
-*/
- SObject Value();
- };
-
- //==========================================================================
- //==========================================================================
-/*! \brief Interface of the %UseCaseIterator.
-
- This interface contains a set of methods used for iteration over the objects in the use case.
-*/
- interface UseCaseIterator
- {
-/*! \brief Initialization of the Iterator.
-
-Activates the %UseCaseIterator. If <VAR>allLevels</VAR> is True the Iterator is activated for all subobjects.
-*/
- void Init(in boolean allLevels);
-/*! \brief Method More
-
- Returns True if the %UseCaseIterator finds one more object.
-*/
- boolean More();
-/*!
- Passes the iterator to the next object.
-*/
- void Next();
-/*!
- Returns the %SObject corresponding to the current object found by the Iterator.
-*/
- SObject Value();
- };
-
- //==========================================================================
- //==========================================================================
-/*! \brief Interface of the %UseCaseBuilder
-
- Use case in the study represents a user-managed subtree, containing all or some of the objects which exist in the study.
- The %UseCaseBuilder interface contains a set of methods used for management of the use case in the study.
-*/
- interface UseCaseBuilder
- {
-/*!
- Adds to the use case an object <VAR>theObject</VAR> as a child of the current object of the use case.
-*/
- boolean Append(in SObject theObject);
-/*!
- Removes an object <VAR>theObject</VAR> from the use case.
-*/
- boolean Remove(in SObject theObject);
-/*!
- Adds a child object <VAR>theObject</VAR> to the given father <VAR>theFather</VAR> object in the use case.
-*/
- boolean AppendTo(in SObject theFather, in SObject theObject);
-/*!
- Inserts in the use case the object <VAR>theFirst</VAR> before the object <VAR>theNext</VAR>.
-*/
- boolean InsertBefore(in SObject theFirst, in SObject theNext);
-/*!
- Sets the current object of the use case.
-*/
- boolean SetCurrentObject(in SObject theObject);
-/*!
- Makes the root object to be the current object of the use case.
-*/
- boolean SetRootCurrent();
-/*!
- Returns True if the given object <VAR>theObject</VAR> of the use case has child objects.
-*/
- boolean HasChildren(in SObject theObject);
-/*!
- Sets the name of the use case.
-*/
- boolean SetName(in string theName);
-/*!
- Gets the name of the use case.
-*/
- string GetName();
-/*!
- Returns True if the given object <VAR>theObject</VAR> represents a use case.
-*/
- boolean IsUseCase(in SObject theObject);
-/*!
- Gets the current object of the use case.
-*/
- SObject GetCurrentObject();
-/*!
- Creates a new use case in the use case browser.
-*/
- SObject AddUseCase(in string theName);
-/*!
- Returns the %UseCaseIterator for the given object <VAR>theObject</VAR> in the use case.
-*/
- UseCaseIterator GetUseCaseIterator(in SObject theObject);
- };
- //==========================================================================
- //==========================================================================
-/*! \brief The callback interface
-
- The %StudyBuilder can be created with the method <VAR>NewBuilder</VAR>. While invocation of this method a new object of the class <VAR>Callback</VAR> is created
- and this object is assigned to the newly created Builder as callback which should be called when adding and removing of the ojects.
-*/
- interface Callback
- {
-/*!
- Invokes the corresponding method <VAR>Append</VAR> of the %UseCaseBuilder.
-*/
- void OnAddSObject(in SObject theObject);
-/*!
- Invokes the corresponding method <VAR>Remove</VAR> of the %UseCaseBuilder.
-*/
- void OnRemoveSObject(in SObject theObject);
- };
-
- //==========================================================================
-/*! \brief %Driver interface
-
- This interface contains a set of methods used for the management
- of the object produced in the %study by a component.
-*/
- //==========================================================================
- interface Driver
- {
-
- /*! \brief Saving the data.
-
- This method is called by the StudyManager when saving a study.
- \param theComponent %SComponent corresponding to this Component
- \return A byte stream TMPFile that contains all saved data
-
-<BR><VAR>See also <A href=exemple/Example19.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
- */
-
-
- TMPFile Save(in SComponent theComponent, in string theURL, in boolean isMultiFile);
-
- TMPFile SaveASCII(in SComponent theComponent, in string theURL, in boolean isMultiFile);
-
- /*! \brief Loading the data.
-
- This method is called by the StudyManager when opening a study.
- \param theComponent %SComponent corresponding to this Component
- \param theStream The file which contains all data saved by the component on Save method
- */
-
- boolean Load(in SComponent theComponent, in TMPFile theStream, in string theURL, in boolean isMultiFile);
-
- boolean LoadASCII(in SComponent theComponent, in TMPFile theStream, in string theURL, in boolean isMultiFile);
-
- /*! \brief Closing of the study
-
- This method Close is called by the StudyManager when closing a study.
-
- */
-
- void Close (in SComponent aSComponent);
- //void Close ( in string aIORSComponent);
-
- /*! \brief The type of the data
-
- Returns the type of data produced by the Component in the study.
- */
-
- string ComponentDataType();
-
- // Driver Transient -> persistent called for each object in study
-/*!
- Transforms IOR into PersistentID of the object. It is called for each
- object in the %study.
-*/
- string IORToLocalPersistentID (in SObject theSObject,
- in string IORString,
- in boolean isMultiFile,
- in boolean isASCII);
-/*!
- Transforms PersistentID into IOR of the object. It is called for each
- object in the %study.
-*/
- string LocalPersistentIDToIOR (in SObject theSObject,
- in string aLocalPersistentID,
- in boolean isMultiFile,
- in boolean isASCII)
- raises (SALOME::SALOME_Exception);
-
- // Publishing in the study
-/*! \brief Publishing in the study
-
- Returns True if the given %Component can publish the %object in the %study.
-*/
- boolean CanPublishInStudy(in Object theIOR) raises (SALOME::SALOME_Exception);
-/*! \brief Publishing in the study
-
- Publishes the given object in the %study, using the algorithm of this component.
- \param theStudy The %study in which the object is published
- \param theSObject If this parameter is null the object is published for the first time. Otherwise
- this parameter should contain a reference to the object published earlier
- \param theObject The object which is published
- \param theName The name of the published object. If this parameter is empty, the name is generated
- automatically by the component.
-*/
- SObject PublishInStudy(in Study theStudy, in SObject theSObject, in Object theObject, in string theName);
-
- // copy/paste methods
-
-/*!
- Returns True, if the given %SObject can be copied to the clipboard.
-*/
- boolean CanCopy(in SObject theObject);
-/*!
- Returns the object %ID and the %TMPFile of the object from the given %SObject.
-*/
- TMPFile CopyFrom(in SObject theObject, out long theObjectID);
-/*!
- Returns True, if the component can paste the object with given %ID of the component with name <VAR>theComponentName</VAR>.
-*/
- boolean CanPaste(in string theComponentName, in long theObjectID);
-/*!
- Returns the %SObject of the pasted object.
-*/
- SObject PasteInto(in TMPFile theStream, in long theObjectID, in SObject theObject);
-
- };
-};
-
-#endif
+++ /dev/null
-// 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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
-//
-//
-//
-// File : SALOMEDS.idl
-// Author : Yves FRICAUD
-// $Header$
-
-/*! \file SALOMEDS_Attributes.idl This file contains a set of interfaces
- for the attributes which can be assigned to %SObject
-*/
-#ifndef _SALOMEDS_AttributesIDL_
-#define _SALOMEDS_AttributesIDL_
-
-#include "SALOMEDS.idl"
-
-module SALOMEDS
-{
-/*! Sequence of double values
-*/
- typedef sequence <double> DoubleSeq;
-/*! Sequence of long values
-*/
- typedef sequence <long> LongSeq;
-/*! Sequence of string values
-*/
- typedef sequence <string> StringSeq;
-/*! \struct Color
- This structure stores a set of elements defining the color based on RGB.
-*/
- struct Color {
-/*! Red color
-*/
- double R;
-/*! Green color
-*/
- double G;
-/*! Blue color
-*/
- double B;
- };
- //==========================================================================
-/*! \brief Attribute allowing to store a real value
-
- Attribute allowing to store a real value
-*/
- //==========================================================================
- interface AttributeReal : GenericAttribute
- {
-/*!
- Returns the value of this attribute.
-<BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-*/
- double Value();
-/*!
- Sets the value of this attribute.
-<BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-*/
- void SetValue(in double value);
- };
- //==========================================================================
-/*! \brief Attribute allowing to store an integer value
-
- Attribute allowing to store an integer value
-*/
- //==========================================================================
- interface AttributeInteger : GenericAttribute
- {
-/*!
- Returns the value of this attribute
-<BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-*/
- long Value();
-/*!
- Sets the value of this attribute
-<BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-*/
- void SetValue(in long value);
- };
- //==========================================================================
-/*! \brief Attribute - sequence of real values
-
- Attribute - sequence of real values, indexing from 1 (like in CASCADE).
-*/
- //==========================================================================
- interface AttributeSequenceOfReal : GenericAttribute
- {
-/*!
- Initialization of the attribute with initial data.
- \param other Initially assigned sequence of real numbers.
-*/
- void Assign (in DoubleSeq other);
-/*!
- Returns the sequence of real numbers stored in the attribute.
-*/
- DoubleSeq CorbaSequence();
-/*!
- Adds to the end of the sequence a real number.
- \param value A real number added to the sequence.
-
-<BR><VAR>See also <A href=exemple/Example3.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-*/
- void Add (in double value);
-/*!
- Removes a real number with a definite index
- from the sequence of real numbers stored in the Attribute.
-*/
- void Remove(in long index);
-/*!
- Substitutes a real number with a definite index for another real number.
-<BR><VAR>See also <A href=exemple/Example3.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- void ChangeValue(in long index, in double value);
-/*!
- Returns a real number with a definite index
- in the sequence of real numbers stored in the Attribute.
-<BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-*/
- double Value(in short index);
-/*!
- Returns the length of the sequence of real numbers stored in the Attribute.
-<BR><VAR>See also <A href=exemple/Example3.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- long Length();
- };
- //==========================================================================
-/*! \brief Attribute - sequence of integer
-
- Attribute - sequence of integer, indexing from 1 (like in CASCADE)
-*/
- //==========================================================================
- interface AttributeSequenceOfInteger : GenericAttribute
- {
-/*!
- Initialization of the attribute with initial data.
- \param other Initially assigned sequence of integer numbers.
-*/
- void Assign (in LongSeq other);
-/*!
- Returns the sequence of integer numbers stored in the Attribute.
-*/
- LongSeq CorbaSequence();
-/*!
- Adds to the end of the sequence an integer number.
- \param value An integer number added to the sequence.
-
-<BR><VAR>See also <A href=exemple/Example3.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- void Add (in long value);
-/*!
- Removes an integer number with a definite index
- from the sequence of integer numbers stored in the Attribute.
-<BR><VAR>See also <A href=exemple/Example3.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- void Remove(in long index);
-/*!
- Substitutes an integer number with a definite index for another integer number.
-*/
- void ChangeValue(in long index, in long value);
-/*!
- Returns an integer number with a definite index
- in the sequence of integer numbers stored in the Attribute.
-<BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-*/
- long Value(in short index);
-/*!
- Returns the length of the sequence of integer numbers stored in the Attribute.
-<BR><VAR>See also <A href=exemple/Example3.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- long Length();
- };
-
- //==========================================================================
-/*! \brief Name attribute
-
- This attribute stores a string value, which corresponds to the name of the %SObject
- or to the name of corresponding object.
-*/
- //==========================================================================
-
- interface AttributeName : GenericAttribute
- {
-/*!
- Returns the value of this attribute
-<BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-*/
- string Value();
-/*!
- Sets the value of this attribute
-<BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-*/
- void SetValue(in string value);
- };
-
- //==========================================================================
-/*! \brief Comment attribute
-
- This attribute stores a string value containing supplementary information about
- the %SObject. In particular it contains the data type of the %SComponent.
-*/
- //==========================================================================
- interface AttributeComment : GenericAttribute
- {
-/*!
- Returns the value of this attribute
-<BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-*/
- string Value();
-/*!
- Sets the value of this attribute
-<BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-*/
- void SetValue(in string value);
- };
- //==========================================================================
-/*! \brief IOR attribute
-
- This attribute stores a string value identifying a runtime object.In particular
- it contains CORBA Interoperable Object Reference.
-*/
- //==========================================================================
- interface AttributeIOR : GenericAttribute
- {
-/*!
- Returns the value of this attribute
-<BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-*/
- string Value();
-/*!
- Sets the value of this attribute
-<BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-*/
- void SetValue(in string value);
- };
-
- //==========================================================================
-/*! \brief Persistent reference attribute
-
- This attribute stores a persistent identifier of the object.
-*/
- //==========================================================================
- interface AttributePersistentRef : GenericAttribute
- {
-/*!
- Returns the value of this attribute
-<BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-*/
- string Value();
-/*!
- Sets the value of this attribute
-<BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-*/
- void SetValue(in string value);
- };
-
- //==========================================================================
- //Below the list of presentation attributes for display study tree in browser
- //==========================================================================
-
-
- //==========================================================================
-/*! \brief Drawable flag Attribute.
-
- This is a presentation attribute necessary for display of the study tree in the browser.
- The item associated to SObject is created/displayed if TRUE.
-*/
- //==========================================================================
- interface AttributeDrawable : GenericAttribute
- {
-/*!
- Returns TRUE if the item is drawable (as it is by default) and FALSE if it isn't.
-<BR><VAR>See also <A href=exemple/Example8.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- boolean IsDrawable();
-/*!
-Sets the items to be drawable if <VAR>value</VAR> is TRUE (the default) or not to be selectable if <VAR>value</VAR>is FALSE.
-<BR><VAR>See also <A href=exemple/Example8.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- void SetDrawable(in boolean value);
- };
-
- //==========================================================================
-/*! \brief Selectable flag Attribute.
-
- This is a presentation attribute necessary for display of the study tree in the browser.
- The item is selectable by %SALOME selection mechanism if TRUE.
-*/
- //==========================================================================
- interface AttributeSelectable : GenericAttribute
- {
-/*!
- Returns TRUE if the item is selectable (as it is by default) and FALSE if it isn't.
-<BR><VAR>See also <A href=exemple/Example9.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- boolean IsSelectable();
-/*!
-Sets the items to be selectable if <VAR>value</VAR> is TRUE (the default) or not to be selectable if <VAR>value</VAR>is FALSE.
-<BR><VAR>See also <A href=exemple/Example9.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- void SetSelectable(in boolean value);
- };
-
- //==========================================================================
-/*! \brief Expandable flag Attribute.
-
- This is a presentation attribute necessary for display of the study tree in the browser.
- It sets this item to be expandable even if it has no children if value is TRUE. If value is FALSE
- expandable only if it has children.
-*/
- //==========================================================================
- interface AttributeExpandable : GenericAttribute
- {
-/*!
- Returns TRUE if this item is expandable even when it has no children.
-<BR><VAR>See also <A href=exemple/Example10.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- boolean IsExpandable();
-/*!
- Sets this item to be expandable even if it has no children if <VAR>value</VAR> is TRUE, and to be
- expandable only if it has children if <VAR>value</VAR> is FALSE (the default).
-<BR><VAR>See also <A href=exemple/Example10.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- void SetExpandable(in boolean value);
- };
-
- //==========================================================================
-/*! \brief Opened flag Attribute.
-
- This is a presentation attribute necessary for display of the study tree in the browser.
- It sets this item to be open (its children are visible) if bool is TRUE, and to be closed (its children
- are not visible) if bool is FALSE.
-*/
- //==========================================================================
- interface AttributeOpened : GenericAttribute
- {
-/*!
- Returns TRUE if this item is open (its children are visible) and FALSE if it isn't.
-<BR><VAR>See also <A href=exemple/Example11.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- boolean IsOpened();
-/*!
- Sets this item to be open (its children are visible) if <VAR>value</VAR> is TRUE, and to be closed
-(its children are not visible) if <VAR>value</VAR> is FALSE.
-<BR><VAR>See also <A href=exemple/Example11.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- void SetOpened(in boolean value);
- };
- //==========================================================================
-/*! \brief TextColorAttribute.
-
- This attribute sets the color of an item.
-*/
- //==========================================================================
- interface AttributeTextColor : GenericAttribute
- {
-/*!
- Returns the color of an item.
-<BR><VAR>See also <A href=exemple/Example12.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- Color TextColor();
-/*!
- Sets the color of an item.
-<BR><VAR>See also <A href=exemple/Example12.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- void SetTextColor(in Color value);
- };
-
- //==========================================================================
- /*! \brief TextHighlightColorAttribute.
-
- This attribute sets the highlight color of an item.
-*/
- //==========================================================================
- interface AttributeTextHighlightColor : GenericAttribute
- {
-/*!
- Returns the highlight color of an item.
-<BR><VAR>See also <A href=exemple/Example13.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- Color TextHighlightColor();
-/*!
- Sets the highlight color of an item.
-<BR><VAR>See also <A href=exemple/Example13.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- void SetTextHighlightColor(in Color value);
- };
- //==========================================================================
-/*! \brief PixMapAttribute.
-
- This attribute stores an icon which is put before the name of an item.
-*/
- //==========================================================================
- interface AttributePixMap : GenericAttribute
- {
-/*!
- Returns True if there is an icon before the name of the item.
-*/
- boolean HasPixMap();
-/*!
- Returns the name of the icon.
-<BR><VAR>See also <A href=exemple/Example14.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- string GetPixMap();
-/*!
- Sets the name of the icon.
-<BR><VAR>See also <A href=exemple/Example14.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- void SetPixMap(in string value);
- };
-
- //==========================================================================
-/*! \brief TreeNodeAttribute.
-
- A set of these attributes on the %SObjects of the %study forms an inner auxiliary
- tree whith its own structure and identifier. The quantity of such trees with different
- identifiers can be arbitrary.
-<BR><VAR>See also <A href=exemple/Example18.html> an example </A> of usage of the methods of this interface in batchmode of %SALOME application.</VAR>
-
-*/
- //==========================================================================
- interface AttributeTreeNode : GenericAttribute
- {
-/*!
- Sets the father TreeNode to this TreeNode.
-*/
- void SetFather(in AttributeTreeNode value);
-/*!
- Returns True if there is the father TreeNode of this TreeNode.
-*/
- boolean HasFather();
-/*!
- Returns the father Treenode of this TreeNode.
-*/
- AttributeTreeNode GetFather();
-/*!
- Sets the previous brother TreeNode to this treeNode.
-*/
- void SetPrevious(in AttributeTreeNode value);
-/*!
- Returns True if there is the previous brother TreeNode of this TreeNode.
-*/
- boolean HasPrevious();
-/*!
- Returns the previous brother TreeNode of this TreeNode.
-*/
- AttributeTreeNode GetPrevious();
-/*!
- Sets the next brother TreeNode to this treeNode.
-*/
- void SetNext(in AttributeTreeNode value);
-/*!
- Returns True if there is the next brother TreeNode of this TreeNode.
-*/
- boolean HasNext();
-/*!
- Returns the previous brother TreeNode of this TreeNode.
-*/
- AttributeTreeNode GetNext();
-/*!
- Sets the first child TreeNode to this treeNode.
-*/
- void SetFirst(in AttributeTreeNode value);
-/*!
- Returns True if there is the first child TreeNode of this TreeNode.
-*/
- boolean HasFirst();
-/*!
- Returns the first child TreeNode of this TreeNode.
-*/
- AttributeTreeNode GetFirst();
-/*!
- Sets ID of the tree. TreeNodes of one tree have the same ID.
-*/
- void SetTreeID(in string value);
-/*!
- Gets ID of the tree.
-*/
- string GetTreeID();
-
-/*!
- Adds a child TreeNode to the end of the list of children of this Treenode.
-*/
- void Append(in AttributeTreeNode value);
-/*!
- Adds a child TreeNode to the beginning of the list of children of this Treenode.
-
-*/
- void Prepend(in AttributeTreeNode value);
-/*!
- Adds a brother TreeNode before this Treenode.
- In this case the both TreeNodes will belong to the same father.
-*/
- void InsertBefore(in AttributeTreeNode value);
-/*!
- Adds a brother TreeNode after this Treenode.
- In this case the both TreeNodes will belong to the same father.
-*/
- void InsertAfter(in AttributeTreeNode value);
-/*!
- Deletes a TreeNode.
-<BR><VAR>See also <A href=exemple/Example3.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- void Remove();
-
-/*!
- Returns the depth of the TreeNode in the
- structure, it means the number of fathers of the given TreeNode.
- (i.e.: the depth of the root TreeNode is 0).
-*/
- long Depth();
-/*!
- Returns True if it is a root TreeNode.
-*/
- boolean IsRoot();
-/*!
- Returns True if this TreeNode is a descendant of the TreeNode.
-*/
- boolean IsDescendant(in AttributeTreeNode value);
-/*!
- Returns True if this TreeNode is the father of the TreeNode.
-*/
- boolean IsFather(in AttributeTreeNode value);
-/*!
- Returns True if this TreeNode is a child of the TreeNode.
-*/
- boolean IsChild(in AttributeTreeNode value);
-/*!
- Returns ID of the according %SObject.
-*/
- string Label();
- };
- //==========================================================================
-/*! \brief LocalID attribute
-
- Attribute describing the link between a %SObject and a local object in the component.
-*/
- //==========================================================================
- interface AttributeLocalID : GenericAttribute
- {
-/*!
- Returns the value of this attribute.
-<BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-*/
- long Value();
-/*!
- Sets the value of this attribute.
-<BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-*/
- void SetValue(in long value);
- };
-
- //==========================================================================
-/*! \brief Attribute storing GUID
-
- Attribute allowing to store GUID
-*/
- //==========================================================================
- interface AttributeUserID : GenericAttribute
- {
-/*!
- Returns the value of this attribute
-<BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-*/
- string Value();
-/*!
- Sets the value of this attribute
-<BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-*/
- void SetValue(in string value);
- };
-
- //==========================================================================
-/*! \brief %AttributeTarget iterface
-
- This attribute stores the list of all %SObjects that refer
- to this %SObject. This attribute is used for inner purposes of the application.
- It is also needed for optimization.
-*/
- //==========================================================================
-
- interface AttributeTarget : GenericAttribute
- {
-/*!
- Adds a %SObject to the list of %SObjects which refer to this %SObject.
-
-<BR><VAR>See also <A href=exemple/Example3.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- void Add(in SObject anObject);
-/*!
- Returns the list of %SObjects which refer to this %SObject.
-*/
- SALOMEDS::Study::ListOfSObject Get();
-/*!
- Deletes a %SObject from the list of %SObjects which refer to this %SObject.
-
-<BR><VAR>See also <A href=exemple/Example3.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
-*/
- void Remove(in SObject anObject);
- };
- //==========================================================================
- /*! \brief %AttributeTableOfInteger interface
-
- This attribute allows to store a table of integers (indexing from 1 like in CASCADE)
- and string titles of this table, of each row, of each column.
-<BR><VAR>See also <A href=exemple/Example21.html> an example </A> of usage of these methods in batchmode of %SALOME application.</VAR>
-
-*/
- //==========================================================================
-
- interface AttributeTableOfInteger : GenericAttribute
- {
-/*!
- This exception is raised when an incorrect index is passed as parameter.
-*/
- exception IncorrectIndex {};
-/*!
- This exception is raised when an incorrect length of the argument is passed as parameter.
-*/
- exception IncorrectArgumentLength {};
-
- // titles: for table, for each row, for each column
-/*!
- Sets the title of the table.
-*/
- void SetTitle(in string theTitle);
-/*!
- Returns the title of the table.
-*/
- string GetTitle();
-/*!
- Sets the title of a row with a definite index.
-*/
- void SetRowTitle(in long theIndex, in string theTitle) raises(IncorrectIndex);
-/*!
- Sets the titles for all rows of the table.
-*/
- void SetRowTitles(in StringSeq theTitles) raises(IncorrectArgumentLength);
-/*!
- Returns the titles of all rows of the table.
-*/
- StringSeq GetRowTitles();
-/*!
- Sets the title of a column with a definite index.
-*/
- void SetColumnTitle(in long theIndex, in string theTitle) raises(IncorrectIndex);
-/*!
- Sets the titles for all columns of the table.
-*/
- void SetColumnTitles(in StringSeq theTitles) raises(IncorrectArgumentLength);
-/*!
- Returns the titles of all columns of the table.
-*/
- StringSeq GetColumnTitles();
-
- //Rows units
-/*!
- Sets the unit of a row with a definite index.
-*/
- void SetRowUnit(in long theIndex, in string theUnit) raises(IncorrectIndex);
-/*!
- Sets the units for all rows of the table.
-*/
- void SetRowUnits(in StringSeq theUnits) raises(IncorrectArgumentLength);
-/*!
- Returns the units of all rows of the table.
-*/
- StringSeq GetRowUnits();
-
- // table information
-/*!
- Returns the number of rows of the table.
-*/
- long GetNbRows();
-/*!
- Returns the number of columns of the table.
-*/
- long GetNbColumns();
-
- // operations with rows
-/*!
- Adds a row to the end of the table.
-*/
- void AddRow(in LongSeq theData) raises(IncorrectArgumentLength);
-/*!
- Sets the values of all elements of the row.
-*/
- void SetRow(in long theRow, in LongSeq theData) raises(IncorrectArgumentLength, IncorrectIndex);
-/*!
- Returns the row of the table.
-*/
- LongSeq GetRow(in long theRow) raises(IncorrectIndex);
-
- // operations with columns
-/*!
- Adds a column to the end of the table.
-*/
- void AddColumn(in LongSeq theData) raises(IncorrectArgumentLength);
-/*!
- Sets the values of all elements of the column.
-*/
- void SetColumn(in long theColumn, in LongSeq theData) raises(IncorrectArgumentLength, IncorrectIndex);
-/*!
- Returns the column of the table.
-*/
- LongSeq GetColumn(in long theColumn) raises(IncorrectIndex);
-
- // operations with elements
-/*!
- Puts a value in the table.
- \param theRow The row, where the value will be placed.
- \param theColumn The column, where the value will be placed.
-*/
- void PutValue(in long theValue, in long theRow, in long theColumn) raises(IncorrectIndex);
-/*!
- Returns True if there is a value in the table.
- \param theRow The row containing the value
- \param theColumn The column containing the value
-*/
- boolean HasValue(in long theRow, in long theColumn);
-/*!
- Returns the value from the table.
- \param theRow The row containing the value
- \param theColumn The column containing the value
-*/
- long GetValue(in long theRow, in long theColumn) raises(IncorrectIndex);
-
-/*!
- Sets the max number of colums in the table.
- \note It'd better to set it before filling the table.
-*/
- void SetNbColumns(in long theNbColumns);
-
-/*!
- Returns the indices of the row where the values are defined.
-*/
- LongSeq GetRowSetIndices(in long theRow) raises(IncorrectIndex);
- // operations with files
-/*!
- Reads a table from a file.
-*/
- boolean ReadFromFile(in SALOMEDS::TMPFile theStream);
-/*!
- Saves a table into a file.
-*/
- SALOMEDS::TMPFile SaveToFile();
- };
-
- //==========================================================================
-/*! \brief %AttributeTableOfReal interface
-
- This attribute allows to store a table of reals (indexing from 1 like in CASCADE)
- and string titles of this table, of each row, of each column.
-<BR><VAR>See also <A href=exemple/Example21.html> an example </A> of usage of these methods in batchmode of %SALOME application.</VAR>
-
-*/
- //==========================================================================
-
- interface AttributeTableOfReal : GenericAttribute
- {
-/*!
- This exception is raised when an incorrect index is passed as parameter.
-*/
- exception IncorrectIndex {};
-/*!
- This exception is raised when an incorrect length of the argument is passed as parameter.
-*/
- exception IncorrectArgumentLength {};
-
- // titles: for table, for each row, for each column
-/*!
- Sets the title of the table.
-*/
- void SetTitle(in string theTitle);
-/*!
- Returns the title of the table.
-*/
- string GetTitle();
-/*!
- Sets the title of a row with a definite index.
-*/
- void SetRowTitle(in long theIndex, in string theTitle) raises(IncorrectIndex);
-/*!
- Sets the titles for all rows of the table.
-*/
- void SetRowTitles(in StringSeq theTitles) raises(IncorrectArgumentLength);
-/*!
- Returns the titles of all rows of the table.
-*/
- StringSeq GetRowTitles();
-/*!
- Sets the title of a column with a definite index.
-*/
- void SetColumnTitle(in long theIndex, in string theTitle) raises(IncorrectIndex);
-/*!
- Sets the titles for all columns of the table.
-*/
- void SetColumnTitles(in StringSeq theTitles) raises(IncorrectArgumentLength);
-/*!
- Returns the titles of all columns of the table.
-*/
- StringSeq GetColumnTitles();
-
- //Rows units
-/*!
- Sets the unit of a row with a definite index.
-*/
- void SetRowUnit(in long theIndex, in string theUnit) raises(IncorrectIndex);
-/*!
- Sets the units for all rows of the table.
-*/
- void SetRowUnits(in StringSeq theUnits) raises(IncorrectArgumentLength);
-/*!
- Returns the units of all rows of the table.
-*/
- StringSeq GetRowUnits();
-
- // table information
-/*!
- Returns the number of rows of the table.
-*/
- long GetNbRows();
-/*!
- Returns the number of columns of the table.
-*/
- long GetNbColumns();
-
- // operations with rows
-/*!
- Adds a row to the end of the table.
-*/
- void AddRow(in DoubleSeq theData) raises(IncorrectArgumentLength);
-/*!
- Sets the values of all elements of the row.
-*/
- void SetRow(in long theRow, in DoubleSeq theData) raises(IncorrectArgumentLength, IncorrectIndex);
-/*!
- Returns the row of the table.
-*/
- DoubleSeq GetRow(in long theRow) raises(IncorrectIndex);
-
- // operations with columns
-/*!
- Adds a column to the end of the table.
-*/
- void AddColumn(in DoubleSeq theData) raises(IncorrectArgumentLength);
-/*!
- Sets the values of all elements of the column.
-*/
- void SetColumn(in long theColumn, in DoubleSeq theData) raises(IncorrectArgumentLength, IncorrectIndex);
-/*!
- Returns the column of the table.
-*/
- DoubleSeq GetColumn(in long theColumn) raises(IncorrectIndex);
-
- // operations with elements
-/*!
- Puts a value in the table.
- \param theRow The row, where the value will be placed.
- \param theColumn The column, where the value will be placed.
-*/
- void PutValue(in double theValue, in long theRow, in long theColumn) raises(IncorrectIndex);
-/*!
- Returns True if there is a value in the table.
- \param theRow The row containing the value
- \param theColumn The column containing the value
-*/
- boolean HasValue(in long theRow, in long theColumn);
-/*!
- Returns the value from the table.
- \param theRow The row containing the value
- \param theColumn The column containing the value
-*/
- double GetValue(in long theRow, in long theColumn) raises(IncorrectIndex);
-
-/*!
- Sets the max number of colums in the table.
- \note It'd better to set it before filling the table.
-*/
- void SetNbColumns(in long theNbColumns);
-
-/*!
- Returns the indices of the row where the values are defined.
-*/
- LongSeq GetRowSetIndices(in long theRow) raises(IncorrectIndex);
- // operations with files
-/*!
- Reads a table from a file.
-*/
- boolean ReadFromFile(in SALOMEDS::TMPFile theStream);
-/*!
- Saves a table into a file.
-*/
- SALOMEDS::TMPFile SaveToFile();
- };
-
-
-
- //==========================================================================
-/*! \brief %AttributeTableOfString interface
-
- This attribute allows to store a table of strings (indexing from 1 like in CASCADE)
- and string titles of this table, of each row, of each column.
-<BR><VAR>See also <A href=exemple/Example21.html> an example </A> of usage of these methods in batchmode of %SALOME application.</VAR>
-
-*/
- //==========================================================================
-
- interface AttributeTableOfString : GenericAttribute
- {
-/*!
- This exception is raised when an incorrect index is passed as parameter.
-*/
- exception IncorrectIndex {};
-/*!
- This exception is raised when an incorrect length of the argument is passed as parameter.
-*/
- exception IncorrectArgumentLength {};
-
- // titles: for table, for each row, for each column
-/*!
- Sets the title of the table.
-*/
- void SetTitle(in string theTitle);
-/*!
- Returns the title of the table.
-*/
- string GetTitle();
-/*!
- Sets the title of a row with a definite index.
-*/
- void SetRowTitle(in long theIndex, in string theTitle) raises(IncorrectIndex);
-/*!
- Sets the titles for all rows of the table.
-*/
- void SetRowTitles(in StringSeq theTitles) raises(IncorrectArgumentLength);
-/*!
- Returns the titles of all rows of the table.
-*/
- StringSeq GetRowTitles();
-/*!
- Sets the title of a column with a definite index.
-*/
- void SetColumnTitle(in long theIndex, in string theTitle) raises(IncorrectIndex);
-/*!
- Sets the titles for all columns of the table.
-*/
- void SetColumnTitles(in StringSeq theTitles) raises(IncorrectArgumentLength);
-/*!
- Returns the titles of all columns of the table.
-*/
- StringSeq GetColumnTitles();
-
- //Rows units
-/*!
- Sets the unit of a row with a definite index.
-*/
- void SetRowUnit(in long theIndex, in string theUnit) raises(IncorrectIndex);
-/*!
- Sets the units for all rows of the table.
-*/
- void SetRowUnits(in StringSeq theUnits) raises(IncorrectArgumentLength);
-/*!
- Returns the units of all rows of the table.
-*/
- StringSeq GetRowUnits();
-
- // table information
-/*!
- Returns the number of rows of the table.
-*/
- long GetNbRows();
-/*!
- Returns the number of columns of the table.
-*/
- long GetNbColumns();
-
- // operations with rows
-/*!
- Adds a row to the end of the table.
-*/
- void AddRow(in StringSeq theData) raises(IncorrectArgumentLength);
-/*!
- Sets the values of all elements of the row.
-*/
- void SetRow(in long theRow, in StringSeq theData) raises(IncorrectArgumentLength, IncorrectIndex);
-/*!
- Returns the row of the table.
-*/
- StringSeq GetRow(in long theRow) raises(IncorrectIndex);
-
- // operations with columns
-/*!
- Adds a column to the end of the table.
-*/
- void AddColumn(in StringSeq theData) raises(IncorrectArgumentLength);
-/*!
- Sets the values of all elements of the column.
-*/
- void SetColumn(in long theColumn, in StringSeq theData) raises(IncorrectArgumentLength, IncorrectIndex);
-/*!
- Returns the column of the table.
-*/
- StringSeq GetColumn(in long theColumn) raises(IncorrectIndex);
-
- // operations with elements
-/*!
- Puts a value in the table.
- \param theRow The row, where the value will be placed.
- \param theColumn The column, where the value will be placed.
-*/
- void PutValue(in string theValue, in long theRow, in long theColumn) raises(IncorrectIndex);
-/*!
- Returns True if there is a value in the table.
- \param theRow The row containing the value
- \param theColumn The column containing the value
-*/
- boolean HasValue(in long theRow, in long theColumn);
-/*!
- Returns the value from the table.
- \param theRow The row containing the value
- \param theColumn The column containing the value
-*/
- string GetValue(in long theRow, in long theColumn) raises(IncorrectIndex);
-
-/*!
- Sets the max number of colums in the table.
- \note It'd better to set it before filling the table.
-*/
- void SetNbColumns(in long theNbColumns);
-
-/*!
- Returns the indices of the row where the values are defined.
-*/
- LongSeq GetRowSetIndices(in long theRow) raises(IncorrectIndex);
- // operations with files
-/*!
- Reads a table from a file.
-*/
- boolean ReadFromFile(in SALOMEDS::TMPFile theStream);
-/*!
- Saves a table into a file.
-*/
- SALOMEDS::TMPFile SaveToFile();
- };
-
-
- //==========================================================================
-/*! \brief %AttributeStudyProperties interface
-
- This attribute allows to store study properties: user name, creation date, creation
- mode, modified flag, locked flag.
-<BR><VAR>See also <A href=exemple/Example20.html> an example </A> of usage of these methods in batchmode of %SALOME application.</VAR>
-
-*/
- //==========================================================================
-
- interface AttributeStudyProperties : GenericAttribute
- {
-/*!
- Sets the name of the author of the %Study
-*/
- void SetUserName(in string theName);
-/*!
- Returns the name of the user of the %Study.
- \note <BR>It returns a null string, if user name is not set
-*/
- string GetUserName();
-/*!
- Sets creation date of the %Study.
-*/
- void SetCreationDate(in long theMinute, in long theHour, in long theDay, in long theMonth, in long theYear);
-/*!
- Returns creation date of the %Study and True if creation date is set.
-*/
- boolean GetCreationDate(out long theMinute, out long theHour, out long theDay, out long theMonth, out long theYear);
-/*!
- Sets creation mode of the %Study.
- \note <BR>Creation mode must be: "from scratch" or "copy from".
-*/
- void SetCreationMode(in string theMode);
-/*!
- Returns creation mode: "from scratch", "copy from", or null string
- if creation mode is not set
-*/
- string GetCreationMode();
-/*!
- Sets the number of transactions executed after the last saving of the document.
-*/
- void SetModified(in long theModified);
-/*!
- Returns True, if the document has been modified and not saved.
-*/
- boolean IsModified();
-/*!
- Returns the number of transactions executed after the last saving of the document.
-*/
- long GetModified();
-/*!
- Sets the document locked for modifications if <VAR>theLocked</VAR> is True.
-*/
- void SetLocked(in boolean theLocked);
-/*!
- Returns True if the document is locked for modifications.
-*/
- boolean IsLocked();
-/*!
- Appends modification parameters to the modifications list.
-*/
- void SetModification(in string theName, in long theMinute, in long theHour, in long theDay, in long theMonth, in long theYear);
-/*!
- Returns a list of mosdifiers user names, modification dates.
- /note <BR>If <VAR>theWithCreator</VAR> is True, then the output list will also contain the name of the author and the date of creation.
-*/
- void GetModificationsList(out StringSeq theNames, out LongSeq theMinutes, out LongSeq theHours, out LongSeq theDays, out LongSeq theMonths, out LongSeq theYears, in boolean theWithCreator);
- };
- //==========================================================================
-/*! \brief %AttributePythonObject interface
-
- Attribute allowing to store pyton objects as a sequence of chars.
-*/
- //==========================================================================
-
- interface AttributePythonObject : GenericAttribute
- {
-/*!
- Sets in the attribute a Python object converted into a sequence of chars.
- \param theSequence A sequence of chars.
- \param IsScript Defines (if True) whether this sequence of chars is a Python script.
-*/
- void SetObject(in string theSequence, in boolean IsScript);
-/*!
- Returns a Python object stored in the attribute as a sequence of chars.
-*/
- string GetObject();
-/*!
- Returns True if the sequence of bytes stored in the attribute corresponds
- to a Python script.
-*/
- boolean IsScript();
- };
-};
-#endif
+++ /dev/null
-// 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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
-//
-//
-//
-// File : SALOME_Component.idl
-// Author : Paul RASCLE, EDF
-// $Header: /dn05/salome/CVS/SALOME_ROOT/idl/SALOME_Component.idl
-
-#ifndef _SALOME_COMPONENT_IDL_
-#define _SALOME_COMPONENT_IDL_
-/*! \ingroup Kernel
-
-This is a package of interfaces used for connecting new components to %SALOME application. It also contains a set of interfaces used
-for management of %MED component in %SALOME application.
-*/
-module Engines
-{
- interface Component ;
-
-/*! \brief Interface of the %Container
-
- This interface defines the process of loading and registration
- of new components in SALOME application
-*/
- interface Container
- {
-/*!
- Initializes the %container with a definite name.
-*/
- Container start_impl( in string ContainerName ) ;
-
-/*!
- Loads into the container a new component, registers it and starts it's CORBA servant.
- \param nameToRegister Name of the component which will be registered in Registry (or Name Service)
- \param componentName Name of the constructed library of the %component
-*/
- Component load_impl(in string nameToRegister, in string componentName);
-
-/*!
- Stops the component servant, and deletes all related objects
-*/
- void remove_impl(in Component component_i);
-
-/*!
- Discharges all components from the container.
-*/
- void finalize_removal() ;
-/*!
- Determines whether the server has been loaded or not.
-*/
-
- void ping();
-/*!
- Name of the %container
-*/
- readonly attribute string name ;
-/*!
- Name of the machine containing this container (location of the container).
-*/
- readonly attribute string machineName ;
-/*!
- Returns True if the %container has been killed
-*/
- boolean Kill_impl() ;
- };
-/*! \brief Interface of the %component
-
- This interface is used for interaction between the %container and the %component and between
- the components inside the container.
-*/
- interface Component
- {
-/*!
- The name of the instance of the %Component
-*/
- readonly attribute string instanceName ;
-/*!
- The name of the interface of the %Component
-*/
- readonly attribute string interfaceName ;
-/*!
- Determines whether the server has already been loaded or not.
-*/
- void ping();
-/*!
- Deactivates the %Component.
-*/
- void destroy() ;
-/*!
- Returns the container that the %Component refers to.
-*/
- Container GetContainerRef() ;
-/*!
- This method is used by the %SUPERVISOR component. It sets the names of the graph and of the node.
-*/
- void Names( in string aGraphName , in string aNodeName ) ;
-/*!
- Returns True if the %Component has been killed.
-*/
- boolean Kill_impl() ;
-/*!
- Returns True if the activity of the %Component has been stopped. (It's action can't be resumed)
-*/
- boolean Stop_impl() ;
-/*!
- Returns True if the activity of the %Component has been suspended. (It's action can be resumed)
-*/
- boolean Suspend_impl() ;
-/*!
- Returns True if the activity of the %Component has been resumed.
-*/
- boolean Resume_impl() ;
-/*!
- Returns the Cpu used (long does not run with python !...)
-*/
- long CpuUsed_impl() ;
- } ;
-} ;
-
-#endif
+++ /dev/null
-// 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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
-//
-//
-//
-// File : SALOME_DataTypeCatalog.idl
-// Author : Estelle Deville, Paul Rascle
-// $Header$
-
-module SALOME_DataTypeCatalog{
-// Type definitions
-
-// List of Data Type Names
- typedef sequence<string> ListOfDataTypeName ;
-
- // Exception thrown if a DataType is not found in the catalog
- exception NotFound {};
-//--------------------------------------------------------------------------
-// Interfaces
-
-// Catalog interface :
-// methods to :
-// - obtain the data type names of the catalog
-// - test the compatibility between two type names
-interface DataCatalog
-{
- ListOfDataTypeName GetDataTypeList() ;
- boolean isDerivedFrom(in string type_in, in string type_out) raises(NotFound);
- string GetDataInterfaceRead(in string type) raises(NotFound);
- string GetDataInterfaceWrite(in string type)raises(NotFound);
- ListOfDataTypeName GetDataTypeParents(in string type) raises(NotFound);
-} ;
-};
+++ /dev/null
-// 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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
-//
-//
-//
-// File : SALOME_Exception.idl
-// Author : Paul RASCLE, EDF
-// $Header$
-
-/*! \file SALOME_Exception.idl This file contains the objects defining the main exception used
-in %SALOME application.
-*/
-#ifndef _SALOME_EXCEPTION_IDL_
-#define _SALOME_EXCEPTION_IDL_
-
-/*!
-Module SALOME regroups all idl definitions for SALOME Kernel
-*/
-
-module SALOME
-{
-/*!
-This enumeration contains the elements indicating the type of the exception.
-*/
- enum ExceptionType
- {
- COMM, /*!< Communication problem */
- BAD_PARAM, /*!< Bad User parameters */
- INTERNAL_ERROR /*!< SALOME Bug, irrecoverable */
- };
-/*!
-This struct contains a set of fields defining the structure of the exception.
-*/
- struct ExceptionStruct
- {
- ExceptionType type; /*!<Type of the exception.*/
- string text; /*!<Message which is shown when the exception is raised.*/
- string sourceFile; /*!<The source file where the exception is raised.*/
- unsigned long lineNumber; /*!<Number of the line of the source file where the exception is raised.*/
- };
-/*!
-The main exception in %SALOME application.
-*/
- exception SALOME_Exception
- {
- ExceptionStruct details;
- };
-
-};
-
-#endif
+++ /dev/null
-// 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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
-//
-//
-//
-// File : SALOME_ModuleCatalog.idl
-// Author : Estelle Deville
-// $Header$
-
-/*! \file SALOME_ModuleCatalog.idl This file conatins a set of interfaces used for
- creation of the catalog of components in %SALOME application
-*/
-
-/*! \ingroup Kernel
-The main package of interfaces used for creation of the module catalog in %SALOME application.
-*/
-module SALOME_ModuleCatalog
-{
- // Type Definitions
-/*!
-This enumeration contains a set of definitions of %SALOME modules.
-*/
- enum ComponentType { GEOM, /*!<Module %GEOM */
- MESH, /*!<Module %MESH */
- Med, /*!<Module %Med*/
- SOLVER, /*!<Module of %SOLVER type */
- DATA, /*!<Module %DATA */
- VISU, /*!<Module %VISU */
- SUPERV, /*!<Module %SUPERVISION */
- OTHER /*!<Any other type of module */
- } ;
-/*!
-This struct contains fields defining the parameters of the services.
-*/
-
- struct ServicesParameter
- {
- string Parametertype; /*!<Type of the parameter.*/
- string Parametername; /*!<Name of the parameter.*/
- } ;
-
- typedef sequence<ServicesParameter> ListOfServicesParameter;
-/*!
-This struct contains fields completely defining each service.
-*/
-
- struct Service
- {
- string ServiceName; /*!<Name of the service.*/
- ListOfServicesParameter ServiceinParameter; /*!< List of input parameters of the services.*/
- ListOfServicesParameter ServiceoutParameter; /*!< List of input parameters of the services.*/
- boolean Servicebydefault; /*!<True if the service is taken with its defult fields.*/
- } ;
-/*!
-List of services of the interface.
-*/
- typedef sequence<Service> ListOfInterfaceService;
-/*!
-List of services.
-*/
- typedef sequence<string> ListOfServices ;
-/*!
-This struct contains fields defining each interface.
-*/
- struct DefinitionInterface
- {
- string interfacename ; /*!<Name of the interface.*/
- ListOfInterfaceService interfaceservicelist ; /*!<List of services of the interface.*/
- } ;
-/*!
-List of interface definitions.
-*/
- typedef sequence<DefinitionInterface> ListOfDefInterface ;
-/*!
-List of interfaces.
-*/
- typedef sequence<string> ListOfInterfaces ;
-/*!
-List of names of components.
-*/
- typedef sequence<string> ListOfComponents ;
-/*!
-List of names of computers.
-*/
- typedef sequence<string> ListOfComputers ;
-/*!
-This struct contains GUI elements used for representation of the module in %IAPP component.
-*/
- struct IAPP_Affich
- {
- string modulename; /*!<Name of the module.*/
- string moduleicone; /*!<Icone representing the module.*/
- };
-/*!
-List of pair GUI elements (component name, component icone)
- used for representation of the module in %IAPP component.
-*/
- typedef sequence<IAPP_Affich> ListOfIAPP_Affich ;
-
-/*!
- This exception is raised when a %component, a %service or a % pathPrefix is not found.
-*/
- exception NotFound
- {
- string what ; /*!<Indicates if it's a %component, a %service or a % pathPrefix.*/
- } ;
-
- interface Acomponent
- {
- // GetInterfaceList : operation to get a list of the interfaces name of
- // a component
- /*!
- Gets a list of names of interfaces of the component
- \return a list of interfaces of the component
- */
- ListOfInterfaces GetInterfaceList() ;
-
- // GetInterface : operation to get one interface of a component
-
- /*!
- Gets a definite interface of the component
- \note <BR>If the specified interface doesn't exist, Notfound exception is thrown
- \param interfacename Name of the interface
- \return Required interface
- */
- DefinitionInterface GetInterface(in string interfacename) raises(NotFound);
-
- // GetServiceList : operation to get a list of the services name of
- // an interface of a component
- /*!
- Gets a list of names of services of a definite interface belonging to the component.
- \note <BR>If the specified interface doesn't exist, Notfound exception is thrown.
- \param interfacename Name of the interface
- \return List of services of the required interface
- */
- ListOfServices GetServiceList(in string interfacename) raises(NotFound);
-
-
- // GetService : operation to get one service of an interface of a component
-
- /*!
- Gets a definite service of an interface of the component.
- \note <BR>If the required service or the specified interface don't exist, Notfound exception is thrown.
- \param interfacename Name of the interface
- \param servicename Name of the service
- \return Required service
- */
-
- Service GetService(in string interfacename,
- in string servicename) raises(NotFound);
-
- // GetDefaultService : operation to get the default service
- // of an interface of a component
-/*!
- Gets the default service of an interface of the component.
- \note <BR>If the required service or the specified interface don't exist, Notfound exception is thrown.
- \param interfacename Name of the interface
- \return Required service
- */
-
- Service GetDefaultService(in string interfacename) raises(NotFound);
-
- // GetPathPrefix : operation to get the PathPrefix of a computer
- /*!
- Gets the prefix path of the computer containing the %component.
- \note <BR>If the required computer doesn't exist, Notfound exception is thrown
- \param machinename Name of the machine
- \return Prefix path
- */
-
- string GetPathPrefix(in string machinename) raises(NotFound);
-
-/*!
- Sets/gets the constraint affected to the component
- (to be resolved by LifeCycle for the computer choice)
-*/
- readonly attribute string constraint ;
-
-/*!
-Sets/gets the name of the component
-*/
- readonly attribute string componentname;
-
-/*!
-Defines whether the component can be multistudy or not
-*/
- readonly attribute boolean multistudy;
-
-/*!
-Defines the type of the component
-*/
- readonly attribute ComponentType component_type ;
-
-/*!
-Sets/gets the icone of the component (for IAPP)
-*/
- readonly attribute string component_icone;
- } ;
-/*! \brief %Module catalog interface
-
-This interface is used for creation of the module catalog in %SALOME application.
-*/
- interface ModuleCatalog
- {
- void ping();
-
-/*!
- Gets a list of names of computers of the catalog
-*/
- ListOfComputers GetComputerList();
-
-/*!
-Gets the %PathPrefix of a computer
-*/
- string GetPathPrefix(in string machinename) raises(NotFound);
-/*!
- Gets a list of names of components of the catalog
-*/
- ListOfComponents GetComponentList();
-/*!
-Gets a list of pair GUI elements (component name, component icone)
-used for representation of the module in %IAPP component.
-*/
-
- ListOfIAPP_Affich GetComponentIconeList();
-/*!
-Gets a list of names of components of a particular type, which belong to this catalog.
-*/
- // GetComponentList : operation to get a list of the components name of
- // a particular type of the catalog
- ListOfComponents GetTypedComponentList(in ComponentType _component_type);
-
-/*!
-Gets one component of the catalog.
-*/
- Acomponent GetComponent(in string componentname) raises(NotFound);
- } ;
-};
+++ /dev/null
-// 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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
-//
-//
-//
-// File : SALOME_Registry.idl
-
-# ifndef __registry_idl__
-# define __registry_idl__
-
-module Registry
-{
- struct Infos
- {
- string name;
- long pid;
- string machine;
- string adip;
- long uid;
- string pwname;
- long tc_start;
- long tc_hello;
- long tc_end;
- long difftime;
- string cdir;
- long status;
- string ior; // client
- };
-
- typedef sequence<Infos> AllInfos;
-
- interface Components
- {
- void ping();
- unsigned long add ( in Infos lesInfos ) ;
- void remove ( in unsigned long id ) ;
- unsigned long size() ;
- AllInfos getall () ;
- AllInfos history () ;
- oneway void end() ;
- oneway void hello( in unsigned long id ) ;
- } ;
-} ;
-
-# endif
+++ /dev/null
-// 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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
-//
-//
-//
-// File : SALOME_RessourcesCatalog.idl
-// Author : Estelle Deville
-// $Header$
-
-module SALOME_RessourcesCatalog{
- // Type Definitions
-
- //Proc_info : information about a processor
- struct proc_info{
- long number;
- string model_name;
- float cpu_mhz;
- float cache_size;
- };
-
- typedef sequence<proc_info> ListOfProc;
-
- //Computer_info : information about a computer
- // Os and informations about processors
- struct computer_info{
- string name;
- string OS;
- string OS_version;
- ListOfProc procs;
- };
-
- enum ContainerType {Cpp, python, NP};
- typedef sequence<ContainerType> ListOfContainerType;
-
- typedef sequence<string> ListOfComputer;
-
- // exception thrown if a computer is not found in the catalog
-
- exception NotFound {};
-
- //------------------------------------------------------------------
- //Interface
- interface RessourcesCatalog {
- ListOfComputer GetComputerList();
- ListOfContainerType GetContainerTypeList (in string computer) raises(NotFound);
- computer_info GetComputerInfo(in string computer) raises(NotFound);
- };
-};
+++ /dev/null
-// 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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
-//
-//
-//
-// File : SALOME_Session.idl
-// Author : Paul RASCLE, EDF
-// $Header$
-
-#include "SALOME_Component.idl"
-/*! \defgroup Kernel SALOME KERNEL module
-*/
-
-/*! \ingroup Kernel
-
- This package contains interfaces used for management of the session in %SALOME application.
-*/
-module SALOME
-{
-/*! \brief State of the session
-
- This enumeration contains values defining the state of the session
-
-*/
- enum SessionState {asleep, running} ;
-
-/*! \brief %Session State and Statistics
-
-
- This struct contains a field list with general information about the session
-*/
-
- struct StatSession
- {
-/*! \brief State of the session
-
- It can be:
- * -# asleep : no running study
- * -# running : one or more running studies
-*/
- SessionState state ;
-/*! Number of running studies
-*/
- short runningStudies ;
-/*! It is True if GUI is active in the session
-*/
- boolean activeGUI ;
- } ;
-/*! \brief Interface of the session
-
- The %session Server launches and stops GUI (Graphical User Interface).
- The %session can be active without GUI (It can contain one or more running studies)
-*/
-
- interface Session
- {
-/*!
- This exception is raised when trying to stop the %session with active GUI
-*/
- exception GUIActive {} ;
-/*!
- This exception is raised when trying to stop the %session with a number of running studies.
-*/
- exception RunningStudies {} ;
-
-/*!
- Launches GUI in the session
-*/
- void GetInterface();
- Engines::Component GetVisuGen();
-
-/*!
- Stops the %Session (It must be idle)
-*/
- void StopSession() raises(GUIActive, RunningStudies) ;
-
-/*!
- Gets Session State
-*/
- StatSession GetStatSession() ;
-/*!
- Determines whether the server has already been loaded or not.
-*/
- void ping();
- } ;
-
-} ;
+++ /dev/null
-// 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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
-//
-//
-//
-// File : SALOME_TestComponent.idl
-// Author : Paul RASCLE, EDF - MARC TAJCHMAN, CEA
-// $Header$
-
-#include "SALOME_Component.idl"
-
-module Engines
-{
-
- interface TestComponent : Component
- {
- string Coucou(in long L);
- };
-
-};
+++ /dev/null
-// 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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
-//
-//
-//
-// File : SMESH_BasicHypothesis.idl
-// Author : Paul RASCLE, EDF
-// $Header$
-
-#ifndef _SMESH_BASICHYPOTHESIS_IDL_
-#define _SMESH_BASICHYPOTHESIS_IDL_
-
-#include "SALOME_Exception.idl"
-#include "SMESH_Hypothesis.idl"
-
-
-module SMESH
-{
- interface SMESH_LocalLength : SMESH_Hypothesis
- {
- void SetLength(in double length)
- raises (SALOME::SALOME_Exception);
- double GetLength();
- };
-
- interface SMESH_NumberOfSegments : SMESH_Hypothesis
- {
- void SetNumberOfSegments(in long segmentsNumber)
- raises (SALOME::SALOME_Exception);
- long GetNumberOfSegments();
- void SetScaleFactor(in double scaleFactor)
- raises (SALOME::SALOME_Exception);
- double GetScaleFactor();
- };
-
- interface SMESH_MaxElementArea : SMESH_Hypothesis
- {
- void SetMaxElementArea(in double area)
- raises (SALOME::SALOME_Exception);
- double GetMaxElementArea();
- };
-
- interface SMESH_MaxElementVolume : SMESH_Hypothesis
- {
- void SetMaxElementVolume(in double volume)
- raises (SALOME::SALOME_Exception);
- double GetMaxElementVolume();
- };
-
- interface SMESH_Regular_1D : SMESH_1D_Algo
- {
- };
-
- interface SMESH_MEFISTO_2D : SMESH_2D_Algo
- {
- };
-
- interface SMESH_Quadrangle_2D : SMESH_2D_Algo
- {
- };
-
- interface SMESH_Hexa_3D : SMESH_3D_Algo
- {
- };
-};
-
-#endif
+++ /dev/null
-// 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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
-//
-//
-//
-// File : SMESH_Gen.idl
-// Author : Paul RASCLE, EDF
-// $Header$
-
-#ifndef _SMESH_GEN_IDL_
-#define _SMESH_GEN_IDL_
-
-#include "SALOME_Exception.idl"
-#include "SALOME_Component.idl"
-#include "SALOMEDS.idl"
-
-#include "GEOM_Gen.idl"
-#include "GEOM_Shape.idl"
-
-#include "SMESH_Mesh.idl"
-#include "SMESH_Hypothesis.idl"
-
-module SMESH
-{
- typedef sequence<GEOM::GEOM_Shape> shape_array;
-
- interface SMESH_Gen : Engines::Component, SALOMEDS::Driver
- {
- /*!
- * Create an hypothesis that can be shared by differents parts of the mesh.
- * An hypothesis is either:
- * - a method used to generate or modify a part of the mesh (algorithm).
- * - a parameter or a law used by an algorithm.
- * Algorithms are 1D, 2D or 3D.
- */
- SMESH_Hypothesis CreateHypothesis( in string anHyp,
- in long studyId)
- raises (SALOME::SALOME_Exception);
-
- /*!
- * Create a Mesh object, given a geometry shape.
- * Mesh is created empty (no points, no elements).
- * Shape is explored via GEOM_Client to create local copies.
- * of TopoDS_Shapes and bind CORBA references of shape & subshapes
- * with TopoDS_Shapes
- */
- SMESH_Mesh Init(in GEOM::GEOM_Gen geomEngine,
- in long studyId,
- in GEOM::GEOM_Shape aShape)
- raises (SALOME::SALOME_Exception);
-
- /*!
- * Create a Mesh object, without a geometry shape reference
- */
-// SMESH_Mesh NewEmpty(in GEOM::GEOM_Gen geomEngine,
-// in long studyId)
-// raises (SALOME::SALOME_Exception);
-
- /*!
- * Mesh a subShape.
- * First, verify list of hypothesis associated with the subShape,
- * return NOK if hypothesis are not sufficient
- */
- boolean Compute(in SMESH_Mesh aMesh, in GEOM::GEOM_Shape aSubShape)
- raises (SALOME::SALOME_Exception);
-
- /*!
- *
- */
-
- boolean IsReadyToCompute(in SMESH_Mesh aMesh, in GEOM::GEOM_Shape aSubShape)
- raises (SALOME::SALOME_Exception);
-
- /*!
- *
- */
- long_array GetSubShapesId(in GEOM::GEOM_Gen geomEngine,
- in long studyId,
- in GEOM::GEOM_Shape mainShape,
- in shape_array listOfSubShape)
- raises (SALOME::SALOME_Exception);
-
- /*!
- *
- */
- // long_array GetSubMeshesState(in GEOM::GEOM_Gen geomEngine,
- // in long studyId,
- // in shape_array listOfSubShape)
- // raises (SALOME::SALOME_Exception);
-
-
- };
-
-};
-
-#endif
+++ /dev/null
-// 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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
-//
-//
-//
-// File : SMESH_Hypothesis.idl
-// Author : Paul RASCLE, EDF
-// $Header$
-
-#ifndef _SMESH_HYPOTHESIS_IDL_
-#define _SMESH_HYPOTHESIS_IDL_
-
-#include "SALOME_Exception.idl"
-
-module SMESH
-{
- interface SMESH_Hypothesis;
-
- typedef sequence<SMESH_Hypothesis> ListOfHypothesis;
- typedef sequence<string> ListOfHypothesisName;
-
- interface SMESH_Hypothesis
- {
- /*!
- * Get the Hypothesis typeName
- */
- string GetName();
-
- /*!
- * Get the internal Id
- */
- long GetId();
- };
-
- interface SMESH_Algo : SMESH_Hypothesis
- {
- /*!
- * Get list of hypothesis that can be used with this algorithm
- */
- ListOfHypothesisName GetCompatibleHypothesis();
-
- };
-
- interface SMESH_1D_Algo : SMESH_Algo
- {
- /*!
- *
- */
- };
-
- interface SMESH_2D_Algo : SMESH_Algo
- {
- /*!
- *
- */
- };
-
- interface SMESH_3D_Algo : SMESH_Algo
- {
- /*!
- *
- */
- };
-};
-
- // -----------------------------------------------------------------
- // Specific Algorithms in separate idl file
- // -----------------------------------------------------------------
-
-
-#endif
+++ /dev/null
-// 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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
-//
-//
-//
-// File : SMESH_Mesh.idl
-// Author : Paul RASCLE, EDF
-// $Header$
-
-#ifndef _SMESH_MESH_IDL_
-#define _SMESH_MESH_IDL_
-
-#include "SALOME_Exception.idl"
-#include "SMESH_Hypothesis.idl"
-
-#include "GEOM_Shape.idl"
-#include "MED.idl"
-
-module SMESH
-{
- typedef sequence<double> double_array ;
- typedef sequence<long> long_array ;
- typedef sequence<string> string_array ;
-
- enum log_command
- {
- ADD_NODE,
- ADD_EDGE,
- ADD_TRIANGLE,
- ADD_QUADRANGLE,
- ADD_TETRAHEDRON,
- ADD_PYRAMID,
- ADD_PRISM,
- ADD_HEXAHEDRON,
- REMOVE_NODE,
- REMOVE_ELEMENT
- };
-
- struct log_block
- {
- long commandType;
- long number;
- double_array coords;
- long_array indexes;
- };
-
- typedef sequence<log_block> log_array;
-
- interface SMESH_subMesh;
- interface SMESH_MeshEditor;
- interface SMESH_Mesh
- {
- /*!
- * Associate a Shape to a Mesh created with NewEmpty
- */
-
-// boolean SetMesh(in GEOM::GEOM_Shape aShape)
-// raises (SALOME::SALOME_Exception);
-
- /*!
- * Get the subMesh object associated to a subShape. The subMesh object
- * gives access to nodes and elements IDs.
- * SubMesh will be used instead of SubShape in a next idl version to
- * adress a specific subMesh...
- */
- SMESH_subMesh GetElementsOnShape(in GEOM::GEOM_Shape aSubShape)
- raises (SALOME::SALOME_Exception);
-
- /*!
- * Create a subMesh without reference to a subShape
- */
-// SMESH_subMesh NewEmpty()
-// raises (SALOME::SALOME_Exception);
-
- /*!
- * Add hypothesis to the mesh, under a particular subShape
- * (or the main shape itself)
- * The Add method is only used to prepare the build of the mesh and store
- * the algorithms and associated parameters.
- * Actual job of mesh the shape is done by MESH_Gen.
- * @params
- * - aSubShape : subShape obtained by a shape explode in GEOM
- * (or main shape)
- * - anHyp : hypothesis object
- * @return
- * - OK if the hypothesis is compatible with the subShape
- * (and all previous hypothesis on the subShape)
- * - NOK if the hypothesis is not compatible with the subShape
- * (or one previous hypothesis on the subShape)
- * raises exception if hypothesis has not been created
- */
- boolean AddHypothesis(in GEOM::GEOM_Shape aSubShape, in SMESH_Hypothesis anHyp)
- raises (SALOME::SALOME_Exception);
-// boolean AddHypothesis(in SMESH_subMesh aSubMesh, in SMESH_Hypothesis anHyp)
-// raises (SALOME::SALOME_Exception);
-
-
- /*!
- * Remove an hypothesis previouly added with AddHypothesis.
- */
- boolean RemoveHypothesis(in GEOM::GEOM_Shape aSubShape,
- in SMESH_Hypothesis anHyp)
- raises (SALOME::SALOME_Exception);
-// boolean RemoveHypothesis(in SMESH_subMesh aSubMesh,
-// in SMESH_Hypothesis anHyp)
-// raises (SALOME::SALOME_Exception);
-
- /*!
- * Get the list of hypothesis added on a subShape
- */
- ListOfHypothesis GetHypothesisList(in GEOM::GEOM_Shape aSubShape)
- raises (SALOME::SALOME_Exception);
-// ListOfHypothesis GetHypothesisList(in SMESH_subMesh aSubMesh)
-// raises (SALOME::SALOME_Exception);
-
- /*!
- * Get the log of nodes and elements added or removed since previous
- * clear of the log.
- * @params
- * - clearAfterGet : log is emptied after Get (safe if concurrents access)
- */
- // string_array GetLog(in boolean clearAfterGet)
- // raises (SALOME::SALOME_Exception);
- log_array GetLog(in boolean clearAfterGet)
- raises (SALOME::SALOME_Exception);
-
- /*!
- * Clear the log of nodes and elements added or removed since previous
- * clear. Must be used immediately after GetLog if clearAfterGet is false.
- */
- void ClearLog()
- raises (SALOME::SALOME_Exception);
-
- /*!
- * Get the internal Id
- */
- long GetId();
-
- /*!
- * Get the study Id
- */
- long GetStudyId();
-
- SMESH_MeshEditor GetMeshEditor()
- raises (SALOME::SALOME_Exception);
-
- /*!
- * Export Mesh with DAT and MED Formats
- */
- void ExportDAT( in string file )
- raises (SALOME::SALOME_Exception);
- void ExportMED( in string file )
- raises (SALOME::SALOME_Exception);
- void ExportUNV( in string file )
- raises (SALOME::SALOME_Exception);
-
- /*!
- * Get MED Mesh
- */
- SALOME_MED::MESH GetMEDMesh()
- raises (SALOME::SALOME_Exception);
-
- long NbNodes()
- raises (SALOME::SALOME_Exception);
-
- long NbEdges()
- raises (SALOME::SALOME_Exception);
-
- long NbFaces()
- raises (SALOME::SALOME_Exception);
-
- long NbTriangles()
- raises (SALOME::SALOME_Exception);
-
- long NbQuadrangles()
- raises (SALOME::SALOME_Exception);
-
- long NbVolumes()
- raises (SALOME::SALOME_Exception);
-
- long NbTetras()
- raises (SALOME::SALOME_Exception);
-
- long NbHexas()
- raises (SALOME::SALOME_Exception);
-
- long NbSubMesh()
- raises (SALOME::SALOME_Exception);
- };
-
- interface SMESH_subMesh
- {
- /*!
- *
- */
- long GetNumberOfElements()
- raises (SALOME::SALOME_Exception);
-
- /*!
- *
- */
- long GetNumberOfNodes()
- raises (SALOME::SALOME_Exception);
-
- /*!
- *
- */
- long_array GetElementsId()
- raises (SALOME::SALOME_Exception);
-
- /*!
- *
- */
- long_array GetNodesId()
- raises (SALOME::SALOME_Exception);
-
- /*!
- * Get SMESH_Mesh which stores nodes coordinates & elements definition
- */
- SMESH_Mesh GetFather()
- raises (SALOME::SALOME_Exception);
-
- /*!
- * Get the internal Id
- */
- long GetId();
-
- /*!
- * Get MED subMesh
- */
- SALOME_MED::FAMILY GetFamily()
- raises (SALOME::SALOME_Exception);
- };
-
- /*
- * This interface makes modifications on the Mesh - removing elements and nodes
- */
- interface SMESH_MeshEditor {
-
-
- boolean RemoveElements(in long_array IDsOfElements)
- raises (SALOME::SALOME_Exception);
-
- boolean RemoveNodes(in long_array IDsOfNodes)
- raises (SALOME::SALOME_Exception);
-
- boolean AddNode(in double x, in double y, in double z)
- raises (SALOME::SALOME_Exception);
-
- boolean AddEdge(in long_array IDsOfNodes)
- raises (SALOME::SALOME_Exception);
-
- boolean AddFace(in long_array IDsOfNodes)
- raises (SALOME::SALOME_Exception);
-
- boolean AddVolume(in long_array IDsOfNodes)
- raises (SALOME::SALOME_Exception);
- };
-};
-
-#endif
+++ /dev/null
-// 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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
-//
-//
-//
-// File : SMESH_BasicHypothesis.idl
-// Author : Paul RASCLE, EDF
-// $Header$
-
-#ifndef _SMESH_BASICHYPOTHESIS_IDL_
-#define _SMESH_BASICHYPOTHESIS_IDL_
-
-#include "SALOME_Exception.idl"
-#include "SMESH_Hypothesis.idl"
-
-
-module SMESH
-{
- interface SMESH_LocalLength : SMESH_Hypothesis
- {
- void SetLength(in double length)
- raises (SALOME::SALOME_Exception);
- double GetLength();
- };
-
- interface SMESH_NumberOfSegments : SMESH_Hypothesis
- {
- void SetNumberOfSegments(in long segmentsNumber)
- raises (SALOME::SALOME_Exception);
- long GetNumberOfSegments();
- void SetScaleFactor(in double scaleFactor)
- raises (SALOME::SALOME_Exception);
- double GetScaleFactor();
- };
-
- interface SMESH_MaxElementArea : SMESH_Hypothesis
- {
- void SetMaxElementArea(in double area)
- raises (SALOME::SALOME_Exception);
- double GetMaxElementArea();
- };
-
- interface SMESH_MaxElementVolume : SMESH_Hypothesis
- {
- void SetMaxElementVolume(in double volume)
- raises (SALOME::SALOME_Exception);
- double GetMaxElementVolume();
- };
-
- interface SMESH_Regular_1D : SMESH_1D_Algo
- {
- };
-
- interface SMESH_MEFISTO_2D : SMESH_2D_Algo
- {
- };
-
- interface SMESH_Quadrangle_2D : SMESH_2D_Algo
- {
- };
-
- interface SMESH_Hexa_3D : SMESH_3D_Algo
- {
- };
-};
-
-#endif
+++ /dev/null
-// 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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
-//
-//
-//
-// File : SMESH_Gen.idl
-// Author : Paul RASCLE, EDF
-// $Header$
-
-#ifndef _SMESH_GEN_IDL_
-#define _SMESH_GEN_IDL_
-
-#include "SALOME_Exception.idl"
-#include "SALOME_Component.idl"
-#include "SALOMEDS.idl"
-
-#include "GEOM_Gen.idl"
-#include "GEOM_Shape.idl"
-
-#include "SMESH_Mesh.idl"
-#include "SMESH_Hypothesis.idl"
-
-module SMESH
-{
- typedef sequence<GEOM::GEOM_Shape> shape_array;
-
- interface SMESH_Gen : Engines::Component, SALOMEDS::Driver
- {
- /*!
- * Create an hypothesis that can be shared by differents parts of the mesh.
- * An hypothesis is either:
- * - a method used to generate or modify a part of the mesh (algorithm).
- * - a parameter or a law used by an algorithm.
- * Algorithms are 1D, 2D or 3D.
- */
- SMESH_Hypothesis CreateHypothesis( in string anHyp,
- in long studyId)
- raises (SALOME::SALOME_Exception);
-
- /*!
- * Create a Mesh object, given a geometry shape.
- * Mesh is created empty (no points, no elements).
- * Shape is explored via GEOM_Client to create local copies.
- * of TopoDS_Shapes and bind CORBA references of shape & subshapes
- * with TopoDS_Shapes
- */
- SMESH_Mesh Init(in GEOM::GEOM_Gen geomEngine,
- in long studyId,
- in GEOM::GEOM_Shape aShape)
- raises (SALOME::SALOME_Exception);
-
- /*!
- * Create a Mesh object, without a geometry shape reference
- */
-// SMESH_Mesh NewEmpty(in GEOM::GEOM_Gen geomEngine,
-// in long studyId)
-// raises (SALOME::SALOME_Exception);
-
- /*!
- * Mesh a subShape.
- * First, verify list of hypothesis associated with the subShape,
- * return NOK if hypothesis are not sufficient
- */
- boolean Compute(in SMESH_Mesh aMesh, in GEOM::GEOM_Shape aSubShape)
- raises (SALOME::SALOME_Exception);
-
- /*!
- *
- */
-
- boolean IsReadyToCompute(in SMESH_Mesh aMesh, in GEOM::GEOM_Shape aSubShape)
- raises (SALOME::SALOME_Exception);
-
- /*!
- *
- */
- long_array GetSubShapesId(in GEOM::GEOM_Gen geomEngine,
- in long studyId,
- in GEOM::GEOM_Shape mainShape,
- in shape_array listOfSubShape)
- raises (SALOME::SALOME_Exception);
-
- /*!
- *
- */
- // long_array GetSubMeshesState(in GEOM::GEOM_Gen geomEngine,
- // in long studyId,
- // in shape_array listOfSubShape)
- // raises (SALOME::SALOME_Exception);
-
-
- };
-
-};
-
-#endif
+++ /dev/null
-// 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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
-//
-//
-//
-// File : SMESH_Hypothesis.idl
-// Author : Paul RASCLE, EDF
-// $Header$
-
-#ifndef _SMESH_HYPOTHESIS_IDL_
-#define _SMESH_HYPOTHESIS_IDL_
-
-#include "SALOME_Exception.idl"
-
-module SMESH
-{
- interface SMESH_Hypothesis;
-
- typedef sequence<SMESH_Hypothesis> ListOfHypothesis;
- typedef sequence<string> ListOfHypothesisName;
-
- interface SMESH_Hypothesis
- {
- /*!
- * Get the Hypothesis typeName
- */
- string GetName();
-
- /*!
- * Get the internal Id
- */
- long GetId();
- };
-
- interface SMESH_Algo : SMESH_Hypothesis
- {
- /*!
- * Get list of hypothesis that can be used with this algorithm
- */
- ListOfHypothesisName GetCompatibleHypothesis();
-
- };
-
- interface SMESH_1D_Algo : SMESH_Algo
- {
- /*!
- *
- */
- };
-
- interface SMESH_2D_Algo : SMESH_Algo
- {
- /*!
- *
- */
- };
-
- interface SMESH_3D_Algo : SMESH_Algo
- {
- /*!
- *
- */
- };
-};
-
- // -----------------------------------------------------------------
- // Specific Algorithms in separate idl file
- // -----------------------------------------------------------------
-
-
-#endif
+++ /dev/null
-// 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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
-//
-//
-//
-// File : SMESH_Mesh.idl
-// Author : Paul RASCLE, EDF
-// $Header$
-
-#ifndef _SMESH_MESH_IDL_
-#define _SMESH_MESH_IDL_
-
-#include "SALOME_Exception.idl"
-#include "SMESH_Hypothesis.idl"
-
-#include "GEOM_Shape.idl"
-#include "MED.idl"
-
-module SMESH
-{
- typedef sequence<double> double_array ;
- typedef sequence<long> long_array ;
- typedef sequence<string> string_array ;
-
- enum log_command
- {
- ADD_NODE,
- ADD_EDGE,
- ADD_TRIANGLE,
- ADD_QUADRANGLE,
- ADD_TETRAHEDRON,
- ADD_PYRAMID,
- ADD_PRISM,
- ADD_HEXAHEDRON,
- REMOVE_NODE,
- REMOVE_ELEMENT
- };
-
- struct log_block
- {
- long commandType;
- long number;
- double_array coords;
- long_array indexes;
- };
-
- typedef sequence<log_block> log_array;
-
- interface SMESH_subMesh;
- interface SMESH_MeshEditor;
- interface SMESH_Mesh
- {
- /*!
- * Associate a Shape to a Mesh created with NewEmpty
- */
-
-// boolean SetMesh(in GEOM::GEOM_Shape aShape)
-// raises (SALOME::SALOME_Exception);
-
- /*!
- * Get the subMesh object associated to a subShape. The subMesh object
- * gives access to nodes and elements IDs.
- * SubMesh will be used instead of SubShape in a next idl version to
- * adress a specific subMesh...
- */
- SMESH_subMesh GetElementsOnShape(in GEOM::GEOM_Shape aSubShape)
- raises (SALOME::SALOME_Exception);
-
- /*!
- * Create a subMesh without reference to a subShape
- */
-// SMESH_subMesh NewEmpty()
-// raises (SALOME::SALOME_Exception);
-
- /*!
- * Add hypothesis to the mesh, under a particular subShape
- * (or the main shape itself)
- * The Add method is only used to prepare the build of the mesh and store
- * the algorithms and associated parameters.
- * Actual job of mesh the shape is done by MESH_Gen.
- * @params
- * - aSubShape : subShape obtained by a shape explode in GEOM
- * (or main shape)
- * - anHyp : hypothesis object
- * @return
- * - OK if the hypothesis is compatible with the subShape
- * (and all previous hypothesis on the subShape)
- * - NOK if the hypothesis is not compatible with the subShape
- * (or one previous hypothesis on the subShape)
- * raises exception if hypothesis has not been created
- */
- boolean AddHypothesis(in GEOM::GEOM_Shape aSubShape, in SMESH_Hypothesis anHyp)
- raises (SALOME::SALOME_Exception);
-// boolean AddHypothesis(in SMESH_subMesh aSubMesh, in SMESH_Hypothesis anHyp)
-// raises (SALOME::SALOME_Exception);
-
-
- /*!
- * Remove an hypothesis previouly added with AddHypothesis.
- */
- boolean RemoveHypothesis(in GEOM::GEOM_Shape aSubShape,
- in SMESH_Hypothesis anHyp)
- raises (SALOME::SALOME_Exception);
-// boolean RemoveHypothesis(in SMESH_subMesh aSubMesh,
-// in SMESH_Hypothesis anHyp)
-// raises (SALOME::SALOME_Exception);
-
- /*!
- * Get the list of hypothesis added on a subShape
- */
- ListOfHypothesis GetHypothesisList(in GEOM::GEOM_Shape aSubShape)
- raises (SALOME::SALOME_Exception);
-// ListOfHypothesis GetHypothesisList(in SMESH_subMesh aSubMesh)
-// raises (SALOME::SALOME_Exception);
-
- /*!
- * Get the log of nodes and elements added or removed since previous
- * clear of the log.
- * @params
- * - clearAfterGet : log is emptied after Get (safe if concurrents access)
- */
- // string_array GetLog(in boolean clearAfterGet)
- // raises (SALOME::SALOME_Exception);
- log_array GetLog(in boolean clearAfterGet)
- raises (SALOME::SALOME_Exception);
-
- /*!
- * Clear the log of nodes and elements added or removed since previous
- * clear. Must be used immediately after GetLog if clearAfterGet is false.
- */
- void ClearLog()
- raises (SALOME::SALOME_Exception);
-
- /*!
- * Get the internal Id
- */
- long GetId();
-
- /*!
- * Get the study Id
- */
- long GetStudyId();
-
- SMESH_MeshEditor GetMeshEditor()
- raises (SALOME::SALOME_Exception);
-
- /*!
- * Export Mesh with DAT and MED Formats
- */
- void ExportDAT( in string file )
- raises (SALOME::SALOME_Exception);
- void ExportMED( in string file )
- raises (SALOME::SALOME_Exception);
- void ExportUNV( in string file )
- raises (SALOME::SALOME_Exception);
-
- /*!
- * Get MED Mesh
- */
- SALOME_MED::MESH GetMEDMesh()
- raises (SALOME::SALOME_Exception);
-
- long NbNodes()
- raises (SALOME::SALOME_Exception);
-
- long NbEdges()
- raises (SALOME::SALOME_Exception);
-
- long NbFaces()
- raises (SALOME::SALOME_Exception);
-
- long NbTriangles()
- raises (SALOME::SALOME_Exception);
-
- long NbQuadrangles()
- raises (SALOME::SALOME_Exception);
-
- long NbVolumes()
- raises (SALOME::SALOME_Exception);
-
- long NbTetras()
- raises (SALOME::SALOME_Exception);
-
- long NbHexas()
- raises (SALOME::SALOME_Exception);
-
- long NbSubMesh()
- raises (SALOME::SALOME_Exception);
- };
-
- interface SMESH_subMesh
- {
- /*!
- *
- */
- long GetNumberOfElements()
- raises (SALOME::SALOME_Exception);
-
- /*!
- *
- */
- long GetNumberOfNodes()
- raises (SALOME::SALOME_Exception);
-
- /*!
- *
- */
- long_array GetElementsId()
- raises (SALOME::SALOME_Exception);
-
- /*!
- *
- */
- long_array GetNodesId()
- raises (SALOME::SALOME_Exception);
-
- /*!
- * Get SMESH_Mesh which stores nodes coordinates & elements definition
- */
- SMESH_Mesh GetFather()
- raises (SALOME::SALOME_Exception);
-
- /*!
- * Get the internal Id
- */
- long GetId();
-
- /*!
- * Get MED subMesh
- */
- SALOME_MED::FAMILY GetFamily()
- raises (SALOME::SALOME_Exception);
- };
-
- /*
- * This interface makes modifications on the Mesh - removing elements and nodes
- */
- interface SMESH_MeshEditor {
-
-
- boolean RemoveElements(in long_array IDsOfElements)
- raises (SALOME::SALOME_Exception);
-
- boolean RemoveNodes(in long_array IDsOfNodes)
- raises (SALOME::SALOME_Exception);
-
- boolean AddNode(in double x, in double y, in double z)
- raises (SALOME::SALOME_Exception);
-
- boolean AddEdge(in long_array IDsOfNodes)
- raises (SALOME::SALOME_Exception);
-
- boolean AddFace(in long_array IDsOfNodes)
- raises (SALOME::SALOME_Exception);
-
- boolean AddVolume(in long_array IDsOfNodes)
- raises (SALOME::SALOME_Exception);
- };
-};
-
-#endif
+++ /dev/null
-// 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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
-//
-//
-//
-// File : SUPERV.idl
-// Author : Jean Rahuel
-// $Header:
-
-/*! \file SUPERV.idl This file contains a set of interfaces of the %SUPERVISION module
-*/
-/*!
- \defgroup Supervision SALOME SUPERVISION module
-*/
-#ifndef __SUPERV_IDL__
-#define __SUPERV_IDL__
-
-#include "SALOME_ModuleCatalog.idl"
-#include "SALOME_Component.idl"
-#include "SALOMEDS.idl"
-/*! \ingroup Supervision
- The main package of interfaces of %SUPERVISION module
-*/
-module SUPERV {
-
-/*!
-This enumeration contains a set of elements defining the type of the port.
-\note <BR>In general, ports represent <STRONG>input or output parameters</STRONG> of the functions,
-implemented in different kinds of nodes of the graph.
-*/
- enum KindOfPort { UndefinedParameter , ServiceParameter , GateParameter ,
- InLineParameter , LoopParameter , SwitchParameter ,
- EndSwitchParameter , GOTOParameter } ;
-
-/*!
-This enumeration contains a set of elements defining the type of the node.
-*/
- enum KindOfNode { FactoryNode , DataFlowNode , ComputingNode ,
- InLineNode , LoopNode , EndLoopNode ,
- SwitchNode , EndSwitchNode , GOTONode , UnknownNode };
-
-/*!
-This struct contains fields defining the date.
-*/
- struct SDate {
- short Second;
- short Minute;
- short Hour;
- short Day;
- short Month;
- short Year;
- };
-/*!
-This enumeration contains a set of elements defining the type of operation, which has been performed
-on this node(graph).
-*/
-
- enum GraphEvent { UndefinedEvent , NoEvent , NewThreadEvent ,
- WaitingEvent , ReadyEvent ,
- RunningEvent , DoneEvent , ErroredEvent ,
- SuspendEvent , ResumeEvent ,
- KillEvent , StopEvent ,
- ReRunEvent , ReStartEvent } ;
-
- // UndefinedState : Non existing Node, Port etc...
-/*!
-This enumeration contains a set of elements defining the current state of the node(graph).
-*/
-
- enum GraphState { UndefinedState , NoState , EditingState , SuspendState ,
- WaitingState , ReadyState , SuspendReadyState ,
- RunningState ,
- DoneState , ErrorState ,
- SuspendDoneState , SuspendErroredState ,
- KillState , StopState ,
- ReRunState , ReStartState ,
- NumberOfGraphStates } ;
-
- typedef sequence<string> ListOfStrings ;
-
- interface Value ;
-
- interface Link ;
-
- typedef sequence<Link> ListOfLinks ;
-
- interface Port ;
-
- typedef sequence<Port> ListOfPorts ;
-
- interface CNode ;
- interface FNode ;
- interface INode ;
- interface GNode ;
- interface LNode ;
- interface ELNode ;
- interface SNode ;
- interface ESNode ;
- typedef sequence<CNode> ListOfCNodes ;
- typedef sequence<FNode> ListOfFNodes ;
- typedef sequence<INode> ListOfINodes ;
- typedef sequence<GNode> ListOfGNodes ;
- typedef sequence<LNode> ListOfLNodes ;
- typedef sequence<ELNode> ListOfELNodes ;
- typedef sequence<SNode> ListOfSNodes ;
- typedef sequence<ESNode> ListOfESNodes ;
-
- struct ListOfNodes {
- ListOfCNodes CNodes ;
- ListOfFNodes FNodes ;
- ListOfINodes INodes ;
- ListOfGNodes GNodes ;
- ListOfLNodes LNodes ;
- ListOfELNodes ELNodes ;
- ListOfSNodes SNodes ;
- ListOfESNodes ESNodes ;
- } ;
-
- interface Graph ;
-
- typedef sequence<Graph> ListOfGraphs ;
-
- // ToSuspendState : will be Suspended before running if waiting or
- // will be Suspended while running or
- // will be Suspended after run
- // ToSuspendStartState : will be Suspended at the beginning of execution
- // ToSuspendDoneState : will be Suspended after run
-/*!
-This enumeration contains a set of elements defining the %ControlState of the node.
-The %ControlState gives a possibility to determine the "control actions" which have been done by
-the user (Suspend, SuspendDone, Kill, etc...).
-*/
- enum ControlState { VoidState , ToSuspendStartState ,
- ToSuspendState , ToSuspendDoneState ,
- ToKillState , ToKillDoneState , ToStopState ,
- NumberOfControlStates } ;
-/*!
-The AutomatonState is an internal state of the automaton of the Executor
-of the %SuperVision %Engine. It is used for inner debugging purposes only.
-*/
-
- enum AutomatonState { UnKnownState ,
- DataUndefState ,
- DataWaitingState ,
- DataReadyState ,
- SuspendedReadyState,
- SuspendedReadyToResumeState ,
- ResumedReadyState ,
- KilledReadyState ,
- StoppedReadyState ,
- ExecutingState ,
- SuspendedExecutingState ,
- ResumedExecutingState ,
- KilledExecutingState ,
- StoppedExecutingState ,
- SuccessedExecutingState ,
- ErroredExecutingState ,
- SuspendedSuccessedState ,
- SuspendedErroredState,
- ResumedSuccessedState ,
- ResumedErroredState ,
- KilledSuccessedState ,
- KilledErroredState ,
- StoppedSuccessedState ,
- StoppedErroredState ,
- SuccessedState ,
- ErroredState ,
- SuspendedState ,
- KilledState ,
- StoppedState ,
- SuspendedSuccessedToReStartState ,
- SuspendedErroredToReStartState ,
- ReRunnedState ,
- ReStartedState ,
- NumberOfAutomatonStates
- } ;
-
-
-
-
-
-
-
-
- ////////////////
-/*! \brief interface %SuperG
-
-This interface contains a set of methods necessary for management of a %graph.
-*/
- interface SuperG : Engines::Component, SALOMEDS::Driver {
- ////////////////
-/*!
- Constructs a graph with possibility to read/edit it
- \param aGraph %aGraphName or %aGraphXmlFile
-*/
- SUPERV::Graph Graph(in string aGraph ) ; // aGraphName or aGraphXmlFile
-
-/*!
- Constructs a read Only graph ( for execution ).
- \note <BR>In this graph there is also a possibility to update nodes, coordinates of the links,
- of container names and input data.
- \param aGraph %aGraphName or %aGraphXmlFile
-*/
- SUPERV::Graph GraphE(in string aGraph ) ; // aGraphName or aGraphXmlFile
-
-/*!
-Creates a value for %Input method in interface %Node.
-*/
- SUPERV::Value StringValue( in string aString ) ;
- SUPERV::Value AnyValue( in any anAny ) ;
-/*!
- Gets a graph from its %IOR
-*/
- SUPERV::Graph getGraph(in string ior); // get Graph from is IOR
-
- };
-
-/*! \brief Interface of a node
-
-This interface includes a set of methods used for management of the nodes in the graph.
-*/
-
- //////////////
- interface CNode : Engines::Component {
- //////////////
-
-
-/*!
-Returns the name of the node(graph).
-*/
- string Name() ;
-/*!
-Returns the service of this node .
-*/
- SALOME_ModuleCatalog::Service Service() ;
-/*!
-Returns the type of the node.
-*/
- SUPERV::KindOfNode Kind() ;
-/*!
-Returns the date of creation of the node(graph).
-*/
- SUPERV::SDate CreationDate() ;
-/*!
-Returns the date of last update of the node(graph).
-*/
- SUPERV::SDate LastUpdateDate() ;
-/*!
-Returns the name of the version of the node(graph).
-*/
- string Version() ;
-/*!
-Returns the name of the author of the node(graph).
-*/
- string Author() ;
-/*!
-Returns the string containing comments about this node(graph).
-*/
- string Comment() ;
-
-
-/*!
-Sets the name of the node(graph). Returns True if it is updated.
-*/
- boolean SetName(in string aNewName ) ;
-/*!
-Sets the name of the author. Returns True if it is updated.
-*/
- boolean SetAuthor(in string anAuthor ) ;
-/*!
-Allows to update the comments about this node(graph).
-*/
- boolean SetComment(in string aComment ) ;
-
-/*!
- Gets a port of the node.
-*/
- SUPERV::Port Port( in string aParameterName ) ;
-
-/*!
- Enters a value into an Input %Port
-*/
- SUPERV::Port Input( in string InputParameterName ,
- in Value aValue ) ;
-
-
- // Create an Input %Port and an Output Port in LabelNode or ControlNode
- // boolean BusPort( in string InOutParameterName ,
- // in string InOutParameterType ,
- // out SUPERV::Port InputPort ,
- // out SUPERV::Port OutputPort ) ;
- // boolean BusPorts( in string InputParameterName ,
- // in string InputParameterType ,
- // in string OutputParameterName ,
- // in string OutputParameterType ,
- // out SUPERV::Port InputPort ,
- // out SUPERV::Port OutputPort ) ;
-
-/*!
- Gets a list of ports of the node(graph)
-*/
- SUPERV::ListOfPorts Ports() ;
-
- // Get list of Links
- SUPERV::ListOfLinks Links() ;
-
-/*!
-Returns True if this node is a graph.
-\note <BR>A node of the graph can also represent in its turn another graph.
-*/
- boolean IsGraph() ;
-/*!
-Returns True if the node appears to be a %computing node.
-*/
- boolean IsComputing() ;
- boolean IsFactory() ;
- boolean IsInLine() ;
- boolean IsGOTO() ;
- boolean IsLoop() ;
- boolean IsEndLoop() ;
- boolean IsSwitch() ;
- boolean IsEndSwitch() ;
-
-/*!
- Returns the number of SubGraphs
-*/
- long SubGraph() ;
-
-/*!
-Returns nuber of threads.
-*/
- long Thread() ;
-
-/*!
- Returns True if the node(graph) is waiting for Data input
-*/
- boolean IsWaiting() ;
-
-/*!
- Returns True if the node(graph) is ready for execution
-*/
- boolean IsReady() ;
-
- /*!
- Returns True if the node(graph) is running
-*/
- boolean IsRunning() ;
-
-/*!
- Returns True if execution is finished
-*/
-
- boolean IsDone() ;
-/*!
- Returns True if execution is suspended
-*/
-
- boolean IsSuspended() ;
-/*!
-Returns the current state of the graph.
-*/
- SUPERV::GraphState State() ;
-
- // wait for ready_to_run state, Suspend and return
- boolean ReadyW() ;
-
- // wait for running state, Suspend and return
- boolean RunningW() ;
-
- // wait for done state, Suspend and return
- boolean DoneW() ;
-
- // wait for Suspend state and return
- boolean SuspendedW() ;
-
- // boolean Ping();
-
- // if not running : will be killed when ready to run
- // if running : Kill immediatly
- boolean Kill();
-
- // will be killed only just after running (only for nodes)
- boolean KillDone();
-
- // if not running : will be stopped when ready to run
- // if running : Stop immediatly
- boolean Stop();
-
- // if not running : will be Suspended when ready to run
- // if running : Suspend immediatly
- boolean Suspend();
-
- // will be Suspended only just after running
- boolean SuspendDone();
-
- // if Suspended : running will continue
- // if not Suspended : cancel current ControlState ( Suspend, Kill, ...)
- boolean Resume();
-
-/*!
- Restarts execution of the node(graph).
-*/
- boolean ReRun();
-/*!
-Restarts execution of the graph beginning from a definite node.
-*/
- boolean ReRunAt( in string aNodeName );
-
-/*!
- Restarts and suspends execution of the node(graph).
-*/
- boolean ReStart();
-/*!
-Restarts and suspends execution of the graph beginning from a definite node.
-*/
- boolean ReStartAt( in string aNodeName );
-
-/*!
- Returns automaton execution state of the node(graph).
-*/
- SUPERV::AutomatonState AutoState() ;
-
- // Control state required : Kill, Suspend, Stop
- SUPERV::ControlState Control() ;
-/*!
-Clears the control state of the node(graph).
-*/
- void ControlClear() ;
-
- boolean ContainerKill();
-/*!
-Sets the position of the node in the window.
-*/
- void Coords( in long X , in long Y ) ;
-/*!
-Returns the position of the node along X-axis.
-*/
- long X() ;
-/*!
-Returns the position of the node along Y-axis.
-*/
- long Y() ;
-
- long CpuUsed() ;
-
- } ;
-
- //////////////
- interface FNode : CNode {
- //////////////
-
- string GetComponentName() ;
- string GetInterfaceName() ;
- string GetContainer() ;
- boolean SetComponentName(in string aComponentName ) ;
- boolean SetInterfaceName(in string anInterfaceName ) ;
- boolean SetContainer(in string aContainer ) ;
- } ;
-
- // InLine Nodes
- //////////////
- interface INode : CNode {
- //////////////
-
- void SetPyFunction( in string FuncName ,
- in SUPERV::ListOfStrings aPyInitFunction ) ;
- SUPERV::ListOfStrings PyFunction() ;
- string PyFuncName() ;
-
- // Create Input/Output Port in InLineNodes
- SUPERV::Port InPort( in string aParameterName , in string aParameterType ) ;
- SUPERV::Port OutPort( in string aParameterName , in string aParameterType ) ;
- } ;
-
- // GOTO/EndLoop/EndSwitch Nodes
- ///////////////
- interface GNode : INode {
- ///////////////
-
- boolean SetCoupled( in string anInLineNode ) ;
- SUPERV::INode Coupled() ;
- } ;
-
- // Loop Nodes
- ///////////////
- interface LNode : GNode {
- ///////////////
-
- void SetPyInit( in string MoreName ,
- in SUPERV::ListOfStrings aPyMoreFunction ) ;
- SUPERV::ListOfStrings PyInit() ;
- string PyInitName() ;
-
- void SetPyMore( in string MoreName ,
- in SUPERV::ListOfStrings aPyMoreFunction ) ;
- SUPERV::ListOfStrings PyMore() ;
- string PyMoreName() ;
-
- void SetPyNext( in string NextName ,
- in SUPERV::ListOfStrings aPyNextFunction ) ;
- SUPERV::ListOfStrings PyNext() ;
- string PyNextName() ;
-
- } ;
-
- // EndOfLoop Nodes
- ////////////////
- interface ELNode : GNode {
- ////////////////
- } ;
-
- // Switch Nodes
- ///////////////
- interface SNode : GNode {
- ///////////////
- } ;
-
- // EndOfSwitch Nodes
- ////////////////
- interface ESNode : GNode {
- ////////////////
- } ;
-
-/*! \brief Interface of a graph
-
-This interface includes a set of methods used for management of the graphs in %SUPERVISION module.
-*/
-
- ///////////////
- interface Graph : INode {
- ///////////////
-
- // Create a Computing Node in a Graph
- SUPERV::CNode CNode( in SALOME_ModuleCatalog::Service aService ) ;
-
- // Create a Factory Node in a Graph
- SUPERV::FNode FNode( in string aComponentName ,
- in string anInterfaceName ,
- in SALOME_ModuleCatalog::Service aService ) ;
-
- // Create an InLine Node in a Graph
- SUPERV::INode INode( in string FuncName , in ListOfStrings aPythonFunction ) ;
-
- // Create a GOTO node and link to the corresponding InLine node
- SUPERV::GNode GNode( in string FuncName , in ListOfStrings aPythonFunction ,
- in string anINode ) ;
-
- // Create a "for" or "while" node and the corresponding end of loop node
- SUPERV::LNode LNode( in string InitName , in ListOfStrings InitFunction ,
- in string MoreName , in ListOfStrings MoreFunction ,
- in string NextName , in ListOfStrings NextFunction ,
- out SUPERV::INode anEndOfLoop ) ;
-
- // Create a "if/elseif/else" or "switch" node and the corresponding end node
- SUPERV::SNode SNode( in string FuncName , in ListOfStrings aPythonFunction ,
- out SUPERV::INode anEndOfSwitch ) ;
-
- // Create a CORBA Component Object Reference
- Engines::Component ComponentRef( in string aComputerContainer ,
- in string aComponentName ) ;
-
-/*!
- Creates a link connecting two ports (%Output %Port and %Input %Port) of the nodes in a Graph
-*/
- SUPERV::Link Link( in SUPERV::Port OutputPort ,
- in SUPERV::Port InputPort ) ;
-
-/*!
-Imports a graph into a file with XML format
-*/
- boolean Import( in string anXmlFile ) ;
-/*!
-Exports a graph from a file with XML format
-*/
- boolean Export( in string anXmlFile ) ;
-/*!
-Returns True if the graph is read Only.
-*/
- boolean IsReadOnly() ;
-
-/*!
- Starts asynchronous execution of the graph.
-*/
- boolean Run() ;
-
-/*!
- Assigns to the %Node an %Event and a %State of the %Node, if the Event is
- available. And returns immediately Nil, NoEvent and NoState if not.
- Returns false if the graph is finished, suspended, killed or stopped.
-\param aNode %Node for which this method is called
-\param anEvent An operation, which has been performed on this node(graph).
-\param aState Current state of the graph
-*/
- boolean EventNoW( out SUPERV::CNode aNode , out SUPERV::GraphEvent anEvent ,
- out SUPERV::GraphState aState ) ;
-
-/*!
- Assigns to the %Node an %Event and a %State of the %Node, if the Event is
- available. Waits if it is not available at the current moment.
- Returns false if the graph is finished, suspended, killed or stopped.
-\param aNode %Node for which this method is called
-\param anEvent An operation, which has been performed on this node(graph).
-\param aState Current state of the graph
-*/
- boolean Event( out SUPERV::CNode aNode , out SUPERV::GraphEvent anEvent ,
- out SUPERV::GraphState aState ) ;
-
- // Same as Event but execution of the thread is suspended between the
- // return of EventW and the next call to EventW
-/*!
- Assigns to the %Node an %Event and a %State of the %Node, if the Event is
- available. And returns immediately Nil, NoEvent and NoState if not.
- Returns false if the graph is finished, suspended, killed or stopped.
-\note <BR>Execution of the thread is suspended between the return of this
-method and its next usage.
-\param aNode %Node for which this method is called
-\param anEvent An operation, which has been performed on this node(graph).
-\param aState Current state of the graph
-*/
- boolean EventW( out SUPERV::CNode aNode , out SUPERV::GraphEvent anEvent ,
- out SUPERV::GraphState aState ) ;
-
- long LevelMax() ;
- SUPERV::ListOfNodes LevelNodes( in long aLevel ) ;
- long ThreadsMax() ;
-/*!
-Returns the number of independent subgraphs
-*/
- long GraphsNumber() ;
-/*!
-Returns the number of currently running threads.
-*/
- long Threads();
-/*!
-Returns the number of suspended threads.
-*/
- long SuspendedThreads();
-/*!
-Returns True if the graph is valid.
-*/
- boolean IsValid() ;
-/*!
-Returns True if the graph can be executed.
-*/
- boolean IsExecutable() ;
-/*!
-Returns True if the graph represents a working algorithm.
-*/
- boolean IsDataFlow() ;
-
-/*!
-Returns True if the graph is being currently edited.
-*/
- boolean IsEditing() ;
-/*!
-Returns True if the graph is being currently executed.
-*/
- boolean IsExecuting() ;
-
- long LastLevelDone() ;
-
-/*!
- Launches step-by-step execution of the graph.
-\note The execution is suspended immediatly after performance of operations of the first node and
-user can specify the nodes, where execution will be again suspended after its resuming.
-*/
- boolean Start() ;
-/*!
-Allows to copy one graph into another.
-*/
- SUPERV::Graph Copy() ;
-/*!
-Merges two graphs
-*/
- boolean Merge( in Graph aGraph ) ;
-/*!
-Returns a list of nodes of the graph.
-*/
- SUPERV::ListOfNodes Nodes() ;
-/*!
-Returns a list of links of the graph.
-*/
- SUPERV::ListOfLinks GLinks() ;
-/*!
-Gets IOR of the garph.
-*/
- string getIOR();
-
-/*!
-Returns a list of graphs.
-\note Not implemented
-*/
- SUPERV::ListOfGraphs Graphs() ;
-
- } ;
-
-
-
-
-
-/*! \brief Interface of the %link
-
-This interface contains a set of methods used for representation and management of the links
-connecting nodes in a %graph.
-*/
-
- //////////////
- interface Link : Engines::Component {
- //////////////
-/*!
-Associates an %Output %Port to the Link
-*/
- SUPERV::Port OutPort() ;
-
-/*!
-Associates an %Input %Port to the Link
-*/
- SUPERV::Port InPort() ;
-
- // For GUI :
-/*! \name Methods used for representation of links in GUI of %SALOME application :
-*/
-/*@{*/
-/*!
-Returns the number of coordinate points which are included in the link.
-\note <BR>Every link can contain a set of coordinate points which constitute it. These points have
-index numbers (beginning from 1) and coordinates defining their position in the window. Indexing of
-the points starts from input port to output port of the corresponding link.
-*/
- long CoordsSize() ;
-/*!
-Adds a coordinate point to the link.
-\param index Index of the point.
-\param X Coordinates of the point.
-\param Y Coordinates of the point.
-*/
- boolean AddCoord( in long index , in long X , in long Y ) ;
-/*!
-Changes the location of a definite coordinate point of the link.
-\param index Index of the point.
-\param X Coordinates of the point.
-\param Y Coordinates of the point.
-*/
-
- boolean ChangeCoord( in long index , in long X , in long Y ) ;
-/*!
-Removes a coordinate point of the link.
-\param index Index of the point.
-*/
-
- boolean RemoveCoord( in long index ) ;
-
-/*!
-Sets the location of a coordinate point of the link.
-\param index Index of the point.
-\param X Coordinates of the point.
-\param Y Coordinates of the point.
-*/
-
- boolean Coords( in long index , out long X , out long Y ) ;
-/*@}*/
-
- // void Destroy() ;
-
- } ;
-
-/*! \brief %Value interface
-
-This interface contains a set of methods used for setting initial parameters of the ports
-*/
-
- ///////////////
- interface Value : Engines::Component {
- ///////////////
-/*!
-Converts the given value into a value of string type.
-*/
- string ToString() ;
-/*!
-Converts the given value into a value of independant data type.
-*/
- any ToAny() ;
-/*!
-Returns True if the value represents an IOR.
-*/
- boolean IsIOR() ;
-/*!
-Gets data type of the component.
-*/
- string ComponentDataType() ;
-
- // void Destroy() ;
-
- } ;
-/*! \brief %Port interface
-
-This interface contains a set of methods used for management of the ports.
-*/
-
- //////////////
- interface Port : Value {
- //////////////
-
-/*!
- Gives a value to an Input %Port
-*/
- boolean Input( in SUPERV::Value aValue ) ;
-
-/*!
-Returns the node of the port
-*/
- SUPERV::CNode Node() ;
-/*!
-Sets the name of the port.
-*/
- string Name() ;
-
- // Type of a Port
- string Type() ;
-
- // Link of an Input Port
-/*!
-Returns the link of an %Input %Port
-*/
- SUPERV::Link Link() ;
-
-/*!
-Returns a list of links of an Input %Port of an EndSwitchNode
-*/
- SUPERV::ListOfLinks Links() ;
-
-/*!
-Returns True if this port appears to be an %Input %Port of a Node
-*/
- boolean IsInput() ;
-
-/*!
-Returns True if an %Input %Value exists for that %Input %Port (without link)
-*/
- boolean HasInput() ;
-
-/*!
-Returns True if the %Port is linked (without value)
-*/
-// Port with link (without Value)
- boolean IsLinked() ;
-
- // Kind of a Port
- SUPERV::KindOfPort Kind() ;
-
- // Port from the service of the node
-/*!
-Returns True if the %Port is a parameter of a service
-*/
- boolean IsParam() ;
- // Port is a Gate of the node
-/*!
-Returns True if the %Port appears to be a GatePort of the node
-*/
- boolean IsGate() ;
- // Port is a parameter of an InLineNode
- boolean IsInLine() ;
- // Port is a LoopParameter (InitLoop or DoLoop) of an LoopNode
- boolean IsLoop() ;
- // Port is an output parameter of a SwitchNode connected to an InGate
-/*!
-Returns True if the %Port appears to be a parameter of a switch node
-*/
- // Port is a parameter of a switch node
- boolean IsSwitch() ;
- // Port is an Input parameter of a EndSwitchNode connected to several output ports
- boolean IsEndSwitch() ;
-
- SUPERV::GraphState State() ;
- boolean IsDone() ;
-
- } ;
-
-};
-#endif
+++ /dev/null
-// 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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
-//
-//
-//
-// File : SubComponent.idl
-// Author :
-// $Header$
-
-#ifndef _SUBCOMPONENT_IDL
-#define _SUBCOMPONENT_IDL
-
-#include "SALOME_Component.idl"
-
-module SuperVisionTest {
-
- interface SubComponent : Engines::Component {
- void Sub( in double x , in double y , out double z ) ;
- } ;
-};
-
-
-#endif
+++ /dev/null
-// 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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
-//
-//
-//
-// File : SyrComponent.idl
-// Author :
-// $Header$
-
-#ifndef _SYRCOMPONENT_IDL
-#define _SYRCOMPONENT_IDL
-
-#include "SALOME_Component.idl"
-
-module SuperVisionTest {
-
- typedef sequence<long> SeqOfSyr ;
-
- interface ListOfSyr ;
-
- interface Syr ;
-
- interface SyrComponent : Engines::Component {
-
- long C_ISEVEN( in long anInteger ) ;
- long C_ISONE( in long anOddInteger ) ;
- long C_M3( in long anOddInteger ) ;
- long C_M3P1( in long anOddInteger ) ;
- long C_DIV2( in long anEvenInteger ) ;
- long C_INCR( in long aCount ) ;
- long C_MIN( in long aMinVal , in long anInteger ) ;
- long C_MAX( in long aMaxVal , in long anInteger ) ;
- ListOfSyr C_LISTOFSYR() ;
- ListOfSyr C_AVERAGE( in ListOfSyr aListOfSyr , in long anInteger ,
- in long aCount , out double anAverage ) ;
-
- Syr Init( in long anOddInteger ) ;
-
- };
-
- interface ListOfSyr : Engines::Component {
- SuperVisionTest::SeqOfSyr GetSeqOfSyr() ;
- void SetSeqOfSyr( in SuperVisionTest::SeqOfSyr aSeqOfSyr ) ;
- };
-
- interface Syr : SyrComponent {
-
- long Initial() ;
- long Current() ;
- long IsEven() ;
- long IsOne() ;
- long Count() ;
- void M3p1() ;
- void Div2() ;
- void Incr() ;
-
- };
-
-} ;
-
-#endif
+++ /dev/null
-// Copyright (C) 2003 CEA/DEN, EDF R&D
-//
-//
-//
-// File : SyrControlComponent.idl
-// Author : Jean Rahuel
-// $Header:
-
-#ifndef _SYRCONTROLCOMPONENT_IDL
-#define _SYRCONTROLCOMPONENT_IDL
-
-#include "SALOME_Component.idl"
-
-module SuperVisionTest {
-
- interface SyrControlComponent : Engines::Component {
-
- void L_OneEven( in long ValOne , in long ValEven ,
- out long Finished , out long Incr ,
- out long Even , out long Odd ) ;
-
- void C_NotOneIsEven( out long ValOne , out long ValEven ) ;
-
- void LOOPN( in long InLoop , in long NN , in long KK ,
- in long min , in long max ,
- out long OutLoop , out long N , out long K ) ;
-
- void WHILENOTONE( in long N , out long OutLoop ) ;
-
- void IFNOTEVEN( in long N , out long Odd , out long Even ) ;
-
- void LOOPi( in long InLoop , in long ii , out long OutLoop , out long i ) ;
-
- void WHILEEVEN( in long N , out long OutLoop ) ;
-
- };
-
-};
-#endif
+++ /dev/null
-// 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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
-//
-//
-//
-// File : TestNotif.idl
-
-# ifndef __TESTNOTIF_IDL_
-# define __TESTNOTIF_IDL_
-
-interface Solver
-{
- boolean Connect();
- oneway void Start() ;
- oneway void ReStart() ;
-} ;
-# endif
+++ /dev/null
-// 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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
-//
-//
-//
-// File : TypeData.idl
-
-#ifndef _SALOME_TYPEDATA_IDL_
-#define _SALOME_TYPEDATA_IDL_
-
-module Engines
-{
-
- typedef sequence<double> DoubleVec ;
- typedef sequence<long> IntVec;
-
- typedef struct CSR {
- unsigned long nbpos;
- unsigned long nbval;
- IntVec pos;
- IntVec col;
- DoubleVec data;
- } CSRMatStruct;
-
-} ;
-
-#endif
-
+++ /dev/null
-// Copyright (C) 2003 CEA/DEN, EDF R&D
-//
-//
-//
-// File : VISU_Gen.idl
-// Author : Alexey Petrov
-
-/*! \file VISU_Gen.idl This file conatins a set of interfaces of %VISU module.
- This module will provide various forms of data visualization in %SALOME application.
- These forms include data tables, XY plots, 3d representations
- and combination of these forms.
-*/
-/*!
- \defgroup Visu SALOME VISU module
-*/
-
-#ifndef __VISU_GEN__
-#define __VISU_GEN__
-
-#include "SALOME_Exception.idl"
-#include "SALOME_Component.idl"
-#include "SALOMEDS.idl"
-#include "SALOMEDS_Attributes.idl"
-#include "MED.idl"
-
-/*! \ingroup Visu
- The main package of interfaces of the module %VISU.
-*/
-module VISU {
- //-------------------------------------------------------
- typedef string IdType;
- enum Scaling{ LINEAR, LOGARITHMIC};
- enum Entity{ NODE, EDGE, FACE, CELL};
- //enum Entity{ CELL, FACE, EDGE, NODE};
-/*!
- This enumeration contains a set of elements defining the type of the module.
-*/
- enum VISUType{ TNONE,
- TCURVE, TTABLE, TCONTAINER, TMESH, TSCALARMAP,
- TISOSURFACE, TDEFORMEDSHAPE, TCUTPLANES, TCUTLINES, TVECTORS, TSTREAMLINES,
- TVISUGEN, TVIEWMANAGER, TRESULT,
- TXYPLOT, TTABLEVIEW, TVIEW3D,
- TENTITY, TFAMILY, TGROUP, TFIELD, TTIMESTAMP,
- TALL};
- interface Base {
-/*!
- Returns ID of the object.
-*/
- IdType GetID();
-/*!
-Returns the type of the presentable object
-*/
- VISUType GetType();
- };
-/*! \brief Presentable object interface
-
- It is the root class of all presentable objects.
-*/
- interface PrsObject : Base{
- };
- //-------------------------------------------------------
-/*! \brief %Table representation interface
-
-Presentation parameters of the %Table view.
-*/
- interface Table : PrsObject {
-/*!
-Sets the title of the table.
-*/
- void SetTitle(in string theTitle);
-/*!
-Gets the title of the table.
-*/
- string GetTitle();
-/*!
- This enumeration contains a set of elements defining the orientation of the table.
-*/
- enum Orientation{ HORIZONTAL, /*!<Horizontal orientation of the table.*/
- VERTIACAL /*!<Vertical orientation of the table.*/
- };
-/*!
-Sets orientation of the table.
-*/
- void SetOrientation(in Orientation theOrientation);
-/*!
-Gets orientation of the table.
-*/
- Orientation GetOrientation();
- /*!
-Gets the number of rows of the table
- */
- long GetNbRows();
- /*!
-Gets the number of columns of the table
- */
- long GetNbColumns();
- };
- //-------------------------------------------------------
-/*! \brief Interface of curve representation.
-
-Manages presentation parameters of one curve.
-It can be used for presentation of a set of curves using a combined presentation.
-*/
- interface Curve : PrsObject{
-/*!
-Sets the title of the curve.
-*/
- void SetTitle(in string theTitle);
-/*!
-Gets the title of the curve.
-*/
- string GetTitle();
-/*!
-Sets the color of the curve.
-*/
- void SetColor(in SALOMEDS::Color theColor);
-/*!
-Gets the color of the curve.
-*/
- SALOMEDS::Color GetColor();
- /*!
- This enumeration contains a set of elements defining the representation type of markers (data points) with help of
-which the curve is constructed on the graphics.
-*/
- enum MarkerType{ NONE, CIRCLE, RECTANGLE, DIAMOND,
- DTRIANGLE, UTRIANGLE, LTRIANGLE, RTRIANGLE,
- CROSS, XCROSS };
-/*!
-Sets the representation type of markers (data points) with help of
-which the curve is constructed on the graphics.
-*/
- void SetMarker(in MarkerType theType);
-/*!
-Gets the representation type of markers (data points) with help of
-which the curve is constructed on the graphics.
-*/
- MarkerType GetMarker();
-/*!
- This enumeration contains a set of elements defining the
- type of representation of curve lines on the graphics.
-*/
- enum LineType{ VOIDLINE, SOLIDLINE, DASHLINE, DOTLINE, DASHDOTLINE, DASHDOTDOTLINE};
-/*!
-Sets the type of representation of curve lines on the graphics.
-*/
- void SetLine(in LineType theType, in long theLineWidth);
-/*!
-Gets the type of representation of curve lines on the graphics.
-*/
- LineType GetLine();
-
-/*!
-Gets the width of the curve line.
-*/
- long GetLineWidth();
- };
-//-------------------------------------------------------
-/*! \brief The %Container presentable object interface
-This interface contains a set of methods used for management of a group of curves
-which are stored in the container.
-*/
- interface Container : PrsObject{
-/*!
-Adds a curve into the container.
-*/
- void AddCurve(in Curve theCurve);
-/*!
-Removes a curve from the container.
-*/
- void RemoveCurve(in Curve theCurve);
-/*!
-Gets the number of curves which are stored in the container.
-*/
- long GetNbCurves();
-/*!
-Removes all curves from the container.
-*/
- void Clear();
-
- };
- //-------------------------------------------------------
- interface Prs3d : PrsObject{
- void Destroy();
- };
-/*!
- This enumeration contains a set of elements defining the
- type of representation of the mesh.
-*/
-
- enum PresentationType{ POINT,
- WIREFRAME,
- SHADED,
- SHRINK
- };
-/*! \brief Interface of the mesh.
-
-This interface manages the presentation parameters of the mesh.
-*/
- interface Mesh : Prs3d{
-/*!
-Sets the color of mesh cells.
-*/
- void SetCellColor(in SALOMEDS::Color theColor);
-/*!
-Gets the color of mesh cells.
-*/
- SALOMEDS::Color GetCellColor();
-/*!
-Sets the color of mesh nodes.
-*/
- void SetNodeColor(in SALOMEDS::Color theColor);
-/*!
-Gets the color of mesh nodes.
-*/
- SALOMEDS::Color GetNodeColor();
-
-/*!
-Sets the color of mesh links.
-*/
- void SetLinkColor(in SALOMEDS::Color theColor);
-/*!
-Gets the color of mesh links.
-*/
- SALOMEDS::Color GetLinkColor();
-/*!
-Sets the type of representation of the mesh.
-*/
- void SetPresentationType(in PresentationType theType);
-/*!
-Gets the type of representation of the mesh.
-*/
- PresentationType GetPresentationType();
- };
- //-------------------------------------------------------
-/*! \brief Interface of the %Scalar Map presentation
-
-This interface contains presentation parameters of the ScalarMap presentation
-*/
- interface ScalarMap : Prs3d{
- void SetScalarMode(in long theScaling);
- long GetScalarMode();
- void SetScaling(in Scaling theScaling);
-/*!
-Gets the type of scaling of the values reflected by this presentation.
-*/
- Scaling GetScaling();
-/*!
-Sets scalar range - min and max boundaries of this presentable object.
-\param theMin Min boundary of this presentable object.
-\param theMax Max boundary of this presentable object.
-*/
- void SetRange(in double theMin, in double theMax);
-/*!
- Gets the min boundary of this presentable object.
-*/
- double GetMin();
-/*!
- Gets the max boundary of this presentable object.
-*/
- double GetMax();
-
-/*! %Orientation of this presentable object. */
- enum Orientation{
- HORIZONTAL, /*!< Horizontal orientation of this presentable object.*/
- VERTICAL /*!< Vertical orientation of this presentable object.*/
- };
-/*!
- Sets the type of orientation of this presentable object.
-*/
- void SetOrientation(in Orientation theOrientation);
-/*!
- Gets the type of orientation of this presentable object.
-*/
- Orientation GetOrientation();
-
-/*! \brief Position of this presentable object.
-
-Sets the position of this presentable object origin on the screen.
-\param X Horizontal position. The value can be between 0 and 1.
-\param Y Vertical position. The value can be between 0 and 1.
-*/
- void SetPosition(in double X, in double Y);
-/*!
- Gets horizontal position of this presentable object origin.
-*/
- double GetPosX();
-/*!
- Gets vertical position of this presentable object origin.
-*/
- double GetPosY();
-/*! \brief Size of this presentable object.
-
-Sets the size of the scalar bar.
-\param theWidth Width of this presentable object. The value can be between 0 and 1.
-\param theHeight Height of this presentable object. The value can be between 0 and 1.
-*/
- void SetSize(in double theWidth, in double theHeight);
-/*!
-Gets the width of this presentable object.
-*/
- double GetWidth();
-/*!
-Gets the height of this presentable object.
-*/
- double GetHeight();
-/*!
-Sets the number of colors which will be used for presentation of this presentable object.
-*/
- void SetNbColors(in long theNbColors);
-/*!
-Gets the number of colors which will be used for presentation of this presentable object.
-*/
- long GetNbColors();
-/*!
-Sets the number of labels which will be used for indication of the gradation
- of this presentable object.
-*/
- void SetLabels(in long theNbLabels);
-/*!
-Gets the number of labels which will be used for indication of the gradation
- of this presentable object.
-*/
- long GetLabels();
-/*!
-Sets the title of this presentable object. For scalar bar by default - the name of the selected result is used.
-*/
- void SetTitle(in string theName);
-/*!
-Gets the title of this presentable object.
-*/
- string GetTitle();
- };
- //-------------------------------------------------------
-/*! \brief Deformed shape presentation interface
-
-Presentation parameters of the deformed shape presentation.
-*/
- interface DeformedShape : ScalarMap{
-/*!
-Sets the scale of the presentatable object.
-*/
- void SetScale(in double theScale);
-/*!
-Gets the scale of the presentatable object.
-*/
- double GetScale();
- };
- //-------------------------------------------------------
-/*! \brief Cut planes interface
-
-Presentation parameters of Cut planes presentation.
-*/
- interface CutPlanes : ScalarMap{
-/*!
- This enumeration contains a set of elements defining the orientation in 3D space
- of cut planes presentation.
-*/
- enum Orientation {XY, YZ, ZX};
-/*!
-Sets the type of orientation in 3D space of cut planes presentation.
-*/
- void SetOrientationType(in Orientation theNb);
-/*!
-Gets the type of orientation in 3D space of cut planes presentation.
-*/
- Orientation GetOrientationType();
- void SetDisplacement(in double theDisp);
- double GetDisplacement();
-/*!
-Sets the number of cut planes.
-*/
- void SetNbPlanes(in long theNb);
-/*!
-Gets the number of cut planes.
-*/
- long GetNbPlanes();
-/*! Rotation around X-axis.
-Sets rotation angle of the cut plane presentation.
-*/
- void SetRotateX(in double theAngle);
-/*! Rotation around X-axis.
-Gets rotation angle of the cut plane presentation.
-*/
- double GetRotateX();
-/*! Rotation around Y-axis.
-Sets rotation angle of the cut plane presentation.
-*/
- void SetRotateY(in double theAngle);
-/*! Rotation around Y-axis.
-Sets rotation angle of the cut plane presentation.
-*/
- double GetRotateY();
- };
- //-------------------------------------------------------
- /*! \brief Interface of the stream lines representation
- This interface contains presentation parameters of
- stream lines presentations.
- */
-/*! \brief Cut lines interface
-
-Presentation parameters of Cut lines presentation.
-*/
- interface CutLines : ScalarMap{
-
- void SetOrientationType(in CutPlanes::Orientation theNb);
- void SetOrientationType2(in CutPlanes::Orientation theNb);
-
- CutPlanes::Orientation GetOrientationType();
- CutPlanes::Orientation GetOrientationType2();
-
- void SetDisplacement(in double theDisp);
- void SetDisplacement2(in double theDisp);
-
- double GetDisplacement();
- double GetDisplacement2();
-
- void SetNbLines(in long theNb);
- long GetNbLines();
-
- void SetRotateX(in double theAngle);
- void SetRotateX2(in double theAngle);
-
- double GetRotateX();
- double GetRotateX2();
-
- void SetRotateY(in double theAngle);
- void SetRotateY2(in double theAngle);
-
- double GetRotateY();
- double GetRotateY2();
- };
-
- interface StreamLines : DeformedShape{
- enum Direction{ FORWARD,
- BACKWARD,
- BOTH
- };
-
- void SetDirection(in Direction theDirection);
- Direction GetDirection();
-
- void SetStepLength(in double theStep);
- double GetStepLength();
-
- void SetPropagationTime(in double theTime);
- double GetPropagationTime();
-
- void SetIntegrationStep(in double theStep);
- double GetIntegrationStep();
-
- void SetSource(in Prs3d thePrs3d);
- Prs3d GetSource();
-
- void SetUsedPoints(in double thePercents);
- double GetUsedPoints();
- };
-
-
-/*! \brief Interface of the isometric surface representation
-
- This interface contains presentation parameters of
- isometric surface presentations.
-*/
- interface IsoSurfaces : ScalarMap{
-/*!
- Sets the number of isometric surfaces.
-*/
- void SetNbSurfaces(in long theNb);
-/*!
- Gets the number of isometric surfaces
-*/
- long GetNbSurfaces();
- };
- //-------------------------------------------------------
-/*! \brief Interface of the vector presentation.
-
-This interface contains presentation parameters of the vector.
-*/
- interface Vectors : DeformedShape{
-/*!
-Sets the width of the line of the vector.
-*/
- void SetLineWidth(in double theWidth);
-/*!
-Gets the width of the line of the vector.
-*/
- double GetLineWidth();
-/*!
- This enumeration contains a set of elements defining the type of representation of the vector head.
-*/
- enum GlyphType{ ARROW,
- CONE2,
- CONE6,
- NONE
- };
-/*!
-Sets the type of representation of the vector head.
-*/
- void SetGlyphType(in GlyphType theType);
-/*!
-Gets the type of representation of the vector head.
-*/
- GlyphType GetGlyphType();
-/*!
- This enumeration contains a set of elements defining the position of the vector head.
-*/
-
- enum GlyphPos{ CENTER, /*!<In the center of the vector.*/
- TAIL, /*!<In the tail of the vector.*/
- HEAD /*!<In the head of the vector.*/
- };
-/*!
-Sets the position of the vector head.
-*/
- void SetGlyphPos(in GlyphPos thePos);
-/*!
-Gets the position of the vector head.
-*/
- GlyphPos GetGlyphPos();
- };
- //-------------------------------------------------------
- interface Animation : Base{
- void addField(in SALOMEDS::SObject theObject);
-
- void generatePresentations(in long theFieldNum);
- boolean generateFrames();
- void clearView();
-
- void startAnimation();
- void stopAnimation();
-
- void nextFrame();
- void prevFrame();
- void firstFrame();
- void lastFrame();
- void gotoFrame(in long theFrame);
-
- long getNbFields();
- long getNbFrames();
- boolean isRunning();
- long getCurrentFrame();
-
- ScalarMap getPresentation(in long theField, in long theFrame);
-
- void setPresentationType(in long theFieldNum, in VISUType theType);
- VISUType getPresentationType(in long theFieldNum);
-
- void setSpeed(in long theSpeed);
- long getSpeed();
-
- boolean isProportional();
-
- void setAnimationRange(in double theMin, in double theMax);
- double getMinRange();
- double getMaxRange();
- boolean isRangeDefined();
-
- void dumpTo(in string thePath);
-
- boolean isCycling();
-
- double getMinTime();
- double getMaxTime();
-
- void setProportional(in boolean theProp);
- void setCycling(in boolean theCycle);
- };
-
-/*! \brief Interface %Result
-
-This interface serves for inner representation of data generated in other sources. (MED object or file)
-This data is needed for further construction of graphical presentations.
-*/
- interface Result : Base {
- };
- //-------------------------------------------------------
- interface ViewManager;
- interface View3D;
-/*! \brief %VISU_Gen interface
-
-This is the main interface of %VISU component. It is necessary for creation of
-post-processing presentations from given %Result and %Table object reference, using the views
-provided by %ViewManager.
-*/
- interface VISU_Gen : Engines::Component, SALOMEDS::Driver, Base{
- void SetCurrentStudy(in SALOMEDS::Study theStudy);
- SALOMEDS::Study GetCurrentStudy();
-/*!
- Gets the %ViewManager which is used for creation of
- post-processing presentations.
-*/
- ViewManager GetViewManager();
-
-/*!
-Imports tables from a file and create TableAttribute in Sudy
-*/
- SALOMEDS::SObject ImportTables(in string theFileName);
-/*!
-Imports data from a file.
-*/
- Result ImportFile(in string theFileName);
-/*!
-Imports data from a %MED object.
-*/
- Result ImportMed(in SALOMEDS::SObject theMedSObject);
-/*!
-Imports data from a %MED field.
-*/
- Result ImportMedField(in SALOME_MED::FIELD theField);
-/*!
-Creates a %Mesh on the basis of the data generated in other sources (MED object or file).
-*/
- Mesh MeshOnEntity(in Result theResult, in string theMeshName, in Entity theEntity);
- Mesh FamilyMeshOnEntity(in Result theResult, in string theMeshName, in Entity theEntity, in string theFamilyName);
- Mesh GroupMesh(in Result theResult, in string theMeshName, in string theGroupName);
-/*!
-Creates a scalar bar presentation.
-\param theResult Data generated in other sources. (MED object or file)
-\param theMeshName One of the meshes presented in MED file
-\param theEntity Type of entity where the field is defined
-\param theFieldName Group of data attributed to the %MESH. The data can be scalar or vector.
-\param theIteration Number of iteration on the field
-*/
- ScalarMap ScalarMapOnField(in Result theResult, in string theMeshName, in Entity theEntity, in string theFieldName, in double theIteration);
-/*!
-Creates a deformed shape presentation.
-\param theResult Data generated in other sources. (MED object or file)
-\param theMeshName One of the meshes presented in MED file
-\param theEntity Type of entity where the field is defined
-\param theFieldName Group of data attributed to the %MESH. The data can be scalar or vector.
-\param theIteration Number of iteration on the field
-*/
- DeformedShape DeformedShapeOnField(in Result theResult, in string theMeshName, in Entity theEntity, in string theFieldName, in double theIteration);
-/*!
-Creates a vector presentation.
-\param theResult Data generated in other sources. (MED object or file)
-\param theMeshName One of the meshes presented in MED file
-\param theEntity Type of entity where the field is defined
-\param theFieldName Group of data attributed to the %MESH. The data can be scalar or vector.
-\param theIteration Number of iteration on the field
-*/
-
- Vectors VectorsOnField(in Result theResult, in string theMeshName, in Entity theEntity, in string theFieldName, in double theIteration);
-/*!
-Creates an iso surface presentation.
-\param theResult Data generated in other sources. (MED object or file)
-\param theMeshName One of the meshes presented in MED file
-\param theEntity Type of entity where the field is defined
-\param theFieldName Group of data attributed to the %MESH. The data can be scalar or vector.
-\param theIteration Number of iteration on the field
-*/
-
- IsoSurfaces IsoSurfacesOnField(in Result theResult, in string theMeshName, in Entity theEntity, in string theFieldName, in double theIteration);
-/*!
-Creates an stream lines presentation.
-\param theResult Data generated in other sources. (MED object or file)
-\param theMeshName One of the meshes presented in MED file
-\param theEntity Type of entity where the field is defined
-\param theFieldName Group of data attributed to the %MESH. The data can be scalar or vector.
-\param theIteration Number of iteration on the field
-*/
- StreamLines StreamLinesOnField(in Result theResult, in string theMeshName, in Entity theEntity, in string theFieldName, in double theIteration);
-
-/*!
-Creates a presentation of cut planes.
-\param theResult Data generated in other sources. (MED object or file)
-\param theMeshName One of the meshes presented in MED file
-\param theEntity Type of entity where the field is defined
-\param theFieldName Group of data attributed to the %MESH. The data can be scalar or vector.
-\param theIteration Number of iteration on the field
-*/
- CutPlanes CutPlanesOnField(in Result theResult, in string theMeshName, in Entity theEntity, in string theFieldName, in double theIteration);
-
-/*!
-Creates a presentation of cut lines.
-\param theResult Data generated in other sources. (MED object or file)
-\param theMeshName One of the meshes presented in MED file
-\param theEntity Type of entity where the field is defined
-\param theFieldName Group of data attributed to the %MESH. The data can be scalar or vector.
-\param theIteration Number of iteration on the field
-*/
- CutLines CutLinesOnField(in Result theResult, in string theMeshName, in Entity theEntity, in string theFieldName, in double theIteration);
-
-/*!
-Creates a table presentation.
-*/
- Table CreateTable(in string theTableEntry);
-/*!
-Creates a curve on the basis of points, whose values are taken from the table.
-\param theTable Table containing the data for construction of curves.
-\param HRow Index of the row in the table: abscissa of the point.
-\param VRow Index of the row in the table: ordinate of the point.
-*/
- Curve CreateCurve(in Table theTable, in long theHRow, in long theVRow);
-/*!
-Creates a presentation form containing an array of references to the curves.
-*/
- Container CreateContainer();
-
- Animation CreateAnimation(in View3D theView3d);
- };
-/*! \brief %View interface
-
- Contains a set of methods used by the %View frame, which can be one of
- the following types: 3d, Table, XY plot.
- %View interface is a base for all types of %view interfaces.
-*/
- interface View: Base{
-/*!
-Sets the title of the %View frame.
-*/
- void SetTitle(in string theTitle);
-/*!
-Gets the title of the %View frame.
-*/
- string GetTitle();
-/*!
-Sets background color of the %View frame.
-*/
- void SetBackground(in SALOMEDS::Color theColor);
-/*!
-Gets background color of the %View frame.
-*/
- SALOMEDS::Color GetBackground();
-/*!
-Minimizes to the task bar or to the bottom of the Desktop the %View frame.
-*/
- void Minimize();
-/*!
-Restores the %View frame.
-*/
- void Restore();
-/*!
-Maximizes the %View frame.
-*/
- void Maximize();
-/*!
-Removes all presentations (presentable objects) from the %view.
-*/
- void EraseAll();
-/*!
-Displays all presentations (presentable objects) in the %view.
-*/
- void DisplayAll();
-/*!
-Removes a definite presentation (presentable object) from the %view.
-*/
- void Erase(in PrsObject thePrsObj);
-/*!
-Displays a definite presentation (presentable object) in the %view.
-*/
- void Display(in PrsObject thePrsObj);
-/*!
-Allows to display only a definite presentation (presentable object) in the %view.
-All other presentations are removed from the %view.
-*/
- void DisplayOnly(in PrsObject thePrsObj);
-/*!
-Updates the view.
-*/
- void Update();
-
-/*!
-Saves the view.
-*/
- boolean SavePicture(in string theFileName);
- };
-
- //-------------------------------------------------------
-/*! \brief 3D view interface
-
-This interface contains a set of methods necessary for representation of objects in 3D space.
-*/
-
- interface View3D : View {
-/*!
-This enumeration contains a set of elements determining a predefined point of view
- (position of the camera in 3D space relative to the presentable object).
-*/
- enum ViewType{ FRONT, BACK, LEFT, RIGHT, TOP, BOTTOM};
-/*!
-This enumeration contains a set of elements determining the axis
-*/
- enum Axis{ XAxis, YAxis, ZAxis};
-/*!
-Data type defining coordinates in 3D space.
-*/
- typedef double XYZ[3];
-
-/*!
- Makes all presentations, which are currently present in the %view, completely visible.
-*/
-
- void FitAll();
-
-/*!
-Sets a predefined point of view (FRONT, BACK, LEFT, RIGHT, TOP, BOTTOM). (In other words it means
- a predefined position of the camera in 3D space with respect to the object which is represented.)
-*/
- void SetView(in ViewType theType);
-
-/*!
-Sets the position of the camera in 3D space. This point is used as the first point of the vector defining
-the view direction of the camera.
-*/
- void SetPointOfView(in XYZ theCoord);
-/*!
-Gets the position of the camera in 3D space.This point is used as the first point of the vector defining
-the view direction of the camera.
-*/
- XYZ GetPointOfView();
-/*!
-Sets the vertical line of the camera in 3D space.
-*/
- void SetViewUp(in XYZ theDir);
-/*!
-Gets the vertical line of the camera in 3D space.
-*/
- XYZ GetViewUp();
-/*!
-Sets the point of sight of the camera. This point is used as the second point of the vector defining
-the view direction of the camera.
-*/
- void SetFocalPoint(in XYZ theDir);
-/*!
-Gets the point of sight of the camera. This point is used as the second point of the vector defining
-the view direction of the camera.
-*/
- XYZ GetFocalPoint();
-/*!
-Zooming of the presentable object. Sets the scale.
-*/
- void SetParallelScale(in double theScale);
-/*!
-Zooming of the presentable object. Gets the scale.
-*/
- double GetParallelScale();
-/*!
-Scaling of the view along a definite axis.
-\param theAxis The axis of the scaling
-\param theParam The coefficient of the scaling
-*/
- void ScaleView(in Axis theAxis, in double theParam);
-/*!
-Removes the scaling of the view.
-*/
- void RemoveScale();
-/*!
-Returns True if the view parameters have been created, False if the parameters have been modified.
-*/
- boolean SaveViewParams(in string theName);
-/*!
-Returns True if the view parameters have been found and applied to the view,
-False if the parameters with this name don't exist.
-*/
- boolean RestoreViewParams(in string theName);
- };
-
-
- //-------------------------------------------------------
- interface TableView : View {
-
- };
-
-
- //-------------------------------------------------------
- interface XYPlot : View {
- void SetSubTitle(in string theTitle);
- string GetSubTitle();
-
- enum CurveType { POINTS, MULTYLINE, SPLINE};
- void SetCurveType(in CurveType theType);
- CurveType GetCurveType();
-
- void SetMarkerSize(in long theSize);
- long GetMarkerSize();
-
- void EnableXGrid(in boolean theMajor, in long theNumMajor, in boolean theMinor, in long theNumMinor);
- void EnableYGrid(in boolean theMajor, in long theNumMajor, in boolean theMinor, in long theNumMinor);
-
- void SetHorScaling(in Scaling theScaling);
- Scaling GetHorScaling();
- void SetVerScaling(in Scaling theScaling);
- Scaling GetVerScaling();
-
- void SetXTitle(in string theTitle);
- string GetXTitle();
-
- void SetYTitle(in string theTitle);
- string GetYTitle();
-
- void ShowLegend(in boolean theShowing);
-
- void FitAll();
- };
-
- //-------------------------------------------------------
-/*! \brief Interface of the %ViewManager
-
- The %ViewManager is necessary for work with view windows (creation and deletion).
-*/
-
- interface ViewManager: Base{
-/*! \brief Getting an active %View Frame
-
- Returns an object reference to the active %View Frame.
- Type of the %View must be checked.
- \note <BR>Returns nil if there are no views currently opened.
-*/
-
- View GetCurrentView();
-/*! \brief Creation of a 3d %View.
-
- Returns an object reference to the newly created 3d %View.
-*/
- View3D Create3DView();
-
- TableView CreateTableView(in Table theTable);
-
- XYPlot CreateXYPlot();
-
- void Destroy(in View theView);
-
- };
-};
-#endif
-
-
+++ /dev/null
-// Copyright (C) 2003 CEA/DEN, EDF R&D
-//
-//
-//
-// File : VISU_Gen.idl
-// Author : Alexey Petrov
-
-/*! \file VISU_Gen.idl This file conatins a set of interfaces of %VISU module.
- This module will provide various forms of data visualization in %SALOME application.
- These forms include data tables, XY plots, 3d representations
- and combination of these forms.
-*/
-/*!
- \defgroup Visu SALOME VISU module
-*/
-
-#ifndef __VISU_GEN__
-#define __VISU_GEN__
-
-#include "SALOME_Exception.idl"
-#include "SALOME_Component.idl"
-#include "SALOMEDS.idl"
-#include "SALOMEDS_Attributes.idl"
-#include "MED.idl"
-
-/*! \ingroup Visu
- The main package of interfaces of the module %VISU.
-*/
-module VISU {
- //-------------------------------------------------------
- typedef string IdType;
- enum Scaling{ LINEAR, LOGARITHMIC};
- enum Entity{ NODE, EDGE, FACE, CELL};
- //enum Entity{ CELL, FACE, EDGE, NODE};
-/*!
- This enumeration contains a set of elements defining the type of the module.
-*/
- enum VISUType{ TNONE,
- TCURVE, TTABLE, TCONTAINER, TMESH, TSCALARMAP,
- TISOSURFACE, TDEFORMEDSHAPE, TCUTPLANES, TCUTLINES, TVECTORS, TSTREAMLINES,
- TVISUGEN, TVIEWMANAGER, TRESULT,
- TXYPLOT, TTABLEVIEW, TVIEW3D,
- TENTITY, TFAMILY, TGROUP, TFIELD, TTIMESTAMP,
- TALL};
- interface Base {
-/*!
- Returns ID of the object.
-*/
- IdType GetID();
-/*!
-Returns the type of the presentable object
-*/
- VISUType GetType();
- };
-/*! \brief Presentable object interface
-
- It is the root class of all presentable objects.
-*/
- interface PrsObject : Base{
- };
- //-------------------------------------------------------
-/*! \brief %Table representation interface
-
-Presentation parameters of the %Table view.
-*/
- interface Table : PrsObject {
-/*!
-Sets the title of the table.
-*/
- void SetTitle(in string theTitle);
-/*!
-Gets the title of the table.
-*/
- string GetTitle();
-/*!
- This enumeration contains a set of elements defining the orientation of the table.
-*/
- enum Orientation{ HORIZONTAL, /*!<Horizontal orientation of the table.*/
- VERTIACAL /*!<Vertical orientation of the table.*/
- };
-/*!
-Sets orientation of the table.
-*/
- void SetOrientation(in Orientation theOrientation);
-/*!
-Gets orientation of the table.
-*/
- Orientation GetOrientation();
- /*!
-Gets the number of rows of the table
- */
- long GetNbRows();
- /*!
-Gets the number of columns of the table
- */
- long GetNbColumns();
- };
- //-------------------------------------------------------
-/*! \brief Interface of curve representation.
-
-Manages presentation parameters of one curve.
-It can be used for presentation of a set of curves using a combined presentation.
-*/
- interface Curve : PrsObject{
-/*!
-Sets the title of the curve.
-*/
- void SetTitle(in string theTitle);
-/*!
-Gets the title of the curve.
-*/
- string GetTitle();
-/*!
-Sets the color of the curve.
-*/
- void SetColor(in SALOMEDS::Color theColor);
-/*!
-Gets the color of the curve.
-*/
- SALOMEDS::Color GetColor();
- /*!
- This enumeration contains a set of elements defining the representation type of markers (data points) with help of
-which the curve is constructed on the graphics.
-*/
- enum MarkerType{ NONE, CIRCLE, RECTANGLE, DIAMOND,
- DTRIANGLE, UTRIANGLE, LTRIANGLE, RTRIANGLE,
- CROSS, XCROSS };
-/*!
-Sets the representation type of markers (data points) with help of
-which the curve is constructed on the graphics.
-*/
- void SetMarker(in MarkerType theType);
-/*!
-Gets the representation type of markers (data points) with help of
-which the curve is constructed on the graphics.
-*/
- MarkerType GetMarker();
-/*!
- This enumeration contains a set of elements defining the
- type of representation of curve lines on the graphics.
-*/
- enum LineType{ VOIDLINE, SOLIDLINE, DASHLINE, DOTLINE, DASHDOTLINE, DASHDOTDOTLINE};
-/*!
-Sets the type of representation of curve lines on the graphics.
-*/
- void SetLine(in LineType theType, in long theLineWidth);
-/*!
-Gets the type of representation of curve lines on the graphics.
-*/
- LineType GetLine();
-
-/*!
-Gets the width of the curve line.
-*/
- long GetLineWidth();
- };
-//-------------------------------------------------------
-/*! \brief The %Container presentable object interface
-This interface contains a set of methods used for management of a group of curves
-which are stored in the container.
-*/
- interface Container : PrsObject{
-/*!
-Adds a curve into the container.
-*/
- void AddCurve(in Curve theCurve);
-/*!
-Removes a curve from the container.
-*/
- void RemoveCurve(in Curve theCurve);
-/*!
-Gets the number of curves which are stored in the container.
-*/
- long GetNbCurves();
-/*!
-Removes all curves from the container.
-*/
- void Clear();
-
- };
- //-------------------------------------------------------
- interface Prs3d : PrsObject{
- void Destroy();
- };
-/*!
- This enumeration contains a set of elements defining the
- type of representation of the mesh.
-*/
-
- enum PresentationType{ POINT,
- WIREFRAME,
- SHADED,
- SHRINK
- };
-/*! \brief Interface of the mesh.
-
-This interface manages the presentation parameters of the mesh.
-*/
- interface Mesh : Prs3d{
-/*!
-Sets the color of mesh cells.
-*/
- void SetCellColor(in SALOMEDS::Color theColor);
-/*!
-Gets the color of mesh cells.
-*/
- SALOMEDS::Color GetCellColor();
-/*!
-Sets the color of mesh nodes.
-*/
- void SetNodeColor(in SALOMEDS::Color theColor);
-/*!
-Gets the color of mesh nodes.
-*/
- SALOMEDS::Color GetNodeColor();
-
-/*!
-Sets the color of mesh links.
-*/
- void SetLinkColor(in SALOMEDS::Color theColor);
-/*!
-Gets the color of mesh links.
-*/
- SALOMEDS::Color GetLinkColor();
-/*!
-Sets the type of representation of the mesh.
-*/
- void SetPresentationType(in PresentationType theType);
-/*!
-Gets the type of representation of the mesh.
-*/
- PresentationType GetPresentationType();
- };
- //-------------------------------------------------------
-/*! \brief Interface of the %Scalar Map presentation
-
-This interface contains presentation parameters of the ScalarMap presentation
-*/
- interface ScalarMap : Prs3d{
- void SetScalarMode(in long theScaling);
- long GetScalarMode();
- void SetScaling(in Scaling theScaling);
-/*!
-Gets the type of scaling of the values reflected by this presentation.
-*/
- Scaling GetScaling();
-/*!
-Sets scalar range - min and max boundaries of this presentable object.
-\param theMin Min boundary of this presentable object.
-\param theMax Max boundary of this presentable object.
-*/
- void SetRange(in double theMin, in double theMax);
-/*!
- Gets the min boundary of this presentable object.
-*/
- double GetMin();
-/*!
- Gets the max boundary of this presentable object.
-*/
- double GetMax();
-
-/*! %Orientation of this presentable object. */
- enum Orientation{
- HORIZONTAL, /*!< Horizontal orientation of this presentable object.*/
- VERTICAL /*!< Vertical orientation of this presentable object.*/
- };
-/*!
- Sets the type of orientation of this presentable object.
-*/
- void SetOrientation(in Orientation theOrientation);
-/*!
- Gets the type of orientation of this presentable object.
-*/
- Orientation GetOrientation();
-
-/*! \brief Position of this presentable object.
-
-Sets the position of this presentable object origin on the screen.
-\param X Horizontal position. The value can be between 0 and 1.
-\param Y Vertical position. The value can be between 0 and 1.
-*/
- void SetPosition(in double X, in double Y);
-/*!
- Gets horizontal position of this presentable object origin.
-*/
- double GetPosX();
-/*!
- Gets vertical position of this presentable object origin.
-*/
- double GetPosY();
-/*! \brief Size of this presentable object.
-
-Sets the size of the scalar bar.
-\param theWidth Width of this presentable object. The value can be between 0 and 1.
-\param theHeight Height of this presentable object. The value can be between 0 and 1.
-*/
- void SetSize(in double theWidth, in double theHeight);
-/*!
-Gets the width of this presentable object.
-*/
- double GetWidth();
-/*!
-Gets the height of this presentable object.
-*/
- double GetHeight();
-/*!
-Sets the number of colors which will be used for presentation of this presentable object.
-*/
- void SetNbColors(in long theNbColors);
-/*!
-Gets the number of colors which will be used for presentation of this presentable object.
-*/
- long GetNbColors();
-/*!
-Sets the number of labels which will be used for indication of the gradation
- of this presentable object.
-*/
- void SetLabels(in long theNbLabels);
-/*!
-Gets the number of labels which will be used for indication of the gradation
- of this presentable object.
-*/
- long GetLabels();
-/*!
-Sets the title of this presentable object. For scalar bar by default - the name of the selected result is used.
-*/
- void SetTitle(in string theName);
-/*!
-Gets the title of this presentable object.
-*/
- string GetTitle();
- };
- //-------------------------------------------------------
-/*! \brief Deformed shape presentation interface
-
-Presentation parameters of the deformed shape presentation.
-*/
- interface DeformedShape : ScalarMap{
-/*!
-Sets the scale of the presentatable object.
-*/
- void SetScale(in double theScale);
-/*!
-Gets the scale of the presentatable object.
-*/
- double GetScale();
- };
- //-------------------------------------------------------
-/*! \brief Cut planes interface
-
-Presentation parameters of Cut planes presentation.
-*/
- interface CutPlanes : ScalarMap{
-/*!
- This enumeration contains a set of elements defining the orientation in 3D space
- of cut planes presentation.
-*/
- enum Orientation {XY, YZ, ZX};
-/*!
-Sets the type of orientation in 3D space of cut planes presentation.
-*/
- void SetOrientationType(in Orientation theNb);
-/*!
-Gets the type of orientation in 3D space of cut planes presentation.
-*/
- Orientation GetOrientationType();
- void SetDisplacement(in double theDisp);
- double GetDisplacement();
-/*!
-Sets the number of cut planes.
-*/
- void SetNbPlanes(in long theNb);
-/*!
-Gets the number of cut planes.
-*/
- long GetNbPlanes();
-/*! Rotation around X-axis.
-Sets rotation angle of the cut plane presentation.
-*/
- void SetRotateX(in double theAngle);
-/*! Rotation around X-axis.
-Gets rotation angle of the cut plane presentation.
-*/
- double GetRotateX();
-/*! Rotation around Y-axis.
-Sets rotation angle of the cut plane presentation.
-*/
- void SetRotateY(in double theAngle);
-/*! Rotation around Y-axis.
-Sets rotation angle of the cut plane presentation.
-*/
- double GetRotateY();
- };
- //-------------------------------------------------------
- /*! \brief Interface of the stream lines representation
- This interface contains presentation parameters of
- stream lines presentations.
- */
-/*! \brief Cut lines interface
-
-Presentation parameters of Cut lines presentation.
-*/
- interface CutLines : ScalarMap{
-
- void SetOrientationType(in CutPlanes::Orientation theNb);
- void SetOrientationType2(in CutPlanes::Orientation theNb);
-
- CutPlanes::Orientation GetOrientationType();
- CutPlanes::Orientation GetOrientationType2();
-
- void SetDisplacement(in double theDisp);
- void SetDisplacement2(in double theDisp);
-
- double GetDisplacement();
- double GetDisplacement2();
-
- void SetNbLines(in long theNb);
- long GetNbLines();
-
- void SetRotateX(in double theAngle);
- void SetRotateX2(in double theAngle);
-
- double GetRotateX();
- double GetRotateX2();
-
- void SetRotateY(in double theAngle);
- void SetRotateY2(in double theAngle);
-
- double GetRotateY();
- double GetRotateY2();
- };
-
- interface StreamLines : DeformedShape{
- enum Direction{ FORWARD,
- BACKWARD,
- BOTH
- };
-
- void SetDirection(in Direction theDirection);
- Direction GetDirection();
-
- void SetStepLength(in double theStep);
- double GetStepLength();
-
- void SetPropagationTime(in double theTime);
- double GetPropagationTime();
-
- void SetIntegrationStep(in double theStep);
- double GetIntegrationStep();
-
- void SetSource(in Prs3d thePrs3d);
- Prs3d GetSource();
-
- void SetUsedPoints(in double thePercents);
- double GetUsedPoints();
- };
-
-
-/*! \brief Interface of the isometric surface representation
-
- This interface contains presentation parameters of
- isometric surface presentations.
-*/
- interface IsoSurfaces : ScalarMap{
-/*!
- Sets the number of isometric surfaces.
-*/
- void SetNbSurfaces(in long theNb);
-/*!
- Gets the number of isometric surfaces
-*/
- long GetNbSurfaces();
- };
- //-------------------------------------------------------
-/*! \brief Interface of the vector presentation.
-
-This interface contains presentation parameters of the vector.
-*/
- interface Vectors : DeformedShape{
-/*!
-Sets the width of the line of the vector.
-*/
- void SetLineWidth(in double theWidth);
-/*!
-Gets the width of the line of the vector.
-*/
- double GetLineWidth();
-/*!
- This enumeration contains a set of elements defining the type of representation of the vector head.
-*/
- enum GlyphType{ ARROW,
- CONE2,
- CONE6,
- NONE
- };
-/*!
-Sets the type of representation of the vector head.
-*/
- void SetGlyphType(in GlyphType theType);
-/*!
-Gets the type of representation of the vector head.
-*/
- GlyphType GetGlyphType();
-/*!
- This enumeration contains a set of elements defining the position of the vector head.
-*/
-
- enum GlyphPos{ CENTER, /*!<In the center of the vector.*/
- TAIL, /*!<In the tail of the vector.*/
- HEAD /*!<In the head of the vector.*/
- };
-/*!
-Sets the position of the vector head.
-*/
- void SetGlyphPos(in GlyphPos thePos);
-/*!
-Gets the position of the vector head.
-*/
- GlyphPos GetGlyphPos();
- };
- //-------------------------------------------------------
- interface Animation : Base{
- void addField(in SALOMEDS::SObject theObject);
-
- void generatePresentations(in long theFieldNum);
- boolean generateFrames();
- void clearView();
-
- void startAnimation();
- void stopAnimation();
-
- void nextFrame();
- void prevFrame();
- void firstFrame();
- void lastFrame();
- void gotoFrame(in long theFrame);
-
- long getNbFields();
- long getNbFrames();
- boolean isRunning();
- long getCurrentFrame();
-
- ScalarMap getPresentation(in long theField, in long theFrame);
-
- void setPresentationType(in long theFieldNum, in VISUType theType);
- VISUType getPresentationType(in long theFieldNum);
-
- void setSpeed(in long theSpeed);
- long getSpeed();
-
- boolean isProportional();
-
- void setAnimationRange(in double theMin, in double theMax);
- double getMinRange();
- double getMaxRange();
- boolean isRangeDefined();
-
- void dumpTo(in string thePath);
-
- boolean isCycling();
-
- double getMinTime();
- double getMaxTime();
-
- void setProportional(in boolean theProp);
- void setCycling(in boolean theCycle);
- };
-
-/*! \brief Interface %Result
-
-This interface serves for inner representation of data generated in other sources. (MED object or file)
-This data is needed for further construction of graphical presentations.
-*/
- interface Result : Base {
- };
- //-------------------------------------------------------
- interface ViewManager;
- interface View3D;
-/*! \brief %VISU_Gen interface
-
-This is the main interface of %VISU component. It is necessary for creation of
-post-processing presentations from given %Result and %Table object reference, using the views
-provided by %ViewManager.
-*/
- interface VISU_Gen : Engines::Component, SALOMEDS::Driver, Base{
- void SetCurrentStudy(in SALOMEDS::Study theStudy);
- SALOMEDS::Study GetCurrentStudy();
-/*!
- Gets the %ViewManager which is used for creation of
- post-processing presentations.
-*/
- ViewManager GetViewManager();
-
-/*!
-Imports tables from a file and create TableAttribute in Sudy
-*/
- SALOMEDS::SObject ImportTables(in string theFileName);
-/*!
-Imports data from a file.
-*/
- Result ImportFile(in string theFileName);
-/*!
-Imports data from a %MED object.
-*/
- Result ImportMed(in SALOMEDS::SObject theMedSObject);
-/*!
-Imports data from a %MED field.
-*/
- Result ImportMedField(in SALOME_MED::FIELD theField);
-/*!
-Creates a %Mesh on the basis of the data generated in other sources (MED object or file).
-*/
- Mesh MeshOnEntity(in Result theResult, in string theMeshName, in Entity theEntity);
- Mesh FamilyMeshOnEntity(in Result theResult, in string theMeshName, in Entity theEntity, in string theFamilyName);
- Mesh GroupMesh(in Result theResult, in string theMeshName, in string theGroupName);
-/*!
-Creates a scalar bar presentation.
-\param theResult Data generated in other sources. (MED object or file)
-\param theMeshName One of the meshes presented in MED file
-\param theEntity Type of entity where the field is defined
-\param theFieldName Group of data attributed to the %MESH. The data can be scalar or vector.
-\param theIteration Number of iteration on the field
-*/
- ScalarMap ScalarMapOnField(in Result theResult, in string theMeshName, in Entity theEntity, in string theFieldName, in double theIteration);
-/*!
-Creates a deformed shape presentation.
-\param theResult Data generated in other sources. (MED object or file)
-\param theMeshName One of the meshes presented in MED file
-\param theEntity Type of entity where the field is defined
-\param theFieldName Group of data attributed to the %MESH. The data can be scalar or vector.
-\param theIteration Number of iteration on the field
-*/
- DeformedShape DeformedShapeOnField(in Result theResult, in string theMeshName, in Entity theEntity, in string theFieldName, in double theIteration);
-/*!
-Creates a vector presentation.
-\param theResult Data generated in other sources. (MED object or file)
-\param theMeshName One of the meshes presented in MED file
-\param theEntity Type of entity where the field is defined
-\param theFieldName Group of data attributed to the %MESH. The data can be scalar or vector.
-\param theIteration Number of iteration on the field
-*/
-
- Vectors VectorsOnField(in Result theResult, in string theMeshName, in Entity theEntity, in string theFieldName, in double theIteration);
-/*!
-Creates an iso surface presentation.
-\param theResult Data generated in other sources. (MED object or file)
-\param theMeshName One of the meshes presented in MED file
-\param theEntity Type of entity where the field is defined
-\param theFieldName Group of data attributed to the %MESH. The data can be scalar or vector.
-\param theIteration Number of iteration on the field
-*/
-
- IsoSurfaces IsoSurfacesOnField(in Result theResult, in string theMeshName, in Entity theEntity, in string theFieldName, in double theIteration);
-/*!
-Creates an stream lines presentation.
-\param theResult Data generated in other sources. (MED object or file)
-\param theMeshName One of the meshes presented in MED file
-\param theEntity Type of entity where the field is defined
-\param theFieldName Group of data attributed to the %MESH. The data can be scalar or vector.
-\param theIteration Number of iteration on the field
-*/
- StreamLines StreamLinesOnField(in Result theResult, in string theMeshName, in Entity theEntity, in string theFieldName, in double theIteration);
-
-/*!
-Creates a presentation of cut planes.
-\param theResult Data generated in other sources. (MED object or file)
-\param theMeshName One of the meshes presented in MED file
-\param theEntity Type of entity where the field is defined
-\param theFieldName Group of data attributed to the %MESH. The data can be scalar or vector.
-\param theIteration Number of iteration on the field
-*/
- CutPlanes CutPlanesOnField(in Result theResult, in string theMeshName, in Entity theEntity, in string theFieldName, in double theIteration);
-
-/*!
-Creates a presentation of cut lines.
-\param theResult Data generated in other sources. (MED object or file)
-\param theMeshName One of the meshes presented in MED file
-\param theEntity Type of entity where the field is defined
-\param theFieldName Group of data attributed to the %MESH. The data can be scalar or vector.
-\param theIteration Number of iteration on the field
-*/
- CutLines CutLinesOnField(in Result theResult, in string theMeshName, in Entity theEntity, in string theFieldName, in double theIteration);
-
-/*!
-Creates a table presentation.
-*/
- Table CreateTable(in string theTableEntry);
-/*!
-Creates a curve on the basis of points, whose values are taken from the table.
-\param theTable Table containing the data for construction of curves.
-\param HRow Index of the row in the table: abscissa of the point.
-\param VRow Index of the row in the table: ordinate of the point.
-*/
- Curve CreateCurve(in Table theTable, in long theHRow, in long theVRow);
-/*!
-Creates a presentation form containing an array of references to the curves.
-*/
- Container CreateContainer();
-
- Animation CreateAnimation(in View3D theView3d);
- };
-/*! \brief %View interface
-
- Contains a set of methods used by the %View frame, which can be one of
- the following types: 3d, Table, XY plot.
- %View interface is a base for all types of %view interfaces.
-*/
- interface View: Base{
-/*!
-Sets the title of the %View frame.
-*/
- void SetTitle(in string theTitle);
-/*!
-Gets the title of the %View frame.
-*/
- string GetTitle();
-/*!
-Sets background color of the %View frame.
-*/
- void SetBackground(in SALOMEDS::Color theColor);
-/*!
-Gets background color of the %View frame.
-*/
- SALOMEDS::Color GetBackground();
-/*!
-Minimizes to the task bar or to the bottom of the Desktop the %View frame.
-*/
- void Minimize();
-/*!
-Restores the %View frame.
-*/
- void Restore();
-/*!
-Maximizes the %View frame.
-*/
- void Maximize();
-/*!
-Removes all presentations (presentable objects) from the %view.
-*/
- void EraseAll();
-/*!
-Displays all presentations (presentable objects) in the %view.
-*/
- void DisplayAll();
-/*!
-Removes a definite presentation (presentable object) from the %view.
-*/
- void Erase(in PrsObject thePrsObj);
-/*!
-Displays a definite presentation (presentable object) in the %view.
-*/
- void Display(in PrsObject thePrsObj);
-/*!
-Allows to display only a definite presentation (presentable object) in the %view.
-All other presentations are removed from the %view.
-*/
- void DisplayOnly(in PrsObject thePrsObj);
-/*!
-Updates the view.
-*/
- void Update();
-
-/*!
-Saves the view.
-*/
- boolean SavePicture(in string theFileName);
- };
-
- //-------------------------------------------------------
-/*! \brief 3D view interface
-
-This interface contains a set of methods necessary for representation of objects in 3D space.
-*/
-
- interface View3D : View {
-/*!
-This enumeration contains a set of elements determining a predefined point of view
- (position of the camera in 3D space relative to the presentable object).
-*/
- enum ViewType{ FRONT, BACK, LEFT, RIGHT, TOP, BOTTOM};
-/*!
-This enumeration contains a set of elements determining the axis
-*/
- enum Axis{ XAxis, YAxis, ZAxis};
-/*!
-Data type defining coordinates in 3D space.
-*/
- typedef double XYZ[3];
-
-/*!
- Makes all presentations, which are currently present in the %view, completely visible.
-*/
-
- void FitAll();
-
-/*!
-Sets a predefined point of view (FRONT, BACK, LEFT, RIGHT, TOP, BOTTOM). (In other words it means
- a predefined position of the camera in 3D space with respect to the object which is represented.)
-*/
- void SetView(in ViewType theType);
-
-/*!
-Sets the position of the camera in 3D space. This point is used as the first point of the vector defining
-the view direction of the camera.
-*/
- void SetPointOfView(in XYZ theCoord);
-/*!
-Gets the position of the camera in 3D space.This point is used as the first point of the vector defining
-the view direction of the camera.
-*/
- XYZ GetPointOfView();
-/*!
-Sets the vertical line of the camera in 3D space.
-*/
- void SetViewUp(in XYZ theDir);
-/*!
-Gets the vertical line of the camera in 3D space.
-*/
- XYZ GetViewUp();
-/*!
-Sets the point of sight of the camera. This point is used as the second point of the vector defining
-the view direction of the camera.
-*/
- void SetFocalPoint(in XYZ theDir);
-/*!
-Gets the point of sight of the camera. This point is used as the second point of the vector defining
-the view direction of the camera.
-*/
- XYZ GetFocalPoint();
-/*!
-Zooming of the presentable object. Sets the scale.
-*/
- void SetParallelScale(in double theScale);
-/*!
-Zooming of the presentable object. Gets the scale.
-*/
- double GetParallelScale();
-/*!
-Scaling of the view along a definite axis.
-\param theAxis The axis of the scaling
-\param theParam The coefficient of the scaling
-*/
- void ScaleView(in Axis theAxis, in double theParam);
-/*!
-Removes the scaling of the view.
-*/
- void RemoveScale();
-/*!
-Returns True if the view parameters have been created, False if the parameters have been modified.
-*/
- boolean SaveViewParams(in string theName);
-/*!
-Returns True if the view parameters have been found and applied to the view,
-False if the parameters with this name don't exist.
-*/
- boolean RestoreViewParams(in string theName);
- };
-
-
- //-------------------------------------------------------
- interface TableView : View {
-
- };
-
-
- //-------------------------------------------------------
- interface XYPlot : View {
- void SetSubTitle(in string theTitle);
- string GetSubTitle();
-
- enum CurveType { POINTS, MULTYLINE, SPLINE};
- void SetCurveType(in CurveType theType);
- CurveType GetCurveType();
-
- void SetMarkerSize(in long theSize);
- long GetMarkerSize();
-
- void EnableXGrid(in boolean theMajor, in long theNumMajor, in boolean theMinor, in long theNumMinor);
- void EnableYGrid(in boolean theMajor, in long theNumMajor, in boolean theMinor, in long theNumMinor);
-
- void SetHorScaling(in Scaling theScaling);
- Scaling GetHorScaling();
- void SetVerScaling(in Scaling theScaling);
- Scaling GetVerScaling();
-
- void SetXTitle(in string theTitle);
- string GetXTitle();
-
- void SetYTitle(in string theTitle);
- string GetYTitle();
-
- void ShowLegend(in boolean theShowing);
-
- void FitAll();
- };
-
- //-------------------------------------------------------
-/*! \brief Interface of the %ViewManager
-
- The %ViewManager is necessary for work with view windows (creation and deletion).
-*/
-
- interface ViewManager: Base{
-/*! \brief Getting an active %View Frame
-
- Returns an object reference to the active %View Frame.
- Type of the %View must be checked.
- \note <BR>Returns nil if there are no views currently opened.
-*/
-
- View GetCurrentView();
-/*! \brief Creation of a 3d %View.
-
- Returns an object reference to the newly created 3d %View.
-*/
- View3D Create3DView();
-
- TableView CreateTableView(in Table theTable);
-
- XYPlot CreateXYPlot();
-
- void Destroy(in View theView);
-
- };
-};
-#endif
-
-
