[MOAB-dev] r2913 - MOAB/trunk/tools/iMesh/python/doc

[jvporter at wisc.edu]

Author: jvporter
Date: 2009-05-27 13:53:22 -0500 (Wed, 27 May 2009)
New Revision: 2913

Added:
   MOAB/trunk/tools/iMesh/python/doc/ibase.rst
   MOAB/trunk/tools/iMesh/python/doc/imesh.rst
Modified:
   MOAB/trunk/tools/iMesh/python/doc/index.rst
Log:
Add basic API reference for Python iMesh interface


Added: MOAB/trunk/tools/iMesh/python/doc/ibase.rst
===================================================================
--- MOAB/trunk/tools/iMesh/python/doc/ibase.rst	                        (rev 0)
+++ MOAB/trunk/tools/iMesh/python/doc/ibase.rst	2009-05-27 18:53:22 UTC (rev 2913)
@@ -0,0 +1,5 @@
+=================
+ iBase Interface
+=================
+
+Nothing here yet...
\ No newline at end of file

Added: MOAB/trunk/tools/iMesh/python/doc/imesh.rst
===================================================================
--- MOAB/trunk/tools/iMesh/python/doc/imesh.rst	                        (rev 0)
+++ MOAB/trunk/tools/iMesh/python/doc/imesh.rst	2009-05-27 18:53:22 UTC (rev 2913)
@@ -0,0 +1,124 @@
+=================
+ iMesh Interface
+=================
+
+.. module:: itaps
+
+.. class:: itaps.iMesh
+
+   .. attribute:: rootSet
+
+   .. attribute:: geometricDimension
+
+   .. attribute:: dfltStorage
+
+   .. attribute:: adjTable
+
+   .. method:: load(set, filename[, options])
+
+      Load a mesh
+
+   .. method:: save(set, filename[, options])
+
+      Save the mesh
+
+   .. method:: getNumOfType(type)
+
+   .. method:: getNumOfTopo(topo)
+
+   .. method:: areEHValid(doReset)
+
+   .. method:: getEntities(set, type, topo)
+
+   .. method:: getVtxCoords(entities[, storageOrder])
+
+   .. method:: getEntType(entities)
+
+   .. method:: getEntTopo(entities)
+
+   .. method:: getEntAdj(entities, typeReq)
+
+   .. method:: getEnt2ndAdj(entities, bridgeType, typeReq)
+
+   .. method:: getAdjEntIndices(entSet, typeRequestor, topoRequestor, typeRequested)
+
+   .. method:: createEntSet(isList)
+
+   .. method:: destroyEntSet(entSet)
+
+   .. method:: setVtxCoords(entities, coords[, storageOrder])
+
+   .. method:: createVtx(coords[, storageOrder])
+
+   .. method:: createEnt(topo, entities)
+
+   .. method:: createEntArr(topo, entitites)
+
+   .. method:: deleteEnt(entities)
+
+   .. method:: createTag(name, size, type)
+
+   .. method:: destroyTag(tag, forced)
+
+   .. method:: getTagHandle(name)
+
+   .. method:: setData(entities, tag, data[, type])
+
+   .. method:: getData(entities, tag[, type])
+
+   .. method:: getAllTags(entities)
+
+   .. method:: rmvTag(entities, tag)
+
+
+.. class:: itaps.iMesh.iterator
+
+   .. method:: reset()
+
+
+.. class:: itaps.iMesh.entitySet
+
+   .. attribute:: isList
+
+   .. method:: getNumEntSets(numHops)
+
+   .. method:: getEntSets(numHops)
+
+   .. method:: add(entities)
+
+   .. method:: remove(entities)
+
+   .. method:: contains(entities)
+
+   .. method:: addChild(entSet)
+
+   .. method:: removeChild(entSet)
+
+   .. method:: isChild(entSet)
+
+   .. method:: getNumChildren(numHops)
+
+   .. method:: getNumParents(numHops)
+
+   .. method:: getChildren(numHops)
+
+   .. method:: getParents(numHops)
+
+   .. method:: iterate(type, topo[, count])
+
+   .. method:: difference(entSet)
+
+   .. method:: intersection(entSet)
+
+   .. method:: union(entSet)
+
+
+.. class:: itaps.iMesh.tag
+
+   .. attribute:: name
+
+   .. attribute:: sizeValues
+
+   .. attribute:: sizeBytes
+
+   .. attribute:: type
\ No newline at end of file

Modified: MOAB/trunk/tools/iMesh/python/doc/index.rst
===================================================================
--- MOAB/trunk/tools/iMesh/python/doc/index.rst	2009-05-27 16:16:51 UTC (rev 2912)
+++ MOAB/trunk/tools/iMesh/python/doc/index.rst	2009-05-27 18:53:22 UTC (rev 2913)
@@ -2,10 +2,12 @@
  PyTAPS
 ========
 
-PyTAPS is a Python package designed to interface with ITAPS, focusing on the
-iMesh interface.
+PyTAPS is a Python package designed to interface with `ITAPS
+<http://www.tstt-scidac.org/>`_, focusing on the iMesh interface.
 
 .. toctree::
    :maxdepth: 2
 
-   build
\ No newline at end of file
+   build
+   ibase
+   imesh
\ No newline at end of file