iron.DataPoints Class Reference

Inheritance diagram for iron.DataPoints:

Collaboration diagram for iron.DataPoints:

Public Member Functions
def	__init__ (self)
def	CreateFinish (self)
def	CreateStartInterface (self, interface, numberOfDataPoints)
def	CreateStart (self, region, numberOfDataPoints)
def	Destroy (self)
def	Finalise (self)
def	LabelGet (self, dataPointGlobalNumber)
def	LabelSet (self, dataPointGlobalNumber, label)
def	NumberOfDataPointsGet (self)
def	UserNumberGet (self, dataPointGlobalNumber)
def	UserNumberSet (self, dataPointGlobalNumber, dataPointUserNumber)
def	ValuesGet (self, dataPointGlobalNumber, dataPointValuesSize)
def	ValuesSet (self, dataPointGlobalNumber, dataPointValues)
def	WeightsGet (self, dataPointGlobalNumber, dataPointWeightsSize)
def	WeightsSet (self, dataPointGlobalNumber, dataPointWeights)

Public Attributes
	cmiss_type

Properties
	numberOfDataPoints = property(NumberOfDataPointsGet, None, None, )

Detailed Description

Contains information on the data points defined on a region.

Definition at line 1320 of file iron.py.

Constructor & Destructor Documentation

def iron.DataPoints.__init__

(

self

)

Initialise a null cmfe_DataPointsType

Definition at line 1324 of file iron.py.

Member Function Documentation

def iron.DataPoints.CreateFinish

(

self

)

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

:rtype: None

Definition at line 1329 of file iron.py.

def iron.DataPoints.CreateStart	(		self,
			region,
			numberOfDataPoints
	)

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

:param region: The region to start the creation of data points on.
:type region: Region
:param numberOfDataPoints: The number of data points to create.
:type numberOfDataPoints: int
:rtype: None

Definition at line 1351 of file iron.py.

def iron.DataPoints.CreateStartInterface	(		self,
			interface,
			numberOfDataPoints
	)

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

:param interface: The interface to start the creation of data points on.
:type interface: Interface
:param numberOfDataPoints: The number of data points to create.
:type numberOfDataPoints: int
:rtype: None

Definition at line 1338 of file iron.py.

def iron.DataPoints.Destroy

(

self

)

Destroys the data points in a region for data points identified by an object.

:rtype: None

Definition at line 1364 of file iron.py.

def iron.DataPoints.Finalise

(

self

)

Finalises a cmfe_DataPointsType object.

:rtype: None

Definition at line 1373 of file iron.py.

def iron.DataPoints.LabelGet	(		self,
			dataPointGlobalNumber
	)

Returns the character label for a data point in a set of data points identified by an object.

:param dataPointGlobalNumber: The global number of the data points to get the label for.
:type dataPointGlobalNumber: int
:returns: label. The label for the data point.
:rtype: string

Definition at line 1382 of file iron.py.

def iron.DataPoints.LabelSet	(		self,
			dataPointGlobalNumber,
			label
	)

Sets/changes the character label for a data point in a set of data points identified by an object.

:param dataPointGlobalNumber: The global number of the data points to set the label for.
:type dataPointGlobalNumber: int
:param label: The label for the data point to set.
:type label: string
:rtype: None

Definition at line 1394 of file iron.py.

def iron.DataPoints.NumberOfDataPointsGet

(

self

)

Returns the number of data points

:returns: numberOfDataPoints. The number of data points
:rtype: int

Definition at line 1407 of file iron.py.

def iron.DataPoints.UserNumberGet	(		self,
			dataPointGlobalNumber
	)

Returns the user number for a data point in a set of data points identified by an object.

:param dataPointGlobalNumber: The global number of the data points to get the data point user number for.
:type dataPointGlobalNumber: int
:returns: dataPointUserNumber. The user number for the data point.
:rtype: int

Definition at line 1417 of file iron.py.

def iron.DataPoints.UserNumberSet	(		self,
			dataPointGlobalNumber,
			dataPointUserNumber
	)

Sets/changes the user number for a data point in a set of data points identified by an object.

:param dataPointGlobalNumber: The global number of the data points to set the data point user number for.
:type dataPointGlobalNumber: int
:param dataPointUserNumber: The user number for the data point to set.
:type dataPointUserNumber: int
:rtype: None

Definition at line 1429 of file iron.py.

def iron.DataPoints.ValuesGet	(		self,
			dataPointGlobalNumber,
			dataPointValuesSize
	)

Returns the values for a data point in a set of data points identified by an object.

:param dataPointGlobalNumber: The global number of the data points to get the data point user number for.
:type dataPointGlobalNumber: int
:param dataPointValuesSize: Size of dataPointValues to allocate.
:returns: dataPointValues. The values for the data point.
:rtype: Array of floats

Definition at line 1442 of file iron.py.

def iron.DataPoints.ValuesSet	(		self,
			dataPointGlobalNumber,
			dataPointValues
	)

Sets/changes the values for a data point in a set of data points identified by an object.

:param dataPointGlobalNumber: The global number of the data points to set the data point user number for.
:type dataPointGlobalNumber: int
:param dataPointValues: The values for the data point to set.
:type dataPointValues: Array of floats
:rtype: None

Definition at line 1455 of file iron.py.

def iron.DataPoints.WeightsGet	(		self,
			dataPointGlobalNumber,
			dataPointWeightsSize
	)

Returns the weights for a data point in a set of data points identified by an object.

:param dataPointGlobalNumber: The global number of the data points to get the data point user number for.
:type dataPointGlobalNumber: int
:param dataPointWeightsSize: Size of dataPointWeights to allocate.
:returns: dataPointWeights. The weights for the data point.
:rtype: Array of floats

Definition at line 1468 of file iron.py.

def iron.DataPoints.WeightsSet	(		self,
			dataPointGlobalNumber,
			dataPointWeights
	)

Sets/changes the weights for a data point in a set of data points identified by an object.

:param dataPointGlobalNumber: The global number of the data points to set the data point user number for.
:type dataPointGlobalNumber: int
:param dataPointWeights: The weights for the data point to set.
:type dataPointWeights: Array of floats
:rtype: None

Definition at line 1481 of file iron.py.

Member Data Documentation

iron.DataPoints.cmiss_type

Definition at line 1327 of file iron.py.

Property Documentation

iron.DataPoints.numberOfDataPoints = property(NumberOfDataPointsGet, None, None, )

static

Definition at line 1494 of file iron.py.