From 77f55b1adbe9e2abca8172f04eb1fa7e9ae81189 Mon Sep 17 00:00:00 2001 From: nadir Date: Fri, 21 Nov 2003 08:44:59 +0000 Subject: [PATCH] Updating a little bit the documentation of the module; especially the documentation of the IDL. --- idl/MED.idl | 64 +++++++++++++++++++++++++++---------------------- idl/MED_Gen.idl | 56 ++++++++++++++++++++++++++++++------------- 2 files changed, 75 insertions(+), 45 deletions(-) diff --git a/idl/MED.idl b/idl/MED.idl index a1b0893c4..3643637c1 100644 --- a/idl/MED.idl +++ b/idl/MED.idl @@ -3,12 +3,16 @@ // Copyright : CEA/DEN/DMSS/LGLS // $Header$ /*! -This file contains the main IDL difinitions of the %MED component in %SALOME application. +This file contains the main IDL definitions of the %MED component in %SALOME application. */ #ifndef MED_IDL #define MED_IDL /*! \defgroup MED SALOME MED component + + This component is dedicated to the mounting in memory of a .med file. some + services of that component store CORBA objects (MED, MESH, FIELD) in the + study and/or give a direct access to those objects. */ #include "SALOME_Exception.idl" @@ -45,7 +49,7 @@ This package contains a set of interfaces used for %SALOME %MED component. interface SUPPORT; /*! -This enumeration contains a set of elements difining the type of geometrical elements which constitue +This enumeration contains a set of elements defining the type of geometrical elements which constitue a %Mesh. */ typedef long medGeometryElement; @@ -69,7 +73,7 @@ a %Mesh. /*! -This enumeration contains a set of elements difining the structural elements (entities) which constitue +This enumeration contains a set of elements defining the structural elements (entities) which constitue a %Mesh. */ typedef long medEntityMesh; @@ -80,10 +84,11 @@ a %Mesh. const medEntityMesh MED_ALL_ENTITIES = 4; /*! -This enumeration contains a set of mode to store data in an array. -For example an array of coordinates in 3D tow storage may be considered: - - X1,Y1,Z1,X2,Y2,...,Zn if MED_FULL_INTERLACE - - X1,X2,...Xn,Y1,Y2,...Zn if MED_NO_INTERLACE +This enumeration contains a set of modes to store data in an array. +For example an array of coordinates in 3D; tow storage may be considered: + + - X1,Y1,Z1,X2,Y2,Z2,...,Xn,Yn,Zn if MED_FULL_INTERLACE + - X1,X2,...,Xn,Y1,Y2,...,Yn,Z1,Z2,...,Zn if MED_NO_INTERLACE */ typedef long medModeSwitch; const medModeSwitch MED_FULL_INTERLACE = 0; @@ -107,7 +112,7 @@ This enumeration contains a set of elements defining the type of connectivity. const medDriverTypes NO_DRIVER = 2; /*! - An array of medGeometryElement + An array of %medGeometryElement */ typedef sequence medGeometryElement_array; @@ -214,7 +219,7 @@ This enumeration contains a set of elements defining the type of connectivity. raises (SALOME::SALOME_Exception); /*! - Returns the SUPPORT containing the boundary elements + Returns the %SUPPORT containing the boundary elements of the mesh. */ @@ -222,7 +227,7 @@ This enumeration contains a set of elements defining the type of connectivity. raises (SALOME::SALOME_Exception); /*! - Returns the SUPPORT containing the boundary elements + Returns the %SUPPORT containing the boundary elements of the support mySupport3D. */ SUPPORT getSkin(in SUPPORT mySupport3D ) raises (SALOME::SALOME_Exception); @@ -243,7 +248,7 @@ This enumeration contains a set of elements defining the type of connectivity. // ------------ /*! - Returns the number of different medGeometryElement types existing + Returns the number of defferent %medGeometryElement types existing in the specified entity. \note @@ -253,7 +258,7 @@ This enumeration contains a set of elements defining the type of connectivity. raises (SALOME::SALOME_Exception); /*! - Returns an array of all medGeometryElement types existing + Returns an array of all %medGeometryElement types existing in the mesh. \note @@ -263,7 +268,7 @@ This enumeration contains a set of elements defining the type of connectivity. raises (SALOME::SALOME_Exception); /*! - Returns the number of elements of type medGeometryElement. + Returns the number of elements of type %medGeometryElement. Note : - Implemented for MED_ALL_ELEMENTS @@ -277,8 +282,8 @@ This enumeration contains a set of elements defining the type of connectivity. Give, in full or no interlace mode (for nodal connectivity), descending or nodal connectivity. - You must give a medEntityMesh (ie:MED_EDGE) and a - medGeometryElement (ie:MED_SEG3). + You must give a %medEntityMesh (ie:MED_EDGE) and a + %medGeometryElement (ie:MED_SEG3). */ SALOME_MED::long_array getConnectivity(in medModeSwitch typeSwitch, in medConnectivity mode, @@ -511,7 +516,7 @@ Internal Corba method. MESH getMesh() raises (SALOME::SALOME_Exception); /*! - Returns the type of medEntityMesh used by the support. + Returns the type of %medEntityMesh used by the support. \note A support deals only with one entity's type @@ -528,59 +533,60 @@ Internal Corba method. boolean isOnAllElements() raises (SALOME::SALOME_Exception); /*! - If the method isOnAllElements returns False, this method + If the method %isOnAllElements() 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 medGeometryElement type. + If %SUPPORT is defined on MED_NODE, use MED_NONE %medGeometryElement + type. */ long getNumberOfElements(in medGeometryElement geomElement) raises (SALOME::SALOME_Exception); long getNumberOfTypes() raises (SALOME::SALOME_Exception); /*! - If isOnAllElements is False, returns an array of medGeometryElement + If isOnAllElements is False, returns an array of %medGeometryElement types used by the support. - medEntityMesh is given by getEntity. + %medEntityMesh is given by getEntity. */ medGeometryElement_array getTypes() raises (SALOME::SALOME_Exception); /*! - If the method isOnAllElements returns False, this method returns an array which - contains all numbers of given medGeometryElement. + If the method %isOnAllElements() returns False, this method returns an array which + contains all numbers of given %medGeometryElement. 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 medGeometryElement type. + If %SUPPORT is defined on MED_NODE, use MED_NONE %medGeometryElement type. */ SALOME_MED::long_array getNumber(in medGeometryElement geomElement) raises (SALOME::SALOME_Exception); /*! - If the method isOnAllElements returns False, this method returns the index + If the method %isOnAllElements() returns False, this method returns the index of element number. Use it with getNumber(MED_ALL_ELEMENTS). \note - See the method getConnectivityIndex for more details. + See the method %getConnectivityIndex for more details. */ SALOME_MED::long_array getNumberIndex() raises (SALOME::SALOME_Exception); /*! - Returns the number of Gauss points for this medGeometryElement. + Returns the number of Gauss points for this %medGeometryElement. \note - Not defined if %SUPPORT is on MED_NODE. - - Not defined for MED_ALL_ELEMENTS medGeometryElement type. + - Not defined for MED_ALL_ELEMENTS %medGeometryElement type. */ long getNumberOfGaussPoint(in medGeometryElement geomElement) raises (SALOME::SALOME_Exception); @@ -786,7 +792,9 @@ Internal Corba method. */ string getComponentUnit(in long i) raises (SALOME::SALOME_Exception); - + /*! + Returns the iteration number. + */ long getIterationNumber() raises (SALOME::SALOME_Exception); /*! diff --git a/idl/MED_Gen.idl b/idl/MED_Gen.idl index 86a68ba5a..c84f5a241 100644 --- a/idl/MED_Gen.idl +++ b/idl/MED_Gen.idl @@ -17,23 +17,45 @@ module SALOME_MED { 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); + /*! + it returns a Corba pointer %MESH on the mesh stored in the .med file + fileName with the name meshName; and it pushes it + in the study named studyName. + */ + SALOME_MED::MESH readMeshInFile(in string fileName, in string studyName, + in string meshName) + raises(SALOME::SALOME_Exception); + + /*! + it returns a Corba pointer %FIELD on the field instance with the order + ordre at the iteration iter, stored in the .med + file fileName with the name fieldName; and it + pushes it in the study named studyName. + */ + SALOME_MED::FIELD readFieldInFile(in string fileName, in string studyName, + in string fieldName, in long ordre, + in long iter) + raises (SALOME::SALOME_Exception); + + /*! + it returns a Corba pointer on the %MED object regrouping all objects + (%MESH and %FIELD) stored in the file fileName; and it pushes + all those objects in the study named studyName. All instances + of the fields are stored without their type. + */ + SALOME_MED::MED readStructFile(in string fileName, + in string studyName) + raises (SALOME::SALOME_Exception); + + /*! + It pushes all Corba pointers (%MED, %MESH, %FIELD) in the study named + studyName. The %MED object regroups all objects + (%MESH and %FIELD) stored in the file fileName and all + instances of the fields are stored with their own type. + */ + void readStructFileWithFieldType(in string fileName, + in string studyName) + raises (SALOME::SALOME_Exception); }; }; -- 2.39.2