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

Contents of class:

dbFileId	CUUID
contentFlag	CInt
baseName	CFilePath
project	CProjectId
subType	CInt
annotation	CString
relPath	CFilePath

Qualifiers for class:

allowUndefined	bool	True	Flag if data file can be undefined at run time
default	dict	NotImplemented
toolTip	str	NotImplemented
guiLabel	str	NotImplemented
guiDefinition	dict	{}
helpFile	str	NotImplemented
saveToDb	bool	True	Save the name of this file in the database
fileExtensions	list	[]	A list of strings containing allowed file extensions (no dot)
mimeTypeName	str
mimeTypeDescription	str
fileLabel	str	None	Label for file
mustExist	bool	False	Flag if data file must exist at run time
fromPreviousJob	bool	False	Flag if input data file can be inferred from preceeding jobs
jobCombo	bool	True	Flag if data widget should be a combo box
fileContentClassName	str	None	A string containing the name of a class which will hold the file contents
isDirectory	bool	False	Flag if the data is a directory
requiredSubType	list	None	A list of allowed sub types
requiredContentFlag	list	None	A 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:

allowUndefined	bool	True
default	dict	NotImplemented
toolTip	str	NotImplemented
guiLabel	str	NotImplemented
guiDefinition	dict	{}
helpFile	str	NotImplemented
saveToDb	bool	False	Save this data in the database

CExePath

CCP4Data.CData -> CCP4File.CExePath

Contents of class:

exePath	CDataFile
exeName	CString

Qualifiers for class:

allowUndefined	bool	True
default	dict	NotImplemented
toolTip	str	NotImplemented
guiLabel	str	NotImplemented
guiDefinition	dict	{}
helpFile	str	NotImplemented
saveToDb	bool	False	Save this data in the database

CExePathList

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

Contents of class:

List of CExePath

Qualifiers for class:

allowUndefined	bool	True
default	list	NotImplemented
toolTip	str	NotImplemented
guiLabel	str	NotImplemented
guiDefinition	dict	{}
helpFile	str	NotImplemented
saveToDb	bool	False	Save this data in the database
listMinLength	int	1	Inclusive minimum length of list
listMaxLength	int	NotImplemented	Inclusive maximum length of list
listCompare	int	NotImplemented	If 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:

exportId

CUUID

Qualifiers for class:

allowUndefined	bool	True
default	dict	NotImplemented
toolTip	str	NotImplemented
guiLabel	str	NotImplemented
guiDefinition	dict	{}
helpFile	str	NotImplemented
saveToDb	bool	False	Save this data in the database

CExportedFileList

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

Contents of class:

List of CExportedFile

Qualifiers for class:

allowUndefined	bool	True
default	list	NotImplemented
toolTip	str	NotImplemented
guiLabel	str	NotImplemented
guiDefinition	dict	{}
helpFile	str	NotImplemented
saveToDb	bool	False	Save this data in the database
listMinLength	int	0	Inclusive minimum length of list
listMaxLength	int	NotImplemented	Inclusive maximum length of list
listCompare	int	NotImplemented	If 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:

allowUndefined	bool	True
default	str	NotImplemented
toolTip	str	NotImplemented
guiLabel	str	NotImplemented
guiDefinition	dict	{}
helpFile	str	NotImplemented
saveToDb	bool	False	Save this data in the database
charWidth	int	-1
minLength	int	None	Minimum length of string
maxLength	int	None	Maximum length of string
onlyEnumerators	bool	True
enumerators	list	['DEF', 'PARAMS', 'LOG', 'PROJECTDIRECTORIES', 'COM', 'REFMAC', 'OUTPUT', 'STATUS', 'PROJECTDATABASE', 'MGSCENE', 'JOBSERVERSTATUS', 'WORKFLOW', 'COMFILEPATCH', 'CUSTOMTASK', 'IMPORTEDJOB', 'I1SUPPLEMENT', 'UNKNOWN']
menuText	list	[]	A list of strings equivalent to the enumerators that will appear in the GUI
allowedCharsCode	int	0	Flag 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:

allowUndefined	bool	True	Flag if allow undefined value at run time
default	str	None	Default file path
toolTip	str	NotImplemented
guiLabel	str	NotImplemented
guiDefinition	dict	{}
helpFile	str	NotImplemented
saveToDb	bool	False	Save this data in the database
charWidth	int	-1
minLength	int	None	Minimum length of string
maxLength	int	None	Maximum length of string
onlyEnumerators	bool	False	If this is true then the enumerators are obligatory - otherwise they are treated as recommended values
enumerators	list	[]	A list of allowed or recommended values for string
menuText	list	[]	A list of strings equivalent to the enumerators that will appear in the GUI
allowedCharsCode	int	0	Flag if the text is limited to set of allowed characters
allowedCharacters	str		Set of characters allowed in file name
allowedCharactersMode	int	1	Handling 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:

project	CProjectId
header	CI2XmlHeader
baseName	CFilePath
relPath	CFilePath

Qualifiers for class:

allowUndefined	bool	True	Flag if data file can be undefined at run time
default	dict	NotImplemented
toolTip	str	NotImplemented
guiLabel	str	NotImplemented
guiDefinition	dict	{}
helpFile	str	NotImplemented
saveToDb	bool	False	Save the name of this file in the database
fileExtensions	list	['xml']	A list of strings containing allowed file extensions (no dot)
mimeTypeName	str
mimeTypeDescription	str
fileLabel	str	None	Label for file
mustExist	bool	False	Flag if data file must exist at run time
fromPreviousJob	bool	False	Flag if input data file can be inferred from preceeding jobs
jobCombo	bool	True	Flag if data widget should be a combo box
fileContentClassName	str	None	A string containing the name of a class which will hold the file contents
isDirectory	bool	False	Flag if the data is a directory
requiredSubType	list	None	A list of allowed sub types
requiredContentFlag	list	None	A list of allowed content flags
autoLoadHeader	bool	True

CI2XmlHeader: Container for header info from XML file

CCP4Data.CData -> CCP4File.CI2XmlHeader

Contents of class:

function	CFileFunction
comment	CString
projectName	CProjectName
hostName	CHostName
userId	CUserId
ccp4iVersion	CVersion
jobId	CUUID
pluginVersion	CVersion
jobNumber	CString
projectId	CProjectId
creationTime	CTime
pluginName	CString
pluginTitle	CString
OS	CString

Qualifiers for class:

allowUndefined	bool	True
default	dict	NotImplemented
toolTip	str	NotImplemented
guiLabel	str	NotImplemented
guiDefinition	dict	{}
helpFile	str	NotImplemented
saveToDb	bool	False	Save 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:

allowUndefined	bool	True
default	dict	NotImplemented
toolTip	str	NotImplemented
guiLabel	str	NotImplemented
guiDefinition	dict	{}
helpFile	str	NotImplemented
saveToDb	bool	False	Save 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:

dbFileId	CUUID
contentFlag	CInt
baseName	CFilePath
project	CProjectId
subType	CInt
annotation	CString
relPath	CFilePath

Qualifiers for class:

allowUndefined	bool	True	Flag if data file can be undefined at run time
default	dict	NotImplemented
toolTip	str	NotImplemented
guiLabel	str	NotImplemented
guiDefinition	dict	{}
helpFile	str	NotImplemented
saveToDb	bool	True	Save the name of this file in the database
fileExtensions	list	['cif', 'ent']	A list of strings containing allowed file extensions (no dot)
mimeTypeName	str
mimeTypeDescription	str
fileLabel	str	None	Label for file
mustExist	bool	False	Flag if data file must exist at run time
fromPreviousJob	bool	False	Flag if input data file can be inferred from preceeding jobs
jobCombo	bool	True	Flag if data widget should be a combo box
fileContentClassName	str	None	A string containing the name of a class which will hold the file contents
isDirectory	bool	False	Flag if the data is a directory
requiredSubType	list	None	A list of allowed sub types
requiredContentFlag	list	None	A list of allowed content flags

CPostscriptDataFile: An postscript format file

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

Contents of class:

dbFileId	CUUID
contentFlag	CInt
baseName	CFilePath
project	CProjectId
subType	CInt
annotation	CString
relPath	CFilePath

Qualifiers for class:

allowUndefined	bool	True	Flag if data file can be undefined at run time
default	dict	NotImplemented
toolTip	str	NotImplemented
guiLabel	str	NotImplemented
guiDefinition	dict	{}
helpFile	str	NotImplemented
saveToDb	bool	True	Save the name of this file in the database
fileExtensions	list	['ps']	A list of strings containing allowed file extensions (no dot)
mimeTypeName	str	application/postscript
mimeTypeDescription	str
fileLabel	str	None	Label for file
mustExist	bool	False	Flag if data file must exist at run time
fromPreviousJob	bool	False	Flag if input data file can be inferred from preceeding jobs
jobCombo	bool	True	Flag if data widget should be a combo box
fileContentClassName	str	None	A string containing the name of a class which will hold the file contents
isDirectory	bool	False	Flag if the data is a directory
requiredSubType	list	None	A list of allowed sub types
requiredContentFlag	list	None	A 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:

allowUndefined	bool	True	Flag if allow undefined value at run time
default	str	None
toolTip	str	NotImplemented
guiLabel	str	NotImplemented
guiDefinition	dict	{}
helpFile	str	NotImplemented
saveToDb	bool	False	Save this data in the database
charWidth	int	-1
minLength	int	None	Minimum length of string
maxLength	int	None	Maximum length of string
onlyEnumerators	bool	False	If this is true then the enumerators are obligatory - otherwise they are treated as recommended values
enumerators	list	[]	A list of allowed or recommended values for string
menuText	list	[]	A list of strings equivalent to the enumerators that will appear in the GUI
allowedCharsCode	int	0	Flag if the text is limited to set of allowed characters
allowUnfound	bool	True	Flag 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:

allowUndefined	bool	True	Flag if allow undefined value at run time
default	str	None
toolTip	str	NotImplemented
guiLabel	str	NotImplemented
guiDefinition	dict	{}
helpFile	str	NotImplemented
saveToDb	bool	False	Save this data in the database
charWidth	int	-1
minLength	int	None	Minimum length of string
maxLength	int	None	Maximum length of string
onlyEnumerators	bool	False	If this is true then the enumerators are obligatory - otherwise they are treated as recommended values
enumerators	list	[]	A list of allowed or recommended values for string
menuText	list	[]	A list of strings equivalent to the enumerators that will appear in the GUI
allowedCharsCode	int	0	Flag if the text is limited to set of allowed characters
allowAlias	bool	True	Flag if allow project to be directory alias at run time
allowUnfound	bool	True	Flag 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:

dbFileId	CUUID
contentFlag	CInt
baseName	CFilePath
project	CProjectId
subType	CInt
annotation	CString
relPath	CFilePath

Qualifiers for class:

allowUndefined	bool	True	Flag if data file can be undefined at run time
default	dict	NotImplemented
toolTip	str	NotImplemented
guiLabel	str	CCP4mg scene
guiDefinition	dict	{}
helpFile	str	NotImplemented
saveToDb	bool	True	Save the name of this file in the database
fileExtensions	list	['scene.xml']	A list of strings containing allowed file extensions (no dot)
mimeTypeName	str	application/CCP4-scene
mimeTypeDescription	str	CCP4mg scene file
fileLabel	str	scene	Label for file
mustExist	bool	False	Flag if data file must exist at run time
fromPreviousJob	bool	False	Flag if input data file can be inferred from preceeding jobs
jobCombo	bool	True	Flag if data widget should be a combo box
fileContentClassName	str	NotImplemented	A string containing the name of a class which will hold the file contents
isDirectory	bool	False	Flag if the data is a directory
requiredSubType	list	None	A list of allowed sub types
requiredContentFlag	list	None	A list of allowed content flags

CSearchPath

CCP4Data.CData -> CCP4File.CSearchPath

Contents of class:

path	CDataFile
name	CString

Qualifiers for class:

allowUndefined	bool	True
default	dict	NotImplemented
toolTip	str	NotImplemented
guiLabel	str	NotImplemented
guiDefinition	dict	{}
helpFile	str	NotImplemented
saveToDb	bool	False	Save this data in the database

CSearchPathList

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

Contents of class:

List of CSearchPath

Qualifiers for class:

allowUndefined	bool	True
default	list	NotImplemented
toolTip	str	NotImplemented
guiLabel	str	NotImplemented
guiDefinition	dict	{}
helpFile	str	NotImplemented
saveToDb	bool	False	Save this data in the database
listMinLength	int	0	Inclusive minimum length of list
listMaxLength	int	NotImplemented	Inclusive maximum length of list
listCompare	int	NotImplemented	If 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:

dbFileId	CUUID
contentFlag	CInt
baseName	CFilePath
project	CProjectId
subType	CInt
annotation	CString
relPath	CFilePath

Qualifiers for class:

allowUndefined	bool	True	Flag if data file can be undefined at run time
default	dict	NotImplemented
toolTip	str	NotImplemented
guiLabel	str	NotImplemented
guiDefinition	dict	{}
helpFile	str	NotImplemented
saveToDb	bool	True	Save the name of this file in the database
fileExtensions	list	['txt', 'log']	A list of strings containing allowed file extensions (no dot)
mimeTypeName	str	"text/plain"
mimeTypeDescription	str	Standard plain text
fileLabel	str	None	Label for file
mustExist	bool	False	Flag if data file must exist at run time
fromPreviousJob	bool	False	Flag if input data file can be inferred from preceeding jobs
jobCombo	bool	True	Flag if data widget should be a combo box
fileContentClassName	str	None	A string containing the name of a class which will hold the file contents
isDirectory	bool	False	Flag if the data is a directory
requiredSubType	list	None	A list of allowed sub types
requiredContentFlag	list	None	A 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:

allowUndefined	bool	True	Flag if allow an unset value at run time
default	str	None	A default value
toolTip	str	NotImplemented
guiLabel	str	NotImplemented
guiDefinition	dict	{}
helpFile	str	NotImplemented
saveToDb	bool	False	Save this data in the database
charWidth	int	10	Number of characters allowed for widget in GUI
minLength	int	None	Minimum length of string
maxLength	int	None	Maximum length of string
onlyEnumerators	bool	False	If this is true then the enumerators are obligatory - otherwise they are treated as recommended values
enumerators	list	[]	A list of allowed or recommended values for string
menuText	list	[]	A list of strings equivalent to the enumerators that will appear in the GUI
allowedCharsCode	int	0	Flag 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:

dbFileId	CUUID
contentFlag	CInt
baseName	CFilePath
project	CProjectId
subType	CInt
annotation	CString
relPath	CFilePath

Qualifiers for class:

allowUndefined	bool	True	Flag if data file can be undefined at run time
default	dict	NotImplemented
toolTip	str	NotImplemented
guiLabel	str	NotImplemented
guiDefinition	dict	{}
helpFile	str	NotImplemented
saveToDb	bool	True	Save the name of this file in the database
fileExtensions	list	['xmgr']	A list of strings containing allowed file extensions (no dot)
mimeTypeName	str
mimeTypeDescription	str
fileLabel	str	None	Label for file
mustExist	bool	False	Flag if data file must exist at run time
fromPreviousJob	bool	False	Flag if input data file can be inferred from preceeding jobs
jobCombo	bool	True	Flag if data widget should be a combo box
fileContentClassName	str	None	A string containing the name of a class which will hold the file contents
isDirectory	bool	False	Flag if the data is a directory
requiredSubType	list	None	A list of allowed sub types
requiredContentFlag	list	None	A list of allowed content flags

CXmlDataFile: A reference to an XML file

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

Contents of class:

dbFileId	CUUID
contentFlag	CInt
baseName	CFilePath
project	CProjectId
subType	CInt
annotation	CString
relPath	CFilePath

Qualifiers for class:

allowUndefined	bool	True	Flag if data file can be undefined at run time
default	dict	NotImplemented
toolTip	str	NotImplemented
guiLabel	str	NotImplemented
guiDefinition	dict	{}
helpFile	str	NotImplemented
saveToDb	bool	False	Save the name of this file in the database
fileExtensions	list	['xml']	A list of strings containing allowed file extensions (no dot)
mimeTypeName	str
mimeTypeDescription	str
fileLabel	str	None	Label for file
mustExist	bool	False	Flag if data file must exist at run time
fromPreviousJob	bool	False	Flag if input data file can be inferred from preceeding jobs
jobCombo	bool	True	Flag if data widget should be a combo box
fileContentClassName	str	None	A string containing the name of a class which will hold the file contents
isDirectory	bool	False	Flag if the data is a directory
requiredSubType	list	None	A list of allowed sub types
requiredContentFlag	list	None	A list of allowed content flags