[MOAB-dev] r1138 - MOAB/trunk/tools/iMesh
tautges at mcs.anl.gov
tautges at mcs.anl.gov
Tue Jun 26 17:28:51 CDT 2007
Author: tautges
Date: 2007-06-26 17:28:50 -0500 (Tue, 26 Jun 2007)
New Revision: 1138
Added:
MOAB/trunk/tools/iMesh/iMesh.dox
Modified:
MOAB/trunk/tools/iMesh/iMesh.h
MOAB/trunk/tools/iMesh/iMesh_MOAB.cpp
MOAB/trunk/tools/iMesh/testc_cbind.c
Log:
Fixing termination of descr in getDescription. Adding lots of comments
to iMesh.h. Adding doxygen config file for iMesh. Fixing char* initialization
(changing to const char*).
Added: MOAB/trunk/tools/iMesh/iMesh.dox
===================================================================
--- MOAB/trunk/tools/iMesh/iMesh.dox (rev 0)
+++ MOAB/trunk/tools/iMesh/iMesh.dox 2007-06-26 22:28:50 UTC (rev 1138)
@@ -0,0 +1,1252 @@
+# Doxyfile 1.5.1
+
+# This file describes the settings to be used by the documentation system
+# doxygen (www.doxygen.org) for a project
+#
+# All text after a hash (#) is considered a comment and will be ignored
+# The format is:
+# TAG = value [value, ...]
+# For lists items can also be appended using:
+# TAG += value [value, ...]
+# Values that contain spaces should be placed between quotes (" ")
+
+#---------------------------------------------------------------------------
+# Project related configuration options
+#---------------------------------------------------------------------------
+
+# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
+# by quotes) that should identify the project.
+
+PROJECT_NAME = iMesh
+
+# The PROJECT_NUMBER tag can be used to enter a project or revision number.
+# This could be handy for archiving the generated documentation or
+# if some version control system is used.
+
+PROJECT_NUMBER =
+
+# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
+# base path where the generated documentation will be put.
+# If a relative path is entered, it will be relative to the location
+# where doxygen was started. If left blank the current directory will be used.
+
+OUTPUT_DIRECTORY = doc
+
+# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
+# 4096 sub-directories (in 2 levels) under the output directory of each output
+# format and will distribute the generated files over these directories.
+# Enabling this option can be useful when feeding doxygen a huge amount of
+# source files, where putting all generated files in the same directory would
+# otherwise cause performance problems for the file system.
+
+CREATE_SUBDIRS = NO
+
+# The OUTPUT_LANGUAGE tag is used to specify the language in which all
+# documentation generated by doxygen is written. Doxygen will use this
+# information to generate all constant output in the proper language.
+# The default language is English, other supported languages are:
+# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
+# Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian,
+# Italian, Japanese, Japanese-en (Japanese with English messages), Korean,
+# Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian,
+# Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
+
+OUTPUT_LANGUAGE = English
+
+# This tag can be used to specify the encoding used in the generated output.
+# The encoding is not always determined by the language that is chosen,
+# but also whether or not the output is meant for Windows or non-Windows users.
+# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
+# forces the Windows encoding (this is the default for the Windows binary),
+# whereas setting the tag to NO uses a Unix-style encoding (the default for
+# all platforms other than Windows).
+
+USE_WINDOWS_ENCODING = NO
+
+# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
+# include brief member descriptions after the members that are listed in
+# the file and class documentation (similar to JavaDoc).
+# Set to NO to disable this.
+
+BRIEF_MEMBER_DESC = YES
+
+# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
+# the brief description of a member or function before the detailed description.
+# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
+# brief descriptions will be completely suppressed.
+
+REPEAT_BRIEF = NO
+
+# This tag implements a quasi-intelligent brief description abbreviator
+# that is used to form the text in various listings. Each string
+# in this list, if found as the leading text of the brief description, will be
+# stripped from the text and the result after processing the whole list, is
+# used as the annotated text. Otherwise, the brief description is used as-is.
+# If left blank, the following values are used ("$name" is automatically
+# replaced with the name of the entity): "The $name class" "The $name widget"
+# "The $name file" "is" "provides" "specifies" "contains"
+# "represents" "a" "an" "the"
+
+ABBREVIATE_BRIEF =
+
+# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
+# Doxygen will generate a detailed section even if there is only a brief
+# description.
+
+ALWAYS_DETAILED_SEC = YES
+
+# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
+# inherited members of a class in the documentation of that class as if those
+# members were ordinary class members. Constructors, destructors and assignment
+# operators of the base classes will not be shown.
+
+INLINE_INHERITED_MEMB = NO
+
+# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
+# path before files name in the file list and in the header files. If set
+# to NO the shortest path that makes the file name unique will be used.
+
+FULL_PATH_NAMES = YES
+
+# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
+# can be used to strip a user-defined part of the path. Stripping is
+# only done if one of the specified strings matches the left-hand part of
+# the path. The tag can be used to show relative paths in the file list.
+# If left blank the directory from which doxygen is run is used as the
+# path to strip.
+
+STRIP_FROM_PATH =
+
+# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
+# the path mentioned in the documentation of a class, which tells
+# the reader which header file to include in order to use a class.
+# If left blank only the name of the header file containing the class
+# definition is used. Otherwise one should specify the include paths that
+# are normally passed to the compiler using the -I flag.
+
+STRIP_FROM_INC_PATH =
+
+# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
+# (but less readable) file names. This can be useful is your file systems
+# doesn't support long names like on DOS, Mac, or CD-ROM.
+
+SHORT_NAMES = NO
+
+# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
+# will interpret the first line (until the first dot) of a JavaDoc-style
+# comment as the brief description. If set to NO, the JavaDoc
+# comments will behave just like the Qt-style comments (thus requiring an
+# explicit @brief command for a brief description.
+
+JAVADOC_AUTOBRIEF = NO
+
+# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
+# treat a multi-line C++ special comment block (i.e. a block of //! or ///
+# comments) as a brief description. This used to be the default behaviour.
+# The new default is to treat a multi-line C++ comment block as a detailed
+# description. Set this tag to YES if you prefer the old behaviour instead.
+
+MULTILINE_CPP_IS_BRIEF = YES
+
+# If the DETAILS_AT_TOP tag is set to YES then Doxygen
+# will output the detailed description near the top, like JavaDoc.
+# If set to NO, the detailed description appears after the member
+# documentation.
+
+DETAILS_AT_TOP = NO
+
+# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
+# member inherits the documentation from any documented member that it
+# re-implements.
+
+INHERIT_DOCS = YES
+
+# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
+# a new page for each member. If set to NO, the documentation of a member will
+# be part of the file/class/namespace that contains it.
+
+SEPARATE_MEMBER_PAGES = NO
+
+# The TAB_SIZE tag can be used to set the number of spaces in a tab.
+# Doxygen uses this value to replace tabs by spaces in code fragments.
+
+TAB_SIZE = 8
+
+# This tag can be used to specify a number of aliases that acts
+# as commands in the documentation. An alias has the form "name=value".
+# For example adding "sideeffect=\par Side Effects:\n" will allow you to
+# put the command \sideeffect (or @sideeffect) in the documentation, which
+# will result in a user-defined paragraph with heading "Side Effects:".
+# You can put \n's in the value part of an alias to insert newlines.
+
+ALIASES =
+
+# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
+# sources only. Doxygen will then generate output that is more tailored for C.
+# For instance, some of the names that are used will be different. The list
+# of all members will be omitted, etc.
+
+OPTIMIZE_OUTPUT_FOR_C = YES
+
+# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
+# sources only. Doxygen will then generate output that is more tailored for Java.
+# For instance, namespaces will be presented as packages, qualified scopes
+# will look different, etc.
+
+OPTIMIZE_OUTPUT_JAVA = NO
+
+# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to
+# include (a tag file for) the STL sources as input, then you should
+# set this tag to YES in order to let doxygen match functions declarations and
+# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
+# func(std::string) {}). This also make the inheritance and collaboration
+# diagrams that involve STL classes more complete and accurate.
+
+BUILTIN_STL_SUPPORT = NO
+
+# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
+# tag is set to YES, then doxygen will reuse the documentation of the first
+# member in the group (if any) for the other members of the group. By default
+# all members of a group must be documented explicitly.
+
+DISTRIBUTE_GROUP_DOC = NO
+
+# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
+# the same type (for instance a group of public functions) to be put as a
+# subgroup of that type (e.g. under the Public Functions section). Set it to
+# NO to prevent subgrouping. Alternatively, this can be done per class using
+# the \nosubgrouping command.
+
+SUBGROUPING = YES
+
+#---------------------------------------------------------------------------
+# Build related configuration options
+#---------------------------------------------------------------------------
+
+# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
+# documentation are documented, even if no documentation was available.
+# Private class members and static file members will be hidden unless
+# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
+
+EXTRACT_ALL = YES
+
+# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
+# will be included in the documentation.
+
+EXTRACT_PRIVATE = YES
+
+# If the EXTRACT_STATIC tag is set to YES all static members of a file
+# will be included in the documentation.
+
+EXTRACT_STATIC = YES
+
+# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
+# defined locally in source files will be included in the documentation.
+# If set to NO only classes defined in header files are included.
+
+EXTRACT_LOCAL_CLASSES = YES
+
+# This flag is only useful for Objective-C code. When set to YES local
+# methods, which are defined in the implementation section but not in
+# the interface are included in the documentation.
+# If set to NO (the default) only methods in the interface are included.
+
+EXTRACT_LOCAL_METHODS = NO
+
+# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
+# undocumented members of documented classes, files or namespaces.
+# If set to NO (the default) these members will be included in the
+# various overviews, but no documentation section is generated.
+# This option has no effect if EXTRACT_ALL is enabled.
+
+HIDE_UNDOC_MEMBERS = NO
+
+# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
+# undocumented classes that are normally visible in the class hierarchy.
+# If set to NO (the default) these classes will be included in the various
+# overviews. This option has no effect if EXTRACT_ALL is enabled.
+
+HIDE_UNDOC_CLASSES = NO
+
+# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
+# friend (class|struct|union) declarations.
+# If set to NO (the default) these declarations will be included in the
+# documentation.
+
+HIDE_FRIEND_COMPOUNDS = NO
+
+# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
+# documentation blocks found inside the body of a function.
+# If set to NO (the default) these blocks will be appended to the
+# function's detailed documentation block.
+
+HIDE_IN_BODY_DOCS = NO
+
+# The INTERNAL_DOCS tag determines if documentation
+# that is typed after a \internal command is included. If the tag is set
+# to NO (the default) then the documentation will be excluded.
+# Set it to YES to include the internal documentation.
+
+INTERNAL_DOCS = NO
+
+# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
+# file names in lower-case letters. If set to YES upper-case letters are also
+# allowed. This is useful if you have classes or files whose names only differ
+# in case and if your file system supports case sensitive file names. Windows
+# and Mac users are advised to set this option to NO.
+
+CASE_SENSE_NAMES = YES
+
+# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
+# will show members with their full class and namespace scopes in the
+# documentation. If set to YES the scope will be hidden.
+
+HIDE_SCOPE_NAMES = NO
+
+# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
+# will put a list of the files that are included by a file in the documentation
+# of that file.
+
+SHOW_INCLUDE_FILES = YES
+
+# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
+# is inserted in the documentation for inline members.
+
+INLINE_INFO = YES
+
+# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
+# will sort the (detailed) documentation of file and class members
+# alphabetically by member name. If set to NO the members will appear in
+# declaration order.
+
+SORT_MEMBER_DOCS = NO
+
+# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
+# brief documentation of file, namespace and class members alphabetically
+# by member name. If set to NO (the default) the members will appear in
+# declaration order.
+
+SORT_BRIEF_DOCS = NO
+
+# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
+# sorted by fully-qualified names, including namespaces. If set to
+# NO (the default), the class list will be sorted only by class name,
+# not including the namespace part.
+# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
+# Note: This option applies only to the class list, not to the
+# alphabetical list.
+
+SORT_BY_SCOPE_NAME = NO
+
+# The GENERATE_TODOLIST tag can be used to enable (YES) or
+# disable (NO) the todo list. This list is created by putting \todo
+# commands in the documentation.
+
+GENERATE_TODOLIST = YES
+
+# The GENERATE_TESTLIST tag can be used to enable (YES) or
+# disable (NO) the test list. This list is created by putting \test
+# commands in the documentation.
+
+GENERATE_TESTLIST = YES
+
+# The GENERATE_BUGLIST tag can be used to enable (YES) or
+# disable (NO) the bug list. This list is created by putting \bug
+# commands in the documentation.
+
+GENERATE_BUGLIST = YES
+
+# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
+# disable (NO) the deprecated list. This list is created by putting
+# \deprecated commands in the documentation.
+
+GENERATE_DEPRECATEDLIST= YES
+
+# The ENABLED_SECTIONS tag can be used to enable conditional
+# documentation sections, marked by \if sectionname ... \endif.
+
+ENABLED_SECTIONS =
+
+# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
+# the initial value of a variable or define consists of for it to appear in
+# the documentation. If the initializer consists of more lines than specified
+# here it will be hidden. Use a value of 0 to hide initializers completely.
+# The appearance of the initializer of individual variables and defines in the
+# documentation can be controlled using \showinitializer or \hideinitializer
+# command in the documentation regardless of this setting.
+
+MAX_INITIALIZER_LINES = 30
+
+# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
+# at the bottom of the documentation of classes and structs. If set to YES the
+# list will mention the files that were used to generate the documentation.
+
+SHOW_USED_FILES = YES
+
+# If the sources in your project are distributed over multiple directories
+# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
+# in the documentation. The default is NO.
+
+SHOW_DIRECTORIES = NO
+
+# The FILE_VERSION_FILTER tag can be used to specify a program or script that
+# doxygen should invoke to get the current version for each file (typically from the
+# version control system). Doxygen will invoke the program by executing (via
+# popen()) the command <command> <input-file>, where <command> is the value of
+# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
+# provided by doxygen. Whatever the program writes to standard output
+# is used as the file version. See the manual for examples.
+
+FILE_VERSION_FILTER =
+
+#---------------------------------------------------------------------------
+# configuration options related to warning and progress messages
+#---------------------------------------------------------------------------
+
+# The QUIET tag can be used to turn on/off the messages that are generated
+# by doxygen. Possible values are YES and NO. If left blank NO is used.
+
+QUIET = NO
+
+# The WARNINGS tag can be used to turn on/off the warning messages that are
+# generated by doxygen. Possible values are YES and NO. If left blank
+# NO is used.
+
+WARNINGS = YES
+
+# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
+# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
+# automatically be disabled.
+
+WARN_IF_UNDOCUMENTED = YES
+
+# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
+# potential errors in the documentation, such as not documenting some
+# parameters in a documented function, or documenting parameters that
+# don't exist or using markup commands wrongly.
+
+WARN_IF_DOC_ERROR = YES
+
+# This WARN_NO_PARAMDOC option can be abled to get warnings for
+# functions that are documented, but have no documentation for their parameters
+# or return value. If set to NO (the default) doxygen will only warn about
+# wrong or incomplete parameter documentation, but not about the absence of
+# documentation.
+
+WARN_NO_PARAMDOC = YES
+
+# The WARN_FORMAT tag determines the format of the warning messages that
+# doxygen can produce. The string should contain the $file, $line, and $text
+# tags, which will be replaced by the file and line number from which the
+# warning originated and the warning text. Optionally the format may contain
+# $version, which will be replaced by the version of the file (if it could
+# be obtained via FILE_VERSION_FILTER)
+
+WARN_FORMAT = "$file:$line: $text"
+
+# The WARN_LOGFILE tag can be used to specify a file to which warning
+# and error messages should be written. If left blank the output is written
+# to stderr.
+
+WARN_LOGFILE =
+
+#---------------------------------------------------------------------------
+# configuration options related to the input files
+#---------------------------------------------------------------------------
+
+# The INPUT tag can be used to specify the files and/or directories that contain
+# documented source files. You may enter file names like "myfile.cpp" or
+# directories like "/usr/src/myproject". Separate the files or directories
+# with spaces.
+
+INPUT = iMesh.h
+
+# If the value of the INPUT tag contains directories, you can use the
+# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
+# and *.h) to filter out the source-files in the directories. If left
+# blank the following patterns are tested:
+# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
+# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
+
+FILE_PATTERNS =
+
+# The RECURSIVE tag can be used to turn specify whether or not subdirectories
+# should be searched for input files as well. Possible values are YES and NO.
+# If left blank NO is used.
+
+RECURSIVE = NO
+
+# The EXCLUDE tag can be used to specify files and/or directories that should
+# excluded from the INPUT source files. This way you can easily exclude a
+# subdirectory from a directory tree whose root is specified with the INPUT tag.
+
+EXCLUDE =
+
+# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
+# directories that are symbolic links (a Unix filesystem feature) are excluded
+# from the input.
+
+EXCLUDE_SYMLINKS = NO
+
+# If the value of the INPUT tag contains directories, you can use the
+# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
+# certain files from those directories. Note that the wildcards are matched
+# against the file with absolute path, so to exclude all test directories
+# for example use the pattern */test/*
+
+EXCLUDE_PATTERNS =
+
+# The EXAMPLE_PATH tag can be used to specify one or more files or
+# directories that contain example code fragments that are included (see
+# the \include command).
+
+EXAMPLE_PATH =
+
+# If the value of the EXAMPLE_PATH tag contains directories, you can use the
+# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
+# and *.h) to filter out the source-files in the directories. If left
+# blank all files are included.
+
+EXAMPLE_PATTERNS =
+
+# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
+# searched for input files to be used with the \include or \dontinclude
+# commands irrespective of the value of the RECURSIVE tag.
+# Possible values are YES and NO. If left blank NO is used.
+
+EXAMPLE_RECURSIVE = NO
+
+# The IMAGE_PATH tag can be used to specify one or more files or
+# directories that contain image that are included in the documentation (see
+# the \image command).
+
+IMAGE_PATH =
+
+# The INPUT_FILTER tag can be used to specify a program that doxygen should
+# invoke to filter for each input file. Doxygen will invoke the filter program
+# by executing (via popen()) the command <filter> <input-file>, where <filter>
+# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
+# input file. Doxygen will then use the output that the filter program writes
+# to standard output. If FILTER_PATTERNS is specified, this tag will be
+# ignored.
+
+INPUT_FILTER =
+
+# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
+# basis. Doxygen will compare the file name with each pattern and apply the
+# filter if there is a match. The filters are a list of the form:
+# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
+# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
+# is applied to all files.
+
+FILTER_PATTERNS =
+
+# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
+# INPUT_FILTER) will be used to filter the input files when producing source
+# files to browse (i.e. when SOURCE_BROWSER is set to YES).
+
+FILTER_SOURCE_FILES = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to source browsing
+#---------------------------------------------------------------------------
+
+# If the SOURCE_BROWSER tag is set to YES then a list of source files will
+# be generated. Documented entities will be cross-referenced with these sources.
+# Note: To get rid of all source code in the generated output, make sure also
+# VERBATIM_HEADERS is set to NO.
+
+SOURCE_BROWSER = NO
+
+# Setting the INLINE_SOURCES tag to YES will include the body
+# of functions and classes directly in the documentation.
+
+INLINE_SOURCES = NO
+
+# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
+# doxygen to hide any special comment blocks from generated source code
+# fragments. Normal C and C++ comments will always remain visible.
+
+STRIP_CODE_COMMENTS = YES
+
+# If the REFERENCED_BY_RELATION tag is set to YES (the default)
+# then for each documented function all documented
+# functions referencing it will be listed.
+
+REFERENCED_BY_RELATION = YES
+
+# If the REFERENCES_RELATION tag is set to YES (the default)
+# then for each documented function all documented entities
+# called/used by that function will be listed.
+
+REFERENCES_RELATION = YES
+
+# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
+# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
+# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
+# link to the source code. Otherwise they will link to the documentstion.
+
+REFERENCES_LINK_SOURCE = YES
+
+# If the USE_HTAGS tag is set to YES then the references to source code
+# will point to the HTML generated by the htags(1) tool instead of doxygen
+# built-in source browser. The htags tool is part of GNU's global source
+# tagging system (see http://www.gnu.org/software/global/global.html). You
+# will need version 4.8.6 or higher.
+
+USE_HTAGS = NO
+
+# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
+# will generate a verbatim copy of the header file for each class for
+# which an include is specified. Set to NO to disable this.
+
+VERBATIM_HEADERS = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the alphabetical class index
+#---------------------------------------------------------------------------
+
+# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
+# of all compounds will be generated. Enable this if the project
+# contains a lot of classes, structs, unions or interfaces.
+
+ALPHABETICAL_INDEX = NO
+
+# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
+# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
+# in which this list will be split (can be a number in the range [1..20])
+
+COLS_IN_ALPHA_INDEX = 5
+
+# In case all classes in a project start with a common prefix, all
+# classes will be put under the same header in the alphabetical index.
+# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
+# should be ignored while generating the index headers.
+
+IGNORE_PREFIX =
+
+#---------------------------------------------------------------------------
+# configuration options related to the HTML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
+# generate HTML output.
+
+GENERATE_HTML = YES
+
+# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `html' will be used as the default path.
+
+HTML_OUTPUT = .
+
+# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
+# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
+# doxygen will generate files with .html extension.
+
+HTML_FILE_EXTENSION = .html
+
+# The HTML_HEADER tag can be used to specify a personal HTML header for
+# each generated HTML page. If it is left blank doxygen will generate a
+# standard header.
+
+HTML_HEADER =
+
+# The HTML_FOOTER tag can be used to specify a personal HTML footer for
+# each generated HTML page. If it is left blank doxygen will generate a
+# standard footer.
+
+HTML_FOOTER =
+
+# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
+# style sheet that is used by each HTML page. It can be used to
+# fine-tune the look of the HTML output. If the tag is left blank doxygen
+# will generate a default style sheet. Note that doxygen will try to copy
+# the style sheet file to the HTML output directory, so don't put your own
+# stylesheet in the HTML output directory as well, or it will be erased!
+
+HTML_STYLESHEET =
+
+# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
+# files or namespaces will be aligned in HTML using tables. If set to
+# NO a bullet list will be used.
+
+HTML_ALIGN_MEMBERS = YES
+
+# If the GENERATE_HTMLHELP tag is set to YES, additional index files
+# will be generated that can be used as input for tools like the
+# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
+# of the generated HTML documentation.
+
+GENERATE_HTMLHELP = NO
+
+# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
+# be used to specify the file name of the resulting .chm file. You
+# can add a path in front of the file if the result should not be
+# written to the html output directory.
+
+CHM_FILE =
+
+# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
+# be used to specify the location (absolute path including file name) of
+# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
+# the HTML help compiler on the generated index.hhp.
+
+HHC_LOCATION =
+
+# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
+# controls if a separate .chi index file is generated (YES) or that
+# it should be included in the master .chm file (NO).
+
+GENERATE_CHI = NO
+
+# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
+# controls whether a binary table of contents is generated (YES) or a
+# normal table of contents (NO) in the .chm file.
+
+BINARY_TOC = NO
+
+# The TOC_EXPAND flag can be set to YES to add extra items for group members
+# to the contents of the HTML help documentation and to the tree view.
+
+TOC_EXPAND = NO
+
+# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
+# top of each HTML page. The value NO (the default) enables the index and
+# the value YES disables it.
+
+DISABLE_INDEX = NO
+
+# This tag can be used to set the number of enum values (range [1..20])
+# that doxygen will group on one line in the generated HTML documentation.
+
+ENUM_VALUES_PER_LINE = 4
+
+# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
+# generated containing a tree-like index structure (just like the one that
+# is generated for HTML Help). For this to work a browser that supports
+# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
+# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
+# probably better off using the HTML help feature.
+
+GENERATE_TREEVIEW = NO
+
+# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
+# used to set the initial width (in pixels) of the frame in which the tree
+# is shown.
+
+TREEVIEW_WIDTH = 250
+
+#---------------------------------------------------------------------------
+# configuration options related to the LaTeX output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
+# generate Latex output.
+
+GENERATE_LATEX = NO
+
+# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `latex' will be used as the default path.
+
+LATEX_OUTPUT = latex
+
+# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
+# invoked. If left blank `latex' will be used as the default command name.
+
+LATEX_CMD_NAME = latex
+
+# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
+# generate index for LaTeX. If left blank `makeindex' will be used as the
+# default command name.
+
+MAKEINDEX_CMD_NAME = makeindex
+
+# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
+# LaTeX documents. This may be useful for small projects and may help to
+# save some trees in general.
+
+COMPACT_LATEX = NO
+
+# The PAPER_TYPE tag can be used to set the paper type that is used
+# by the printer. Possible values are: a4, a4wide, letter, legal and
+# executive. If left blank a4wide will be used.
+
+PAPER_TYPE = a4wide
+
+# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
+# packages that should be included in the LaTeX output.
+
+EXTRA_PACKAGES =
+
+# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
+# the generated latex document. The header should contain everything until
+# the first chapter. If it is left blank doxygen will generate a
+# standard header. Notice: only use this tag if you know what you are doing!
+
+LATEX_HEADER =
+
+# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
+# is prepared for conversion to pdf (using ps2pdf). The pdf file will
+# contain links (just like the HTML output) instead of page references
+# This makes the output suitable for online browsing using a pdf viewer.
+
+PDF_HYPERLINKS = NO
+
+# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
+# plain latex in the generated Makefile. Set this option to YES to get a
+# higher quality PDF documentation.
+
+USE_PDFLATEX = NO
+
+# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
+# command to the generated LaTeX files. This will instruct LaTeX to keep
+# running if errors occur, instead of asking the user for help.
+# This option is also used when generating formulas in HTML.
+
+LATEX_BATCHMODE = NO
+
+# If LATEX_HIDE_INDICES is set to YES then doxygen will not
+# include the index chapters (such as File Index, Compound Index, etc.)
+# in the output.
+
+LATEX_HIDE_INDICES = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the RTF output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
+# The RTF output is optimized for Word 97 and may not look very pretty with
+# other RTF readers or editors.
+
+GENERATE_RTF = NO
+
+# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `rtf' will be used as the default path.
+
+RTF_OUTPUT = rtf
+
+# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
+# RTF documents. This may be useful for small projects and may help to
+# save some trees in general.
+
+COMPACT_RTF = NO
+
+# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
+# will contain hyperlink fields. The RTF file will
+# contain links (just like the HTML output) instead of page references.
+# This makes the output suitable for online browsing using WORD or other
+# programs which support those fields.
+# Note: wordpad (write) and others do not support links.
+
+RTF_HYPERLINKS = NO
+
+# Load stylesheet definitions from file. Syntax is similar to doxygen's
+# config file, i.e. a series of assignments. You only have to provide
+# replacements, missing definitions are set to their default value.
+
+RTF_STYLESHEET_FILE =
+
+# Set optional variables used in the generation of an rtf document.
+# Syntax is similar to doxygen's config file.
+
+RTF_EXTENSIONS_FILE =
+
+#---------------------------------------------------------------------------
+# configuration options related to the man page output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
+# generate man pages
+
+GENERATE_MAN = YES
+
+# The MAN_OUTPUT tag is used to specify where the man pages will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `man' will be used as the default path.
+
+MAN_OUTPUT = man
+
+# The MAN_EXTENSION tag determines the extension that is added to
+# the generated man pages (default is the subroutine's section .3)
+
+MAN_EXTENSION = .3
+
+# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
+# then it will generate one additional man file for each entity
+# documented in the real man page(s). These additional files
+# only source the real man page, but without them the man command
+# would be unable to find the correct page. The default is NO.
+
+MAN_LINKS = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the XML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_XML tag is set to YES Doxygen will
+# generate an XML file that captures the structure of
+# the code including all documentation.
+
+GENERATE_XML = NO
+
+# The XML_OUTPUT tag is used to specify where the XML pages will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `xml' will be used as the default path.
+
+XML_OUTPUT = xml
+
+# The XML_SCHEMA tag can be used to specify an XML schema,
+# which can be used by a validating XML parser to check the
+# syntax of the XML files.
+
+XML_SCHEMA =
+
+# The XML_DTD tag can be used to specify an XML DTD,
+# which can be used by a validating XML parser to check the
+# syntax of the XML files.
+
+XML_DTD =
+
+# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
+# dump the program listings (including syntax highlighting
+# and cross-referencing information) to the XML output. Note that
+# enabling this will significantly increase the size of the XML output.
+
+XML_PROGRAMLISTING = YES
+
+#---------------------------------------------------------------------------
+# configuration options for the AutoGen Definitions output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
+# generate an AutoGen Definitions (see autogen.sf.net) file
+# that captures the structure of the code including all
+# documentation. Note that this feature is still experimental
+# and incomplete at the moment.
+
+GENERATE_AUTOGEN_DEF = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the Perl module output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_PERLMOD tag is set to YES Doxygen will
+# generate a Perl module file that captures the structure of
+# the code including all documentation. Note that this
+# feature is still experimental and incomplete at the
+# moment.
+
+GENERATE_PERLMOD = NO
+
+# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
+# the necessary Makefile rules, Perl scripts and LaTeX code to be able
+# to generate PDF and DVI output from the Perl module output.
+
+PERLMOD_LATEX = NO
+
+# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
+# nicely formatted so it can be parsed by a human reader. This is useful
+# if you want to understand what is going on. On the other hand, if this
+# tag is set to NO the size of the Perl module output will be much smaller
+# and Perl will parse it just the same.
+
+PERLMOD_PRETTY = YES
+
+# The names of the make variables in the generated doxyrules.make file
+# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
+# This is useful so different doxyrules.make files included by the same
+# Makefile don't overwrite each other's variables.
+
+PERLMOD_MAKEVAR_PREFIX =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the preprocessor
+#---------------------------------------------------------------------------
+
+# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
+# evaluate all C-preprocessor directives found in the sources and include
+# files.
+
+ENABLE_PREPROCESSING = YES
+
+# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
+# names in the source code. If set to NO (the default) only conditional
+# compilation will be performed. Macro expansion can be done in a controlled
+# way by setting EXPAND_ONLY_PREDEF to YES.
+
+MACRO_EXPANSION = NO
+
+# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
+# then the macro expansion is limited to the macros specified with the
+# PREDEFINED and EXPAND_AS_DEFINED tags.
+
+EXPAND_ONLY_PREDEF = NO
+
+# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
+# in the INCLUDE_PATH (see below) will be search if a #include is found.
+
+SEARCH_INCLUDES = YES
+
+# The INCLUDE_PATH tag can be used to specify one or more directories that
+# contain include files that are not input files but should be processed by
+# the preprocessor.
+
+INCLUDE_PATH =
+
+# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
+# patterns (like *.h and *.hpp) to filter out the header-files in the
+# directories. If left blank, the patterns specified with FILE_PATTERNS will
+# be used.
+
+INCLUDE_FILE_PATTERNS =
+
+# The PREDEFINED tag can be used to specify one or more macro names that
+# are defined before the preprocessor is started (similar to the -D option of
+# gcc). The argument of the tag is a list of macros of the form: name
+# or name=definition (no spaces). If the definition and the = are
+# omitted =1 is assumed. To prevent a macro definition from being
+# undefined via #undef or recursively expanded use the := operator
+# instead of the = operator.
+
+PREDEFINED =
+
+# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
+# this tag can be used to specify a list of macro names that should be expanded.
+# The macro definition that is found in the sources will be used.
+# Use the PREDEFINED tag if you want to use a different macro definition.
+
+EXPAND_AS_DEFINED =
+
+# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
+# doxygen's preprocessor will remove all function-like macros that are alone
+# on a line, have an all uppercase name, and do not end with a semicolon. Such
+# function macros are typically used for boiler-plate code, and will confuse
+# the parser if not removed.
+
+SKIP_FUNCTION_MACROS = YES
+
+#---------------------------------------------------------------------------
+# Configuration::additions related to external references
+#---------------------------------------------------------------------------
+
+# The TAGFILES option can be used to specify one or more tagfiles.
+# Optionally an initial location of the external documentation
+# can be added for each tagfile. The format of a tag file without
+# this location is as follows:
+# TAGFILES = file1 file2 ...
+# Adding location for the tag files is done as follows:
+# TAGFILES = file1=loc1 "file2 = loc2" ...
+# where "loc1" and "loc2" can be relative or absolute paths or
+# URLs. If a location is present for each tag, the installdox tool
+# does not have to be run to correct the links.
+# Note that each tag file must have a unique name
+# (where the name does NOT include the path)
+# If a tag file is not located in the directory in which doxygen
+# is run, you must also specify the path to the tagfile here.
+
+TAGFILES =
+
+# When a file name is specified after GENERATE_TAGFILE, doxygen will create
+# a tag file that is based on the input files it reads.
+
+GENERATE_TAGFILE =
+
+# If the ALLEXTERNALS tag is set to YES all external classes will be listed
+# in the class index. If set to NO only the inherited external classes
+# will be listed.
+
+ALLEXTERNALS = NO
+
+# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
+# in the modules index. If set to NO, only the current project's groups will
+# be listed.
+
+EXTERNAL_GROUPS = YES
+
+# The PERL_PATH should be the absolute path and name of the perl script
+# interpreter (i.e. the result of `which perl').
+
+PERL_PATH = /usr/bin/perl
+
+#---------------------------------------------------------------------------
+# Configuration options related to the dot tool
+#---------------------------------------------------------------------------
+
+# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
+# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
+# or super classes. Setting the tag to NO turns the diagrams off. Note that
+# this option is superseded by the HAVE_DOT option below. This is only a
+# fallback. It is recommended to install and use dot, since it yields more
+# powerful graphs.
+
+CLASS_DIAGRAMS = YES
+
+# If set to YES, the inheritance and collaboration graphs will hide
+# inheritance and usage relations if the target is undocumented
+# or is not a class.
+
+HIDE_UNDOC_RELATIONS = YES
+
+# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
+# available from the path. This tool is part of Graphviz, a graph visualization
+# toolkit from AT&T and Lucent Bell Labs. The other options in this section
+# have no effect if this option is set to NO (the default)
+
+HAVE_DOT = NO
+
+# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
+# will generate a graph for each documented class showing the direct and
+# indirect inheritance relations. Setting this tag to YES will force the
+# the CLASS_DIAGRAMS tag to NO.
+
+CLASS_GRAPH = YES
+
+# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
+# will generate a graph for each documented class showing the direct and
+# indirect implementation dependencies (inheritance, containment, and
+# class references variables) of the class with other documented classes.
+
+COLLABORATION_GRAPH = YES
+
+# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
+# will generate a graph for groups, showing the direct groups dependencies
+
+GROUP_GRAPHS = YES
+
+# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
+# collaboration diagrams in a style similar to the OMG's Unified Modeling
+# Language.
+
+UML_LOOK = NO
+
+# If set to YES, the inheritance and collaboration graphs will show the
+# relations between templates and their instances.
+
+TEMPLATE_RELATIONS = NO
+
+# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
+# tags are set to YES then doxygen will generate a graph for each documented
+# file showing the direct and indirect include dependencies of the file with
+# other documented files.
+
+INCLUDE_GRAPH = YES
+
+# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
+# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
+# documented header file showing the documented files that directly or
+# indirectly include this file.
+
+INCLUDED_BY_GRAPH = YES
+
+# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
+# generate a call dependency graph for every global function or class method.
+# Note that enabling this option will significantly increase the time of a run.
+# So in most cases it will be better to enable call graphs for selected
+# functions only using the \callgraph command.
+
+CALL_GRAPH = NO
+
+# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then doxygen will
+# generate a caller dependency graph for every global function or class method.
+# Note that enabling this option will significantly increase the time of a run.
+# So in most cases it will be better to enable caller graphs for selected
+# functions only using the \callergraph command.
+
+CALLER_GRAPH = NO
+
+# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
+# will graphical hierarchy of all classes instead of a textual one.
+
+GRAPHICAL_HIERARCHY = YES
+
+# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
+# then doxygen will show the dependencies a directory has on other directories
+# in a graphical way. The dependency relations are determined by the #include
+# relations between the files in the directories.
+
+DIRECTORY_GRAPH = YES
+
+# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
+# generated by dot. Possible values are png, jpg, or gif
+# If left blank png will be used.
+
+DOT_IMAGE_FORMAT = png
+
+# The tag DOT_PATH can be used to specify the path where the dot tool can be
+# found. If left blank, it is assumed the dot tool can be found in the path.
+
+DOT_PATH =
+
+# The DOTFILE_DIRS tag can be used to specify one or more directories that
+# contain dot files that are included in the documentation (see the
+# \dotfile command).
+
+DOTFILE_DIRS =
+
+# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
+# (in pixels) of the graphs generated by dot. If a graph becomes larger than
+# this value, doxygen will try to truncate the graph, so that it fits within
+# the specified constraint. Beware that most browsers cannot cope with very
+# large images.
+
+MAX_DOT_GRAPH_WIDTH = 1024
+
+# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
+# (in pixels) of the graphs generated by dot. If a graph becomes larger than
+# this value, doxygen will try to truncate the graph, so that it fits within
+# the specified constraint. Beware that most browsers cannot cope with very
+# large images.
+
+MAX_DOT_GRAPH_HEIGHT = 1024
+
+# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
+# graphs generated by dot. A depth value of 3 means that only nodes reachable
+# from the root by following a path via at most 3 edges will be shown. Nodes
+# that lay further from the root node will be omitted. Note that setting this
+# option to 1 or 2 may greatly reduce the computation time needed for large
+# code bases. Also note that a graph may be further truncated if the graph's
+# image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH
+# and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default),
+# the graph is not depth-constrained.
+
+MAX_DOT_GRAPH_DEPTH = 0
+
+# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
+# background. This is disabled by default, which results in a white background.
+# Warning: Depending on the platform used, enabling this option may lead to
+# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
+# read).
+
+DOT_TRANSPARENT = NO
+
+# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
+# files in one run (i.e. multiple -o and -T options on the command line). This
+# makes dot run faster, but since only newer versions of dot (>1.8.10)
+# support this, this feature is disabled by default.
+
+DOT_MULTI_TARGETS = NO
+
+# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
+# generate a legend page explaining the meaning of the various boxes and
+# arrows in the dot generated graphs.
+
+GENERATE_LEGEND = YES
+
+# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
+# remove the intermediate dot files that are used to generate
+# the various graphs.
+
+DOT_CLEANUP = YES
+
+#---------------------------------------------------------------------------
+# Configuration::additions related to the search engine
+#---------------------------------------------------------------------------
+
+# The SEARCHENGINE tag specifies whether or not a search engine should be
+# used. If set to NO the values of all tags below this one will be ignored.
+
+SEARCHENGINE = YES
Modified: MOAB/trunk/tools/iMesh/iMesh.h
===================================================================
--- MOAB/trunk/tools/iMesh/iMesh.h 2007-06-25 22:52:19 UTC (rev 1137)
+++ MOAB/trunk/tools/iMesh/iMesh.h 2007-06-26 22:28:50 UTC (rev 1138)
@@ -1,6 +1,66 @@
#ifndef IMESH_CBIND_H__
#define IMESH_CBIND_H__
+ /** \mainpage The ITAPS Mesh Interface iMesh
+ *
+ * The ITAPS Mesh Interface iMesh provides a common interface for
+ * accessing mesh and data associated with a mesh. Applications written
+ * to use this interface can use a variety of implementations, choosing
+ * the one that best meets its needs. They can also use tools written
+ * to this interface, for example mesh smoothing, adaptive mesh refinement,
+ * and parallel mesh support.
+ *
+ * \section ITAPS Data Model
+ *
+ * The ITAPS interfaces use a data model composed of four basic data types: \n
+ * \em Entity: basic topological entities in a mesh, e.g. vertices,
+ * triangles, hexahedra. \n
+ * \em Entity \em Set: arbitrary grouping of other entities and sets.
+ * Entity sets also support parent/child relations with other sets which
+ * are distinct from entities contained in those sets. Parent/child links
+ * can be used to embed graph relationships between sets, e.g. to
+ * represent topological relationships between the sets. \n
+ * \em Interface: the object with which mesh is associated and on which
+ * functions in iMesh are called. \n
+ * \em Tag: application data associated with objects of any of the other
+ * data types. Each tag has a designated name, size, and data type.
+ *
+ * \section JTAPS Entity Type, Topology
+ * Each entity has a specific Entity Type and Entity Topology. The Entity
+ * Type is one of VERTEX, EDGE, FACE, and REGION, and is synonymous with
+ * the topological dimension of the entity. The Entity Topology denotes
+ * the specific shape, for example TRIANGLE, QUADRILATERAL, TETRAHEDRON,
+ * and HEXAHEDRON. Entity Type and Entity Topology exist as enumerated
+ * types, Entity Type in the iBase_EntityType enumeration, and
+ * Entity Topology in the iMesh_EntityTopology enumeration.
+ *
+ * \section KTAPS Entity-, Array-, and Iterator-Based Access
+ *
+ * The iMesh interface provides functions for accessing entities
+ * individually, as arrays of entities, or using iterators. These access
+ * methods have different memory versus execution time tradeoffs,
+ * depending on the implementation.
+ *
+ * \section LTAPS Lists Passed Through Interface
+ *
+ * Many of the functions in iMesh have arguments corresponding to lists of
+ * objects. In-type arguments for lists consist of a pointer to an array and
+ * a list size. Lists returned from functions are passed in three arguments,
+ * a pointer to the array representing the list, and pointers to the
+ * allocated and occupied lengths of the array. These three arguments are
+ * inout-type arguments, because they can be allocated by the application and
+ * passed into the interface to hold the results of the function. Lists
+ * which are pre-allocated must be large enough to hold the results of the
+ * function; if this is not the case, an error is generated. Otherwise, the
+ * occupied size is changed to the size output from the function. If a list
+ * argument is unallocated (the list pointer points to a NULL value) or if
+ * the incoming value of the allocated size is zero, the list storage will be
+ * allocated by the implementation. IN ALL CASES, MEMORY ALLOCATED BY ITAPS
+ * INTERFACE IMPLEMENTATIONS IS DONE USING THE C MALLOC FUNCTION, AND CAN BE
+ * DE-ALLOCATED USING THE C FREE FUNCTION.
+ *
+ */
+
#ifndef ITAPS
#define ITAPS
#endif
@@ -12,10 +72,24 @@
extern "C" {
#endif
+ //! Type used to store iMesh interface handle
+ /** Type used to store iMesh interface handle
+ */
typedef void* iMesh_Instance;
+
+ //! Type used to store an iterator returned by iMesh
+ /** Type used to store an iterator returned by iMesh
+ */
typedef void* iMesh_EntityIterator;
+
+ //! Type used to store an array iterator returned by iMesh
+ /** Type used to store an array iterator returned by iMesh
+ */
typedef void* iMesh_EntityArrIterator;
+ //! Enumerator specifying entity topology
+ /** Enumerator specifying entity topology.
+ */
enum iMesh_EntityTopology {
iMesh_POINT = 0, /**< a general zero-dimensional entity */
iMesh_LINE_SEGMENT, /**< a general one-dimensional entity */
@@ -38,23 +112,63 @@
* about all the topology types */
};
+ //! Get the error type returned from the last iMesh function
+ /** Get the error type returned from the last iMesh function. Value
+ * returned is a member of the iBase_ErrorType enumeration.
+ * \param instance iMesh instance handle
+ * \param *error_type Error type returned from last iMesh function
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_getErrorType(iMesh_Instance instance,
/*out*/ int *error_type,
int *err);
+ //! Get a description of the error returned from the last iMesh function
+ /** Get a description of the error returned from the last iMesh function
+ * \param instance iMesh instance handle
+ * \param descr Pointer to a character string to be filled with a
+ * description of the error from the last iMesh function
+ * \param *err Pointer to error type returned from function
+ * \param descr_len Length of the character string pointed to by descr
+ */
void iMesh_getDescription(iMesh_Instance instance,
/*inout*/ char *descr,
int *err,
/*in*/ int descr_len);
+ //! Construct a new iMesh instance
+ /** Construct a new iMesh instance, using implementation-specific
+ * options
+ * \param options Pointer to implementation-specific options string
+ * \param instance Pointer to iMesh instance handle returned from function
+ * \param *err Pointer to error type returned from function
+ * \param options_len Length of the character string pointed to by options
+ */
void iMesh_newMesh(const char *options,
/*out*/ iMesh_Instance *instance,
/*out*/ int *err,
/*in*/ int options_len);
+ //! Destroy an iMesh instance
+ /** Destroy an iMesh instance
+ * \param instance iMesh instance to be destroyed
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_dtor(iMesh_Instance instance,
/*out*/ int *err);
+ //! Load a mesh from a file
+ /** Load a mesh from a file. If entity set is specified, loaded mesh
+ * is added to that set; specify zero if that is not desired.
+ * \param instance iMesh instance handle
+ * \param entity_set_handle Set to which loaded mesh will be added, zero
+ * if not desired
+ * \param name File name from which mesh is to be loaded
+ * \param options Pointer to implementation-specific options string
+ * \param *err Pointer to error type returned from function
+ * \param name_len Length of the file name character string
+ * \param options_len Length of the options character string
+ */
void iMesh_load(iMesh_Instance instance,
/*in*/ const iBase_EntitySetHandle entity_set_handle,
/*in*/ const char *name,
@@ -63,6 +177,17 @@
/*in*/ int name_len,
/*in*/ int options_len);
+ //! Save a mesh to a file
+ /** Save a mesh to a file. If entity set is specified, save only the
+ * mesh contained in that set.
+ * \param instance iMesh instance handle
+ * \param entity_set_handle Entity set being saved
+ * \param name File name to which mesh is to be saved
+ * \param options Pointer to implementation-specific options string
+ * \param *err Pointer to error type returned from function
+ * \param name_len Length of the file name character string
+ * \param options_len Length of the options character string
+ */
void iMesh_save(iMesh_Instance instance,
/*in*/ const iBase_EntitySetHandle entity_set_handle,
/*in*/ const char *name,
@@ -71,41 +196,139 @@
/*in*/ const int name_len,
/*in*/ int options_len);
+ //! Get handle of the root set for this instance
+ /** Get handle of the root set for this instance. All mesh in
+ * this instance can be accessed from this set.
+ * \param instance iMesh instance handle
+ * \param root_set Pointer to set handle returned from function
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_getRootSet(iMesh_Instance instance,
/*out*/ iBase_EntitySetHandle *root_set,
/*out*/ int *err);
+ //! Get the geometric dimension of mesh represented in this instance
+ /** Get the geometric dimension of mesh represented in this instance
+ * \param instance iMesh instance handle
+ * \param geom_dim Pointer to dimension returned from this function
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_getGeometricDimension(iMesh_Instance instance,
/*out*/ int *geom_dim,
/*out*/ int *err);
+ //! Get the default storage order used by this implementation
+ /** Get the default storage order used by this implementation. Value
+ * returned is a member of the iBase_StorageOrder enumeration.
+ * \param instance iMesh instance handle
+ * \param order Pointer to storage order returned from function
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_getDfltStorage(iMesh_Instance instance,
/*out*/ int *order,
/*out*/ int *err);
+ //! Get the adjacency table for this implementation
+ /** Get the adjacency table for this implementation. This table
+ * is a 4x4 array, with indices 0-based, where A(i,j) (i=row, j=column)
+ * represents the relative cost of retrieving adjacencies between
+ * entities of dimension i to entities of dimension j
+ * \param instance iMesh instance handle
+ * \param *adjacency_table Pointer to array representing adjacency table
+ * returned from function
+ * \param adjacency_table_allocated Pointer to allocated size of
+ * adjacency table
+ * \param adjacency_table_size Pointer to occupied size of
+ * adjacency table
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_getAdjTable (iMesh_Instance instance,
/*out*/ int** adjacency_table,
/*inout*/ int* adjacency_table_allocated,
/*out*/ int* adjacency_table_size,
/*out*/ int *err);
+ //! Get the number of entities with the specified type in the instance or set
+ /** Get the number of entities with the specified type in the instance
+ * or set. If entity set handle is zero, return information for instance,
+ * otherwise for set. Value of entity type must be from the
+ * iBase_EntityType enumeration. If iBase_ALL_TYPES is specified,
+ * total number of entities (excluding entity sets) is returned.
+ * \param instance iMesh instance handle
+ * \param entity_set_handle Entity set being queried
+ * \param entity_type Type of entity requested
+ * \param num_type Pointer to number of entities, returned from function
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_getNumOfType(iMesh_Instance instance,
/*in*/ const iBase_EntitySetHandle entity_set_handle,
/*in*/ const int entity_type,
/*out*/ int *num_type,
/*out*/ int *err);
+ //! Get the number of entities with the specified topology in the instance or set
+ /** Get the number of entities with the specified topology in the instance
+ * or set. If entity set handle is zero, return information for instance,
+ * otherwise for set. Value of entity topology must be from the
+ * iMesh_EntityTopology enumeration. If iMesh_ALL_TOPOLOGIES is specified,
+ * total number of entities (excluding entity sets) is returned.
+ * \param instance iMesh instance handle
+ * \param entity_set_handle Entity set being queried
+ * \param entity_topology Topology of entity requested
+ * \param num_topo Pointer to number of entities, returned from function
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_getNumOfTopo(iMesh_Instance instance,
/*in*/ const iBase_EntitySetHandle entity_set_handle,
/*in*/ const int entity_topology,
/*out*/ int *num_topo,
/*out*/ int *err);
+ //! Return whether entity handles have changed since last reset or since
+ //! instance construction
+ /** Return whether entity handles have changed since last reset or since
+ * instance construction. If non-zero value is returned, it is not
+ * guaranteed that a handle from before the last call to this function
+ * represents the same entity as the same handle value does now. If
+ * doReset is non-zero, resets the starting point for this function.
+ * \param instance iMesh instance handle
+ * \param doReset Perform a reset on the starting point after which handles
+ * are invariant.
+ * \param areHandlesInvariant Pointer to invariant flag returned from function
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_areEHValid(iMesh_Instance instance,
/*in*/ int doReset,
/*out*/ int *areHandlesInvariant,
/*out*/ int *err);
+ //! Return coordinates of all vertices defined in this instance or set
+ /** Return coordinates of all vertices defined in this instance or set.
+ * If non-zero set is input, return coordinates for vertices either in
+ * the set or contained by entities in the set. If storage order is
+ * a value other than iBase_UNDETERMINED, coordinates are returned with
+ * that storage order; otherwise storage order is in native order with
+ * respect to the implementation. On return, storage order contains
+ * order of the returned coordinates.
+ * \param instance iMesh instance handle
+ * \param entity_set_handle Entity set for which vertex coordinates are
+ * requested
+ * \param *coordinates Pointer to array holding coordinates
+ * \param *coordinates_allocated Pointer to allocated size of coordinates
+ * array
+ * \param *coordinates_size Pointer to occupied size of coordinates
+ * array
+ * \param *in_entity_set Pointer to array of flags; if entity set was
+ * input, (*in_entity_set)[i]=1 indicates that vertex i was in
+ * the entity set, zero otherwise.
+ * \param *in_entity_set_allocated Pointer to allocated size of
+ * in_entity_set array
+ * \param *in_entity_set_size Pointer to occupied size of
+ * in_entity_set array
+ * \param *storage_order Pointer to storage order requested/returned from
+ * function
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_getAllVtxCoords (iMesh_Instance instance,
/*in*/ const iBase_EntitySetHandle entity_set_handle,
/*inout*/ double** coordinates,
@@ -116,6 +339,33 @@
/*out*/ int* in_entity_set_size,
/*inout*/ int* storage_order, /*out*/ int *err);
+ //! Get adjacent entities as connectivity lists
+ /** For a specified set handle, entity type and/or entity topology,
+ * return connectivity of adjacent entities of specified dimension.
+ * Connectivity is expressed as index into array of vertices returned
+ * by getEntities function. \em offset[i] is the index of the first
+ * vertex of the first entity adjacent to entity \em i in the entity set
+ * or the mesh. The topology of entities whose connectivity is returned
+ * is given in the entity_topologies array.
+ * \param instance iMesh instance handle
+ * \param entity_set_handle Entity set being queried
+ * \param requested_entity_type Type of entity requested
+ * \param requested_entity_topology Topology of entity requested
+ * \param entity_adjacency_type Adjacency type
+ * \param *offset Pointer to array of offsets returned from function
+ * \param *offset_allocated Pointer to allocated size of offset array
+ * \param *offset_size Pointer to occupied size of offset array
+ * \param *index Pointer to array of indices returned from function
+ * \param *index_allocated Pointer to allocated size of index array
+ * \param *index_size Pointer to occupied size of index array
+ * \param *entity_topologies Pointer to array of entity topologies
+ * returned from function
+ * \param *entity_topologies_allocated Pointer to allocated size of
+ * entity_topologies array
+ * \param *entity_topologies_size Pointer to occupied size of
+ * entity_topologies array
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_getVtxCoordIndex (iMesh_Instance instance,
/*in*/ const iBase_EntitySetHandle entity_set_handle,
/*in*/ const int requested_entity_type,
@@ -132,6 +382,23 @@
/*out*/ int* entity_topologies_size,
/*out*/ int *err);
+ //! Get entities of specific type and/or topology in set or instance
+ /** Get entities of specific type and/or topology in set or instance. All
+ * entities of a given type or topology are requested by specifying
+ * iBase_ALL_TOPOLOGIES or iBase_ALL_TYPES, respectively. Specified type
+ * or topology must be a value in the iBase_EntityType or iBase_EntityTopology
+ * enumeration, respectively.
+ * \param instance iMesh instance handle
+ * \param entity_set_handle Entity set being queried
+ * \param entity_type Type of entities being requested
+ * \param entity_topology Topology of entities being requested
+ * \param *entity_handles Pointer to array of entity handles returned
+ * from function
+ * \param *entity_handles_allocated Pointer to allocated size of
+ * entity_handles array
+ * \param *entity_handles_size Pointer to occupied size of entity_handles array
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_getEntities(iMesh_Instance instance,
/*in*/ const iBase_EntitySetHandle entity_set_handle,
/*in*/ const int entity_type,
@@ -141,6 +408,23 @@
/*out*/ int* entity_handles_size,
/*out*/ int *err);
+ //! Get coordinates of specified vertices
+ /** Get coordinates of specified vertices. If storage order is passed in
+ * with a value other than iBase_UNDETERMINED, coordinates are returned
+ * in the specified storage order, otherwise storage order is that native
+ * to the implementation. Storage order of returned coordinates is also
+ * returned.
+ * \param instance iMesh instance handle
+ * \param vertex_handles Array of mesh vertex handles whose coordinates are
+ * being requested
+ * \param vertex_handles_size Number of vertices in vertex_handles array
+ * \param storage_order Pointer to storage order requested/returned from
+ * function
+ * \param *coords Pointer to array of coordinates returned from function
+ * \param *coords_allocated Pointer to allocated size of coords array
+ * \param *coords_size Pointer to occupied size of coords array
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_getVtxArrCoords(iMesh_Instance instance,
/*in*/ const iBase_EntityHandle* vertex_handles,
/*in*/ const int vertex_handles_size,
@@ -151,6 +435,42 @@
/*out*/ int *err);
+ //! Get entities adjacent to those of requested type/topology in set or instance
+ /** Get entities adjacent to those of requested type/topology in set or
+ * instance. If set is specified, also returns whether each adjacent entity
+ * is in the set ((*in_entity_set)[i]=1 indicates that adjacent entity
+ * (*adj_entity_handles)[i] is in the specified set). If adjacencies for
+ * all entities of specified type or
+ * topology are desired, specify iMesh_ALL_TOPOLOGIES or iBase_ALL_TYPES,
+ * respectively. Types and topologies input to this function must be values
+ * in the iBase_EntityType or iBase_EntityTopology enumerations, respectively.
+ * \em offset[i] stores index of first adjacent entity to entity \em i from
+ * mesh or set.
+ * \param instance iMesh instance handle
+ * \param entity_set_handle Entity set whose adjacent entities are requested
+ * (zero indicates whole mesh)
+ * \param entity_type_requestor Return entities adjacent to entities of this
+ * type
+ * \param entity_topology_requestor Return entities adjacent to entities of
+ * this topology
+ * \param entity_type_requested Return adjacent entities of this type
+ * \param *adj_entity_handles Pointer to array of adjacent entity handles
+ * returned from function
+ * \param *adj_entity_handles_allocated Pointer to allocated size of
+ * adj_entity_handles array
+ * \param *adj_entity_handles_size Pointer to occupied size of
+ * adj_entity_handles array
+ * \param *offset Pointer to array of offsets returned from function
+ * \param *offset_allocated Pointer to allocated size of offset array
+ * \param *offset_size Pointer to occupied size of offset array
+ * \param *in_entity_set Pointer to array of in_entity_set returned
+ * from function
+ * \param *in_entity_set_allocated Pointer to allocated size of
+ * in_entity_set array
+ * \param *in_entity_set_size Pointer to occupied size of in_entity_set
+ * array
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_getAdjEntities(iMesh_Instance instance,
/*in*/ const iBase_EntityHandle entity_set_handle,
/*in*/ const int entity_type_requestor,
@@ -167,6 +487,24 @@
/*out*/ int* in_entity_set_size,
/*out*/ int *err);
+ //! Initialize an array iterator over specified entity type, topology, and
+ //! size
+ /** Initialize an array iterator over specified entity type, topology, and
+ * size, for a specified set or instance. Iterator returned can be used
+ * as input to functions returning entities for the iterator. If all
+ * entities of a specified type and/or topology are to be iterated,
+ * specify iBase_ALL_TYPES or iMesh_ALL_TOPOLOGIES, respectively.
+ * Specified type or topology must be a value in the iBase_EntityType or
+ * iMesh_EntityTopology enumerations, respectively.
+ * \param instance iMesh instance handle
+ * \param entity_set_handle Entity set being iterated
+ * \param requested_entity_type Type of entity to iterate
+ * \param requested_entity_topology Topology of entity to iterate
+ * \param requested_array_size Size of chunks of handles returned for each
+ * value of the iterator
+ * \param entArr_iterator Pointer to iterator returned from function
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_initEntArrIter(iMesh_Instance instance,
/*in*/ const iBase_EntitySetHandle entity_set_handle,
/*in*/ const int requested_entity_type,
@@ -175,6 +513,23 @@
/*out*/ iMesh_EntityArrIterator* entArr_iterator,
/*out*/ int *err);
+ //! Get entities contained in array iterator and increment iterator
+ /** Get the entities contained in an array iterator, and increment the
+ * iterator. Also return whether the next value of the iterator has
+ * any entities (if non-zero, next iterator value is the end of the
+ * iteration).
+ * \param instance iMesh instance handle
+ * \param entArr_iterator Iterator being queried
+ * \param *entity_handles Pointer to array of entity handles contained in
+ * current value of iterator
+ * \param *entity_handles_allocated Pointer to allocated size of
+ * entity_handles array
+ * \param *entity_handles_size Pointer to occupied size of entity_handles
+ * array
+ * \param has_data Pointer to flag; if returned non-zero, next iterator
+ * has a non-zero number of entities
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_getNextEntArrIter(iMesh_Instance instance,
/*in*/ iMesh_EntityArrIterator entArr_iterator,
/*inout*/ iBase_EntityHandle** entity_handles,
@@ -184,16 +539,39 @@
/*out*/ int *err);
+ //! Reset the array iterator
+ /** Reset the array iterator
+ * \param instance iMesh instance handle
+ * \param entArr_iterator Iterator to reset
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_resetEntArrIter(iMesh_Instance instance,
/*in*/ iMesh_EntityArrIterator entArr_iterator,
/*out*/ int *err);
+ //! Destroy the specified array iterator
+ /** Destroy the specified array iterator
+ * \param instance iMesh instance handle
+ * \param entArr_iterator Iterator which gets destroyed
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_endEntArrIter(iMesh_Instance instance,
/*in*/ iMesh_EntityArrIterator entArr_iterator,
/*out*/ int *err);
-
+ //! Get the entity topology for the specified entities
+ /** Get the entity topology for the specified entities. Topologies
+ * returned are values in the iMesh_EntityTopology enumeration.
+ * \param instance iMesh instance handle
+ * \param entity_handles Array of entity handles being queried
+ * \param entity_handles_size Number of entities in entity_handles array
+ * \param *topology Pointer to array of entity topologies returned
+ * from function
+ * \param *topology_allocated Pointer to allocated size of topology array
+ * \param *topology_size Pointer to occupied size of topology array
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_getEntArrTopo(iMesh_Instance instance,
/*in*/ const iBase_EntityHandle* entity_handles,
/*in*/ const int entity_handles_size,
@@ -203,6 +581,17 @@
/*out*/ int *err);
+ //! Get the entity type for the specified entities
+ /** Get the entity type for the specified entities. Types
+ * returned are values in the iBase_EntityType enumeration.
+ * \param instance iMesh instance handle
+ * \param entity_handles Array of entity handles being queried
+ * \param entity_handles_size Number of entities in entity_handles array
+ * \param *type Pointer to array of types returned from function
+ * \param *type_allocated Pointer to allocated size of type array
+ * \param *type_size Pointer to occupied size of type array
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_getEntArrType(iMesh_Instance instance,
/*in*/ const iBase_EntityHandle* entity_handles,
/*in*/ const int entity_handles_size,
@@ -212,6 +601,26 @@
/*out*/ int *err);
+ //! Get entities of specified type adjacent to entities
+ /** Get entities of specified type adjacent to entities. Specified type
+ * must be value in the iBase_EntityType enumeration. \em offset(i) is
+ * index of first entity in adjacentEntityHandles array adjacent to
+ * entity_handles[i].
+ * \param instance iMesh instance handle
+ * \param entity_handles Array of entity handles being queried
+ * \param entity_handles_size Number of entities in entity_handles array
+ * \param entity_type_requested Type of adjacent entities requested
+ * \param *adjacentEntityHandles Pointer to array of adjacentEntityHandles
+ * returned from function
+ * \param *adjacentEntityHandles_allocated Pointer to allocated size of
+ * adjacentEntityHandles array
+ * \param *adj_entity_handles_size Pointer to occupied size of
+ * adjacentEntityHandles array
+ * \param *offset Pointer to array of offsets returned from function
+ * \param *offset_allocated Pointer to allocated size of offset array
+ * \param *offset_size Pointer to occupied size of offset array
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_getEntArrAdj(iMesh_Instance instance,
/*in*/ const iBase_EntityHandle* entity_handles,
/*in*/ const int entity_handles_size,
@@ -224,21 +633,56 @@
/*out*/ int* offset_size,
/*out*/ int *err);
+ //! Create an entity set
+ /** Create an entity set, either ordered (isList=1) or unordered
+ * (isList=0). Unordered entity sets can contain a given entity or
+ * set only once.
+ * \param instance iMesh instance handle
+ * \param isList If non-zero, an ordered list is created, otherwise an
+ * unordered set is created.
+ * \param entity_set_created Entity set created by function
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_createEntSet(iMesh_Instance instance,
/*in*/ const int isList,
/*out*/ iBase_EntitySetHandle* entity_set_created,
/*out*/ int *err);
-
+ //! Destroy an entity set
+ /** Destroy an entity set
+ * \param instance iMesh instance handle
+ * \param entity_set Entity set to be destroyed
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_destroyEntSet(iMesh_Instance instance,
/*in*/ iBase_EntitySetHandle entity_set,
/*out*/ int *err);
+ //! Return whether a specified set is ordered or unordered
+ /** Return whether a specified set is ordered (*is_list=1) or
+ * unordered (*is_list=0)
+ * \param instance iMesh instance handle
+ * \param entity_set Entity set being queried
+ * \param is_list Pointer to flag returned from function
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_isList(iMesh_Instance instance,
/*in*/ const iBase_EntitySetHandle entity_set,
/*out*/ int *is_list,
/*out*/ int *err);
+ //! Get the number of entity sets contained in a set or interface
+ /** Get the number of entity sets contained in a set or interface. If
+ * a set is input which is not the root set, num_hops indicates the
+ * maximum number of contained sets from entity_set_handle to one of the
+ * contained sets, inclusive of the contained set.
+ * \param instance iMesh instance handle
+ * \param entity_set_handle Entity set being queried
+ * \param num_hops Maximum hops from entity_set_handle to contained set,
+ * inclusive of the contained set
+ * \param num_sets Pointer to the number of sets returned from function
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_getNumEntSets(iMesh_Instance instance,
/*in*/ const iBase_EntitySetHandle entity_set_handle,
/*in*/ const int num_hops,
@@ -246,6 +690,23 @@
/*out*/ int *err);
+ //! Get the entity sets contained in a set or interface
+ /** Get the entity sets contained in a set or interface. If
+ * a set is input which is not the root set, num_hops indicates the
+ * maximum number of contained sets from entity_set_handle to one of the
+ * contained sets, inclusive of the contained set.
+ * \param instance iMesh instance handle
+ * \param entity_set_handle Entity set being queried
+ * \param num_hops Maximum hops from entity_set_handle to contained set,
+ * inclusive of the contained set
+ * \param *contained_set_handles Pointer to array of set handles returned
+ * from function
+ * \param contained_set_handles_allocated Pointer to allocated length of
+ * contained_set_handles array
+ * \param contained_set_handles_size Pointer to occupied length of
+ * contained_set_handles array
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_getEntSets(iMesh_Instance instance,
/*in*/ const iBase_EntitySetHandle entity_set_handle,
/*in*/ const int num_hops,
@@ -254,17 +715,40 @@
/*out*/ int* contained_set_handles_size,
/*out*/ int *err);
+ //! Add an entity to a set
+ /** Add an entity to a set
+ * \param instance iMesh instance handle
+ * \param entity_handle The entity being added
+ * \param entity_set Pointer to the set being added to
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_addEntToSet(iMesh_Instance instance,
/*in*/ const iBase_EntityHandle entity_handle,
/*inout*/ iBase_EntitySetHandle* entity_set,
/*out*/ int *err);
+ //! Remove an entity from a set
+ /** Remove an entity from a set
+ *
+ * \param instance iMesh instance handle
+ * \param entity_handle The entity being removed
+ * \param entity_set Pointer to the set being removed from
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_rmvEntFromSet(iMesh_Instance instance,
/*in*/ const iBase_EntityHandle entity_handle,
/*inout*/ iBase_EntitySetHandle* entity_set,
/*out*/ int *err);
+ //! Add an array of entities to a set
+ /** Add an array of entities to a set
+ * \param instance iMesh instance handle
+ * \param entity_handles Array of entities being added
+ * \param entity_handles_size Number of entities in entity_handles array
+ * \param entity_set Pointer to the set being added to
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_addEntArrToSet(iMesh_Instance instance,
/*in*/ const iBase_EntityHandle* entity_handles,
/*in*/ const int entity_handles_size,
@@ -272,6 +756,14 @@
/*out*/ int *err);
+ //! Remove an array of entities from a set
+ /** Remove an array of entities from a set
+ * \param instance iMesh instance handle
+ * \param entity_handles Array of entities being remove
+ * \param entity_handles_size Number of entities in entity_handles array
+ * \param entity_set Pointer to the set being removed from
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_rmvEntArrFromSet(iMesh_Instance instance,
/*in*/ const iBase_EntityHandle* entity_handles,
/*in*/ const int entity_handles_size,
@@ -279,57 +771,153 @@
/*out*/ int *err);
+ //! Add an entity set to a set
+ /** Add an entity set to a set
+ * \param instance iMesh instance handle
+ * \param entity_set_to_add The entity set being added
+ * \param entity_set_handle Pointer to the set being added to
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_addEntSet(iMesh_Instance instance,
/*in*/ const iBase_EntityHandle entity_set_to_add,
/*inout*/ iBase_EntitySetHandle* entity_set_handle,
/*out*/ int *err);
+ //! Remove an entity set from a set
+ /** Remove an entity set from a set
+ * \param instance iMesh instance handle
+ * \param entity_set_to_remove The entity set being removed
+ * \param entity_set_handle Pointer to the set being removed from
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_rmvEntSet(iMesh_Instance instance,
/*in*/ const iBase_EntitySetHandle entity_set_to_remove,
/*inout*/ iBase_EntitySetHandle* entity_set_handle,
/*out*/ int *err);
+ //! Return whether an entity is contained in another set
+ /** Return whether an entity is contained (*is_contained=1) or not
+ * contained (*is_contained=0) in another set
+ * \param instance iMesh instance handle
+ * \param containing_entity_set Entity set being queried
+ * \param contained_entity Entity potentially contained in
+ * containing_entity_set
+ * \param is_contained Pointer to flag returned from function
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_isEntContained(iMesh_Instance instance,
/*in*/ const iBase_EntitySetHandle containing_entity_set,
/*in*/ const iBase_EntitySetHandle contained_entity,
/*out*/ int *is_contained,
/*out*/ int *err);
+ //! Return whether an entity set is contained in another set
+ /** Return whether a set is contained (*is_contained=1) or not contained
+ * (*is_contained=0) in another set
+ * \param instance iMesh instance handle
+ * \param containing_entity_set Entity set being queried
+ * \param contained_entity_set Entity set potentially contained in
+ * containing_entity_set
+ * \param is_contained Pointer to flag returned from function
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_isEntSetContained(iMesh_Instance instance,
/*in*/ const iBase_EntitySetHandle containing_entity_set,
/*in*/ const iBase_EntitySetHandle contained_entity_set,
/*out*/ int *is_contained,
/*out*/ int *err);
+ //! Add parent/child links between two sets
+ /** Add parent/child links between two sets. Makes parent point to child
+ * and child point to parent.
+ * \param instance iMesh instance handle
+ * \param parent_entity_set Pointer to parent set
+ * \param child_entity_set Pointer to child set
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_addPrntChld(iMesh_Instance instance,
/*inout*/ iBase_EntitySetHandle* parent_entity_set,
/*inout*/ iBase_EntitySetHandle* child_entity_set,
/*out*/ int *err);
+ //! Remove parent/child links between two sets
+ /** Remove parent/child links between two sets.
+ * \param instance iMesh instance handle
+ * \param parent_entity_set Pointer to parent set
+ * \param child_entity_set Pointer to child set
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_rmvPrntChld(iMesh_Instance instance,
/*inout*/ iBase_EntitySetHandle* parent_entity_set,
/*inout*/ iBase_EntitySetHandle* child_entity_set,
/*out*/ int *err);
+ //! Return whether two sets are related by parent/child links
+ /** Return whether two sets are related (*is_child=1) or not (*is_child=0)
+ * by parent/child links
+ * \param instance iMesh instance handle
+ * \param parent_entity_set Pointer to parent set
+ * \param child_entity_set Pointer to child set
+ * \param is_child Pointer to flag returned from function
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_isChildOf(iMesh_Instance instance,
/*in*/ const iBase_EntitySetHandle parent_entity_set,
/*in*/ const iBase_EntitySetHandle child_entity_set,
/*out*/ int *is_child,
/*out*/ int *err);
+ //! Get the number of child sets linked from a specified set
+ /** Get the number of child sets linked from a specified set. If num_hops
+ * is non-zero, this represents the maximum hops from entity_set to any
+ * child in the count.
+ * \param instance iMesh instance handle
+ * \param entity_set Entity set being queried
+ * \param num_hops Maximum hops from entity_set_handle to child set,
+ * inclusive of the child set
+ * \param num_child Pointer to number of children returned from function
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_getNumChld(iMesh_Instance instance,
/*in*/ const iBase_EntitySetHandle entity_set,
/*in*/ const int num_hops,
/*out*/ int *num_child,
/*out*/ int *err);
+ //! Get the number of parent sets linked from a specified set
+ /** Get the number of parent sets linked from a specified set. If num_hops
+ * is non-zero, this represents the maximum hops from entity_set to any
+ * parent in the count.
+ * \param instance iMesh instance handle
+ * \param entity_set Entity set being queried
+ * \param num_hops Maximum hops from entity_set_handle to parent set,
+ * inclusive of the parent set
+ * \param num_parent Pointer to number of parents returned from function
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_getNumPrnt(iMesh_Instance instance,
/*in*/ const iBase_EntitySetHandle entity_set,
/*in*/ const int num_hops,
/*out*/ int *num_parent,
/*out*/ int *err);
+ //! Get the child sets linked from a specified set
+ /** Get the child sets linked from a specified set. If num_hops
+ * is non-zero, this represents the maximum hops from entity_set to any
+ * child.
+ * \param instance iMesh instance handle
+ * \param from_entity_set Entity set being queried
+ * \param num_hops Maximum hops from entity_set_handle to child set,
+ * inclusive of the child set
+ * \param *entity_set_handles Pointer to array of child sets
+ * returned from function
+ * \param *entity_set_handles_allocated Pointer to allocated size of
+ * entity_set_handles array
+ * \param *entity_set_handles_size Pointer to occupied size of
+ * entity_set_handles array
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_getChldn(iMesh_Instance instance,
/*in*/ const iBase_EntitySetHandle from_entity_set,
/*in*/ const int num_hops,
@@ -338,6 +926,22 @@
/*out*/ int* entity_set_handles_size,
/*out*/ int *err);
+ //! Get the parent sets linked from a specified set
+ /** Get the parent sets linked from a specified set. If num_hops
+ * is non-zero, this represents the maximum hops from entity_set to any
+ * parent.
+ * \param instance iMesh instance handle
+ * \param from_entity_set Entity set being queried
+ * \param num_hops Maximum hops from entity_set_handle to parent set,
+ * inclusive of the parent set
+ * \param *entity_set_handles Pointer to array of parent sets
+ * returned from function
+ * \param *entity_set_handles_allocated Pointer to allocated size of
+ * entity_set_handles array
+ * \param *entity_set_handles_size Pointer to occupied size of
+ * entity_set_handles array
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_getPrnts(iMesh_Instance instance,
/*in*/ const iBase_EntitySetHandle from_entity_set,
/*in*/ const int num_hops,
@@ -346,6 +950,19 @@
/*out*/ int* entity_set_handles_size,
/*out*/ int *err);
+ //! Set coordinates for an array of vertices
+ /** Set coordinates for an array of vertices. Specified storage
+ * order must be either iBase_INTERLEAVED or iBase_BLOCKED, and
+ * indicates order of x, y, and z coordinates in coordinate array.
+ * \param instance iMesh instance handle
+ * \param vertex_handles Array of vertex handles
+ * \param vertex_handles_size Number of vertex handles in array
+ * \param storage_order Storage order of coordinates in coordinate array
+ * \param new_coords Coordinate array
+ * \param new_coords_size Size of coordinate array; should be
+ * 3*vertex_handles_size
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_setVtxArrCoords(iMesh_Instance instance,
/*in*/ iBase_EntityHandle* vertex_handles,
/*in*/ const int vertex_handles_size,
@@ -355,6 +972,23 @@
/*out*/ int *err);
+ //! Create an array of new vertices at specified coordinates
+ /** Create an array of new vertices at specified coordinates. Value of
+ * storage_order must be either iBase_INTERLEAVED or iBase_BLOCKED.
+ * \param instance iMesh instance handle
+ * \param num_verts Number of new vertices to be created
+ * \param storage_order Storage order of coordinates in new_coords array
+ * \param new_coords Array of coordinates of new vertices
+ * \param new_coords_size Number of coordinates in new_coords array, should
+ * be 3*num_verts
+ * \param *new_vertex_handles Pointer to array of new vertex handles
+ * returned from function
+ * \param *new_vertex_handles_allocated Pointer to allocated size of
+ * new_vertex_handles array
+ * \param *new_vertex_handles_size Pointer to occupied size of
+ * new_vertex_handles array
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_createVtxArr(iMesh_Instance instance,
/*in*/ const int num_verts,
/*in*/ const int storage_order,
@@ -366,6 +1000,29 @@
/*out*/ int *err);
+ //! Create an array of new entities with specified lower-order topology
+ /** Create an array of new entities with specified lower-order topology.
+ * Specified new_entity_topology must be value in iMesh_EntityTopology
+ * enumeration. Values return in status array must be values in the
+ * iBase_CreationStatus enumeration.
+ * \param instance iMesh instance handle
+ * \param new_entity_topology Topology of created entity
+ * \param lower_order_entity_handles Array of lower order entity handles
+ * used to construct new entities
+ * \param lower_order_entity_handles_size Number of entities in array of
+ * lower order entity handles
+ * \param *new_entity_handles Pointer to array of new_entity_handles
+ * returned from function
+ * \param *new_entity_handles_allocated Pointer to allocated size of
+ * new_entity_handles array
+ * \param *new_entity_handles_size Pointer to occupied size of
+ * new_entity_handles array
+ * \param *status Pointer to array of creation status returned from
+ * function
+ * \param *status_allocated Pointer to allocated size of status array
+ * \param *status_size Pointer to occupied size of status array
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_createEntArr(iMesh_Instance instance,
/*in*/ const int new_entity_topology,
/*in*/ const iBase_EntityHandle* lower_order_entity_handles,
@@ -379,12 +1036,32 @@
/*out*/ int *err);
+ //! Delete specified entities
+ /** Delete specified entities
+ * \param instance iMesh instance handle
+ * \param entity_handles Array of entity handles to be deleted
+ * \param entity_handles_size Number of entities in array to be deleted
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_deleteEntArr(iMesh_Instance instance,
/*in*/ iBase_EntityHandle* entity_handles,
/*in*/ const int entity_handles_size,
/*out*/ int *err);
+ //! Create a tag with specified name, size, and type
+ /** Create a tag with specified name, size, and type. Tag size is in
+ * units of size of tag_type data types. Value input for tag type must be
+ * value in iBase_TagType enumeration.
+ * \param instance iMesh instance handle
+ * \param tag_name Character string indicating tag name
+ * \param tag_size Size of each tag value, in units of number of tag_type
+ * entities
+ * \param tag_type Data type for data stored in this tag
+ * \param tag_handle Pointer to tag handle returned from function
+ * \param *err Pointer to error type returned from function
+ * \param tag_name_len Length of tag name string
+ */
void iMesh_createTag(iMesh_Instance instance,
/*in*/ const char* tag_name,
/*in*/ const int tag_size,
@@ -394,39 +1071,98 @@
/*in*/ const int tag_name_len);
+ //! Destroy a tag
+ /** Destroy a tag. If forced is non-zero and entities still have values
+ * set for this tag, tag is deleted anyway and those values disappear,
+ * otherwise tag is not deleted.
+ * \param instance iMesh instance handle
+ * \param tag_handle Handle of tag to be deleted
+ * \param forced If non-zero, delete the tag even if entities have values
+ * set for that tag
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_destroyTag(iMesh_Instance instance,
/*in*/ iBase_TagHandle tag_handle,
/*in*/ const int forced,
/*out*/ int *err);
+ //! Get the name for a given tag handle
+ /** Get the name for a given tag handle
+ * \param instance iMesh instance handle
+ * \param tag_handle Tag handle being queried
+ * \param name Pointer to character string to store name returned from
+ * function
+ * \param *err Pointer to error type returned from function
+ * \param name_len Length of character string input to function
+ */
void iMesh_getTagName(iMesh_Instance instance,
/*in*/ const iBase_TagHandle tag_handle,
/*inout*/ char *name,
/*out*/ int *err,
/*in*/ int name_len);
+ //! Get size of a tag in units of numbers of tag data type
+ /** Get size of a tag in units of numbers of tag data type
+ * \param instance iMesh instance handle
+ * \param tag_handle Handle of tag being queried
+ * \param tag_size Pointer to tag size returned from function
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_getTagSizeValues(iMesh_Instance instance,
/*in*/ const iBase_TagHandle tag_handle,
/*out*/ int *tag_size,
/*out*/ int *err);
+ //! Get size of a tag in units of bytes
+ /** Get size of a tag in units of bytes
+ * \param instance iMesh instance handle
+ * \param tag_handle Handle of tag being queried
+ * \param tag_size Pointer to tag size returned from function
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_getTagSizeBytes(iMesh_Instance instance,
/*in*/ const iBase_TagHandle tag_handle,
/*out*/ int *tag_size,
/*out*/ int *err);
+ //! Get a the handle of an existing tag with the specified name
+ /** Get a the handle of an existing tag with the specified name
+ * \param instance iMesh instance handle
+ * \param tag_name Name of tag being queried
+ * \param tag_handle Pointer to tag handle returned from function
+ * \param *err Pointer to error type returned from function
+ * \param tag_name_len Length of tag name string
+ */
void iMesh_getTagHandle(iMesh_Instance instance,
/*in*/ const char* tag_name,
/*out*/ iBase_TagHandle *tag_handle,
/*out*/ int *err,
int tag_name_len);
+ //! Get the data type of the specified tag handle
+ /** Get the data type of the specified tag handle. Tag type is a value in
+ * the iBase_TagType enumeration.
+ * \param instance iMesh instance handle
+ * \param tag_handle Handle for the tag being queried
+ * \param tag_type Pointer to tag type returned from function
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_getTagType(iMesh_Instance instance,
/*in*/ const iBase_TagHandle tag_handle,
/*out*/ int *tag_type,
/*out*/ int *err);
-
+ //! Set a tag value of arbitrary type on an entity set
+ /** Set a tag value of arbitrary type on an entity set. Tag data is
+ * passed as char* type,
+ * but really represents pointer to arbitrary data.
+ * \param instance iMesh instance handle
+ * \param entity_set_handle Entity set on which tag is being set
+ * \param tag_handle Tag being set on an entity set
+ * \param tag_value Pointer to tag data being set on entity set
+ * \param tag_value_size Size in bytes of tag data
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_setEntSetData(iMesh_Instance instance,
/*in*/ iBase_EntitySetHandle entity_set_handle,
/*in*/ const iBase_TagHandle tag_handle,
@@ -435,6 +1171,14 @@
/*out*/ int *err);
+ //! Set a tag value of integer type on an entity set
+ /** Set a tag value of integer type on an entity set.
+ * \param instance iMesh instance handle
+ * \param entity_set Entity set on which tag is being set
+ * \param tag_handle Tag being set on an entity set
+ * \param tag_value Tag value being set on entity set
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_setEntSetIntData(iMesh_Instance instance,
/*in*/ iBase_EntitySetHandle entity_set,
/*in*/ const iBase_TagHandle tag_handle,
@@ -442,6 +1186,14 @@
/*out*/ int *err);
+ //! Set a tag value of double type on an entity set
+ /** Set a tag value of double type on an entity set.
+ * \param instance iMesh instance handle
+ * \param entity_set Entity set on which tag is being set
+ * \param tag_handle Tag being set on an entity set
+ * \param tag_value Tag value being set on entity set
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_setEntSetDblData(iMesh_Instance instance,
/*in*/ iBase_EntitySetHandle entity_set,
/*in*/ const iBase_TagHandle tag_handle,
@@ -449,6 +1201,14 @@
/*out*/ int *err);
+ //! Set a tag value of entity handle type on an entity set
+ /** Set a tag value of entity handle type on an entity set.
+ * \param instance iMesh instance handle
+ * \param entity_set Entity set on which tag is being set
+ * \param tag_handle Tag being set on an entity set
+ * \param tag_value Tag value being set on entity set
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_setEntSetEHData(iMesh_Instance instance,
/*in*/ iBase_EntitySetHandle entity_set,
/*in*/ const iBase_TagHandle tag_handle,
@@ -456,6 +1216,17 @@
/*out*/ int *err);
+ //! Get the value of a tag of arbitrary type on an entity set
+ /** Get the value of a tag of arbitrary type on an entity set. Tag data
+ * is passed back as char* type, but really represents arbitrary data.
+ * \param instance iMesh instance handle
+ * \param entity_set_handle Entity set on which tag is being set
+ * \param tag_handle Tag being set on an entity set
+ * \param *tag_value Pointer to tag data array being queried
+ * \param *tag_value_allocated Pointer to tag data array allocated size
+ * \param *tag_value_size Pointer to tag data array occupied size
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_getEntSetData(iMesh_Instance instance,
/*in*/ const iBase_EntitySetHandle entity_set_handle,
/*in*/ const iBase_TagHandle tag_handle,
@@ -464,24 +1235,59 @@
/*inout*/ int* tag_value_size,
/*out*/ int *err);
+ //! Get the value of a tag of integer type on an entity set
+ /** Get the value of a tag of integer type on an entity set.
+ * \param instance iMesh instance handle
+ * \param entity_set Entity set on which tag is being set
+ * \param tag_handle Tag being set on an entity set
+ * \param *out_data Pointer to tag value returned from function
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_getEntSetIntData(iMesh_Instance instance,
/*in*/ const iBase_EntitySetHandle entity_set,
/*in*/ const iBase_TagHandle tag_handle,
/*out*/ int *out_data,
/*out*/ int *err);
+ //! Get the value of a tag of double type on an entity set
+ /** Get the value of a tag of double type on an entity set.
+ * \param instance iMesh instance handle
+ * \param entity_set Entity set on which tag is being set
+ * \param tag_handle Tag being set on an entity set
+ * \param *out_data Pointer to tag value returned from function
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_getEntSetDblData(iMesh_Instance instance,
/*in*/ const iBase_EntitySetHandle entity_set,
/*in*/ const iBase_TagHandle tag_handle,
/*out*/ double *out_data,
/*out*/ int *err);
+ //! Get the value of a tag of entity handle type on an entity set
+ /** Get the value of a tag of entity handle type on an entity set.
+ * \param instance iMesh instance handle
+ * \param entity_set Entity set on which tag is being set
+ * \param tag_handle Tag being set on an entity set
+ * \param *out_data Pointer to tag value returned from function
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_getEntSetEHData(iMesh_Instance instance,
/*in*/ const iBase_EntitySetHandle entity_set,
/*in*/ const iBase_TagHandle tag_handle,
/*out*/ iBase_EntityHandle *out_data,
/*out*/ int *err);
+ //! Get all the tags associated with a specified entity set
+ /** Get all the tags associated with a specified entity set
+ * \param instance iMesh instance handle
+ * \param entity_set_handle Entity being queried
+ * \param *tag_handles Pointer to array of tag_handles returned from
+ * function
+ * \param *tag_handles_allocated Pointer to allocated size of tag_handles
+ * array
+ * \param *tag_handles_size Pointer to occupied size of tag_handles array
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_getAllEntSetTags(iMesh_Instance instance,
/*in*/ const iBase_EntitySetHandle entity_set_handle,
/*out*/ iBase_TagHandle** tag_handles,
@@ -489,23 +1295,65 @@
/*out*/ int* tag_handles_size,
/*out*/ int *err);
+ //! Remove a tag value from an entity set
+ /** Remove a tag value from an entity set
+ * \param instance iMesh instance handle
+ * \param entity_set_handle Entity set from which tag is being removed
+ * \param tag_handle Tag handle of tag being removed
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_rmvEntSetTag(iMesh_Instance instance,
/*in*/ iBase_EntitySetHandle entity_set_handle,
/*in*/ const iBase_TagHandle tag_handle,
/*out*/ int *err);
+ //! Set coordinates for a vertex
+ /** Set coordinates for a vertex.
+ * \param instance iMesh instance handle
+ * \param vertex_handle vertex handle being set
+ * \param x x coordinate being set
+ * \param y y coordinate being set
+ * \param z z coordinate being set
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_setVtxCoords(iMesh_Instance instance,
/*in*/ iBase_EntityHandle vertex_handle,
/*in*/ const double x, /*in*/ const double y,
/*in*/ const double z,
/*out*/ int *err);
+ //! Create a new vertex at specified coordinates
+ /** Create a new vertex at specified coordinates.
+ * \param instance iMesh instance handle
+ * \param x x coordinate of new vertex
+ * \param y y coordinate of new vertex
+ * \param z z coordinate of new vertex
+ * \param new_vertex_handle Pointer to new vertex handles returned from
+ * function
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_createVtx(iMesh_Instance instance,
/*in*/ const double x, /*in*/ const double y,
/*in*/ const double z,
/*out*/ iBase_EntityHandle* new_vertex_handle,
/*out*/ int *err);
+ //! Create a new entity with specified lower-order topology
+ /** Create a new entity with specified lower-order topology.
+ * Specified new_entity_topology must be value in iMesh_EntityTopology
+ * enumeration. Value returned as status must be a value in the
+ * iBase_CreationStatus enumeration.
+ * \param instance iMesh instance handle
+ * \param new_entity_topology Topology of created entity
+ * \param lower_order_entity_handles Array of lower order entity handles
+ * used to construct new entity
+ * \param lower_order_entity_handles_size Number of entities in array of
+ * lower order entity handles
+ * \param new_entity_handle Pointer to new entity handle returned from
+ * function
+ * \param status Pointer to creation status returned from function
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_createEnt(iMesh_Instance instance,
/*in*/ const int new_entity_topology,
/*in*/ const iBase_EntityHandle* lower_order_entity_handles,
@@ -514,10 +1362,29 @@
/*out*/ int* status,
/*out*/ int *err);
+ //! Delete specified entity
+ /** Delete specified entity
+ * \param instance iMesh instance handle
+ * \param entity_handle Entity to be deleted
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_deleteEnt(iMesh_Instance instance,
/*in*/ iBase_EntityHandle entity_handle,
/*out*/ int *err);
+ //! Get tag values of arbitrary type for an array of entities
+ /** Get tag values of arbitrary type for an array of entities. Tag data
+ * is returned as char* type, but really represents arbitrary data.
+ * \param instance iMesh instance handle
+ * \param entity_handles Entity array on which tag is being set
+ * \param entity_handles_size Number of entities in array
+ * \param tag_handle Tag being set on an entity
+ * \param *tag_values Pointer to tag data array being returned from
+ * function
+ * \param tag_values_allocated Pointer to allocated size of tag data array
+ * \param tag_values_size Pointer to occupied size of tag data array
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_getArrData(iMesh_Instance instance,
/*in*/ const iBase_EntityHandle* entity_handles,
/*in*/ const int entity_handles_size,
@@ -527,6 +1394,18 @@
/*out*/ int* tag_values_size,
/*out*/ int *err);
+ //! Get tag values of integer type for an array of entities
+ /** Get tag values of integer type for an array of entities.
+ * \param instance iMesh instance handle
+ * \param entity_handles Entity array on which tag is being set
+ * \param entity_handles_size Number of entities in array
+ * \param tag_handle Tag being set on an entity
+ * \param *tag_values Pointer to tag data array being returned from
+ * function
+ * \param tag_values_allocated Pointer to allocated size of tag data array
+ * \param tag_values_size Pointer to occupied size of tag data array
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_getIntArrData(iMesh_Instance instance,
/*in*/ const iBase_EntityHandle* entity_handles,
/*in*/ const int entity_handles_size,
@@ -536,6 +1415,18 @@
/*out*/ int* tag_values_size,
/*out*/ int *err);
+ //! Get tag values of double type for an array of entities
+ /** Get tag values of double type for an array of entities.
+ * \param instance iMesh instance handle
+ * \param entity_handles Entity array on which tag is being set
+ * \param entity_handles_size Number of entities in array
+ * \param tag_handle Tag being set on an entity
+ * \param *tag_values Pointer to tag data array being returned from
+ * function
+ * \param tag_values_allocated Pointer to allocated size of tag data array
+ * \param tag_values_size Pointer to occupied size of tag data array
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_getDblArrData(iMesh_Instance instance,
/*in*/ const iBase_EntityHandle* entity_handles,
/*in*/ const int entity_handles_size,
@@ -545,6 +1436,18 @@
/*out*/ int* tag_values_size,
/*out*/ int *err);
+ //! Get tag values of entity handle type for an array of entities
+ /** Get tag values of entity handle type for an array of entities.
+ * \param instance iMesh instance handle
+ * \param entity_handles Entity array on which tag is being set
+ * \param entity_handles_size Number of entities in array
+ * \param tag_handle Tag being set on an entity
+ * \param *tag_value Pointer to tag data array being returned from
+ * function
+ * \param tag_value_allocated Pointer to allocated size of tag data array
+ * \param tag_value_size Pointer to occupied size of tag data array
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_getEHArrData(iMesh_Instance instance,
/*in*/ const iBase_EntityHandle* entity_handles,
/*in*/ const int entity_handles_size,
@@ -554,6 +1457,17 @@
/*out*/ int* tag_value_size,
/*out*/ int *err);
+ //! Set tag values of arbitrary type on an array of entities
+ /** Set tag values of arbitrary type on an array of entities. Tag data is
+ * passed as char* type, but really represents pointer to arbitrary data.
+ * \param instance iMesh instance handle
+ * \param entity_handles Entity array on which tag is being set
+ * \param entity_handles_size Number of entities in array
+ * \param tag_handle Tag being set on an entity
+ * \param tag_values Pointer to tag data being set on entity
+ * \param tag_values_size Size in total bytes of tag data
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_setArrData(iMesh_Instance instance,
/*in*/ iBase_EntityHandle* entity_handles,
/*in*/ const int entity_handles_size,
@@ -562,6 +1476,16 @@
/*in*/ const int tag_values_size,
/*out*/ int *err);
+ //! Set tag values of integer type on an array of entities
+ /** Set tag values of integer type on an array of entities.
+ * \param instance iMesh instance handle
+ * \param entity_handles Entity array on which tag is being set
+ * \param entity_handles_size Number of entities in array
+ * \param tag_handle Tag being set on an entity
+ * \param tag_values Pointer to tag data being set on entities
+ * \param tag_values_size Size in total number of integers of tag data
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_setIntArrData(iMesh_Instance instance,
/*in*/ iBase_EntityHandle* entity_handles,
/*in*/ const int entity_handles_size,
@@ -570,6 +1494,16 @@
/*in*/ const int tag_values_size,
/*out*/ int *err);
+ //! Set tag values of double type on an array of entities
+ /** Set tag values of double type on an array of entities.
+ * \param instance iMesh instance handle
+ * \param entity_handles Entity array on which tag is being set
+ * \param entity_handles_size Number of entities in array
+ * \param tag_handle Tag being set on an entity
+ * \param tag_values Pointer to tag data being set on entities
+ * \param tag_values_size Size in total number of doubles of tag data
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_setDblArrData(iMesh_Instance instance,
/*in*/ iBase_EntityHandle* entity_handles,
/*in*/ const int entity_handles_size,
@@ -578,6 +1512,17 @@
/*in*/ const int tag_values_size,
/*out*/ int *err);
+ //! Set tag values of entity handle type on an array of entities
+ /** Set tag values of entity handle type on an array of entities.
+ * \param instance iMesh instance handle
+ * \param entity_handles Entity array on which tag is being set
+ * \param entity_handles_size Number of entities in array
+ * \param tag_handle Tag being set on an entity
+ * \param tag_values Pointer to tag data being set on entities
+ * \param tag_values_size Size in total number of entity handles of tag
+ * data
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_setEHArrData(iMesh_Instance instance,
/*in*/ iBase_EntityHandle* entity_handles,
/*in*/ const int entity_handles_size,
@@ -586,12 +1531,31 @@
/*in*/ const int tag_values_size,
/*out*/ int *err);
+ //! Remove a tag value from an array of entities
+ /** Remove a tag value from an array of entities
+ * \param instance iMesh instance handle
+ * \param entity_handles Entity from which tag is being removed
+ * \param entity_handles_size Number of entities in entity array
+ * \param tag_handle Tag handle of tag being removed
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_rmvArrTag(iMesh_Instance instance,
/*in*/ iBase_EntityHandle* entity_handles,
/*in*/ const int entity_handles_size,
/*in*/ const iBase_TagHandle tag_handle,
/*out*/ int *err);
+ //! Get the value of a tag of arbitrary type on an entity
+ /** Get the value of a tag of arbitrary type on an entity. Tag data
+ * is passed back as char* type, but really represents arbitrary data.
+ * \param instance iMesh instance handle
+ * \param entity_handle Entity on which tag is being set
+ * \param tag_handle Tag being set on an entity
+ * \param *tag_value Pointer to tag data array being queried
+ * \param *tag_value_allocated Pointer to tag data array allocated size
+ * \param *tag_value_size Pointer to tag data array occupied size
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_getData(iMesh_Instance instance,
/*in*/ const iBase_EntityHandle entity_handle,
/*in*/ const iBase_TagHandle tag_handle,
@@ -600,24 +1564,58 @@
/*out*/ int *tag_value_size,
/*out*/ int *err);
+ //! Get the value of a tag of integer type on an entity
+ /** Get the value of a tag of integer type on an entity.
+ * \param instance iMesh instance handle
+ * \param entity_handle Entity on which tag is being set
+ * \param tag_handle Tag being set on an entity
+ * \param *out_data Pointer to tag value returned from function
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_getIntData(iMesh_Instance instance,
/*in*/ const iBase_EntityHandle entity_handle,
/*in*/ const iBase_TagHandle tag_handle,
/*out*/ int *out_data,
/*out*/ int *err);
+ //! Get the value of a tag of double type on an entity
+ /** Get the value of a tag of double type on an entity.
+ * \param instance iMesh instance handle
+ * \param entity_handle Entity on which tag is being set
+ * \param tag_handle Tag being set on an entity
+ * \param *out_data Pointer to tag value returned from function
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_getDblData(iMesh_Instance instance,
/*in*/ const iBase_EntityHandle entity_handle,
/*in*/ const iBase_TagHandle tag_handle,
/*out*/ double *out_data,
/*out*/ int *err);
+ //! Get the value of a tag of entity handle type on an entity
+ /** Get the value of a tag of entity handle type on an entity.
+ * \param instance iMesh instance handle
+ * \param entity_handle Entity on which tag is being set
+ * \param tag_handle Tag being set on an entity
+ * \param *out_data Pointer to tag value returned from function
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_getEHData(iMesh_Instance instance,
/*in*/ const iBase_EntityHandle entity_handle,
/*in*/ const iBase_TagHandle tag_handle,
/*out*/ iBase_EntityHandle *out_data,
/*out*/ int *err);
+ //! Set a tag value of arbitrary type on an entity
+ /** Set a tag value of arbitrary type on an entity. Tag data is
+ * passed as char* type, but really represents pointer to arbitrary data.
+ * \param instance iMesh instance handle
+ * \param entity_handle Entity on which tag is being set
+ * \param tag_handle Tag being set on an entity
+ * \param tag_value Pointer to tag data being set on entity
+ * \param tag_value_size Size in bytes of tag data
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_setData(iMesh_Instance instance,
/*in*/ iBase_EntityHandle entity_handle,
/*in*/ const iBase_TagHandle tag_handle,
@@ -625,12 +1623,28 @@
/*in*/ const int tag_value_size,
/*out*/ int *err);
+ //! Set a tag value of integer type on an entity
+ /** Set a tag value of integer type on an entity.
+ * \param instance iMesh instance handle
+ * \param entity_handle Entity on which tag is being set
+ * \param tag_handle Tag being set on an entity
+ * \param tag_value Tag value being set on entity
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_setIntData(iMesh_Instance instance,
/*in*/ iBase_EntityHandle entity_handle,
/*in*/ const iBase_TagHandle tag_handle,
/*in*/ const int tag_value,
/*out*/ int *err);
+ //! Set a tag value of double type on an entity
+ /** Set a tag value of double type on an entity.
+ * \param instance iMesh instance handle
+ * \param entity_handle Entity on which tag is being set
+ * \param tag_handle Tag being set on an entity
+ * \param tag_value Tag value being set on entity
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_setDblData(iMesh_Instance instance,
/*in*/ iBase_EntityHandle entity_handle,
@@ -638,12 +1652,31 @@
/*in*/ const double tag_value,
/*out*/ int *err);
+ //! Set a tag value of entity handle type on an entity
+ /** Set a tag value of entity handle type on an entity.
+ * \param instance iMesh instance handle
+ * \param entity_handle Entity on which tag is being set
+ * \param tag_handle Tag being set on an entity
+ * \param tag_value Tag value being set on entity
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_setEHData(iMesh_Instance instance,
/*in*/ iBase_EntityHandle entity_handle,
/*in*/ const iBase_TagHandle tag_handle,
/*in*/ const iBase_EntityHandle tag_value,
/*out*/ int *err);
+ //! Get all the tags associated with a specified entity handle
+ /** Get all the tags associated with a specified entity handle
+ * \param instance iMesh instance handle
+ * \param entity_handle Entity being queried
+ * \param *tag_handles Pointer to array of tag_handles returned from
+ * function
+ * \param *tag_handles_allocated Pointer to allocated size of tag_handles
+ * array
+ * \param *tag_handles_size Pointer to occupied size of tag_handles array
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_getAllTags(iMesh_Instance instance,
/*in*/ const iBase_EntityHandle entity_handle,
/*inout*/ iBase_TagHandle** tag_handles,
@@ -651,11 +1684,33 @@
/*out*/ int* tag_handles_size,
/*out*/ int *err);
+ //! Remove a tag value from an entity
+ /** Remove a tag value from an entity
+ * \param instance iMesh instance handle
+ * \param entity_handle Entity from which tag is being removed
+ * \param tag_handle Tag handle of tag being removed
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_rmvTag(iMesh_Instance instance,
/*in*/ iBase_EntityHandle entity_handle,
/*in*/ const iBase_TagHandle tag_handle,
/*out*/ int *err);
+ //! Initialize an iterator over specified entity type, topology, and size
+ /** Initialize an iterator over specified entity type, topology, and size,
+ * for a specified set or instance. Iterator returned can be used as input
+ * to functions returning the entity for the iterator. If all entities of
+ * a specified type and/or topology are to be iterated, specify
+ * iBase_ALL_TYPES or iMesh_ALL_TOPOLOGIES, respectively. Specified type
+ * or topology must be a value in the iBase_EntityType or
+ * iMesh_EntityTopology enumerations, respectively.
+ * \param instance iMesh instance handle
+ * \param entity_set_handle Entity set being iterated
+ * \param requested_entity_type Type of entity to iterate
+ * \param requested_entity_topology Topology of entity to iterate
+ * \param entity_iterator Pointer to iterator returned from function
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_initEntIter(iMesh_Instance instance,
/*in*/ const iBase_EntitySetHandle entity_set_handle,
/*in*/ const int requested_entity_type,
@@ -663,35 +1718,99 @@
/*out*/ iMesh_EntityIterator* entity_iterator,
/*out*/ int *err);
+ //! Get entity corresponding to an iterator and increment iterator
+ /** Get the entity corresponding to an array iterator, and increment the
+ * iterator. Also return whether the next value of the iterator has
+ * an entity (if non-zero, next iterator value is the end of the
+ * iteration).
+ * \param instance iMesh instance handle
+ * \param entity_iterator Iterator being queried
+ * \param entity_handle Pointer to an entity handle corresponding to the
+ * current value of iterator
+ * \param has_data Pointer to flag; if returned non-zero, next iterator
+ * has an entity
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_getNextEntIter(iMesh_Instance instance,
/*in*/ iMesh_EntityIterator entity_iterator,
/*out*/ iBase_EntityHandle* entity_handle,
/*out*/ int *has_data,
/*out*/ int *err);
+ //! Reset the iterator
+ /** Reset the iterator
+ * \param instance iMesh instance handle
+ * \param entity_iterator Iterator to reset
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_resetEntIter(iMesh_Instance instance,
/*in*/ iMesh_EntityIterator entity_iterator,
/*out*/ int *err);
+ //! Destroy the specified iterator
+ /** Destroy the specified iterator
+ * \param instance iMesh instance handle
+ * \param entity_iterator Iterator which gets destroyed
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_endEntIter(iMesh_Instance instance,
/*in*/ iMesh_EntityIterator entity_iterator,
/*out*/ int *err);
+ //! Get the entity topology for the specified entity
+ /** Get the entity topology for the specified entity. Topology
+ * returned is a value in the iMesh_EntityTopology enumeration.
+ * \param instance iMesh instance handle
+ * \param entity_handle Entity handle being queried
+ * \param *out_topo Pointer to entity topology returned from function
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_getEntTopo(iMesh_Instance instance,
/*in*/ const iBase_EntityHandle entity_handle,
/*out*/ int *out_topo,
/*out*/ int *err);
+ //! Get the entity type for the specified entity
+ /** Get the entity type for the specified entity. Type returned is a value
+ * in the iBase_EntityType enumeration.
+ * \param instance iMesh instance handle
+ * \param entity_handle Entity handle being queried
+ * \param *out_type Pointer to entity type returned from function
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_getEntType(iMesh_Instance instance,
/*in*/ const iBase_EntityHandle entity_handle,
/*out*/ int *out_type,
/*out*/ int *err);
+ //! Get coordinates of specified vertex
+ /** Get coordinates of specified vertex.
+ * \param instance iMesh instance handle
+ * \param vertex_handle Mesh vertex being queried
+ * \param *x Pointer to x coordinate returned from function
+ * \param *y Pointer to y coordinate returned from function
+ * \param *z Pointer to z coordinate returned from function
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_getVtxCoord(iMesh_Instance instance,
/*in*/ const iBase_EntityHandle vertex_handle,
/*out*/ double *x, /*out*/ double *y, /*out*/ double *z,
/*out*/ int *err);
+ //! Get entities of specified type adjacent to an entity
+ /** Get entities of specified type adjacent to an entity. Specified type
+ * must be value in the iBase_EntityType enumeration.
+ * \param instance iMesh instance handle
+ * \param entity_handle Entity handle being queried
+ * \param entity_type_requested Type of adjacent entities requested
+ * \param *adj_entity_handles Pointer to array of adjacent entities
+ * returned from function
+ * \param *adj_entity_handles_allocated Pointer to allocated size of
+ * adj_entity_handles array
+ * \param *adj_entity_handles_size Pointer to occupied size of
+ * adj_entity_handles array
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_getEntAdj(iMesh_Instance instance,
/*in*/ const iBase_EntityHandle entity_handle,
/*in*/ const int entity_type_requested,
@@ -700,18 +1819,42 @@
/*out*/ int* adj_entity_handles_size,
/*out*/ int *err);
+ //! Subtract contents of one entity set from another
+ /** Subtract contents of one entity set from another
+ * \param instance iMesh instance handle
+ * \param entity_set_1 Entity set from which other set is being subtracted
+ * \param entity_set_2 Entity set being subtracted from other set
+ * \param result_entity_set Pointer to entity set returned from function
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_subtract(iMesh_Instance instance,
/*in*/ const iBase_EntitySetHandle entity_set_1,
/*in*/ const iBase_EntitySetHandle entity_set_2,
/*out*/ iBase_EntitySetHandle* result_entity_set,
/*out*/ int *err);
+ //! Intersect contents of one entity set with another
+ /** Intersect contents of one entity set with another
+ * \param instance iMesh instance handle
+ * \param entity_set_1 Entity set being intersected with another
+ * \param entity_set_2 Entity set being intersected with another
+ * \param result_entity_set Pointer to entity set returned from function
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_intersect(iMesh_Instance instance,
/*in*/ const iBase_EntitySetHandle entity_set_1,
/*in*/ const iBase_EntitySetHandle entity_set_2,
/*out*/ iBase_EntitySetHandle* result_entity_set,
/*out*/ int *err);
+ //! Unite contents of one entity set with another
+ /** Unite contents of one entity set with another
+ * \param instance iMesh instance handle
+ * \param entity_set_1 Entity set being united with another
+ * \param entity_set_2 Entity set being united with another
+ * \param result_entity_set Pointer to entity set returned from function
+ * \param *err Pointer to error type returned from function
+ */
void iMesh_unite(iMesh_Instance instance,
/*in*/ const iBase_EntitySetHandle entity_set_1,
/*in*/ const iBase_EntitySetHandle entity_set_2,
Modified: MOAB/trunk/tools/iMesh/iMesh_MOAB.cpp
===================================================================
--- MOAB/trunk/tools/iMesh/iMesh_MOAB.cpp 2007-06-25 22:52:19 UTC (rev 1137)
+++ MOAB/trunk/tools/iMesh/iMesh_MOAB.cpp 2007-06-26 22:28:50 UTC (rev 1138)
@@ -205,8 +205,9 @@
void iMesh_getDescription(iMesh_Instance instance,
char *descr, int *err, int descr_len)
{
- strncpy(descr, iMesh_LAST_ERROR.description,
- MIN(strlen(iMesh_LAST_ERROR.description), ((unsigned int) descr_len)));
+ unsigned int len = MIN(strlen(iMesh_LAST_ERROR.description), ((unsigned int) descr_len));
+ strncpy(descr, iMesh_LAST_ERROR.description, len);
+ descr[len] = '\0';
RETURN(iBase_SUCCESS);
}
Modified: MOAB/trunk/tools/iMesh/testc_cbind.c
===================================================================
--- MOAB/trunk/tools/iMesh/testc_cbind.c 2007-06-25 22:52:19 UTC (rev 1137)
+++ MOAB/trunk/tools/iMesh/testc_cbind.c 2007-06-26 22:28:50 UTC (rev 1138)
@@ -1161,7 +1161,7 @@
// Create a tag
int result;
iBase_TagHandle tag_handle = NULL;
- char *tag_name = "int_tag";
+ const char *tag_name = "int_tag";
int tag_name_size = 8;
iMesh_createTag(mesh, tag_name, 1, iBase_INTEGER,
&tag_handle, &result, tag_name_size);
More information about the moab-dev
mailing list