ScanRow

class ScanRow(table, row=None)

Bases: object

The ScanRow class is a row of a ScanTable.

Generated from model’s revision -1, branch

Methods Summary

calDataTypeFromBin(row, eis)	Set the calDataType in row from the EndianInput (eis) instance.
calPatternFromBin(row, eis)	Set the optional calPattern in row from the EndianInput (eis) instance.
calibrationFunctionFromBin(row, eis)	Set the optional calibrationFunction in row from the EndianInput (eis) instance.
calibrationOnLineFromBin(row, eis)	Set the calibrationOnLine in row from the EndianInput (eis) instance.
calibrationSetFromBin(row, eis)	Set the optional calibrationSet in row from the EndianInput (eis) instance.
clearCalPattern()	Mark calPattern, which is an optional field, as non-existent.
clearCalibrationFunction()	Mark calibrationFunction, which is an optional field, as non-existent.
clearCalibrationSet()	Mark calibrationSet, which is an optional field, as non-existent.
clearFieldName()	Mark fieldName, which is an optional field, as non-existent.
clearNumField()	Mark numField, which is an optional field, as non-existent.
clearSourceName()	Mark sourceName, which is an optional field, as non-existent.
compareNoAutoInc(execBlockId, scanNumber, …)	Compare each attribute except the autoincrementable one of this ScanRow with the corresponding parameters and return True if there is a match and False otherwise.
compareRequiredValue(startTime, endTime, …)
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 optional 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.
getCalDataType()	Get calDataType.
getCalPattern()	Get calPattern, which is optional.
getCalibrationFunction()	Get calibrationFunction, which is optional.
getCalibrationOnLine()	Get calibrationOnLine.
getCalibrationSet()	Get calibrationSet, which is optional.
getEndTime()	Get endTime.
getExecBlockId()	Get execBlockId.
getExecBlockUsingExecBlockId()	Returns the row in the ExecBlock table having ExecBlock.execBlockId == execBlockId
getFieldName()	Get fieldName, which is optional.
getNumField()	Get numField, which is optional.
getNumIntent()	Get numIntent.
getNumSubscan()	Get numSubscan.
getScanIntent()	Get scanIntent.
getScanNumber()	Get scanNumber.
getSourceName()	Get sourceName, which is optional.
getStartTime()	Get startTime.
getTable()	Return the table to which this row belongs.
initFromBinMethods()
isAdded()
isCalPatternExists()	The attribute calPattern is optional.
isCalibrationFunctionExists()	The attribute calibrationFunction is optional.
isCalibrationSetExists()	The attribute calibrationSet is optional.
isFieldNameExists()	The attribute fieldName is optional.
isNumFieldExists()	The attribute numField is optional.
isSourceNameExists()	The attribute sourceName is optional.
numFieldFromBin(row, eis)	Set the optional numField in row from the EndianInput (eis) instance.
numIntentFromBin(row, eis)	Set the numIntent in row from the EndianInput (eis) instance.
numSubscanFromBin(row, eis)	Set the numSubscan in row from the EndianInput (eis) instance.
scanIntentFromBin(row, eis)	Set the scanIntent in row from the EndianInput (eis) instance.
scanNumberFromBin(row, eis)	Set the scanNumber in row from the EndianInput (eis) instance.
setCalDataType(calDataType)	Set calDataType with the specified CalDataOrigin [] value.
setCalPattern(calPattern)	Set calPattern with the specified AntennaMotionPattern [] value.
setCalibrationFunction(calibrationFunction)	Set calibrationFunction with the specified CalibrationFunction [] value.
setCalibrationOnLine(calibrationOnLine)	Set calibrationOnLine with the specified bool [] value.
setCalibrationSet(calibrationSet)	Set calibrationSet with the specified CalibrationSet [] 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.
setNumField(numField)	Set numField with the specified int value.
setNumIntent(numIntent)	Set numIntent with the specified int value.
setNumSubscan(numSubscan)	Set numSubscan with the specified int value.
setScanIntent(scanIntent)	Set scanIntent with the specified ScanIntent [] value.
setScanNumber(scanNumber)	Set scanNumber with the specified int value.
setSourceName(sourceName)	Set sourceName with the specified str value.
setStartTime(startTime)	Set startTime with the specified ArrayTime value.
sourceNameFromBin(row, eis)	Set the optional sourceName in row from the EndianInput (eis) instance.
startTimeFromBin(row, eis)	Set the startTime 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

static calDataTypeFromBin(row, eis)

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

static calPatternFromBin(row, eis)

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

static calibrationFunctionFromBin(row, eis)

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

static calibrationOnLineFromBin(row, eis)

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

static calibrationSetFromBin(row, eis)

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

clearCalPattern()

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

clearCalibrationFunction()

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

clearCalibrationSet()

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

clearFieldName()

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

clearNumField()

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

clearSourceName()

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

compareNoAutoInc(execBlockId, scanNumber, startTime, endTime, numIntent, numSubscan, scanIntent, calDataType, calibrationOnLine)

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

compareRequiredValue(startTime, endTime, numIntent, numSubscan, scanIntent, calDataType, calibrationOnLine)

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 optional 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.

getCalDataType()

Get calDataType. return calDataType as CalDataOrigin []

getCalPattern()

Get calPattern, which is optional. return calPattern as AntennaMotionPattern [] raises ValueError If calPattern does not exist.

getCalibrationFunction()

Get calibrationFunction, which is optional. return calibrationFunction as CalibrationFunction [] raises ValueError If calibrationFunction does not exist.

getCalibrationOnLine()

Get calibrationOnLine. return calibrationOnLine as bool []

getCalibrationSet()

Get calibrationSet, which is optional. return calibrationSet as CalibrationSet [] raises ValueError If calibrationSet 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, which is optional. return fieldName as str [] raises ValueError If fieldName does not exist.

getNumField()

Get numField, which is optional. return numField as int raises ValueError If numField does not exist.

getNumIntent()

Get numIntent. return numIntent as int

getNumSubscan()

Get numSubscan. return numSubscan as int

getScanIntent()

Get scanIntent. return scanIntent as ScanIntent []

getScanNumber()

Get scanNumber. return scanNumber as int

getSourceName()

Get sourceName, which is optional. return sourceName as str raises ValueError If sourceName does not exist.

getStartTime()

Get startTime. return startTime as ArrayTime

getTable()

Return the table to which this row belongs.

static initFromBinMethods()

isAdded()

isCalPatternExists()

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

isCalibrationFunctionExists()

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

isCalibrationSetExists()

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

isFieldNameExists()

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

isNumFieldExists()

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

isSourceNameExists()

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

static numFieldFromBin(row, eis)

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

static numIntentFromBin(row, eis)

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

static numSubscanFromBin(row, eis)

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

static scanIntentFromBin(row, eis)

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

static scanNumberFromBin(row, eis)

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

setCalDataType(calDataType)

Set calDataType with the specified CalDataOrigin [] value. calDataType The CalDataOrigin [] value to which calDataType is to be set.

setCalPattern(calPattern)

Set calPattern with the specified AntennaMotionPattern [] value. calPattern The AntennaMotionPattern [] value to which calPattern is to be set.

setCalibrationFunction(calibrationFunction)

Set calibrationFunction with the specified CalibrationFunction [] value. calibrationFunction The CalibrationFunction [] value to which calibrationFunction is to be set.

setCalibrationOnLine(calibrationOnLine)

Set calibrationOnLine with the specified bool [] value. calibrationOnLine The bool [] value to which calibrationOnLine is to be set.

setCalibrationSet(calibrationSet)

Set calibrationSet with the specified CalibrationSet [] value. calibrationSet The CalibrationSet [] value to which calibrationSet 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.

setNumField(numField)

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

setNumIntent(numIntent)

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

setNumSubscan(numSubscan)

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

setScanIntent(scanIntent)

Set scanIntent with the specified ScanIntent [] value. scanIntent The ScanIntent [] value to which scanIntent 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.

setSourceName(sourceName)

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

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.

static sourceNameFromBin(row, eis)

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

static startTimeFromBin(row, eis)

Set the startTime 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.