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

Class: Sample


    The information on the sample. The sample conforms to a particular sample reference information. The sample is the contents that has been used during an experiment that contains the sample components which is located in an Holder.
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: CrystalSample
Children:
link sampleComponents to class SampleComponent
Constructor: newObj = Sample( sampleStore,name=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
amountDisplayUnit Word 0..1 This is the unit entered by user and used for display.  
amountUnit AmountUnit 0..1 One of the three possible units: kg, L or number.  
batchNum Word 0..1 This is the batch or lot number of the sample.  
colPosition Int 0..1 The column position of the sample in the holder.  
creationDate DateTime 0..1 Derived. The creation date is derived from the endDate of the Experiment which creates it.  
currentAmount Float 0..1 The current amount of the sample. Can be deduced by a subtraction between the initial amount and all the amount which are implied in experiments.  
currentAmountFlag Boolean 0..1 Was current amount validated?  
details String 0..1 Free text, for notes, explanatory comments, etc.  
initialAmount Float 0..1 The initial amount of the sample at the creation date.  
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.  
rowPosition Int 0..1 The row position of the sample in the holder.  
solvent Solvent 0..1 Solvent used for sample  
subPosition Int 0..1 The sub-position of the sample in the holder.  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
dropAnnotations ccp.api.lims.Crystallization.DropAnnotation 0..*  
hazardPhrases ccp.api.lims.Classification.HazardPhrase 0..* List of all hazard pharses associated to a particular sample.  
holder ccp.api.lims.Holder.Holder 0..1 The holder to which the samples belong.  
inputSamples ccp.api.lims.Experiment.InputSample 0..* Input sample list that describes the amount of sample used per experiment for a given sample.  
localRiskPhrases ccp.api.lims.Classification.HazardPhrase 0..* Derived. Local risk phrases that are specific to a certain laboratory.  
mixtures ccp.api.nmr.NmrScreen.Mixture 0..*  
nmrExperiments ccp.api.nmr.Nmr.Experiment 0..* Nmrr experiments carried out on Sample  
outputSample ccp.api.lims.Experiment.OutputSample 0..1 Output sample list that describes the amount of sample created by that experiment for a given sample.  
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.  
refSample RefSample 0..1 The RefSample that conforms to the Sample.  
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
amountDisplayUnit
getAmountDisplayUnit Word -
setAmountDisplayUnit - Word
amountUnit
getAmountUnit AmountUnit -
setAmountUnit - AmountUnit
batchNum
getBatchNum Word -
setBatchNum - Word
colPosition
getColPosition Int -
setColPosition - Int
creationDate
getCreationDate DateTime - non-std.
currentAmount
getCurrentAmount Float -
setCurrentAmount - Float
currentAmountFlag
getCurrentAmountFlag Boolean -
setCurrentAmountFlag - Boolean
details
getDetails String -
setDetails - String
initialAmount
getInitialAmount Float -
setInitialAmount - Float
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
rowPosition
getRowPosition Int -
setRowPosition - Int
solvent
getSolvent Solvent -
setSolvent - Solvent
subPosition
getSubPosition Int -
setSubPosition - Int

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
dropAnnotations
getDropAnnotations ccp.api.lims.Crystallization.DropAnnotation Set -
setDropAnnotations - ccp.api.lims.Crystallization.DropAnnotation Set
sortedDropAnnotations ccp.api.lims.Crystallization.DropAnnotation List -
addDropAnnotation - ccp.api.lims.Crystallization.DropAnnotation
removeDropAnnotation - ccp.api.lims.Crystallization.DropAnnotation
findFirstDropAnnotation ccp.api.lims.Crystallization.DropAnnotation keyword=value pairs
findAllDropAnnotations ccp.api.lims.Crystallization.DropAnnotation 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
holder
getHolder ccp.api.lims.Holder.Holder -
setHolder - ccp.api.lims.Holder.Holder
inputSamples
getInputSamples ccp.api.lims.Experiment.InputSample Set -
setInputSamples - ccp.api.lims.Experiment.InputSample Set
sortedInputSamples ccp.api.lims.Experiment.InputSample List -
addInputSample - ccp.api.lims.Experiment.InputSample
removeInputSample - ccp.api.lims.Experiment.InputSample
findFirstInputSample ccp.api.lims.Experiment.InputSample keyword=value pairs
findAllInputSamples ccp.api.lims.Experiment.InputSample 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
mixtures
getMixtures ccp.api.nmr.NmrScreen.Mixture Set -
setMixtures - ccp.api.nmr.NmrScreen.Mixture Set
sortedMixtures ccp.api.nmr.NmrScreen.Mixture List -
addMixture - ccp.api.nmr.NmrScreen.Mixture
removeMixture - ccp.api.nmr.NmrScreen.Mixture
findFirstMixture ccp.api.nmr.NmrScreen.Mixture keyword=value pairs
findAllMixtures ccp.api.nmr.NmrScreen.Mixture Set keyword=value pairs
nmrExperiments
getNmrExperiments ccp.api.nmr.Nmr.Experiment Set -
setNmrExperiments - ccp.api.nmr.Nmr.Experiment Set
sortedNmrExperiments ccp.api.nmr.Nmr.Experiment List -
addNmrExperiment - ccp.api.nmr.Nmr.Experiment
removeNmrExperiment - ccp.api.nmr.Nmr.Experiment
findFirstNmrExperiment ccp.api.nmr.Nmr.Experiment keyword=value pairs
findAllNmrExperiments ccp.api.nmr.Nmr.Experiment Set keyword=value pairs
outputSample
getOutputSample ccp.api.lims.Experiment.OutputSample -
setOutputSample - ccp.api.lims.Experiment.OutputSample
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
refSample
getRefSample RefSample -
setRefSample - RefSample
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 Sample 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
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_00001

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