Version: 8.3.0
Home
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
geomField Class Reference

Field on Geometry. More...

Public Member Functions

def __init__
 
def getShape
 Returns the shape the field lies on. More...
 
def getName
 Returns the field name. More...
 
def getType
 Returns type of field data as integer [0-3]. More...
 
def getTypeEnum
 Returns type of field data: one of GEOM.FDT_Bool, GEOM.FDT_Int, GEOM.FDT_Double, GEOM.FDT_String. More...
 
def getDimension
 Returns dimension of the shape the field lies on: 0 - VERTEX, 1 - EDGE, 2 - FACE, 3 - SOLID, -1 - whole shape. More...
 
def getComponents
 Returns names of components. More...
 
def addStep
 Adds a time step to the field. More...
 
def removeStep
 Remove a time step from the field. More...
 
def countSteps
 Returns number of time steps in the field. More...
 
def getSteps
 Returns a list of time step IDs in the field. More...
 
def getStep
 Returns a time step by its ID. More...
 
def getStamp
 Returns the time of the field step. More...
 
def setStamp
 Changes the time of the field step. More...
 
def getValues
 Returns values of the field step. More...
 
def setValues
 Changes values of the field step. More...
 

Data Fields

 field
 

Detailed Description

Field on Geometry.

Constructor & Destructor Documentation

def __init__ (   self)

Member Function Documentation

def getShape (   self)

Returns the shape the field lies on.

def getName (   self)

Returns the field name.

def getType (   self)

Returns type of field data as integer [0-3].

def getTypeEnum (   self)

Returns type of field data: one of GEOM.FDT_Bool, GEOM.FDT_Int, GEOM.FDT_Double, GEOM.FDT_String.

def getDimension (   self)

Returns dimension of the shape the field lies on: 0 - VERTEX, 1 - EDGE, 2 - FACE, 3 - SOLID, -1 - whole shape.

def getComponents (   self)

Returns names of components.

def addStep (   self,
  step,
  stamp,
  values 
)

Adds a time step to the field.

Parameters
stepthe time step number further used as the step identifier
stampthe time step time
valuesthe values of the time step

References geomField.setValues().

def removeStep (   self,
  step 
)

Remove a time step from the field.

def countSteps (   self)

Returns number of time steps in the field.

def getSteps (   self)

Returns a list of time step IDs in the field.

def getStep (   self,
  step 
)

Returns a time step by its ID.

def getStamp (   self,
  step 
)

Returns the time of the field step.

References geomField.getStep().

def setStamp (   self,
  step,
  stamp 
)

Changes the time of the field step.

References geomField.getStep().

def getValues (   self,
  step 
)

Returns values of the field step.

References geomField.getStep().

def setValues (   self,
  step,
  values 
)

Changes values of the field step.

References geomField.getStep(), and geomField.getTypeEnum().

Field Documentation

field