public class MicroplateConfiguration extends java.lang.Object implements java.lang.Cloneable, java.io.Serializable, Configuration
Constructor and Description |
---|
MicroplateConfiguration()
Default constructor.
|
MicroplateConfiguration(int numPositions)
Constructor for a microplate type, when no microplate is used, but the functionality of the microplate
measurement methods should be used for custom positions.
|
MicroplateConfiguration(int numWellsX,
int numWellsY,
double wellWidth,
double wellHeight)
Constructor for a custom defined microplate.
|
MicroplateConfiguration(Microplate microplateType)
Constructor for a predefined microplate type.
|
Modifier and Type | Method and Description |
---|---|
void |
checkConfiguration()
Checks the current state of the configuration.
|
java.lang.Object |
clone() |
java.lang.String |
getMicroplateTypeID()
Returns the type ID of the microplate, or NULL if the microplate does not correspond to a predefined type.
|
int |
getNumPositions()
Microplate measurements can be "misused" to measure just some arbitrary positions.
|
int |
getNumWellsX()
Returns the number of wells in the x-direction.
|
int |
getNumWellsY()
Returns the number of wells in the y-direction.
|
java.lang.String |
getTypeIdentifier()
Returns a unique identifier for this configuration type.
|
double |
getWellHeight()
Returns the height of one well (distance of well centers)
|
double |
getWellMarginX()
Returns the margin in each well between the well-border and the first measured point.
|
double |
getWellMarginY()
Returns the margin in each well between the well-border and the first measured point.
|
int |
getWellNumPositionsX()
Returns the number of positions measured in the x-direction in each well.
|
int |
getWellNumPositionsY()
Returns the number of positions measured in the y-direction in each well.
|
double |
getWellPositionDistanceX()
Returns the distance between two adjacent positions in a well in the x-direction.
|
double |
getWellPositionDistanceY()
Returns the distance between two adjacent positions in a well in the y-direction.
|
double |
getWellWidth()
Returns the width of one well (distance of well centers)
|
boolean |
isAliasMicroplate()
Microplate measurements can be "misused" to measure just some arbitrary positions (see
setNumPositions() ). |
boolean |
setMicroplateDimensions(int numWellsX,
int numWellsY,
double wellWidth,
double wellHeight,
int wellPositionsX,
int wellPositionsY,
double wellMarginX,
double wellMarginY)
Sets the dimensions of the microplate and the measured positions.
|
boolean |
setMicroplateType(Microplate microplateType)
Sets the type of the microplate.
|
boolean |
setNumPositions(int numPositions)
Microplate measurements can be "misused" to measure just some arbitrary positions.
|
boolean |
setNumWellsX(int numWellsX)
Sets the number of wells in the x-direction.
|
boolean |
setNumWellsY(int numWellsY)
Sets the number of wells in the y-direction.
|
boolean |
setWellHeight(double wellHeight)
Sets the height of one well (distance of well centers)
|
boolean |
setWellMarginX(double wellMarginX)
Sets the margin in each well between the well-border and the first measured point.
|
boolean |
setWellMarginY(double wellMarginY)
Sets the margin in each well between the well-border and the first measured point.
|
boolean |
setWellNumPositionsX(int wellPositionsX)
Sets the number of positions measured in the x-direction in each well.
|
boolean |
setWellNumPositionsY(int wellPositionsY)
Sets the number of positions measured in the y-direction in each well.
|
boolean |
setWellWidth(double wellWidth)
Sets the width of one well (distance of well centers)
|
public MicroplateConfiguration()
public MicroplateConfiguration(Microplate microplateType)
microplateType
- The predefined microplate type.public MicroplateConfiguration(int numWellsX, int numWellsY, double wellWidth, double wellHeight)
numWellsX
- number of wells in the horizontal direction.numWellsY
- number of wells in the vertical direction.wellWidth
- width of a well (well-well distance).wellHeight
- height of a well (well-well distance).public MicroplateConfiguration(int numPositions)
numPositions
- Number of positions.public java.lang.String getTypeIdentifier()
Configuration
getTypeIdentifier
in interface Configuration
public boolean isAliasMicroplate()
setNumPositions()
).
If this is true, this function returns TRUE.public boolean setNumPositions(int numPositions)
isAliasMicroplate()
to true.numPositions
- The number of abitrary positions to measure.public int getNumPositions()
isAliasMicroplate()
is true, than this function returns the number of positions, otherwise it returns the x-dimension of the microplate.public int getNumWellsX()
public int getNumWellsY()
public boolean setNumWellsX(int numWellsX)
numWellsX
- the Horizontal well number.public boolean setNumWellsY(int numWellsY)
numWellsY
- the Horizontal well number.public boolean setMicroplateDimensions(int numWellsX, int numWellsY, double wellWidth, double wellHeight, int wellPositionsX, int wellPositionsY, double wellMarginX, double wellMarginY)
numWellsX
- Number of wells in the x-direction.numWellsY
- Number of wells in the y-direction.wellWidth
- Width of a well.wellHeight
- Height of a well.wellPositionsX
- Number of measured positions in one well in the x-direction.wellPositionsY
- Number of measured positions in one well in the y-direction.wellMarginX
- Relative margin between the well border and the first measured position in the x-direction.wellMarginY
- Relative margin between the well border and the first measured position in the y-direction.public double getWellWidth()
public double getWellHeight()
public boolean setWellWidth(double wellWidth)
wellWidth
- width of one well.public boolean setWellHeight(double wellHeight)
wellHeight
- width of one well.public java.lang.String getMicroplateTypeID()
public boolean setMicroplateType(Microplate microplateType)
microplateType
- the type of microplate.public boolean setWellNumPositionsX(int wellPositionsX)
wellPositionsX
- number of positions in a well in the x-direction.public int getWellNumPositionsX()
public boolean setWellNumPositionsY(int wellPositionsY)
wellPositionsY
- number of positions in a well in the y-direction.public int getWellNumPositionsY()
public boolean setWellMarginX(double wellMarginX)
wellMarginX
- margin in the x-directionpublic double getWellMarginX()
public boolean setWellMarginY(double wellMarginY)
wellMarginY
- margin in the y-directionpublic double getWellMarginY()
public double getWellPositionDistanceX()
public double getWellPositionDistanceY()
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
clone
in class java.lang.Object
java.lang.CloneNotSupportedException
public void checkConfiguration() throws ConfigurationException
Configuration
ConfigurationException
is thrown describing the error, and what has to be changed in the configuration, by the user,
such that it becomes valid. This error can then e.g. be displayed to the user
(see ConfigurationAddonTools.displayConfigurationInvalid(ConfigurationException, YouScopeClient).checkConfiguration
in interface Configuration
ConfigurationException