From: nri Date: Thu, 22 May 2003 09:56:41 +0000 (+0000) Subject: NRI : Add documentation. X-Git-Tag: Start-v1_1a~2 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=0e247676963ead2850554d57f5a3098fde48ebb9;p=modules%2Fsmesh.git NRI : Add documentation. --- diff --git a/doc/Makefile.in b/doc/Makefile.in new file mode 100644 index 000000000..019015971 --- /dev/null +++ b/doc/Makefile.in @@ -0,0 +1,33 @@ + +# -* Makefile *- +# +# Author : Patrick GOLDBRONN (CEA) +# Date : 30/11/2001 +# $Header$ +# +# source path +top_srcdir=@top_srcdir@ +top_builddir=.. +srcdir=@srcdir@ +VPATH=.:@srcdir@ + +SUBDIRS=html + +doc: + @@SETX@; for d in $(SUBDIRS); do \ + (cd $$d && $(MAKE) $@) || exit 1; \ + done +clean: + @@SETX@; for d in $(SUBDIRS); do \ + (cd $$d && $(MAKE) $@) || exit 1; \ + done + +distclean: clean + @@SETX@; for d in $(SUBDIRS); do \ + (cd $$d && $(MAKE) $@) || exit 1; \ + done + +install: + @@SETX@; for d in $(SUBDIRS); do \ + (cd $$d && $(MAKE) $@) || exit 1; \ + done diff --git a/doc/html/INPUT/HTML/SMESH_BasicHypothesis.html b/doc/html/INPUT/HTML/SMESH_BasicHypothesis.html new file mode 100644 index 000000000..8a92d45dd --- /dev/null +++ b/doc/html/INPUT/HTML/SMESH_BasicHypothesis.html @@ -0,0 +1,98 @@ + + + + + + + + + + + + + + + + +
interface SMESH_LocalLength
IDL file
Python
void SetLength ( in double length )
SetLength ( length )
double GetLength ( )
return_value = GetLength ( )

+ + + + + + + + + + + + + + + +
interface SMESH_NumberOfSegments
IDL file
Python
void SetNumberOfSegments ( in long segmentsNumber )
SetNumberOfSegments ( segmentsNumber )
long GetNumberOfSegments ( )
return_value = GetNumberOfSegments ( )

+ + + + + + + + + + + + + + + +
interface SMESH_MaxElementArea
IDL file
Python
void SetMaxElementArea ( in double area )
SetMaxElementArea ( area )
double GetMaxElementArea ( )
return_value = GetMaxElementArea ( )

+ + + + + + + + + + + + + + + +
interface SMESH_MaxElementVolume
IDL file
Python
void SetMaxElementVolume ( in double volume )
SetMaxElementVolume ( volume )
double GetMaxElementVolume ( )
return_value = GetMaxElementVolume ( )

+ + + + + + + +
interface SMESH_Regular_1D
IDL file
Python

+ + + + + + + +
interface SMESH_MEFISTO_2D
IDL file
Python

+ + + + + + + +
interface SMESH_Quadrangle_2D
IDL file
Python

+ + + + + + + +
interface SMESH_Hexa_3D
IDL file
Python

+ diff --git a/doc/html/INPUT/HTML/SMESH_Gen.html b/doc/html/INPUT/HTML/SMESH_Gen.html new file mode 100644 index 000000000..03b96aba2 --- /dev/null +++ b/doc/html/INPUT/HTML/SMESH_Gen.html @@ -0,0 +1,30 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
interface SMESH_Gen
IDL file
Python
SMESH_Hypothesis CreateHypothesis ( in string anHyp, in long studyId )
return_value = CreateHypothesis ( anHyp, studyId )
SMESH_Mesh Init ( in GEOM_Gen geomEngine, in long studyId, in GEOM_Shape aShape )
return_value = Init ( geomEngine, studyId, aShape )
boolean Compute ( in SMESH_Mesh aMesh, in GEOM_Shape aSubShape )
return_value = Compute ( aMesh, aSubShape )
boolean IsReadyToCompute ( in SMESH_Mesh aMesh, in GEOM_Shape aSubShape )
return_value = IsReadyToCompute ( aMesh, aSubShape )
long_array GetSubShapesId ( in GEOM_Gen geomEngine, in long studyId, in GEOM_Shape mainShape, in shape_array listOfSubShape )
return_value = GetSubShapesId ( geomEngine, studyId, mainShape, listOfSubShape )

+ diff --git a/doc/html/INPUT/HTML/SMESH_Hypothesis.html b/doc/html/INPUT/HTML/SMESH_Hypothesis.html new file mode 100644 index 000000000..8ffb0b9fb --- /dev/null +++ b/doc/html/INPUT/HTML/SMESH_Hypothesis.html @@ -0,0 +1,54 @@ + + + + + + + + + + + + + + + + +
interface SMESH_Hypothesis
IDL file
Python
string GetName ( )
return_value = GetName ( )
long GetId ( )
return_value = GetId ( )

+ + + + + + + + + + + +
interface SMESH_Algo
IDL file
Python
ListOfHypothesisName GetCompatibleHypothesis ( )
return_value = GetCompatibleHypothesis ( )

+ + + + + + + +
interface SMESH_1D_Algo
IDL file
Python

+ + + + + + + +
interface SMESH_2D_Algo
IDL file
Python

+ + + + + + + +
interface SMESH_3D_Algo
IDL file
Python

+ diff --git a/doc/html/INPUT/HTML/SMESH_Mesh.html b/doc/html/INPUT/HTML/SMESH_Mesh.html new file mode 100644 index 000000000..b6a66cf43 --- /dev/null +++ b/doc/html/INPUT/HTML/SMESH_Mesh.html @@ -0,0 +1,166 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
interface SMESH_Mesh
IDL file
Python
SMESH_subMesh GetElementsOnShape ( in GEOM_Shape aSubShape )
return_value = GetElementsOnShape ( aSubShape )
boolean AddHypothesis ( in GEOM_Shape aSubShape, in SMESH_Hypothesis anHyp )
return_value = AddHypothesis ( aSubShape, anHyp )
boolean RemoveHypothesis ( in GEOM_Shape aSubShape, in SMESH_Hypothesis anHyp )
return_value = RemoveHypothesis ( aSubShape, anHyp )
ListOfHypothesis GetHypothesisList ( in GEOM_Shape aSubShape )
return_value = GetHypothesisList ( aSubShape )
log_array GetLog ( in boolean clearAfterGet )
return_value = GetLog ( clearAfterGet )
void ClearLog ( )
ClearLog ( )
long GetId ( )
return_value = GetId ( )
long GetStudyId ( )
return_value = GetStudyId ( )
SMESH_MeshEditor GetMeshEditor ( )
return_value = GetMeshEditor ( )
void ExportDAT ( in string file )
ExportDAT ( file )
void ExportMED ( in string file )
ExportMED ( file )
void ExportUNV ( in string file )
ExportUNV ( file )
MESH GetMEDMesh ( )
return_value = GetMEDMesh ( )
long NbNodes ( )
return_value = NbNodes ( )
long NbEdges ( )
return_value = NbEdges ( )
long NbFaces ( )
return_value = NbFaces ( )
long NbTriangles ( )
return_value = NbTriangles ( )
long NbQuadrangles ( )
return_value = NbQuadrangles ( )
long NbVolumes ( )
return_value = NbVolumes ( )
long NbTetras ( )
return_value = NbTetras ( )
long NbHexas ( )
return_value = NbHexas ( )
long NbSubMesh ( )
return_value = NbSubMesh ( )

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
interface SMESH_subMesh
IDL file
Python
long GetNumberOfElements ( )
return_value = GetNumberOfElements ( )
long GetNumberOfNodes ( )
return_value = GetNumberOfNodes ( )
long_array GetElementsId ( )
return_value = GetElementsId ( )
long_array GetNodesId ( )
return_value = GetNodesId ( )
SMESH_Mesh GetFather ( )
return_value = GetFather ( )
long GetId ( )
return_value = GetId ( )
FAMILY GetFamily ( )
return_value = GetFamily ( )

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
interface SMESH_MeshEditor
IDL file
Python
boolean RemoveElements ( in long_array IDsOfElements )
return_value = RemoveElements ( IDsOfElements )
boolean RemoveNodes ( in long_array IDsOfNodes )
return_value = RemoveNodes ( IDsOfNodes )
boolean AddNode ( in double x, in double y, in double z )
return_value = AddNode ( x, y, z )
boolean AddEdge ( in long_array IDsOfNodes )
return_value = AddEdge ( IDsOfNodes )
boolean AddFace ( in long_array IDsOfNodes )
return_value = AddFace ( IDsOfNodes )
boolean AddVolume ( in long_array IDsOfNodes )
return_value = AddVolume ( IDsOfNodes )

+ diff --git a/doc/html/INPUT/doxyfile b/doc/html/INPUT/doxyfile new file mode 100755 index 000000000..f9f6dd732 --- /dev/null +++ b/doc/html/INPUT/doxyfile @@ -0,0 +1,203 @@ +# Doxyfile 1.3-rc1 + +#--------------------------------------------------------------------------- +# General configuration options +#--------------------------------------------------------------------------- +PROJECT_NAME = "SALOME PRO - SMESH - v.1.1a" +PROJECT_NUMBER = id#1.0 +OUTPUT_DIRECTORY = ../ +OUTPUT_LANGUAGE = English +EXTRACT_ALL = YES +EXTRACT_PRIVATE = YES +EXTRACT_STATIC = YES +EXTRACT_LOCAL_CLASSES = YES +HIDE_UNDOC_MEMBERS = NO +HIDE_UNDOC_CLASSES = NO +HIDE_FRIEND_COMPOUNDS = NO +HIDE_IN_BODY_DOCS = NO +BRIEF_MEMBER_DESC = YES +REPEAT_BRIEF = NO +ALWAYS_DETAILED_SEC = YES +INLINE_INHERITED_MEMB = YES +FULL_PATH_NAMES = NO +STRIP_FROM_PATH = +INTERNAL_DOCS = YES +CASE_SENSE_NAMES = YES +SHORT_NAMES = NO +HIDE_SCOPE_NAMES = NO +VERBATIM_HEADERS = YES +SHOW_INCLUDE_FILES = YES +JAVADOC_AUTOBRIEF = YES +MULTILINE_CPP_IS_BRIEF = NO +DETAILS_AT_TOP = NO +INHERIT_DOCS = YES +INLINE_INFO = YES +SORT_MEMBER_DOCS = NO +DISTRIBUTE_GROUP_DOC = NO +TAB_SIZE = 5 +GENERATE_TODOLIST = YES +GENERATE_TESTLIST = YES +GENERATE_BUGLIST = YES +GENERATE_DEPRECATEDLIST= YES +ALIASES = +ENABLED_SECTIONS = +MAX_INITIALIZER_LINES = 25 +OPTIMIZE_OUTPUT_FOR_C = YES +OPTIMIZE_OUTPUT_JAVA = YES +SHOW_USED_FILES = NO +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- +QUIET = NO +WARNINGS = YES +WARN_IF_UNDOCUMENTED = YES +WARN_FORMAT = "$file:$line: $text" +WARN_LOGFILE = log.txt +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- +INPUT = ../../../share/salome/idl/SMESH_Gen.idl \ + ../../../share/salome/idl/SMESH_Mesh.idl \ + ../../../share/salome/idl/SMESH_BasicHypothesis.idl \ + ../../../share/salome/idl/SMESH_Hypothesis.idl +FILE_PATTERNS = +RECURSIVE = NO +EXCLUDE = +EXCLUDE_SYMLINKS = NO +EXCLUDE_PATTERNS = +EXAMPLE_PATH = +EXAMPLE_PATTERNS = +EXAMPLE_RECURSIVE = NO +IMAGE_PATH = sources/ +INPUT_FILTER = +FILTER_SOURCE_FILES = YES +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- +SOURCE_BROWSER = NO +INLINE_SOURCES = NO +STRIP_CODE_COMMENTS = YES +REFERENCED_BY_RELATION = NO +REFERENCES_RELATION = YES +#--------------------------------------------------------------------------- +# configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- +ALPHABETICAL_INDEX = NO +COLS_IN_ALPHA_INDEX = 5 +IGNORE_PREFIX = +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- +GENERATE_HTML = YES +HTML_OUTPUT = html +HTML_FILE_EXTENSION = .html +HTML_HEADER = sources/myheader.html +HTML_FOOTER = +HTML_STYLESHEET = +HTML_ALIGN_MEMBERS = YES +GENERATE_HTMLHELP = NO +CHM_FILE = +HHC_LOCATION = +GENERATE_CHI = NO +BINARY_TOC = NO +TOC_EXPAND = NO +DISABLE_INDEX = NO +ENUM_VALUES_PER_LINE = 4 +GENERATE_TREEVIEW = NO +TREEVIEW_WIDTH = 250 +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- +GENERATE_LATEX = NO +LATEX_OUTPUT = latex +LATEX_CMD_NAME = latex +MAKEINDEX_CMD_NAME = makeindex +COMPACT_LATEX = NO +PAPER_TYPE = a4wide +EXTRA_PACKAGES = +LATEX_HEADER = +PDF_HYPERLINKS = NO +USE_PDFLATEX = NO +LATEX_BATCHMODE = NO +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- +GENERATE_RTF = NO +RTF_OUTPUT = rtf +COMPACT_RTF = NO +RTF_HYPERLINKS = NO +RTF_STYLESHEET_FILE = +RTF_EXTENSIONS_FILE = +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- +GENERATE_MAN = NO +MAN_OUTPUT = man +MAN_EXTENSION = .3 +MAN_LINKS = NO +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- +GENERATE_XML = NO +XML_SCHEMA = +XML_DTD = +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- +GENERATE_AUTOGEN_DEF = NO +#--------------------------------------------------------------------------- +# configuration options related to the Perl module output +#--------------------------------------------------------------------------- +GENERATE_PERLMOD = NO +PERLMOD_LATEX = NO +PERLMOD_PRETTY = YES +PERLMOD_MAKEVAR_PREFIX = +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- +ENABLE_PREPROCESSING = YES +MACRO_EXPANSION = YES +EXPAND_ONLY_PREDEF = NO +SEARCH_INCLUDES = YES +INCLUDE_PATH = +INCLUDE_FILE_PATTERNS = +PREDEFINED = +EXPAND_AS_DEFINED = +SKIP_FUNCTION_MACROS = NO +#--------------------------------------------------------------------------- +# Configuration::addtions related to external references +#--------------------------------------------------------------------------- +TAGFILES = +GENERATE_TAGFILE = +ALLEXTERNALS = NO +EXTERNAL_GROUPS = YES +PERL_PATH = /usr/bin/perl +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- +CLASS_DIAGRAMS = YES +HIDE_UNDOC_RELATIONS = NO +HAVE_DOT = YES +CLASS_GRAPH = YES +COLLABORATION_GRAPH = NO +TEMPLATE_RELATIONS = YES +INCLUDE_GRAPH = YES +INCLUDED_BY_GRAPH = NO +GRAPHICAL_HIERARCHY = YES +DOT_IMAGE_FORMAT = jpg +DOT_PATH = +DOTFILE_DIRS = +MAX_DOT_GRAPH_WIDTH = 1024 +MAX_DOT_GRAPH_HEIGHT = 1200 +GENERATE_LEGEND = NO +DOT_CLEANUP = YES +#--------------------------------------------------------------------------- +# Configuration::addtions related to the search engine +#--------------------------------------------------------------------------- +SEARCHENGINE = NO +CGI_NAME = search.cgi +CGI_URL = +DOC_URL = +DOC_ABSPATH = +BIN_ABSPATH = /usr/local/bin/ +EXT_DOC_PATHS = diff --git a/doc/html/INPUT/sources/Application-About.png b/doc/html/INPUT/sources/Application-About.png new file mode 100755 index 000000000..80e0bcb06 Binary files /dev/null and b/doc/html/INPUT/sources/Application-About.png differ diff --git a/doc/html/INPUT/sources/Application-About1.jpg b/doc/html/INPUT/sources/Application-About1.jpg new file mode 100755 index 000000000..b8f2cfb6d Binary files /dev/null and b/doc/html/INPUT/sources/Application-About1.jpg differ diff --git a/doc/html/INPUT/sources/application.gif b/doc/html/INPUT/sources/application.gif new file mode 100644 index 000000000..10da488d2 Binary files /dev/null and b/doc/html/INPUT/sources/application.gif differ diff --git a/doc/html/INPUT/sources/application.jpg b/doc/html/INPUT/sources/application.jpg new file mode 100755 index 000000000..6d3b6a0a8 Binary files /dev/null and b/doc/html/INPUT/sources/application.jpg differ diff --git a/doc/html/INPUT/sources/bg_salomepro.gif b/doc/html/INPUT/sources/bg_salomepro.gif new file mode 100755 index 000000000..677b70468 Binary files /dev/null and b/doc/html/INPUT/sources/bg_salomepro.gif differ diff --git a/doc/html/INPUT/sources/doxygen.css b/doc/html/INPUT/sources/doxygen.css new file mode 100755 index 000000000..6e2c772fe --- /dev/null +++ b/doc/html/INPUT/sources/doxygen.css @@ -0,0 +1,49 @@ +H1 { text-align: center; } +CAPTION { font-weight: bold } +A.qindex {} +A.qindexRef {} +A.el { text-decoration: none; font-weight: bold } +A.elRef { font-weight: bold } +A.code { text-decoration: none; font-weight: normal; color: #4444ee } +A.codeRef { font-weight: normal; color: #4444ee } +A:hover { text-decoration: none; background-color: lightblue } +DL.el { margin-left: -1cm } +DIV.fragment { width: 100%; border: none; background-color: #CCCCCC } +DIV.ah { background-color: #CCCCCC; font-weight: bold; color: #ffffff; margin-bottom: 3px; margin-top: 3px } +TD.md { background-color: lightblue; font-weight: bold; } +TD.mdname1 { background-color: lightblue; font-weight: bold; color: #602020; } +TD.mdname { background-color: lightblue; font-weight: bold; color: #602020; width: 600px; } +DIV.groupHeader { margin-left: 16px; margin-top: 12px; margin-bottom: 6px; font-weight: bold } +DIV.groupText { margin-left: 16px; font-style: italic; font-size: smaller } +BODY { background: url(sources/bg_salomepro.gif) } +TD.indexkey { + background-color: #CCCCCC; + font-weight: bold; + padding-right : 10px; + padding-top : 2px; + padding-left : 10px; + padding-bottom : 2px; + margin-left : 0px; + margin-right : 0px; + margin-top : 2px; + margin-bottom : 2px +} +TD.indexvalue { + background-color: #CCCCCC; + font-style: italic; + padding-right : 10px; + padding-top : 2px; + padding-left : 10px; + padding-bottom : 2px; + margin-left : 0px; + margin-right : 0px; + margin-top : 2px; + margin-bottom : 2px +} +span.keyword { color: #008000 } +span.keywordtype { color: #604020 } +span.keywordflow { color: #e08000 } +span.comment { color: #800000 } +span.preprocessor { color: #806020 } +span.stringliteral { color: #002080 } +span.charliteral { color: #008080 } diff --git a/doc/html/INPUT/sources/logocorp.gif b/doc/html/INPUT/sources/logocorp.gif new file mode 100755 index 000000000..7697e0837 Binary files /dev/null and b/doc/html/INPUT/sources/logocorp.gif differ diff --git a/doc/html/INPUT/sources/myheader.html b/doc/html/INPUT/sources/myheader.html new file mode 100755 index 000000000..83ca543cd --- /dev/null +++ b/doc/html/INPUT/sources/myheader.html @@ -0,0 +1,24 @@ + + + + + + Main Page + + + +  +
+ + + + + + +
+
+
+ + + + diff --git a/doc/html/INPUT/sources/occ.gif b/doc/html/INPUT/sources/occ.gif new file mode 100755 index 000000000..ce017c8ae Binary files /dev/null and b/doc/html/INPUT/sources/occ.gif differ diff --git a/doc/html/Makefile.in b/doc/html/Makefile.in new file mode 100644 index 000000000..6b636a242 --- /dev/null +++ b/doc/html/Makefile.in @@ -0,0 +1,38 @@ +# -* Makefile *- +# +# Author : Vasily Rusyaev (Open Cascade NN) +# Date : 13/02/2003 +# $Header: +# +# source path +top_srcdir=@top_srcdir@ +top_builddir=../.. +srcdir=@srcdir@ +VPATH=.:@srcdir@ +doxygen=@DOXYGEN@ + +@COMMENCE@ + +doc: + cp -fr $(srcdir)/INPUT ./; \ + cd INPUT; \ + sed 's|../../../share/salome|../$(top_srcdir)|' doxyfile > doxyfile1; \ + mv -f doxyfile1 doxyfile; \ + $(doxygen) ./doxyfile; \ + cd ..; \ + cp -f $(srcdir)/INPUT/sources/doxygen.css ./html/doxygen.css + cp -fr $(srcdir)/INPUT/sources/ html/ + cp -fr $(srcdir)/INPUT/exemple/ html/ + cp -fr $(srcdir)/INPUT/HTML/ html/ + +clean: + rm -rf html + +distclean: clean + rm -rf INPUT + +install: + cp -rf html $(docdir) + +uninstall: + rm -rf $(docdir)/html