iron.Region Class Reference

Inheritance diagram for iron.Region:

Collaboration diagram for iron.Region:

Public Member Functions
def	__init__ (self)
def	CoordinateSystemGet (self, coordinateSystem)
def	CoordinateSystemSet (self, coordinateSystem)
def	CreateFinish (self)
def	CreateStart (self, regionUserNumber, parentRegion)
def	DataPointsGet (self, dataPoints)
def	Destroy (self)
def	Finalise (self)
def	LabelGet (self)
def	LabelSet (self, label)
def	NodesGet (self, nodes)

Public Attributes
	cmiss_type

Properties
	dataPoints = property(DataPointsGet, None, None, )
	nodes = property(NodesGet, None, None, )
	coordinateSystem = property(CoordinateSystemGet, CoordinateSystemSet, None, )
	label = property(LabelGet, LabelSet, None, )

Detailed Description

Contains information for a region.

Definition at line 7367 of file iron.py.

Constructor & Destructor Documentation

def iron.Region.__init__

(

self

)

Initialise a null cmfe_RegionType

Definition at line 7371 of file iron.py.

Member Function Documentation

def iron.Region.CoordinateSystemGet	(		self,
			coordinateSystem
	)

Returns the coordinate system for a region identified by an object.

:param coordinateSystem: On return, the regions coordinate system.
:type coordinateSystem: CoordinateSystem
:rtype: None

Definition at line 7376 of file iron.py.

def iron.Region.CoordinateSystemSet	(		self,
			coordinateSystem
	)

Sets/changes the coordinate system for a region identified by an object.

:param coordinateSystem: The coordinate system to set.
:type coordinateSystem: CoordinateSystem
:rtype: None

Definition at line 7387 of file iron.py.

def iron.Region.CreateFinish

(

self

)

Finishes the creation of a region identified by an object.

:rtype: None

Definition at line 7398 of file iron.py.

def iron.Region.CreateStart	(		self,
			regionUserNumber,
			parentRegion
	)

Starts the creation of a region identified by an object.

:param regionUserNumber: The user number of the region to start the creation of.
:type regionUserNumber: int
:param parentRegion: The parent region to  to start the creation of the region in.
:type parentRegion: Region
:rtype: None

Definition at line 7407 of file iron.py.

def iron.Region.DataPointsGet	(		self,
			dataPoints
	)

Returns the data points for a region identified by an object.

:param dataPoints: On return, the regions data points.
:type dataPoints: DataPoints
:rtype: None

Definition at line 7420 of file iron.py.

def iron.Region.Destroy

(

self

)

Destroys a region identified by an object.

:rtype: None

Definition at line 7431 of file iron.py.

def iron.Region.Finalise

(

self

)

Finalises a cmfe_RegionType object.

:rtype: None

Definition at line 7440 of file iron.py.

def iron.Region.LabelGet

(

self

)

Returns the character string label for a region identified by an object.

:returns: label. The region label.
:rtype: string

Definition at line 7449 of file iron.py.

def iron.Region.LabelSet	(		self,
			label
	)

Sets/changes the character string label for a region identified by an object.

:param label: The region label to set.
:type label: string
:rtype: None

Definition at line 7459 of file iron.py.

def iron.Region.NodesGet	(		self,
			nodes
	)

Returns the nodes for a region identified by an object.

:param nodes: On return, the regions nodes.
:type nodes: Nodes
:rtype: None

Definition at line 7470 of file iron.py.

Member Data Documentation

iron.Region.cmiss_type

Definition at line 7374 of file iron.py.

Property Documentation

iron.Region.coordinateSystem = property(CoordinateSystemGet, CoordinateSystemSet, None, )

static

Definition at line 7485 of file iron.py.

iron.Region.dataPoints = property(DataPointsGet, None, None, )

static

Definition at line 7481 of file iron.py.

iron.Region.label = property(LabelGet, LabelSet, None, )

static

Definition at line 7487 of file iron.py.

iron.Region.nodes = property(NodesGet, None, None, )

static

Definition at line 7483 of file iron.py.