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

Class: RefSample


    Reference data to which a 'real' sample conforms. This is a means to store details which are shared by instances of the same reagent but are supplier and batch independant.
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link sampleStore to class SampleStore
Main key: name
Mandatory Attributes: name
Known Subclasses: None
Children:
link refSampleSources to class RefSampleSource
link sampleComponents to class SampleComponent
Constructor: newObj = RefSample( sampleStore,name=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
details String 0..1 Free text, for notes, explanatory comments, etc.  
ionicStrength Float 0..1 The ionic strength (dimensionless quantity).  
isActive Boolean 0..1 True if the sample is active.  
isHazard Boolean 0..1 Is the sample hazard?  
name Line 1..1 The name of the sample or the code to identify it. It is the unique identifier.  
ph Float 0..1 The pH.  
solvent Solvent 0..1 Solvent used for sample  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
conformings Sample 0..* List of samples that are conforming to the RefSample.  
hazardPhrases ccp.api.lims.Classification.HazardPhrase 0..* List of all hazard pharses associated to a particular sample.  
localRiskPhrases ccp.api.lims.Classification.HazardPhrase 0..* Derived. Local risk phrases that are specific to a certain laboratory.  
parent SampleStore 1..1 link to parent object - synonym for sampleStore  
rPhrases ccp.api.lims.Classification.HazardPhrase 0..* Derived. Risk Phrases (R-phrases) that are associated to a sample.  
refInputSamples ccp.api.lims.Protocol.RefInputSample 0..*  
refOutputSamples ccp.api.lims.Protocol.RefOutputSample 0..*  
refSamplePositions ccp.api.lims.Holder.RefSamplePosition 0..*  
refSampleSources RefSampleSource 0..* (Child link). child link to class RefSampleSource  
sPhrases ccp.api.lims.Classification.HazardPhrase 0..* Derived. Safety Phrases (S-phrases) that are associated to a sample.  
sampleCategories ccp.api.lims.Classification.SampleCategory 0..* List of sample category associated to a sample.  
sampleComponents SampleComponent 0..* (Child link). child link to class SampleComponent  
sampleStore SampleStore 1..1 (Parent link). parent link  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
details
getDetails String -
setDetails - String
ionicStrength
getIonicStrength Float -
setIonicStrength - Float
isActive
getIsActive Boolean -
setIsActive - Boolean
isHazard
getIsHazard Boolean -
setIsHazard - Boolean
name
getName Line -
setName - Line
ph
getPh Float -
setPh - Float
solvent
getSolvent Solvent -
setSolvent - Solvent

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
conformings
getConformings Sample Set -
setConformings - Sample Set
sortedConformings Sample List -
addConforming - Sample
removeConforming - Sample
findFirstConforming Sample keyword=value pairs
findAllConformings Sample Set keyword=value pairs
hazardPhrases
getHazardPhrases ccp.api.lims.Classification.HazardPhrase Set -
setHazardPhrases - ccp.api.lims.Classification.HazardPhrase Set
sortedHazardPhrases ccp.api.lims.Classification.HazardPhrase List -
addHazardPhrase - ccp.api.lims.Classification.HazardPhrase
removeHazardPhrase - ccp.api.lims.Classification.HazardPhrase
findFirstHazardPhrase ccp.api.lims.Classification.HazardPhrase keyword=value pairs
findAllHazardPhrases ccp.api.lims.Classification.HazardPhrase Set keyword=value pairs
localRiskPhrases
getLocalRiskPhrases ccp.api.lims.Classification.HazardPhrase Set - non-std.
sortedLocalRiskPhrases ccp.api.lims.Classification.HazardPhrase List -
findFirstLocalRiskPhrase ccp.api.lims.Classification.HazardPhrase keyword=value pairs
findAllLocalRiskPhrases ccp.api.lims.Classification.HazardPhrase Set keyword=value pairs
parent
getParent SampleStore -
rPhrases
getRPhrases ccp.api.lims.Classification.HazardPhrase Set - non-std.
sortedRPhrases ccp.api.lims.Classification.HazardPhrase List -
findFirstRPhrase ccp.api.lims.Classification.HazardPhrase keyword=value pairs
findAllRPhrases ccp.api.lims.Classification.HazardPhrase Set keyword=value pairs
refInputSamples
getRefInputSamples ccp.api.lims.Protocol.RefInputSample Set -
setRefInputSamples - ccp.api.lims.Protocol.RefInputSample Set
sortedRefInputSamples ccp.api.lims.Protocol.RefInputSample List -
addRefInputSample - ccp.api.lims.Protocol.RefInputSample
removeRefInputSample - ccp.api.lims.Protocol.RefInputSample
findFirstRefInputSample ccp.api.lims.Protocol.RefInputSample keyword=value pairs
findAllRefInputSamples ccp.api.lims.Protocol.RefInputSample Set keyword=value pairs
refOutputSamples
getRefOutputSamples ccp.api.lims.Protocol.RefOutputSample Set -
setRefOutputSamples - ccp.api.lims.Protocol.RefOutputSample Set
sortedRefOutputSamples ccp.api.lims.Protocol.RefOutputSample List -
addRefOutputSample - ccp.api.lims.Protocol.RefOutputSample
removeRefOutputSample - ccp.api.lims.Protocol.RefOutputSample
findFirstRefOutputSample ccp.api.lims.Protocol.RefOutputSample keyword=value pairs
findAllRefOutputSamples ccp.api.lims.Protocol.RefOutputSample Set keyword=value pairs
refSamplePositions
getRefSamplePositions ccp.api.lims.Holder.RefSamplePosition Set -
setRefSamplePositions - ccp.api.lims.Holder.RefSamplePosition Set
sortedRefSamplePositions ccp.api.lims.Holder.RefSamplePosition List -
addRefSamplePosition - ccp.api.lims.Holder.RefSamplePosition
removeRefSamplePosition - ccp.api.lims.Holder.RefSamplePosition
findFirstRefSamplePosition ccp.api.lims.Holder.RefSamplePosition keyword=value pairs
findAllRefSamplePositions ccp.api.lims.Holder.RefSamplePosition Set keyword=value pairs
refSampleSources
getRefSampleSources RefSampleSource Set -
sortedRefSampleSources RefSampleSource List -
findFirstRefSampleSource RefSampleSource keyword=value pairs
findAllRefSampleSources RefSampleSource Set keyword=value pairs
sPhrases
getSPhrases ccp.api.lims.Classification.HazardPhrase Set - non-std.
sortedSPhrases ccp.api.lims.Classification.HazardPhrase List -
findFirstSPhrase ccp.api.lims.Classification.HazardPhrase keyword=value pairs
findAllSPhrases ccp.api.lims.Classification.HazardPhrase Set keyword=value pairs
sampleCategories
getSampleCategories ccp.api.lims.Classification.SampleCategory Set -
setSampleCategories - ccp.api.lims.Classification.SampleCategory Set
sortedSampleCategories ccp.api.lims.Classification.SampleCategory List -
addSampleCategory - ccp.api.lims.Classification.SampleCategory
removeSampleCategory - ccp.api.lims.Classification.SampleCategory
findFirstSampleCategory ccp.api.lims.Classification.SampleCategory keyword=value pairs
findAllSampleCategories ccp.api.lims.Classification.SampleCategory Set keyword=value pairs
sampleComponents
getSampleComponents SampleComponent Set -
sortedSampleComponents SampleComponent List -
findFirstSampleComponent SampleComponent keyword=value pairs
findAllSampleComponents SampleComponent Set keyword=value pairs
sampleStore
getSampleStore SampleStore -

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey RefSample 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
newRefSampleSource RefSampleSource catalogNum, supplier, ...
newSampleComponent SampleComponent refComponent, ...

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:44_00003

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