SubscanRow

class SubscanRow(table, row=None)

Bases: object

The SubscanRow class is a row of a SubscanTable.

Generated from model’s revision -1, branch

Methods Summary

clearCorrelatorCalibration()	Mark correlatorCalibration, which is an optional field, as non-existent.
clearSubscanMode()	Mark subscanMode, which is an optional field, as non-existent.
compareNoAutoInc(execBlockId, scanNumber, …)	Compare each attribute except the autoincrementable one of this SubscanRow with the corresponding parameters and return True if there is a match and False otherwise.
compareRequiredValue(startTime, endTime, …)
correlatorCalibrationFromBin(row, eis)	Set the optional correlatorCalibration in row from the EndianInput (eis) instance.
endTimeFromBin(row, eis)	Set the endTime in row from the EndianInput (eis) instance.
equalByRequiredValue(otherRow)	Return True if all required attributes of the value part are equal to their homologues in otherRow and False otherwise.
execBlockIdFromBin(row, eis)	Set the execBlockId in row from the EndianInput (eis) instance.
fieldNameFromBin(row, eis)	Set the fieldName in row from the EndianInput (eis) instance.
fromBin(eis, table, attributesSeq)	Given an EndianInput instance by the table (which must be a Pointing instance) and the list of attributes to be found in eis, in order, this constructs a row by pulling off values from that EndianInput in the expected order.
getCorrelatorCalibration()	Get correlatorCalibration, which is optional.
getEndTime()	Get endTime.
getExecBlockId()	Get execBlockId.
getExecBlockUsingExecBlockId()	Returns the row in the ExecBlock table having ExecBlock.execBlockId == execBlockId
getFieldName()	Get fieldName.
getNumIntegration()	Get numIntegration.
getNumSubintegration()	Get numSubintegration.
getScanNumber()	Get scanNumber.
getStartTime()	Get startTime.
getSubscanIntent()	Get subscanIntent.
getSubscanMode()	Get subscanMode, which is optional.
getSubscanNumber()	Get subscanNumber.
getTable()	Return the table to which this row belongs.
initFromBinMethods()
isAdded()
isCorrelatorCalibrationExists()	The attribute correlatorCalibration is optional.
isSubscanModeExists()	The attribute subscanMode is optional.
numIntegrationFromBin(row, eis)	Set the numIntegration in row from the EndianInput (eis) instance.
numSubintegrationFromBin(row, eis)	Set the numSubintegration in row from the EndianInput (eis) instance.
scanNumberFromBin(row, eis)	Set the scanNumber in row from the EndianInput (eis) instance.
setCorrelatorCalibration(correlatorCalibration)	Set correlatorCalibration with the specified CorrelatorCalibration value.
setEndTime(endTime)	Set endTime with the specified ArrayTime value.
setExecBlockId(execBlockId)	Set execBlockId with the specified Tag value.
setFieldName(fieldName)	Set fieldName with the specified str value.
setFromXML(xmlrow)	Fill the values of this row from an XML string that was produced by the toXML() method.
setNumIntegration(numIntegration)	Set numIntegration with the specified int value.
setNumSubintegration(numSubintegration)	Set numSubintegration with the specified int [] value.
setScanNumber(scanNumber)	Set scanNumber with the specified int value.
setStartTime(startTime)	Set startTime with the specified ArrayTime value.
setSubscanIntent(subscanIntent)	Set subscanIntent with the specified SubscanIntent value.
setSubscanMode(subscanMode)	Set subscanMode with the specified SwitchingMode value.
setSubscanNumber(subscanNumber)	Set subscanNumber with the specified int value.
startTimeFromBin(row, eis)	Set the startTime in row from the EndianInput (eis) instance.
subscanIntentFromBin(row, eis)	Set the subscanIntent in row from the EndianInput (eis) instance.
subscanModeFromBin(row, eis)	Set the optional subscanMode in row from the EndianInput (eis) instance.
subscanNumberFromBin(row, eis)	Set the subscanNumber in row from the EndianInput (eis) instance.
toBin(eos)	Write this row out to the EndianOutput instance, eos.
toXML()	Return this row in the form of an XML string.

Methods Documentation

clearCorrelatorCalibration()

Mark correlatorCalibration, which is an optional field, as non-existent.

clearSubscanMode()

Mark subscanMode, which is an optional field, as non-existent.

compareNoAutoInc(execBlockId, scanNumber, subscanNumber, startTime, endTime, fieldName, subscanIntent, numIntegration, numSubintegration)

Compare each attribute except the autoincrementable one of this SubscanRow with the corresponding parameters and return True if there is a match and False otherwise.

compareRequiredValue(startTime, endTime, fieldName, subscanIntent, numIntegration, numSubintegration)

static correlatorCalibrationFromBin(row, eis)

Set the optional correlatorCalibration in row from the EndianInput (eis) instance.

static endTimeFromBin(row, eis)

Set the endTime in row from the EndianInput (eis) instance.

equalByRequiredValue(otherRow)

Return True if all required attributes of the value part are equal to their homologues in otherRow and False otherwise.

static execBlockIdFromBin(row, eis)

Set the execBlockId in row from the EndianInput (eis) instance.

static fieldNameFromBin(row, eis)

Set the fieldName in row from the EndianInput (eis) instance.

static fromBin(eis, table, attributesSeq)

Given an EndianInput instance by the table (which must be a Pointing instance) and the list of attributes to be found in eis, in order, this constructs a row by pulling off values from that EndianInput in the expected order.

The new row object is returned.

getCorrelatorCalibration()

Get correlatorCalibration, which is optional. return correlatorCalibration as CorrelatorCalibration raises ValueError If correlatorCalibration does not exist.

getEndTime()

Get endTime. return endTime as ArrayTime

getExecBlockId()

Get execBlockId. return execBlockId as Tag

getExecBlockUsingExecBlockId()

Returns the row in the ExecBlock table having ExecBlock.execBlockId == execBlockId

getFieldName()

Get fieldName. return fieldName as str

getNumIntegration()

Get numIntegration. return numIntegration as int

getNumSubintegration()

Get numSubintegration. return numSubintegration as int []

getScanNumber()

Get scanNumber. return scanNumber as int

getStartTime()

Get startTime. return startTime as ArrayTime

getSubscanIntent()

Get subscanIntent. return subscanIntent as SubscanIntent

getSubscanMode()

Get subscanMode, which is optional. return subscanMode as SwitchingMode raises ValueError If subscanMode does not exist.

getSubscanNumber()

Get subscanNumber. return subscanNumber as int

getTable()

Return the table to which this row belongs.

static initFromBinMethods()

isAdded()

isCorrelatorCalibrationExists()

The attribute correlatorCalibration is optional. Return True if this attribute exists. return True if and only if the correlatorCalibration attribute exists.

isSubscanModeExists()

The attribute subscanMode is optional. Return True if this attribute exists. return True if and only if the subscanMode attribute exists.

static numIntegrationFromBin(row, eis)

Set the numIntegration in row from the EndianInput (eis) instance.

static numSubintegrationFromBin(row, eis)

Set the numSubintegration in row from the EndianInput (eis) instance.

static scanNumberFromBin(row, eis)

Set the scanNumber in row from the EndianInput (eis) instance.

setCorrelatorCalibration(correlatorCalibration)

Set correlatorCalibration with the specified CorrelatorCalibration value. correlatorCalibration The CorrelatorCalibration value to which correlatorCalibration is to be set.

setEndTime(endTime)

Set endTime with the specified ArrayTime value. endTime The ArrayTime value to which endTime is to be set. The value of endTime can be anything allowed by the ArrayTime constructor.

setExecBlockId(execBlockId)

Set execBlockId with the specified Tag value. execBlockId The Tag value to which execBlockId is to be set. The value of execBlockId can be anything allowed by the Tag constructor.

Raises a ValueError If an attempt is made to change a part of the key after is has been added to the table.

setFieldName(fieldName)

Set fieldName with the specified str value. fieldName The str value to which fieldName is to be set.

setFromXML(xmlrow)

Fill the values of this row from an XML string that was produced by the toXML() method. If xmlrow is a minidom.Element with a nodeName of row then it will be used as is. Anything else that is not a string is an error.

setNumIntegration(numIntegration)

Set numIntegration with the specified int value. numIntegration The int value to which numIntegration is to be set.

setNumSubintegration(numSubintegration)

Set numSubintegration with the specified int [] value. numSubintegration The int [] value to which numSubintegration is to be set.

setScanNumber(scanNumber)

Set scanNumber with the specified int value. scanNumber The int value to which scanNumber is to be set.

Raises a ValueError If an attempt is made to change a part of the key after is has been added to the table.

setStartTime(startTime)

Set startTime with the specified ArrayTime value. startTime The ArrayTime value to which startTime is to be set. The value of startTime can be anything allowed by the ArrayTime constructor.

setSubscanIntent(subscanIntent)

Set subscanIntent with the specified SubscanIntent value. subscanIntent The SubscanIntent value to which subscanIntent is to be set.

setSubscanMode(subscanMode)

Set subscanMode with the specified SwitchingMode value. subscanMode The SwitchingMode value to which subscanMode is to be set.

setSubscanNumber(subscanNumber)

Set subscanNumber with the specified int value. subscanNumber The int value to which subscanNumber is to be set.

Raises a ValueError If an attempt is made to change a part of the key after is has been added to the table.

static startTimeFromBin(row, eis)

Set the startTime in row from the EndianInput (eis) instance.

static subscanIntentFromBin(row, eis)

Set the subscanIntent in row from the EndianInput (eis) instance.

static subscanModeFromBin(row, eis)

Set the optional subscanMode in row from the EndianInput (eis) instance.

static subscanNumberFromBin(row, eis)

Set the subscanNumber in row from the EndianInput (eis) instance.

toBin(eos)

Write this row out to the EndianOutput instance, eos.

toXML()

Return this row in the form of an XML string.