geomField Class Reference

Field on Geometry. More...

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

Data Fields
	field

Detailed Description

Field on Geometry.

Constructor & Destructor Documentation

__init__()

def __init__	(		self,
		*	args
	)

Member Function Documentation

getShape()

def getShape

(

self

)

Returns the shape the field lies on.

References geomField.field.

getName()

def getName

(

self

)

Returns the field name.

References geomField.field.

getType()

def getType

(

self

)

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

References geomBuilder.EnumToLong(), and geomField.field.

getTypeEnum()

def getTypeEnum

(

self

)

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

References geomField.field.

getDimension()

def getDimension

(

self

)

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

References geomField.field.

getComponents()

def getComponents

(

self

)

Returns names of components.

References geomField.field.

addStep()

def addStep	(		self,
			step,
			stamp,
			values
	)

Adds a time step to the field.

Parameters

step	the time step number further used as the step identifier
stamp	the time step time
values	the values of the time step

References geomField.field, and geomField.setValues().

removeStep()

def removeStep	(		self,
			step
	)

Remove a time step from the field.

References geomField.field.

countSteps()

def countSteps

(

self

)

Returns number of time steps in the field.

References geomField.field.

getSteps()

def getSteps

(

self

)

Returns a list of time step IDs in the field.

References geomField.field.

getStep()

def getStep	(		self,
			step
	)

Returns a time step by its ID.

References geomField.field.

getStamp()

def getStamp	(		self,
			step
	)

Returns the time of the field step.

References geomField.getStep().

setStamp()

def setStamp	(		self,
			step,
			stamp
	)

Changes the time of the field step.

References geomField.getStep().

getValues()

def getValues	(		self,
			step
	)

Returns values of the field step.

References geomField.getStep().

setValues()

def setValues	(		self,
			step,
			values
	)

Changes values of the field step.

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

Field Documentation

field

field