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

Class: Ruler


    One-dimensional, PanelType-mapped graphical mark.
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link analysisProject to class AnalysisProject
Main key: serial
Mandatory Attributes: position, panelType
Known Subclasses: None
Children: None
Constructor: newObj = Ruler( analysisProject,position=value, panelType=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
color RgbColor 1..1 Ruler color  
dashLength Int 1..1 For dashed line - length of dash part in arbitrary units (scale handled by program).  
gapLength Int 1..1 Length of gap in dashed line - handled as for dashLength  
lineWidth Float 1..1 Width of line in arbitrary units, handled as for dashLength.  
position Float 1..1 Ruler position in the unit appropriate for the PanelType  
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
analysisProject AnalysisProject 1..1 (Parent link). parent link  
panelType PanelType 1..1 the PanelType of the Ruler  
parent AnalysisProject 1..1 link to parent object - synonym for analysisProject  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
color
getColor RgbColor -
setColor - RgbColor
dashLength
getDashLength Int -
setDashLength - Int
gapLength
getGapLength Int -
setGapLength - Int
lineWidth
getLineWidth Float -
setLineWidth - Float
position
getPosition Float -
setPosition - Float
serial
getSerial Int -
setSerial - Int

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
analysisProject
getAnalysisProject AnalysisProject -
panelType
getPanelType PanelType -
setPanelType - PanelType
parent
getParent AnalysisProject -

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey Ruler 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_2006-08-17-14:16:22_00020

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:09 2015    from data model package  ccpnmr.api.Analysis.Ruler   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk