Data Model version 2.1.2
Acknowledgements
Diagram | Class Map | Attribute Map | Method Map | Help | License
Home | Package | Class: { prev | next } | Attribute | Method

Class: StructureEnsembleData


    StructureEnsemble data for calculations
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link run to class Run
Main key: serial
Mandatory Attributes: ensembleId, molSystemCode
Known Subclasses: None
Children: None
Constructor: newObj = StructureEnsembleData( run,ensembleId=value, molSystemCode=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
code Word 0..1 Unique identifier for the parameter within the context of the application being run  
details Text 0..1 Free text, for notes, explanatory comments, etc.  
ensembleId Int 1..1 ensembleId of relevant StructureEnsemble - used in deriving link to Structures  
ioRole IoRole 1..1 Role of data in calculation (input / output).  
modelSerials Int 0..* serial of MolStructure.Models linked to. If empty all Models in ensemble are used.  
molSystemCode Word 1..1 MolSystem code of relevant MolSystem - used in deriving link to Structures  
name Line 0..1 Human readable name of parameter  
serial Int 1..1 Serial number of object. Serves as object main key. Serial numbers of deleted objects are not re-used. Serial numbers can only be set by the implementation. Values are in practice always positive, since negative values are interpreted as a signal to set the next free serial  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
models ccp.api.molecule.MolStructure.Model 0..* Derived. StructureEnsemble.Models used as data  
parameterGroup ParameterGroup 0..1 Parameter group that Data belong to  
parent Run 1..1 link to parent object - synonym for run  
run Run 1..1 (Parent link). parent link  
runParameters RunParameter 0..* parameters that refer to unit of data.  
structureEnsemble ccp.api.molecule.MolStructure.StructureEnsemble 0..1 Derived. StructureEnsemble used as data  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
code
getCode Word -
setCode - Word
details
getDetails Text -
setDetails - Text
ensembleId
getEnsembleId Int -
setEnsembleId - Int
ioRole
getIoRole IoRole -
setIoRole - IoRole
modelSerials
getModelSerials Int Tuple -
setModelSerials - Int List
addModelSerial - Int
removeModelSerial - Int
molSystemCode
getMolSystemCode Word -
setMolSystemCode - Word
name
getName Line -
setName - Line
serial
getSerial Int -
setSerial - Int

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
models
getModels ccp.api.molecule.MolStructure.Model Tuple - non-std.
setModels - ccp.api.molecule.MolStructure.Model List non-std.
addModel - ccp.api.molecule.MolStructure.Model
removeModel - ccp.api.molecule.MolStructure.Model
findFirstModel ccp.api.molecule.MolStructure.Model keyword=value pairs
findAllModels ccp.api.molecule.MolStructure.Model List keyword=value pairs
parameterGroup
getParameterGroup ParameterGroup -
setParameterGroup - ParameterGroup
parent
getParent Run -
run
getRun Run -
runParameters
getRunParameters RunParameter Set -
setRunParameters - RunParameter Set
sortedRunParameters RunParameter List -
addRunParameter - RunParameter
removeRunParameter - RunParameter
findFirstRunParameter RunParameter keyword=value pairs
findAllRunParameters RunParameter Set keyword=value pairs
structureEnsemble
getStructureEnsemble ccp.api.molecule.MolStructure.StructureEnsemble - non-std.
setStructureEnsemble - ccp.api.molecule.MolStructure.StructureEnsemble non-std.

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey StructureEnsembleData memops.api.Implementation.MemopsObject, Any List static
getFullKey Any List Boolean
getLocalKey Any -
get Any String
set - String, Any

Factory Methods (in package)

Go to Top
Method Return Parameters
None

Other Methods (in package)

Go to Top
Method Return Parameters Comment
None

Appendix

Go to Top

guid:

www.ccpn.ac.uk_Fogh_2009-05-20-16:32:11_00004

isImplicit:

False

Tag

Value
repositoryId $Id: $

Tag

Value
repositoryTag $Name: $

Special constructor code:

None

Special destructor code:

None

Special postDestructor code:

None

Constraints:

None
Known inward one-way links: None
  Data Model Version 2.1.2
Go to Top  
  Autogenerated by  PyApiDocGen  revision 1.3   on  Mon Mar 2 17:25:13 2015    from data model package  ccp.api.nmr.NmrCalc.StructureEnsembleData   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk