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

Class: CsaConstraintList

Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link nmrConstraintStore to class NmrConstraintStore
Main key: serial
Mandatory Attributes: None
Known Subclasses: None
Children:
link constraints to class CsaConstraint
Constructor: newObj = CsaConstraintList( nmrConstraintStore, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
details String 0..1 free text containing notes, descriptive remarks, etc.  
experimentSerials Int 0..* Serials for experiments that have contributed to Constraints in constraintList. Serve as key for derived link experiments  
isotopeCode Word 0..1 String indicating Isotope (e.g. 13C, 3He, 2H, 235U ...) to which all chemical shift anisotropies in list should belong  
measureListSerials Int 0..* Serials for measurementLists that have contributed to Constraints in constraintList. Serve as key for derived link measurementLists.  
name Line 0..1 Name of constraint list. Serves as a descriptive addition to the serial number.  
serial Int 1..1 The serial number is the key for class AbstractConstraintList and together with the parent object serves as a unique identifier for the AbstractConstraintList. Serial numbers are generated by the API. Serial numbers of deleted objects are not reused.  
unit Word 0..1 Measurement unit of listed constraints. Should be made into an enumeration.  
usedForCalculation Boolean 1..1 Determines if the ConstraintList was (or should be) used for structure calculation.  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
conditionState ConditionState 0..1 COndition set that COnstraint list refers to  
constraints CsaConstraint 0..* (Child link). child link to class CsaConstraint  
energyTerms ccp.api.nmr.NmrCalc.EnergyTerm 0..* RestraintGroups using ConstraintList  
experiments ccp.api.nmr.Nmr.Experiment 0..* Derived. Experiments from which ConstraintLists are derived. May be incomplete or not set.  
isotope ccp.api.molecule.ChemElement.Isotope 0..1 Derived. Isotope for Constraints in Chemical Shift Anisotropy Constraint List  
measurementLists ccp.api.nmr.Nmr.AbstractMeasurementList 0..* Derived. Measurement Lists used in deriving Constraint list  
method ccp.api.general.Method.Method 0..1 Default Method used for calculating Constraints in ConstraintList. May be overwritten by Method for individual Constraints.  
nmrConstraintListValidations ccp.api.molecule.Validation.NmrConstraintListValidation 0..* Validation results that include AbstractConstraintList  
nmrConstraintStore NmrConstraintStore 1..1 (Parent link). parent link  
parent NmrConstraintStore 1..1 link to parent object - synonym for nmrConstraintStore  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
details
getDetails String -
setDetails - String
experimentSerials
getExperimentSerials Int Set -
setExperimentSerials - Int Set
addExperimentSerial - Int
removeExperimentSerial - Int
isotopeCode
getIsotopeCode Word -
setIsotopeCode - Word
measureListSerials
getMeasureListSerials Int Set -
setMeasureListSerials - Int Set
addMeasureListSerial - Int
removeMeasureListSerial - Int
name
getName Line -
setName - Line
serial
getSerial Int -
setSerial - Int
unit
getUnit Word -
setUnit - Word
usedForCalculation
getUsedForCalculation Boolean -
setUsedForCalculation - Boolean

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
conditionState
getConditionState ConditionState -
setConditionState - ConditionState
constraints
getConstraints CsaConstraint Set -
sortedConstraints CsaConstraint List -
findFirstConstraint CsaConstraint keyword=value pairs
findAllConstraints CsaConstraint Set keyword=value pairs
energyTerms
getEnergyTerms ccp.api.nmr.NmrCalc.EnergyTerm Set -
setEnergyTerms - ccp.api.nmr.NmrCalc.EnergyTerm Set
sortedEnergyTerms ccp.api.nmr.NmrCalc.EnergyTerm List -
addEnergyTerm - ccp.api.nmr.NmrCalc.EnergyTerm
removeEnergyTerm - ccp.api.nmr.NmrCalc.EnergyTerm
findFirstEnergyTerm ccp.api.nmr.NmrCalc.EnergyTerm keyword=value pairs
findAllEnergyTerms ccp.api.nmr.NmrCalc.EnergyTerm Set keyword=value pairs
experiments
getExperiments ccp.api.nmr.Nmr.Experiment Set - non-std.
setExperiments - ccp.api.nmr.Nmr.Experiment Set non-std.
sortedExperiments ccp.api.nmr.Nmr.Experiment List -
addExperiment - ccp.api.nmr.Nmr.Experiment non-std.
removeExperiment - ccp.api.nmr.Nmr.Experiment non-std.
findFirstExperiment ccp.api.nmr.Nmr.Experiment keyword=value pairs
findAllExperiments ccp.api.nmr.Nmr.Experiment Set keyword=value pairs
isotope
getIsotope ccp.api.molecule.ChemElement.Isotope - non-std.
measurementLists
getMeasurementLists ccp.api.nmr.Nmr.AbstractMeasurementList Set - non-std.
setMeasurementLists - ccp.api.nmr.Nmr.AbstractMeasurementList Set non-std.
sortedMeasurementLists ccp.api.nmr.Nmr.AbstractMeasurementList List -
addMeasurementList - ccp.api.nmr.Nmr.AbstractMeasurementList non-std.
removeMeasurementList - ccp.api.nmr.Nmr.AbstractMeasurementList non-std.
findFirstMeasurementList ccp.api.nmr.Nmr.AbstractMeasurementList keyword=value pairs
findAllMeasurementLists ccp.api.nmr.Nmr.AbstractMeasurementList Set keyword=value pairs
method
getMethod ccp.api.general.Method.Method -
setMethod - ccp.api.general.Method.Method
nmrConstraintListValidations
getNmrConstraintListValidations ccp.api.molecule.Validation.NmrConstraintListValidation Set -
setNmrConstraintListValidations - ccp.api.molecule.Validation.NmrConstraintListValidation Set
sortedNmrConstraintListValidations ccp.api.molecule.Validation.NmrConstraintListValidation List -
addNmrConstraintListValidation - ccp.api.molecule.Validation.NmrConstraintListValidation
removeNmrConstraintListValidation - ccp.api.molecule.Validation.NmrConstraintListValidation
findFirstNmrConstraintListValidation ccp.api.molecule.Validation.NmrConstraintListValidation keyword=value pairs
findAllNmrConstraintListValidations ccp.api.molecule.Validation.NmrConstraintListValidation Set keyword=value pairs
nmrConstraintStore
getNmrConstraintStore NmrConstraintStore -
parent
getParent NmrConstraintStore -

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey CsaConstraintList 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
newCsaConstraint CsaConstraint resonance, ...

Other Methods (in package)

Go to Top
Method Return Parameters Comment
None

Appendix

Go to Top

guid:

www.ccpn.ac.uk_Fogh_2008-04-16-13:49:36_00001

isImplicit:

False

Tag

Value
repositoryId $Id: CsaConstraintList.xml,v 1.12 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:06:51 2013    from data model package  ccp.api.nmr.NmrConstraint.CsaConstraintList   revision 1.12  
  Work done by the CCPN team.
www.ccpn.ac.uk