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

Class: AxisRegion


    This corresponds to one region of an AxisPanel.
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link axisPanel to class AxisPanel
Main key: serial
Mandatory Attributes: None
Known Subclasses: None
Children: None
Constructor: newObj = AxisRegion( axisPanel, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
isActive Boolean 1..1 Determines whether this region in the spectrum window is currently considered active, usually for the purpose of strip plots.  
overrideRegion Float 0..2 Override region, to use instead of main region  
region Float 2..2 The region of this axis in the units specified by the AxisUnit of the AxisPanel.  
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  
size Int 1..1 The size of the region in pixels.  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
axisPanel AxisPanel 1..1 (Parent link). parent link  
axisRegionGroup AxisRegionGroup 0..1 AxisRegionGroup that groups AxisRegions  
parent AxisPanel 1..1 link to parent object - synonym for axisPanel  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
isActive
getIsActive Boolean -
setIsActive - Boolean
overrideRegion
getOverrideRegion Float Tuple -
setOverrideRegion - Float List
addOverrideRegion - Float
removeOverrideRegion - Float
region
getRegion Float Tuple -
setRegion - Float List
serial
getSerial Int -
setSerial - Int
size
getSize Int -
setSize - Int

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
axisPanel
getAxisPanel AxisPanel -
axisRegionGroup
getAxisRegionGroup AxisRegionGroup -
setAxisRegionGroup - AxisRegionGroup
parent
getParent AxisPanel -

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey AxisRegion 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_00006

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  Thu Oct 2 16:09:49 2014    from data model package  ccpnmr.api.Analysis.AxisRegion   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk