CDataFile: A data file - expected to have associated class for file contents

CCP4Data.CData -> CCP4File.CDataFile

Contents of class:

dbFileIdCUUID
contentFlagCInt
baseNameCFilePath
projectCProjectId
subTypeCInt
annotationCString
relPathCFilePath

Qualifiers for class:

allowUndefinedboolTrueFlag if data file can be undefined at run time
defaultdictNotImplemented
toolTipstrNotImplemented
guiLabelstrNotImplemented
guiDefinitiondict{}
helpFilestrNotImplemented
saveToDbboolTrueSave the name of this file in the database
fileExtensionslist[]A list of strings containing allowed file extensions (no dot)
mimeTypeNamestr
mimeTypeDescriptionstr
fileLabelstrNoneLabel for file
mustExistboolFalseFlag if data file must exist at run time
fromPreviousJobboolFalseFlag if input data file can be inferred from preceeding jobs
jobComboboolTrueFlag if data widget should be a combo box
fileContentClassNamestrNoneA string containing the name of a class which will hold the file contents
isDirectoryboolFalseFlag if the data is a directory
requiredSubTypelistNoneA list of allowed sub types
requiredContentFlaglistNoneA list of allowed content flags

CDataFileContent: Base class for classes holding file contents

CCP4Data.CData -> CCP4File.CDataFileContent

Contents of class:

This is a simple class without contents

Qualifiers for class:

allowUndefinedboolTrue
defaultdictNotImplemented
toolTipstrNotImplemented
guiLabelstrNotImplemented
guiDefinitiondict{}
helpFilestrNotImplemented
saveToDbboolFalseSave this data in the database

CExePath

CCP4Data.CData -> CCP4File.CExePath

Contents of class:

exePathCDataFile
exeNameCString

Qualifiers for class:

allowUndefinedboolTrue
defaultdictNotImplemented
toolTipstrNotImplemented
guiLabelstrNotImplemented
guiDefinitiondict{}
helpFilestrNotImplemented
saveToDbboolFalseSave this data in the database

CExePathList

CCP4Data.CData -> CCP4Data.CCollection -> CCP4Data.CList -> CCP4File.CExePathList

Contents of class:

List of CExePath

Qualifiers for class:

allowUndefinedboolTrue
defaultlistNotImplemented
toolTipstrNotImplemented
guiLabelstrNotImplemented
guiDefinitiondict{}
helpFilestrNotImplemented
saveToDbboolFalseSave this data in the database
listMinLengthint1Inclusive minimum length of list
listMaxLengthintNotImplementedInclusive maximum length of list
listCompareintNotImplementedIf has value 1/-1 consecutive items in list must be greater/less than preceeding item. The list item class must have a __cmp__() method.

CExportedFile

CCP4Data.CData -> CCP4File.CExportedFile

Contents of class:

exportIdCUUID

Qualifiers for class:

allowUndefinedboolTrue
defaultdictNotImplemented
toolTipstrNotImplemented
guiLabelstrNotImplemented
guiDefinitiondict{}
helpFilestrNotImplemented
saveToDbboolFalseSave this data in the database

CExportedFileList

CCP4Data.CData -> CCP4Data.CCollection -> CCP4Data.CList -> CCP4File.CExportedFileList

Contents of class:

List of CExportedFile

Qualifiers for class:

allowUndefinedboolTrue
defaultlistNotImplemented
toolTipstrNotImplemented
guiLabelstrNotImplemented
guiDefinitiondict{}
helpFilestrNotImplemented
saveToDbboolFalseSave this data in the database
listMinLengthint0Inclusive minimum length of list
listMaxLengthintNotImplementedInclusive maximum length of list
listCompareintNotImplementedIf has value 1/-1 consecutive items in list must be greater/less than preceeding item. The list item class must have a __cmp__() method.

CFileFunction: List of recognised XML file functions

CCP4Data.CData -> CCP4Data.CBaseData -> CCP4Data.CString -> CCP4File.CFileFunction

Contents of class:

This is a simple class without contents

Qualifiers for class:

allowUndefinedboolTrue
defaultstrNotImplemented
toolTipstrNotImplemented
guiLabelstrNotImplemented
guiDefinitiondict{}
helpFilestrNotImplemented
saveToDbboolFalseSave this data in the database
charWidthint-1
minLengthintNoneMinimum length of string
maxLengthintNoneMaximum length of string
onlyEnumeratorsboolTrue
enumeratorslist['DEF', 'PARAMS', 'LOG', 'PROJECTDIRECTORIES', 'COM', 'REFMAC', 'OUTPUT', 'STATUS', 'PROJECTDATABASE', 'MGSCENE', 'JOBSERVERSTATUS', 'WORKFLOW', 'COMFILEPATCH', 'CUSTOMTASK', 'IMPORTEDJOB', 'I1SUPPLEMENT', 'UNKNOWN']
menuTextlist[]A list of strings equivalent to the enumerators that will appear in the GUI
allowedCharsCodeint0Flag if the text is limited to set of allowed characters

CFilePath: A file path

CCP4Data.CData -> CCP4Data.CBaseData -> CCP4Data.CString -> CCP4File.CFilePath

Contents of class:

This is a simple class without contents

Qualifiers for class:

allowUndefinedboolTrueFlag if allow undefined value at run time
defaultstrNoneDefault file path
toolTipstrNotImplemented
guiLabelstrNotImplemented
guiDefinitiondict{}
helpFilestrNotImplemented
saveToDbboolFalseSave this data in the database
charWidthint-1
minLengthintNoneMinimum length of string
maxLengthintNoneMaximum length of string
onlyEnumeratorsboolFalseIf this is true then the enumerators are obligatory - otherwise they are treated as recommended values
enumeratorslist[]A list of allowed or recommended values for string
menuTextlist[]A list of strings equivalent to the enumerators that will appear in the GUI
allowedCharsCodeint0Flag if the text is limited to set of allowed characters
allowedCharactersstrSet of characters allowed in file name
allowedCharactersModeint1Handling of violation of allowed characters

CI2XmlDataFile: A reference to an XML file with CCP4i2 Header

CCP4Data.CData -> CCP4File.CDataFile -> CCP4File.CXmlDataFile -> CCP4File.CI2XmlDataFile

Contents of class:

projectCProjectId
headerCI2XmlHeader
baseNameCFilePath
relPathCFilePath

Qualifiers for class:

allowUndefinedboolTrueFlag if data file can be undefined at run time
defaultdictNotImplemented
toolTipstrNotImplemented
guiLabelstrNotImplemented
guiDefinitiondict{}
helpFilestrNotImplemented
saveToDbboolFalseSave the name of this file in the database
fileExtensionslist['xml']A list of strings containing allowed file extensions (no dot)
mimeTypeNamestr
mimeTypeDescriptionstr
fileLabelstrNoneLabel for file
mustExistboolFalseFlag if data file must exist at run time
fromPreviousJobboolFalseFlag if input data file can be inferred from preceeding jobs
jobComboboolTrueFlag if data widget should be a combo box
fileContentClassNamestrNoneA string containing the name of a class which will hold the file contents
isDirectoryboolFalseFlag if the data is a directory
requiredSubTypelistNoneA list of allowed sub types
requiredContentFlaglistNoneA list of allowed content flags
autoLoadHeaderboolTrue

CI2XmlHeader: Container for header info from XML file

CCP4Data.CData -> CCP4File.CI2XmlHeader

Contents of class:

functionCFileFunction
commentCString
projectNameCProjectName
hostNameCHostName
userIdCUserId
ccp4iVersionCVersion
jobIdCUUID
pluginVersionCVersion
jobNumberCString
projectIdCProjectId
creationTimeCTime
pluginNameCString
pluginTitleCString
OSCString

Qualifiers for class:

allowUndefinedboolTrue
defaultdictNotImplemented
toolTipstrNotImplemented
guiLabelstrNotImplemented
guiDefinitiondict{}
helpFilestrNotImplemented
saveToDbboolFalseSave this data in the database

CMmcifData: Generic mmCIF data. This is intended to be a base class for other classes specific to coordinates, reflections or geometry data.

CCP4Data.CData -> CCP4File.CDataFileContent -> CCP4File.CMmcifData

Contents of class:

This is a simple class without contents

Qualifiers for class:

allowUndefinedboolTrue
defaultdictNotImplemented
toolTipstrNotImplemented
guiLabelstrNotImplemented
guiDefinitiondict{}
helpFilestrNotImplemented
saveToDbboolFalseSave this data in the database

CMmcifDataFile: A generic mmCIF format file. This is intended to be a base class for other classes specific to coordinates, reflections or geometry data.

CCP4Data.CData -> CCP4File.CDataFile -> CCP4File.CMmcifDataFile

Contents of class:

dbFileIdCUUID
contentFlagCInt
baseNameCFilePath
projectCProjectId
subTypeCInt
annotationCString
relPathCFilePath

Qualifiers for class:

allowUndefinedboolTrueFlag if data file can be undefined at run time
defaultdictNotImplemented
toolTipstrNotImplemented
guiLabelstrNotImplemented
guiDefinitiondict{}
helpFilestrNotImplemented
saveToDbboolTrueSave the name of this file in the database
fileExtensionslist['cif', 'ent']A list of strings containing allowed file extensions (no dot)
mimeTypeNamestr
mimeTypeDescriptionstr
fileLabelstrNoneLabel for file
mustExistboolFalseFlag if data file must exist at run time
fromPreviousJobboolFalseFlag if input data file can be inferred from preceeding jobs
jobComboboolTrueFlag if data widget should be a combo box
fileContentClassNamestrNoneA string containing the name of a class which will hold the file contents
isDirectoryboolFalseFlag if the data is a directory
requiredSubTypelistNoneA list of allowed sub types
requiredContentFlaglistNoneA list of allowed content flags

CPostscriptDataFile: An postscript format file

CCP4Data.CData -> CCP4File.CDataFile -> CCP4File.CPostscriptDataFile

Contents of class:

dbFileIdCUUID
contentFlagCInt
baseNameCFilePath
projectCProjectId
subTypeCInt
annotationCString
relPathCFilePath

Qualifiers for class:

allowUndefinedboolTrueFlag if data file can be undefined at run time
defaultdictNotImplemented
toolTipstrNotImplemented
guiLabelstrNotImplemented
guiDefinitiondict{}
helpFilestrNotImplemented
saveToDbboolTrueSave the name of this file in the database
fileExtensionslist['ps']A list of strings containing allowed file extensions (no dot)
mimeTypeNamestrapplication/postscript
mimeTypeDescriptionstr
fileLabelstrNoneLabel for file
mustExistboolFalseFlag if data file must exist at run time
fromPreviousJobboolFalseFlag if input data file can be inferred from preceeding jobs
jobComboboolTrueFlag if data widget should be a combo box
fileContentClassNamestrNoneA string containing the name of a class which will hold the file contents
isDirectoryboolFalseFlag if the data is a directory
requiredSubTypelistNoneA list of allowed sub types
requiredContentFlaglistNoneA list of allowed content flags

CProjectId: The CCP4i2 database project id - a global unique id

CCP4Data.CData -> CCP4Data.CBaseData -> CCP4Data.CString -> CCP4Data.CUUID -> CCP4File.CProjectId

Contents of class:

This is a simple class without contents

Qualifiers for class:

allowUndefinedboolTrueFlag if allow undefined value at run time
defaultstrNone
toolTipstrNotImplemented
guiLabelstrNotImplemented
guiDefinitiondict{}
helpFilestrNotImplemented
saveToDbboolFalseSave this data in the database
charWidthint-1
minLengthintNoneMinimum length of string
maxLengthintNoneMaximum length of string
onlyEnumeratorsboolFalseIf this is true then the enumerators are obligatory - otherwise they are treated as recommended values
enumeratorslist[]A list of allowed or recommended values for string
menuTextlist[]A list of strings equivalent to the enumerators that will appear in the GUI
allowedCharsCodeint0Flag if the text is limited to set of allowed characters
allowUnfoundboolTrueFlag if allow unfound project at run time

CProjectName: The name of a CCP4i project or directory alias

CCP4Data.CData -> CCP4Data.CBaseData -> CCP4Data.CString -> CCP4File.CProjectName

Contents of class:

This is a simple class without contents

Qualifiers for class:

allowUndefinedboolTrueFlag if allow undefined value at run time
defaultstrNone
toolTipstrNotImplemented
guiLabelstrNotImplemented
guiDefinitiondict{}
helpFilestrNotImplemented
saveToDbboolFalseSave this data in the database
charWidthint-1
minLengthintNoneMinimum length of string
maxLengthintNoneMaximum length of string
onlyEnumeratorsboolFalseIf this is true then the enumerators are obligatory - otherwise they are treated as recommended values
enumeratorslist[]A list of allowed or recommended values for string
menuTextlist[]A list of strings equivalent to the enumerators that will appear in the GUI
allowedCharsCodeint0Flag if the text is limited to set of allowed characters
allowAliasboolTrueFlag if allow project to be directory alias at run time
allowUnfoundboolTrueFlag if allow unfound project at run time

CSceneDataFile: An xml format file for defining scene in CCP4mg.

CCP4Data.CData -> CCP4File.CDataFile -> CCP4File.CSceneDataFile

Contents of class:

dbFileIdCUUID
contentFlagCInt
baseNameCFilePath
projectCProjectId
subTypeCInt
annotationCString
relPathCFilePath

Qualifiers for class:

allowUndefinedboolTrueFlag if data file can be undefined at run time
defaultdictNotImplemented
toolTipstrNotImplemented
guiLabelstrCCP4mg scene
guiDefinitiondict{}
helpFilestrNotImplemented
saveToDbboolTrueSave the name of this file in the database
fileExtensionslist['scene.xml']A list of strings containing allowed file extensions (no dot)
mimeTypeNamestrapplication/CCP4-scene
mimeTypeDescriptionstrCCP4mg scene file
fileLabelstrsceneLabel for file
mustExistboolFalseFlag if data file must exist at run time
fromPreviousJobboolFalseFlag if input data file can be inferred from preceeding jobs
jobComboboolTrueFlag if data widget should be a combo box
fileContentClassNamestrNotImplementedA string containing the name of a class which will hold the file contents
isDirectoryboolFalseFlag if the data is a directory
requiredSubTypelistNoneA list of allowed sub types
requiredContentFlaglistNoneA list of allowed content flags

CSearchPath

CCP4Data.CData -> CCP4File.CSearchPath

Contents of class:

pathCDataFile
nameCString

Qualifiers for class:

allowUndefinedboolTrue
defaultdictNotImplemented
toolTipstrNotImplemented
guiLabelstrNotImplemented
guiDefinitiondict{}
helpFilestrNotImplemented
saveToDbboolFalseSave this data in the database

CSearchPathList

CCP4Data.CData -> CCP4Data.CCollection -> CCP4Data.CList -> CCP4File.CSearchPathList

Contents of class:

List of CSearchPath

Qualifiers for class:

allowUndefinedboolTrue
defaultlistNotImplemented
toolTipstrNotImplemented
guiLabelstrNotImplemented
guiDefinitiondict{}
helpFilestrNotImplemented
saveToDbboolFalseSave this data in the database
listMinLengthint0Inclusive minimum length of list
listMaxLengthintNotImplementedInclusive maximum length of list
listCompareintNotImplementedIf has value 1/-1 consecutive items in list must be greater/less than preceeding item. The list item class must have a __cmp__() method.

CTextDataFile: A text data file

CCP4Data.CData -> CCP4File.CDataFile -> CCP4File.CTextDataFile

Contents of class:

dbFileIdCUUID
contentFlagCInt
baseNameCFilePath
projectCProjectId
subTypeCInt
annotationCString
relPathCFilePath

Qualifiers for class:

allowUndefinedboolTrueFlag if data file can be undefined at run time
defaultdictNotImplemented
toolTipstrNotImplemented
guiLabelstrNotImplemented
guiDefinitiondict{}
helpFilestrNotImplemented
saveToDbboolTrueSave the name of this file in the database
fileExtensionslist['txt', 'log']A list of strings containing allowed file extensions (no dot)
mimeTypeNamestr"text/plain"
mimeTypeDescriptionstrStandard plain text
fileLabelstrNoneLabel for file
mustExistboolFalseFlag if data file must exist at run time
fromPreviousJobboolFalseFlag if input data file can be inferred from preceeding jobs
jobComboboolTrueFlag if data widget should be a combo box
fileContentClassNamestrNoneA string containing the name of a class which will hold the file contents
isDirectoryboolFalseFlag if the data is a directory
requiredSubTypelistNoneA list of allowed sub types
requiredContentFlaglistNoneA list of allowed content flags

CVersion: A (string) version number of the form n.m.i

CCP4Data.CData -> CCP4Data.CBaseData -> CCP4Data.CString -> CCP4File.CVersion

Contents of class:

This is a simple class without contents

Qualifiers for class:

allowUndefinedboolTrueFlag if allow an unset value at run time
defaultstrNoneA default value
toolTipstrNotImplemented
guiLabelstrNotImplemented
guiDefinitiondict{}
helpFilestrNotImplemented
saveToDbboolFalseSave this data in the database
charWidthint10Number of characters allowed for widget in GUI
minLengthintNoneMinimum length of string
maxLengthintNoneMaximum length of string
onlyEnumeratorsboolFalseIf this is true then the enumerators are obligatory - otherwise they are treated as recommended values
enumeratorslist[]A list of allowed or recommended values for string
menuTextlist[]A list of strings equivalent to the enumerators that will appear in the GUI
allowedCharsCodeint0Flag if the text is limited to set of allowed characters

CXmgrDataFile: An xmgr format file. This is the input format for xmgrace, as output by scala or aimless

CCP4Data.CData -> CCP4File.CDataFile -> CCP4File.CXmgrDataFile

Contents of class:

dbFileIdCUUID
contentFlagCInt
baseNameCFilePath
projectCProjectId
subTypeCInt
annotationCString
relPathCFilePath

Qualifiers for class:

allowUndefinedboolTrueFlag if data file can be undefined at run time
defaultdictNotImplemented
toolTipstrNotImplemented
guiLabelstrNotImplemented
guiDefinitiondict{}
helpFilestrNotImplemented
saveToDbboolTrueSave the name of this file in the database
fileExtensionslist['xmgr']A list of strings containing allowed file extensions (no dot)
mimeTypeNamestr
mimeTypeDescriptionstr
fileLabelstrNoneLabel for file
mustExistboolFalseFlag if data file must exist at run time
fromPreviousJobboolFalseFlag if input data file can be inferred from preceeding jobs
jobComboboolTrueFlag if data widget should be a combo box
fileContentClassNamestrNoneA string containing the name of a class which will hold the file contents
isDirectoryboolFalseFlag if the data is a directory
requiredSubTypelistNoneA list of allowed sub types
requiredContentFlaglistNoneA list of allowed content flags

CXmlDataFile: A reference to an XML file

CCP4Data.CData -> CCP4File.CDataFile -> CCP4File.CXmlDataFile

Contents of class:

dbFileIdCUUID
contentFlagCInt
baseNameCFilePath
projectCProjectId
subTypeCInt
annotationCString
relPathCFilePath

Qualifiers for class:

allowUndefinedboolTrueFlag if data file can be undefined at run time
defaultdictNotImplemented
toolTipstrNotImplemented
guiLabelstrNotImplemented
guiDefinitiondict{}
helpFilestrNotImplemented
saveToDbboolFalseSave the name of this file in the database
fileExtensionslist['xml']A list of strings containing allowed file extensions (no dot)
mimeTypeNamestr
mimeTypeDescriptionstr
fileLabelstrNoneLabel for file
mustExistboolFalseFlag if data file must exist at run time
fromPreviousJobboolFalseFlag if input data file can be inferred from preceeding jobs
jobComboboolTrueFlag if data widget should be a combo box
fileContentClassNamestrNoneA string containing the name of a class which will hold the file contents
isDirectoryboolFalseFlag if the data is a directory
requiredSubTypelistNoneA list of allowed sub types
requiredContentFlaglistNoneA list of allowed content flags