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

Class: Procedure


    A procedure is a list of steps that can be repeated.
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link protocol to class Protocol
Main key: serial
Mandatory Attributes: procNumber
Known Subclasses: None
Children:
link steps to class Step
Constructor: newObj = Procedure( protocol,procNumber=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
details String 0..1 Details field for comments.  
name Line 0..1 The name of the procedure.  
numCycles Int 1..1 The number of times the procedure is repeated.  
procNumber Int 1..1 The place of the procedure in the order of procedures of the protocol. Need not be sequential, successive procdedures could be numbered (-10,0,10,12,17,20,...). The procedures are performed according to increasing value of this attribute.  
remarks String 0..* Some remarks.  
role Line 0..1 The role of the procedure that it takes for a protocol .  
serial Int 1..1 Unique identifier.  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
instrumentTypes ccp.api.lims.Classification.InstrumentType 0..* List of instrument type associated to a procedure.  
parent Protocol 1..1 link to parent object - synonym for protocol  
protocol Protocol 1..1 (Parent link). parent link  
steps Step 0..* (Child link). child link to class Step  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
details
getDetails String -
setDetails - String
name
getName Line -
setName - Line
numCycles
getNumCycles Int -
setNumCycles - Int
procNumber
getProcNumber Int -
setProcNumber - Int
remarks
getRemarks String Tuple -
setRemarks - String List
addRemark - String
removeRemark - String
role
getRole Line -
setRole - Line
serial
getSerial Int -
setSerial - Int

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
instrumentTypes
getInstrumentTypes ccp.api.lims.Classification.InstrumentType Set -
setInstrumentTypes - ccp.api.lims.Classification.InstrumentType Set
sortedInstrumentTypes ccp.api.lims.Classification.InstrumentType List -
addInstrumentType - ccp.api.lims.Classification.InstrumentType
removeInstrumentType - ccp.api.lims.Classification.InstrumentType
findFirstInstrumentType ccp.api.lims.Classification.InstrumentType keyword=value pairs
findAllInstrumentTypes ccp.api.lims.Classification.InstrumentType Set keyword=value pairs
parent
getParent Protocol -
protocol
getProtocol Protocol -
steps
getSteps Step Set -
sortedSteps Step List -
findFirstStep Step keyword=value pairs
findAllSteps Step Set keyword=value pairs

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey Procedure 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
newAddStep AddStep stepNumber, refInputSample, ...
newCentrifugationStep CentrifugationStep stepNumber, ...
newFiltrationStep FiltrationStep stepNumber, ...
newFlowStep FlowStep stepNumber, ...
newPressStep PressStep stepNumber, ...
newSonicationStep SonicationStep stepNumber, ...
newStep Step stepNumber, ...
newTemperatureStep TemperatureStep finalTemperature, initialTemperature, stepNumber, ...
newWaitStep WaitStep stepNumber, ...

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_00002

isImplicit:

False

Tag

Value
repositoryId $Id: $

Tag

Value
repositoryTag $Name: $

Special constructor code:

None

Special destructor code:

None

Special postDestructor code:

None

Constraint name:

stepNumber_is_secondary_key_for_Step
Constraint code: ll = self.steps
aSet = frozenset(x.stepNumber for x in ll)
isValid = (len(aSet) == len(ll))
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:32 2014    from data model package  ccp.api.lims.Protocol.Procedure   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk