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

Class: NmrProject


    grouping of related NMR data
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link memopsRoot to class memops.api.Implementation.MemopsRoot
Main key: name
Mandatory Attributes: name
Partitions Children: True
Known Subclasses: None
Children:
link atomSets to class AtomSet
link chainStateSets to class ChainStateSet
link derivedDataLists to class DerivedDataList
link experiments to class Experiment
link measurementLists to class AbstractMeasurementList
link nmrExpSeries to class NmrExpSeries
link peakClusters to class PeakCluster
link resonanceGroups to class ResonanceGroup
link resonanceSets to class ResonanceSet
link resonances to class Resonance
link sampleConditionSets to class SampleConditionSet
link shiftReferences to class ShiftReference
link structureAnalyses to class StructureAnalysis
link structureGenerations to class StructureGeneration
Constructor: newObj = NmrProject( memopsRoot,name=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
name Line 1..1 name of NmrProject  

Inherited Attributes (not in package): applicationDataclassNamecreatedByfieldNamesguidinConstructorisDeletedisLoadedisModifiableisModifiedisReadinglastUnlockedBymetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
analysisProject ccpnmr.api.Analysis.AnalysisProject 0..1 Analysis project that relates to the Nmr Project  
analysisProjectV3 ccpnmr.api.AnalysisV3.AnalysisProjectV3 0..1 AnalysisV3 project that relates to the Nmr Project  
atomSets AtomSet 0..* (Child link). child link to class AtomSet  
chainStateSets ChainStateSet 0..* (Child link). child link to class ChainStateSet  
derivedDataLists DerivedDataList 0..* (Child link). child link to class DerivedDataList  
experiments Experiment 0..* (Child link). child link to class Experiment  
measurementLists AbstractMeasurementList 0..* (Child link). child link to class AbstractMeasurementList  
memopsRoot memops.api.Implementation.MemopsRoot 1..1 (Parent link). parent link  
nmrCalcStores ccp.api.nmr.NmrCalc.NmrCalcStore 0..* Derived. NMR calculations run on project  
nmrConstraintStores ccp.api.nmr.NmrConstraint.NmrConstraintStore 0..* NmrConstraintStores that refer to the NmrProject  
nmrExpSeries NmrExpSeries 0..* (Child link). child link to class NmrExpSeries  
parent memops.api.Implementation.MemopsRoot 1..1 link to parent object - synonym for memopsRoot  
peakClusters PeakCluster 0..* (Child link). child link to class PeakCluster  
resonanceGroups ResonanceGroup 0..* (Child link). child link to class ResonanceGroup  
resonanceSets ResonanceSet 0..* (Child link). child link to class ResonanceSet  
resonances Resonance 0..* (Child link). child link to class Resonance  
sampleConditionSets SampleConditionSet 0..* (Child link). child link to class SampleConditionSet  
shiftReferences ShiftReference 0..* (Child link). child link to class ShiftReference  
structureAnalyses StructureAnalysis 0..* (Child link). child link to class StructureAnalysis  
structureGenerations StructureGeneration 0..* (Child link). child link to class StructureGeneration  
validationStores ccp.api.molecule.Validation.ValidationStore 0..* StrucutreValidationStores relevant to NmrProject  

Inherited Attributes (not in package): accessactiveAccessactiveRepositoriespackageLocatorroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
name
getName Line -
setName - Line

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
analysisProject
getAnalysisProject ccpnmr.api.Analysis.AnalysisProject -
setAnalysisProject - ccpnmr.api.Analysis.AnalysisProject
analysisProjectV3
getAnalysisProjectV3 ccpnmr.api.AnalysisV3.AnalysisProjectV3 -
setAnalysisProjectV3 - ccpnmr.api.AnalysisV3.AnalysisProjectV3
atomSets
getAtomSets AtomSet Set -
sortedAtomSets AtomSet List -
findFirstAtomSet AtomSet keyword=value pairs
findAllAtomSets AtomSet Set keyword=value pairs
chainStateSets
getChainStateSets ChainStateSet Set -
sortedChainStateSets ChainStateSet List -
findFirstChainStateSet ChainStateSet keyword=value pairs
findAllChainStateSets ChainStateSet Set keyword=value pairs
derivedDataLists
getDerivedDataLists DerivedDataList Set -
sortedDerivedDataLists DerivedDataList List -
findFirstDerivedDataList DerivedDataList keyword=value pairs
findAllDerivedDataLists DerivedDataList Set keyword=value pairs
experiments
getExperiments Experiment Set -
sortedExperiments Experiment List -
findFirstExperiment Experiment keyword=value pairs
findAllExperiments Experiment Set keyword=value pairs
measurementLists
getMeasurementLists AbstractMeasurementList Set -
sortedMeasurementLists AbstractMeasurementList List -
findFirstMeasurementList AbstractMeasurementList keyword=value pairs
findAllMeasurementLists AbstractMeasurementList Set keyword=value pairs
memopsRoot
getMemopsRoot memops.api.Implementation.MemopsRoot -
nmrCalcStores
getNmrCalcStores ccp.api.nmr.NmrCalc.NmrCalcStore Set - non-std.
sortedNmrCalcStores ccp.api.nmr.NmrCalc.NmrCalcStore List -
findFirstNmrCalcStore ccp.api.nmr.NmrCalc.NmrCalcStore keyword=value pairs
findAllNmrCalcStores ccp.api.nmr.NmrCalc.NmrCalcStore Set keyword=value pairs
nmrConstraintStores
getNmrConstraintStores ccp.api.nmr.NmrConstraint.NmrConstraintStore Set -
setNmrConstraintStores - ccp.api.nmr.NmrConstraint.NmrConstraintStore Set
sortedNmrConstraintStores ccp.api.nmr.NmrConstraint.NmrConstraintStore List -
findFirstNmrConstraintStore ccp.api.nmr.NmrConstraint.NmrConstraintStore keyword=value pairs
findAllNmrConstraintStores ccp.api.nmr.NmrConstraint.NmrConstraintStore Set keyword=value pairs
nmrExpSeries
getNmrExpSeries NmrExpSeries Set -
sortedNmrExpSeries NmrExpSeries List -
findFirstNmrExpSeries NmrExpSeries keyword=value pairs
findAllNmrExpSeries NmrExpSeries Set keyword=value pairs
parent
getParent memops.api.Implementation.MemopsRoot -
peakClusters
getPeakClusters PeakCluster Set -
sortedPeakClusters PeakCluster List -
findFirstPeakCluster PeakCluster keyword=value pairs
findAllPeakClusters PeakCluster Set keyword=value pairs
resonanceGroups
getResonanceGroups ResonanceGroup Set -
sortedResonanceGroups ResonanceGroup List -
findFirstResonanceGroup ResonanceGroup keyword=value pairs
findAllResonanceGroups ResonanceGroup Set keyword=value pairs
resonanceSets
getResonanceSets ResonanceSet Set -
sortedResonanceSets ResonanceSet List -
findFirstResonanceSet ResonanceSet keyword=value pairs
findAllResonanceSets ResonanceSet Set keyword=value pairs
resonances
getResonances Resonance Set -
sortedResonances Resonance List -
findFirstResonance Resonance keyword=value pairs
findAllResonances Resonance Set keyword=value pairs
sampleConditionSets
getSampleConditionSets SampleConditionSet Set -
sortedSampleConditionSets SampleConditionSet List -
findFirstSampleConditionSet SampleConditionSet keyword=value pairs
findAllSampleConditionSets SampleConditionSet Set keyword=value pairs
shiftReferences
getShiftReferences ShiftReference Set -
sortedShiftReferences ShiftReference List -
findFirstShiftReference ShiftReference keyword=value pairs
findAllShiftReferences ShiftReference Set keyword=value pairs
structureAnalyses
getStructureAnalyses StructureAnalysis Set -
sortedStructureAnalyses StructureAnalysis List -
findFirstStructureAnalysis StructureAnalysis keyword=value pairs
findAllStructureAnalyses StructureAnalysis Set keyword=value pairs
structureGenerations
getStructureGenerations StructureGeneration Set -
sortedStructureGenerations StructureGeneration List -
findFirstStructureGeneration StructureGeneration keyword=value pairs
findAllStructureGenerations StructureGeneration Set keyword=value pairs
validationStores
getValidationStores ccp.api.molecule.Validation.ValidationStore Set -
setValidationStores - ccp.api.molecule.Validation.ValidationStore Set
sortedValidationStores ccp.api.molecule.Validation.ValidationStore List -
addValidationStore - ccp.api.molecule.Validation.ValidationStore
removeValidationStore - ccp.api.molecule.Validation.ValidationStore
findFirstValidationStore ccp.api.molecule.Validation.ValidationStore keyword=value pairs
findAllValidationStores ccp.api.molecule.Validation.ValidationStore Set keyword=value pairs

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey NmrProject memops.api.Implementation.MemopsRoot, 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
newAtomSet AtomSet atoms, ...
newChainStateSet ChainStateSet chain, ...
newDataList DataList unit, ...
newDipolarRelaxList DipolarRelaxList ...
newExperiment Experiment name, numDim, ...
newExternalShiftReference ExternalShiftReference atomGroup, isotopeCode, molName, referenceType, value, ...
newHExchProtectionList HExchProtectionList ...
newHExchRateList HExchRateList ...
newInternalShiftReference InternalShiftReference atomGroup, isotopeCode, molName, referenceType, value, ...
newIsotropicS2List IsotropicS2List ...
newJCouplingList JCouplingList ...
newNmrExpSeries NmrExpSeries conditionNames, ...
newNoeList NoeList ...
newPeakCluster PeakCluster clusterType, ...
newPkaList PkaList ...
newRdcList RdcList ...
newResonance Resonance isotopeCode, ...
newResonanceGroup ResonanceGroup ...
newResonanceSet ResonanceSet atomSets, resonances, ...
newSampleConditionSet SampleConditionSet ...
newShiftAnisotropyList ShiftAnisotropyList ...
newShiftDifferenceList ShiftDifferenceList ...
newShiftList ShiftList ...
newSpectralDensityList SpectralDensityList ...
newStructureAnalysis StructureAnalysis ...
newStructureGeneration StructureGeneration ...
newT1List T1List sf, ...
newT1RhoList T1RhoList sf, ...
newT2List T2List sf, ...

Other Methods (in package)

Go to Top
Method Return Parameters Comment
None

Appendix

Go to Top

guid:

www.ccpn.ac.uk_Fogh_2006-08-16-18:19:48_00001

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: memops.api.Implementation.MemopsRoot.currentNmrProject
  Data Model Version 2.1.2
Go to Top  
  Autogenerated by  PyApiDocGen  revision 1.3   on  Thu Oct 2 16:09:37 2014    from data model package  ccp.api.nmr.Nmr.NmrProject   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk