CalDataRow

class CalDataRow(table, row=None)

Bases: object

The CalDataRow class is a row of a CalDataTable.

Generated from model’s revision -1, branch

Methods Summary

assocCalDataIdFromBin(row, eis)	Set the optional assocCalDataId in row from the EndianInput (eis) instance.
assocCalNatureFromBin(row, eis)	Set the optional assocCalNature in row from the EndianInput (eis) instance.
calDataIdFromBin(row, eis)	Set the calDataId in row from the EndianInput (eis) instance.
calDataTypeFromBin(row, eis)	Set the calDataType in row from the EndianInput (eis) instance.
calTypeFromBin(row, eis)	Set the calType in row from the EndianInput (eis) instance.
clearAssocCalDataId()	Mark assocCalDataId, which is an optional field, as non-existent.
clearAssocCalNature()	Mark assocCalNature, which is an optional field, as non-existent.
clearFieldName()	Mark fieldName, which is an optional field, as non-existent.
clearScanIntent()	Mark scanIntent, which is an optional field, as non-existent.
clearSourceCode()	Mark sourceCode, which is an optional field, as non-existent.
clearSourceName()	Mark sourceName, which is an optional field, as non-existent.
compareNoAutoInc(startTimeObserved, …)	Compare each attribute except the autoincrementable one of this CalDataRow with the corresponding parameters and return True if there is a match and False otherwise.
compareRequiredValue(startTimeObserved, …)
endTimeObservedFromBin(row, eis)	Set the endTimeObserved 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.
execBlockUIDFromBin(row, eis)	Set the execBlockUID 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.
getAssocCalDataId()	Get assocCalDataId, which is optional.
getAssocCalNature()	Get assocCalNature, which is optional.
getCalDataId()	Get calDataId.
getCalDataType()	Get calDataType.
getCalType()	Get calType.
getEndTimeObserved()	Get endTimeObserved.
getExecBlockUID()	Get execBlockUID.
getFieldName()	Get fieldName, which is optional.
getNumScan()	Get numScan.
getScanIntent()	Get scanIntent, which is optional.
getScanSet()	Get scanSet.
getSourceCode()	Get sourceCode, which is optional.
getSourceName()	Get sourceName, which is optional.
getStartTimeObserved()	Get startTimeObserved.
getTable()	Return the table to which this row belongs.
initFromBinMethods()
isAdded()
isAssocCalDataIdExists()	The attribute assocCalDataId is optional.
isAssocCalNatureExists()	The attribute assocCalNature is optional.
isFieldNameExists()	The attribute fieldName is optional.
isScanIntentExists()	The attribute scanIntent is optional.
isSourceCodeExists()	The attribute sourceCode is optional.
isSourceNameExists()	The attribute sourceName is optional.
numScanFromBin(row, eis)	Set the numScan in row from the EndianInput (eis) instance.
scanIntentFromBin(row, eis)	Set the optional scanIntent in row from the EndianInput (eis) instance.
scanSetFromBin(row, eis)	Set the scanSet in row from the EndianInput (eis) instance.
setAssocCalDataId(assocCalDataId)	Set assocCalDataId with the specified Tag value.
setAssocCalNature(assocCalNature)	Set assocCalNature with the specified AssociatedCalNature value.
setCalDataId(calDataId)	Set calDataId with the specified Tag value.
setCalDataType(calDataType)	Set calDataType with the specified CalDataOrigin value.
setCalType(calType)	Set calType with the specified CalType value.
setEndTimeObserved(endTimeObserved)	Set endTimeObserved with the specified ArrayTime value.
setExecBlockUID(execBlockUID)	Set execBlockUID with the specified EntityRef 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.
setNumScan(numScan)	Set numScan with the specified int value.
setScanIntent(scanIntent)	Set scanIntent with the specified ScanIntent [] value.
setScanSet(scanSet)	Set scanSet with the specified int [] value.
setSourceCode(sourceCode)	Set sourceCode with the specified str [] value.
setSourceName(sourceName)	Set sourceName with the specified str [] value.
setStartTimeObserved(startTimeObserved)	Set startTimeObserved with the specified ArrayTime value.
sourceCodeFromBin(row, eis)	Set the optional sourceCode in row from the EndianInput (eis) instance.
sourceNameFromBin(row, eis)	Set the optional sourceName in row from the EndianInput (eis) instance.
startTimeObservedFromBin(row, eis)	Set the startTimeObserved 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 assocCalDataIdFromBin(row, eis)

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

static assocCalNatureFromBin(row, eis)

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

static calDataIdFromBin(row, eis)

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

static calDataTypeFromBin(row, eis)

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

static calTypeFromBin(row, eis)

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

clearAssocCalDataId()

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

clearAssocCalNature()

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

clearFieldName()

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

clearScanIntent()

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

clearSourceCode()

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

clearSourceName()

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

compareNoAutoInc(startTimeObserved, endTimeObserved, execBlockUID, calDataType, calType, numScan, scanSet)

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

compareRequiredValue(startTimeObserved, endTimeObserved, execBlockUID, calDataType, calType, numScan, scanSet)

static endTimeObservedFromBin(row, eis)

Set the endTimeObserved 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 execBlockUIDFromBin(row, eis)

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

getAssocCalDataId()

Get assocCalDataId, which is optional. return assocCalDataId as Tag raises ValueError If assocCalDataId does not exist.

getAssocCalNature()

Get assocCalNature, which is optional. return assocCalNature as AssociatedCalNature raises ValueError If assocCalNature does not exist.

getCalDataId()

Get calDataId. return calDataId as Tag

getCalDataType()

Get calDataType. return calDataType as CalDataOrigin

getCalType()

Get calType. return calType as CalType

getEndTimeObserved()

Get endTimeObserved. return endTimeObserved as ArrayTime

getExecBlockUID()

Get execBlockUID. return execBlockUID as EntityRef

getFieldName()

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

getNumScan()

Get numScan. return numScan as int

getScanIntent()

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

getScanSet()

Get scanSet. return scanSet as int []

getSourceCode()

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

getSourceName()

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

getStartTimeObserved()

Get startTimeObserved. return startTimeObserved as ArrayTime

getTable()

Return the table to which this row belongs.

static initFromBinMethods()

isAdded()

isAssocCalDataIdExists()

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

isAssocCalNatureExists()

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

isFieldNameExists()

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

isScanIntentExists()

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

isSourceCodeExists()

The attribute sourceCode is optional. Return True if this attribute exists. return True if and only if the sourceCode 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 numScanFromBin(row, eis)

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

static scanIntentFromBin(row, eis)

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

static scanSetFromBin(row, eis)

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

setAssocCalDataId(assocCalDataId)

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

setAssocCalNature(assocCalNature)

Set assocCalNature with the specified AssociatedCalNature value. assocCalNature The AssociatedCalNature value to which assocCalNature is to be set.

setCalDataId(calDataId)

Set calDataId with the specified Tag value. calDataId The Tag value to which calDataId is to be set. The value of calDataId 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.

setCalDataType(calDataType)

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

setCalType(calType)

Set calType with the specified CalType value. calType The CalType value to which calType is to be set.

setEndTimeObserved(endTimeObserved)

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

setExecBlockUID(execBlockUID)

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

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.

setNumScan(numScan)

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

setScanIntent(scanIntent)

Set scanIntent with the specified ScanIntent [] value. scanIntent The ScanIntent [] value to which scanIntent is to be set.

setScanSet(scanSet)

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

setSourceCode(sourceCode)

Set sourceCode with the specified str [] value. sourceCode The str [] value to which sourceCode is to be set.

setSourceName(sourceName)

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

setStartTimeObserved(startTimeObserved)

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

static sourceCodeFromBin(row, eis)

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

static sourceNameFromBin(row, eis)

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

static startTimeObservedFromBin(row, eis)

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