iron.Nodes Class Reference

Inheritance diagram for iron.Nodes:

Collaboration diagram for iron.Nodes:

Public Member Functions
def	__init__ (self)
def	CreateFinish (self)
def	CreateStartInterface (self, interface, numberOfNodes)
def	CreateStart (self, region, numberOfNodes)
def	Destroy (self)
def	Finalise (self)
def	LabelGet (self, nodeGlobalNumber)
def	LabelSet (self, nodeGlobalNumber, label)
def	NumberOfNodesGet (self)
def	UserNumberGet (self, nodeGlobalNumber)
def	UserNumberSet (self, nodeGlobalNumber, nodeUserNumber)
def	UserNumbersAllSet (self, nodeUserNumbers)

Public Attributes
	cmiss_type

Properties
	userNumbersAll = property(None, UserNumbersAllSet, None, )
	numberOfNodes = property(NumberOfNodesGet, None, None, )

Detailed Description

Contains information on the nodes defined on a region.

Definition at line 6969 of file iron.py.

Constructor & Destructor Documentation

def iron.Nodes.__init__

(

self

)

Initialise a null cmfe_NodesType

Definition at line 6973 of file iron.py.

Member Function Documentation

def iron.Nodes.CreateFinish

(

self

)

Finishes the creation of a nodes in a region for nodes identified by an object.

:rtype: None

Definition at line 6978 of file iron.py.

def iron.Nodes.CreateStart	(		self,
			region,
			numberOfNodes
	)

Starts the creation of a nodes in a region for nodes identified by an object.

:param region: The region to start the creation of nodes on.
:type region: Region
:param numberOfNodes: The number of nodes to create.
:type numberOfNodes: int
:rtype: None

Definition at line 7000 of file iron.py.

def iron.Nodes.CreateStartInterface	(		self,
			interface,
			numberOfNodes
	)

Starts the creation of a nodes in a region for nodes identified by an object.

:param interface: The interface to start the creation of nodes on.
:type interface: Interface
:param numberOfNodes: The number of nodes to create.
:type numberOfNodes: int
:rtype: None

Definition at line 6987 of file iron.py.

def iron.Nodes.Destroy

(

self

)

Destroys the nodes in a region for nodes identified by an object.

:rtype: None

Definition at line 7013 of file iron.py.

def iron.Nodes.Finalise

(

self

)

Finalises a cmfe_NodesType object.

:rtype: None

Definition at line 7022 of file iron.py.

def iron.Nodes.LabelGet	(		self,
			nodeGlobalNumber
	)

Returns the character label for a node in a set of nodes identified by an object. \todo should this be user number??

:param nodeGlobalNumber: The global number of the nodes to get the label for.
:type nodeGlobalNumber: int
:returns: label. The label for the node.
:rtype: string

Definition at line 7031 of file iron.py.

def iron.Nodes.LabelSet	(		self,
			nodeGlobalNumber,
			label
	)

Sets/changes the character label for a node in a set of nodes identified by an object. \todo should this be user number??

:param nodeGlobalNumber: The global number of the nodes to set the label for.
:type nodeGlobalNumber: int
:param label: The label for the node to set.
:type label: string
:rtype: None

Definition at line 7043 of file iron.py.

def iron.Nodes.NumberOfNodesGet

(

self

)

Returns the number of nodes

:returns: numberOfNodes. The number of nodes
:rtype: int

Definition at line 7056 of file iron.py.

def iron.Nodes.UserNumberGet	(		self,
			nodeGlobalNumber
	)

Returns the user number for a node in a set of nodes identified by an object. \todo should this be user number??

:param nodeGlobalNumber: The global number of the nodes to get the node user number for.
:type nodeGlobalNumber: int
:returns: nodeUserNumber. The user number for the node.
:rtype: int

Definition at line 7066 of file iron.py.

def iron.Nodes.UserNumbersAllSet	(		self,
			nodeUserNumbers
	)

Sets/changes the user numbers for a set of nodes identified by an object.

:param nodeUserNumbers: The user numbers for the nodes to set.
:type nodeUserNumbers: Array of ints
:rtype: None

Definition at line 7091 of file iron.py.

def iron.Nodes.UserNumberSet	(		self,
			nodeGlobalNumber,
			nodeUserNumber
	)

Sets/changes the user number for a node in a set of nodes identified by an object. \todo should this be user number??

:param nodeGlobalNumber: The global number of the nodes to set the node user number for.
:type nodeGlobalNumber: int
:param nodeUserNumber: The user number for the node to set.
:type nodeUserNumber: int
:rtype: None

Definition at line 7078 of file iron.py.

Member Data Documentation

iron.Nodes.cmiss_type

Definition at line 6976 of file iron.py.

Property Documentation

iron.Nodes.numberOfNodes = property(NumberOfNodesGet, None, None, )

static

Definition at line 7104 of file iron.py.

iron.Nodes.userNumbersAll = property(None, UserNumbersAllSet, None, )

static

Definition at line 7102 of file iron.py.