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

Class: Location


    The information on a laboratory location used for storage.
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link locationStore to class LocationStore
Main key: serial
Mandatory Attributes: name
Known Subclasses: None
Children: None
Constructor: newObj = Location( locationStore,name=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
locationType Line 0..1 The type of the location. e.g. 'Building', 'Room', 'Fridge', 'Cupboard', 'Shelves',...  
name Line 1..1 The name of the location.  
pressure Float 0..1 The pressure of the location in pascal (Pa).  
pressureDisplayUnit Word 0..1 This is the unit entered by user and used for display.  
serial Int 1..1 Unique identifier.  
tempDisplayUnit Word 0..1 This is the unit entered by user and used for display.  
temperature Float 0..1 The temperature of the location in kelvin (K).  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
contents Location 0..* List of sub location contained in another location. This is the contents of a Location.  
holderLocations ccp.api.lims.Holder.HolderLocation 0..* List over time of occupancy for a given location.  
location Location 0..1  
locationStore LocationStore 1..1 (Parent link). parent link  
organisation ccp.api.general.Affiliation.Organisation 0..1 The organisation to which the location belongs.  
parent LocationStore 1..1 link to parent object - synonym for locationStore  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
locationType
getLocationType Line -
setLocationType - Line
name
getName Line -
setName - Line
pressure
getPressure Float -
setPressure - Float
pressureDisplayUnit
getPressureDisplayUnit Word -
setPressureDisplayUnit - Word
serial
getSerial Int -
setSerial - Int
tempDisplayUnit
getTempDisplayUnit Word -
setTempDisplayUnit - Word
temperature
getTemperature Float -
setTemperature - Float

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
contents
getContents Location Set -
setContents - Location Set
sortedContents Location List -
addContent - Location
removeContent - Location
findFirstContent Location keyword=value pairs
findAllContents Location Set keyword=value pairs
holderLocations
getHolderLocations ccp.api.lims.Holder.HolderLocation Set -
setHolderLocations - ccp.api.lims.Holder.HolderLocation Set
sortedHolderLocations ccp.api.lims.Holder.HolderLocation List -
findFirstHolderLocation ccp.api.lims.Holder.HolderLocation keyword=value pairs
findAllHolderLocations ccp.api.lims.Holder.HolderLocation Set keyword=value pairs
location
getLocation Location -
setLocation - Location
locationStore
getLocationStore LocationStore -
organisation
getOrganisation ccp.api.general.Affiliation.Organisation -
setOrganisation - ccp.api.general.Affiliation.Organisation
parent
getParent LocationStore -

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey Location 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:54_00064

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:12 2014    from data model package  ccp.api.lims.Location.Location   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk