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

Class: ExpTransfer


    Magnetisation transfer between two AtomSites. The transfer does not say anything about direction, merely that e.g. an H and a C are connected by a one-bond coupling.

    The ExpTransferPaths and the AtomSites they select describe the network of nuclei that must be present in order to get observable peaks from a ginve ExpGraph.
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link expGraph to class ExpGraph
Main key: serial
Mandatory Attributes: atomSites
Known Subclasses: None
Children: None
Constructor: newObj = ExpTransfer( expGraph,atomSites=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
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  
transferToSelf Boolean 1..1 Does transfer permit magnetisation to remain on the same site ('diagonal' peak)?  
transferType ExpTransferType 0..1 Type of transfer. E.g. NOESY. Intended to describe the minimum information necessary to establish the relationship between the ExpAtomSites connected by the transfer  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
atomSites AtomSite 2..2 AtomSites connected by Transfer  
expGraph ExpGraph 1..1 (Parent link). parent link  
parent ExpGraph 1..1 link to parent object - synonym for expGraph  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
serial
getSerial Int -
setSerial - Int
transferToSelf
getTransferToSelf Boolean -
setTransferToSelf - Boolean
transferType
getTransferType ExpTransferType -
setTransferType - ExpTransferType

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
atomSites
getAtomSites AtomSite Set -
setAtomSites - AtomSite Set
sortedAtomSites AtomSite List -
findFirstAtomSite AtomSite keyword=value pairs
findAllAtomSites AtomSite Set keyword=value pairs
expGraph
getExpGraph ExpGraph -
parent
getParent ExpGraph -

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey ExpTransfer 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-16-14:22:45_00021

isImplicit:

False

Tag

Value
repositoryId $Id: $

Tag

Value
repositoryTag $Name: $

Special constructor code:

None

Special destructor code:

None

Special postDestructor code:

None

Constraint name:

transferToSelf_requires_identical_isotopes
Constraint code: not self.transferToSelf or len(set(x.isotopeCode for x in self.atomSites)) == 1
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:09 2014    from data model package  ccp.api.nmr.NmrExpPrototype.ExpTransfer   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk