Chronos Plugins 5.4.0
This documentation covers the plugin interfaces definitions and an example implementation.
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Protected Member Functions | Properties | List of all members
AxelSemrau.Chronos.Plugin.TrayGeometry Class Reference

Basic description of a simple rectangle tray geometry. More...

Public Member Functions

 TrayGeometry (int rows, int cols)
 Construct a tray with the given number of columns and rows.
 

Public Attributes

Quantity x
 Outer dimensions.
 
Quantity Quantity y
 

Protected Member Functions

 TrayGeometry ()
 For derived classes that may have to do some extra work for finding out the dimensions.
 

Properties

int Rows [get, protected set]
 Number of rows on the tray.
 
int Cols [get, protected set]
 Number of columns on the tray.
 
bool IndexingDirectionX [get, protected set]
 When increasing the index from position 1 on, are we moving in sampler axis X direction?
 
Quantity Quantity Quantity z Size [get, protected set]
 
Quantity Quantity Quantity z FirstSampleOffset [get, protected set]
 
Quantity Quantity Quantity z AlternateSampleOffset [get, protected set]
 
Quantity CavityDiameter [get, protected set]
 Diameter of the cavities.
 
Quantity TotalRowLengthY [get, protected set]
 Total length of a row in Y direction. Please keep the IndexingOrientationX in mind when making calculations based on this.
 
Quantity TotalColLengthX [get, protected set]
 Total length of a column in X direction. Please keep the IndexingOrientationX in mind when making calculations based on this.
 

Detailed Description

Basic description of a simple rectangle tray geometry.

Definition at line 118 of file DeviceInterfaces.cs.

Constructor & Destructor Documentation

◆ TrayGeometry() [1/2]

AxelSemrau.Chronos.Plugin.TrayGeometry.TrayGeometry ( int  rows,
int  cols 
)

Construct a tray with the given number of columns and rows.

Parameters
rows
cols

Definition at line 172 of file DeviceInterfaces.cs.

173 {
174 Rows = rows;
175 Cols = cols;
176 IndexingDirectionX = true;
177 }
AxelSemrau.Chronos.Plugin.TrayGeometry.IndexingDirectionX
bool IndexingDirectionX
When increasing the index from position 1 on, are we moving in sampler axis X direction?
Definition: DeviceInterfaces.cs:132
AxelSemrau.Chronos.Plugin.TrayGeometry.Cols
int Cols
Number of columns on the tray.
Definition: DeviceInterfaces.cs:127
AxelSemrau.Chronos.Plugin.TrayGeometry.Rows
int Rows
Number of rows on the tray.
Definition: DeviceInterfaces.cs:123

References AxelSemrau.Chronos.Plugin.TrayGeometry.Cols, AxelSemrau.Chronos.Plugin.TrayGeometry.IndexingDirectionX, and AxelSemrau.Chronos.Plugin.TrayGeometry.Rows.

◆ TrayGeometry() [2/2]

AxelSemrau.Chronos.Plugin.TrayGeometry.TrayGeometry ( )
protected

For derived classes that may have to do some extra work for finding out the dimensions.

Definition at line 182 of file DeviceInterfaces.cs.

183 {
184 }

Member Data Documentation

◆ x

Quantity AxelSemrau.Chronos.Plugin.TrayGeometry.x

Outer dimensions.

For closely packed trays, the offset from the first position to the first position of the next row.

When looking from the top: Distance from the top left corner to the first sample.

If the layout is regular, these values are null.

Definition at line 137 of file DeviceInterfaces.cs.

◆ y

Quantity Quantity AxelSemrau.Chronos.Plugin.TrayGeometry.y

Definition at line 137 of file DeviceInterfaces.cs.

Property Documentation

◆ AlternateSampleOffset

Quantity Quantity Quantity z AxelSemrau.Chronos.Plugin.TrayGeometry.AlternateSampleOffset
getprotected set

Definition at line 150 of file DeviceInterfaces.cs.

150{ get; protected set; }

◆ CavityDiameter

Quantity AxelSemrau.Chronos.Plugin.TrayGeometry.CavityDiameter
getprotected set

Diameter of the cavities.

Definition at line 155 of file DeviceInterfaces.cs.

155{ get; protected set; }

◆ Cols

int AxelSemrau.Chronos.Plugin.TrayGeometry.Cols
getprotected set

Number of columns on the tray.

Definition at line 127 of file DeviceInterfaces.cs.

127{ get; protected set; }

Referenced by AxelSemrau.Chronos.Plugin.TrayGeometry.TrayGeometry().

◆ FirstSampleOffset

Quantity Quantity Quantity z AxelSemrau.Chronos.Plugin.TrayGeometry.FirstSampleOffset
getprotected set

Definition at line 142 of file DeviceInterfaces.cs.

142{ get; protected set; }

◆ IndexingDirectionX

bool AxelSemrau.Chronos.Plugin.TrayGeometry.IndexingDirectionX
getprotected set

When increasing the index from position 1 on, are we moving in sampler axis X direction?

Definition at line 132 of file DeviceInterfaces.cs.

132{ get; protected set; }

Referenced by AxelSemrau.Chronos.Plugin.TrayGeometry.TrayGeometry().

◆ Rows

int AxelSemrau.Chronos.Plugin.TrayGeometry.Rows
getprotected set

Number of rows on the tray.

Definition at line 123 of file DeviceInterfaces.cs.

123{ get; protected set; }

Referenced by AxelSemrau.Chronos.Plugin.TrayGeometry.TrayGeometry().

◆ Size

Quantity Quantity Quantity z AxelSemrau.Chronos.Plugin.TrayGeometry.Size
getprotected set

Definition at line 137 of file DeviceInterfaces.cs.

137{ get; protected set; }

◆ TotalColLengthX

Quantity AxelSemrau.Chronos.Plugin.TrayGeometry.TotalColLengthX
getprotected set

Total length of a column in X direction. Please keep the IndexingOrientationX in mind when making calculations based on this.

Definition at line 164 of file DeviceInterfaces.cs.

164{ get; protected set; }

◆ TotalRowLengthY

Quantity AxelSemrau.Chronos.Plugin.TrayGeometry.TotalRowLengthY
getprotected set

Total length of a row in Y direction. Please keep the IndexingOrientationX in mind when making calculations based on this.

Definition at line 160 of file DeviceInterfaces.cs.

160{ get; protected set; }
The documentation for this class was generated from the following file: