X-Git-Url: http://git.salome-platform.org/gitweb/?p=modules%2Fsmesh.git;a=blobdiff_plain;f=idl%2FSMESH_Gen.idl;h=69d725c7cc77455e13402400aad211159380e4d8;hp=ec43ae7146def2c40e68c18b07bde5386984ce71;hb=0fc0831670e27a5611b941c52dc152fd63964515;hpb=193c49c87753b6ccabb2b5e6dc935aa480d2d43e diff --git a/idl/SMESH_Gen.idl b/idl/SMESH_Gen.idl index ec43ae714..69d725c7c 100644 --- a/idl/SMESH_Gen.idl +++ b/idl/SMESH_Gen.idl @@ -1,4 +1,4 @@ -// Copyright (C) 2007-2015 CEA/DEN, EDF R&D, OPEN CASCADE +// Copyright (C) 2007-2020 CEA/DEN, EDF R&D, OPEN CASCADE // // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS @@ -76,7 +76,7 @@ module SMESH const long Tag_LastGroup = 16; /*! - * Hypothesis definintion error + * Hypothesis definition error */ struct AlgoStateError { @@ -116,6 +116,15 @@ module SMESH }; typedef sequence compute_error_array; + /*! + * Way to initialize hypothesis + */ + struct HypInitParams + { + short way; // 0 - by mesh, 1 - by geometry size + prefered parameters, 2 - by averageLength + double averageLength; + boolean quadDominated; + }; interface SMESH_Gen : Engines::EngineComponent, SALOMEDS::Driver { @@ -139,17 +148,22 @@ module SMESH boolean IsEmbeddedMode(); /*! - Set the current study + Update the study */ - void SetCurrentStudy( in SALOMEDS::Study theStudy ); - + void UpdateStudy(); + + /*! + Set enable publishing in the study + */ + void SetEnablePublish( in boolean theIsEnablePublish ); + /*! - Get the current study + Get enable publishing in the study */ - SALOMEDS::Study GetCurrentStudy(); + boolean IsEnablePublish(); /*! - * Create a hypothesis that can be shared by differents parts of the mesh. + * Create a hypothesis that can be shared by different 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. @@ -159,6 +173,15 @@ module SMESH in string theLibName ) raises ( SALOME::SALOME_Exception ); + /*! + * Create a hypothesis and initialize it by average length + */ + SMESH_Hypothesis CreateHypothesisByAverageLength( in string theHypName, + in string theLibName, + in double theAverageLength, + in boolean theQuadDominated) + raises ( SALOME::SALOME_Exception ); + /*! * Return a hypothesis holding parameter values corresponding either to the mesh * existing on the given geometry or to size of the geometry. @@ -170,7 +193,7 @@ module SMESH in string theLibName, in SMESH_Mesh theMesh, in GEOM::GEOM_Object theGeom, - in boolean byMesh) + in HypInitParams theWay) raises ( SALOME::SALOME_Exception ); /*! @@ -276,7 +299,39 @@ module SMESH raises ( SALOME::SALOME_Exception ); /*! - * Concatenate the given meshes or groups into one mesh. + * Create a mesh by copying definitions of another mesh to a given geometry + * \param sourceMesh - a mesh to copy + * \param newGeometry - a new geometry + * \param meshName - a name of the new mesh + * \param toCopyGroups - to create groups in the new mesh + * \param toReuseHypotheses - if True, existing hypothesis will be used by the new mesh, + * otherwise new hypotheses with the same parameters will be created for the new mesh. + * \param toCopyElements - to copy mesh elements of same sub-shapes of the two geometries + * \param newMesh - return a new mesh + * \param newGroups - return new groups + * \param newSubmeshes - return new sub-meshes + * \param newHypotheses - return new algorithms and hypotheses + * \param invalidEntries - return study entries of objects whose + * counterparts are not found in the newGeometry, followed by entries + * of mesh sub-objects that are invalid because they depend on a not found + * preceding sub-shape + */ + boolean CopyMeshWithGeom( in SMESH_Mesh sourceMesh, + in GEOM::GEOM_Object newGeometry, + in string meshName, + in boolean toCopyGroups, + in boolean toReuseHypotheses, + in boolean toCopyElements, + out SMESH_Mesh newMesh, + out ListOfGroups newGroups, + out submesh_array newSubmeshes, + out ListOfHypothesis newHypotheses, + out string_array invalidEntries) + raises ( SALOME::SALOME_Exception ); + + /*! + * Concatenate the given meshes or groups into one mesh, + * optionally to theMeshToAppendTo. * Union groups with the same name and type if * theUniteIdenticalGroups flag is true. * Merge coincident nodes and elements if @@ -285,11 +340,13 @@ module SMESH SMESH_Mesh Concatenate(in ListOfIDSources theMeshesArray, in boolean theUniteIdenticalGroups, in boolean theMergeNodesAndElements, - in double theMergeTolerance) + in double theMergeTolerance, + in SMESH_Mesh theMeshToAppendTo) raises ( SALOME::SALOME_Exception ); /*! - * Concatenate the given meshes into one mesh. + * Concatenate the given meshes into one mesh, + * optionally to theMeshToAppendTo. * Union groups with the same name and type if * theUniteIdenticalGroups flag is true. * Merge coincident nodes and elements if @@ -299,7 +356,8 @@ module SMESH SMESH_Mesh ConcatenateWithGroups(in ListOfIDSources theMeshesArray, in boolean theUniteIdenticalGroups, in boolean theMergeNodesAndElements, - in double theMergeTolerance) + in double theMergeTolerance, + in SMESH_Mesh theMeshToAppendTo) raises ( SALOME::SALOME_Exception ); /*! @@ -343,7 +401,7 @@ module SMESH raises ( SALOME::SALOME_Exception ); /*! - * Return errors of hypotheses definintion + * Return errors of hypotheses definition * algo_error_array is empty if everything is OK */ algo_error_array GetAlgoState( in SMESH_Mesh theMesh, @@ -406,10 +464,25 @@ module SMESH */ long GetObjectId(in Object theObject); + /*! + * \brief Get version of MED format being used. + */ + string GetMEDFileVersion(); + /*! * \brief Get MED version of the file by its name. */ - boolean GetMEDVersion(in string theFileName, out MED_VERSION theVersion); + string GetMEDVersion(in string theFileName); + + /*! + * \brief Check compatibility of file with MED format being used, for read only. + */ + boolean CheckCompatibility(in string theFileName); + + /*! + * \brief Check compatibility of file with MED format being used, for append on write. + */ + boolean CheckWriteCompatibility(in string theFileName); /*! * \brief Get names of meshes defined in file with the specified name. @@ -445,9 +518,9 @@ module SMESH * Return indices of elements, which are located inside the sphere * \param theSource - mesh, sub-mesh or group * \param theElemType - mesh element type - * \param theX - x cooridate of the center of the sphere - * \param theY - y cooridate of the center of the sphere - * \param theZ - y cooridate of the center of the sphere + * \param theX - x coordinate of the center of the sphere + * \param theY - y coordinate of the center of the sphere + * \param theZ - y coordinate of the center of the sphere * \param theR - radius of the sphere */ long_array GetInsideSphere( in SMESH_IDSource theSource, @@ -461,12 +534,12 @@ module SMESH * Return indices of elements, which are located inside the box * \param theSource - mesh, sub-mesh or group * \param theElemType - mesh element type - * \param theX1 - x cooridate of the first opposite point - * \param theY1 - y cooridate of the first opposite point - * \param theZ1 - y cooridate of the first opposite point - * \param theX2 - x cooridate of the second opposite point - * \param theY2 - y cooridate of the second opposite point - * \param theZ2 - y cooridate of the second opposite point + * \param theX1 - x coordinate of the first opposite point + * \param theY1 - y coordinate of the first opposite point + * \param theZ1 - y coordinate of the first opposite point + * \param theX2 - x coordinate of the second opposite point + * \param theY2 - y coordinate of the second opposite point + * \param theZ2 - y coordinate of the second opposite point */ long_array GetInsideBox( in SMESH_IDSource theSource, in ElementType theElemType, @@ -480,12 +553,12 @@ module SMESH * Return indices of elements, which are located inside the box * \param theSource - mesh, sub-mesh or group * \param theElemType - mesh element type - * \param theX - x cooridate of the cented of the bottom face - * \param theY - y cooridate of the cented of the bottom face - * \param theZ - y cooridate of the cented of the bottom face - * \param theDX - x cooridate of the cented of the base vector - * \param theDY - y cooridate of the cented of the base vector - * \param theDZ - z cooridate of the cented of the base vector + * \param theX - x coordinate of the cented of the bottom face + * \param theY - y coordinate of the cented of the bottom face + * \param theZ - y coordinate of the cented of the bottom face + * \param theDX - x coordinate of the cented of the base vector + * \param theDY - y coordinate of the cented of the base vector + * \param theDZ - z coordinate of the cented of the base vector * \param theH - height of the cylinder * \param theR - radius of the cylinder */