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

Class: RegionWeight


    Weighting of spectral region. By default regions are weighted 1.0 unless explicitly set otherwise.
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link trialSet to class TrialSet
Main key: serial
Mandatory Attributes: maxPpm, minPpm
Known Subclasses: None
Children: None
Constructor: newObj = RegionWeight( trialSet,maxPpm=value, minPpm=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
maxPpm Float 1..1 Higher ppm value for interval.  
minPpm Float 1..1 Lower ppm value for interval.  
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  
weight NonNegativeFloat 1..1 Weighting applied to interval  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
parent TrialSet 1..1 link to parent object - synonym for trialSet  
trialSet TrialSet 1..1 (Parent link). parent link  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
maxPpm
getMaxPpm Float -
setMaxPpm - Float
minPpm
getMinPpm Float -
setMinPpm - Float
serial
getSerial Int -
setSerial - Int
weight
getWeight NonNegativeFloat -
setWeight - NonNegativeFloat

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
parent
getParent TrialSet -
trialSet
getTrialSet TrialSet -

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey RegionWeight 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_2012-05-21-18:09:06_00003

isImplicit:

False

Tag

Value
repositoryId $Id: $

Tag

Value
repositoryTag $Name: $

Special constructor code:

None

Special destructor code:

None

Special postDestructor code:

None

Constraint name:

intervals_do_not_overlap
Constraint code: isValid = True
minval = self.minPpm
maxval = self.maxPpm
for obj in self.trialSet.regionWeights:
  if obj is not self and obj.maxPpm > minval and obj.minPpm < maxval:
    isValid = False
    break

Constraint name:

minPpm_lt_maxPpm
Constraint code: self.minPpm < self.maxPpm
Known inward one-way links: None
  Data Model Version 2.1.2
Go to Top  
  Autogenerated by  PyApiDocGen  revision 1.3   on  Fri Mar 28 11:18:51 2014    from data model package  ccp.api.nmr.NmrScreen.RegionWeight   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk