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

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

Inheritance:


Details:

Parent: link layout to class Layout
Main key: serial
Mandatory Attributes: axisCode, position, unit
Known Subclasses: None
Children: None
Constructor: newObj = Ruler( layout,axisCode=value, position=value, unit=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
axisCode Word 1..1 Axis code - identifier for axisType link  
color RgbaColor 1..1 color of ruler  
dashLength PositiveInt 1..1 Length of mark dash, in pixels.  
lineWidth PositiveFloat 1..1 Line width, in pixels  
position Float 1..1 Position in the defined unit.  
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  
unit Word 1..1 unit for axes - identifier for AxisUnit link.  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
axisType ccpnmr.api.AnalysisWindow.AxisType 0..1 Derived. AxisType relating to Marking  
axisUnit ccpnmr.api.AnalysisWindow.AxisUnit 0..1 Derived. AxisUnit relating to Marking  
layout Layout 1..1 (Parent link). parent link  
parent Layout 1..1 link to parent object - synonym for layout  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
axisCode
getAxisCode Word -
setAxisCode - Word
color
getColor RgbaColor -
setColor - RgbaColor
dashLength
getDashLength PositiveInt -
setDashLength - PositiveInt
lineWidth
getLineWidth PositiveFloat -
setLineWidth - PositiveFloat
position
getPosition Float -
setPosition - Float
serial
getSerial Int -
setSerial - Int
unit
getUnit Word -
setUnit - Word

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
axisType
getAxisType ccpnmr.api.AnalysisWindow.AxisType - non-std.
setAxisType - ccpnmr.api.AnalysisWindow.AxisType non-std.
axisUnit
getAxisUnit ccpnmr.api.AnalysisWindow.AxisUnit - non-std.
setAxisUnit - ccpnmr.api.AnalysisWindow.AxisUnit non-std.
layout
getLayout Layout -
parent
getParent Layout -

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_2011-11-16-17:07:15_00014

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  Fri Mar 28 11:18:10 2014    from data model package  ccpnmr.api.AnalysisLayout.Ruler   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk