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

Class: Run


    Calculation run, collecting input and output.
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link nmrCalcStore to class NmrCalcStore
Main key: serial
Mandatory Attributes: None
Known Subclasses: None
Children:
link data to class Data
link runParameters to class RunParameter
Constructor: newObj = Run( nmrCalcStore, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
affiliationStoreName Line 0..1 Name of AffiliationStore storing Operator person record. Part of key for derived link "operator".  
annealProtocolApp Line 0..1 Application used in AnnealProtocol. Part of the key for the annealProtocol derived link  
annealProtocolCode Line 0..1 Annealing protocol code. Part of the key for the derived annealProtocol link.  
annealProtocolStoreName Line 0..1 Name of AnnealProtocolStore containing AnnealProtocol. Part of the key for the annealProtocol derived link  
details Text 0..1 Free text, for notes, explanatory comments, etc.  
operatorSerial PositiveInt 0..1 Serial of operator. Part of key for derived link "operator"  
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  
status Status 1..1 Calculation status  
structureGenerationSerial PositiveInt 0..1 serial for Nmr.StructureGeneration associated with this run. Key for derived link structureGeneration  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
annealProtocol molsim.api.AnnealProtocol.AnnealProtocol 0..1 Derived. AnnealProtocol used for run  
data Data 0..* (Child link). child link to class Data  
inputs Data 0..* Derived. Input data units  
nmrCalcStore NmrCalcStore 1..1 (Parent link). parent link  
operator ccp.api.general.Affiliation.Person 0..1 Person submitting the calculation  
outputs Data 0..* Derived. output data units  
parent NmrCalcStore 1..1 link to parent object - synonym for nmrCalcStore  
runParameters RunParameter 0..* (Child link). child link to class RunParameter  
structureGeneration ccp.api.nmr.Nmr.StructureGeneration 0..1 Derived. NMR Structure generation that run contributes to  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
affiliationStoreName
getAffiliationStoreName Line -
setAffiliationStoreName - Line
annealProtocolApp
getAnnealProtocolApp Line -
setAnnealProtocolApp - Line
annealProtocolCode
getAnnealProtocolCode Line -
setAnnealProtocolCode - Line
annealProtocolStoreName
getAnnealProtocolStoreName Line -
setAnnealProtocolStoreName - Line
details
getDetails Text -
setDetails - Text
operatorSerial
getOperatorSerial PositiveInt -
setOperatorSerial - PositiveInt
serial
getSerial Int -
setSerial - Int
status
getStatus Status -
setStatus - Status
structureGenerationSerial
getStructureGenerationSerial PositiveInt -
setStructureGenerationSerial - PositiveInt

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
annealProtocol
getAnnealProtocol molsim.api.AnnealProtocol.AnnealProtocol - non-std.
setAnnealProtocol - molsim.api.AnnealProtocol.AnnealProtocol non-std.
data
getData Data Set -
sortedData Data List -
findFirstData Data keyword=value pairs
findAllData Data Set keyword=value pairs
inputs
getInputs Data Set - non-std.
sortedInputs Data List -
findFirstInput Data keyword=value pairs
findAllInputs Data Set keyword=value pairs
nmrCalcStore
getNmrCalcStore NmrCalcStore -
operator
getOperator ccp.api.general.Affiliation.Person - non-std.
setOperator - ccp.api.general.Affiliation.Person non-std.
outputs
getOutputs Data Set - non-std.
sortedOutputs Data List -
findFirstOutput Data keyword=value pairs
findAllOutputs Data Set keyword=value pairs
parent
getParent NmrCalcStore -
runParameters
getRunParameters RunParameter Set -
sortedRunParameters RunParameter List -
findFirstRunParameter RunParameter keyword=value pairs
findAllRunParameters RunParameter Set keyword=value pairs
structureGeneration
getStructureGeneration ccp.api.nmr.Nmr.StructureGeneration - non-std.
setStructureGeneration - ccp.api.nmr.Nmr.StructureGeneration non-std.

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey Run 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
newConstraintStoreData ConstraintStoreData constraintStoreSerial, ...
newDerivedListData DerivedListData derivedDataListSerial, ...
newEnergyTerm EnergyTerm ...
newExternalData ExternalData ...
newMatrixData MatrixData ...
newMeasurementListData MeasurementListData measurementListSerial, ...
newMolResidueData MolResidueData chainCode, molSystemCode, ...
newMolSystemData MolSystemData molSystemCode, ...
newPeakListData PeakListData ...
newRunParameter RunParameter ...
newSpectrumData SpectrumData ...
newSpinSystemData SpinSystemData resonanceGroupSerial, ...
newStructureEnsembleData StructureEnsembleData ensembleId, molSystemCode, ...
newTensorData TensorData orientationMatrix, ...
newViolationListData ViolationListData constraintStoreSerial, violationListSerial, ...

Other Methods (in package)

Go to Top
Method Return Parameters Comment
None

Appendix

Go to Top

guid:

www.ccpn.ac.uk_Fogh_2009-04-16-16:23:57_00004

isImplicit:

False

Tag

Value
repositoryId $Id: Run.xml,v 1.10 2011-01-13 14:40:35 rhfogh Exp $

Tag

Value
repositoryTag $Name: not supported by cvs2svn $

Special constructor code:

None

Special destructor code:

None

Constraints:

None
Known inward one-way links: None
  Data Model Version 2.0.6
Go to Top  
  Autogenerated by  PyApiDocGen  revision 1.3   on  Wed Aug 7 15:07:01 2013    from data model package  ccp.api.nmr.NmrCalc.Run   revision 1.10  
  Work done by the CCPN team.
www.ccpn.ac.uk