pychemstation.utils.table_types

  1from __future__ import annotations
  2
  3from dataclasses import dataclass
  4from enum import Enum
  5from typing import TypeVar
  6
  7
  8class TableOperation(Enum):
  9    """
 10    MACROS related to editing and reading tables in Chemstation.
 11    """
 12
 13    def __str__(self):
 14        return "%s" % self.value
 15
 16    DELETE_TABLE = 'DelTab {register}, "{table_name}"'
 17    CREATE_TABLE = 'NewTab {register}, "{table_name}"'
 18    NEW_ROW = 'InsTabRow {register}, "{table_name}"'
 19    NEW_ROW_SPECIFIC = 'InsTabRow {register}, "{table_name}"'
 20    MOVE_ROW = 'MoveTabRow {register}, "{table_name}", {from_row}, {to_row}'
 21    DELETE_ROW = 'DelTabRow {register}, "{table_name}", {row}'
 22    EDIT_ROW_VAL = 'SetTabVal "{register}", "{table_name}", {row}, "{col_name}", {val}'
 23    EDIT_ROW_TEXT = (
 24        'SetTabText "{register}", "{table_name}", {row}, "{col_name}", "{val}"'
 25    )
 26    GET_ROW_VAL = 'TabVal("{register}", "{table_name}", {row}, "{col_name}")'
 27    GET_ROW_TEXT = 'TabText$("{register}", "{table_name}", {row}, "{col_name}")'
 28    GET_NUM_ROWS = 'Rows = TabHdrVal({register}, "{table_name}", "{col_name}")'
 29    GET_OBJ_HDR_VAL = 'ObjHdrVal("{register}", "{register_flag}")'
 30    GET_OBJ_HDR_TEXT = 'ObjHdrText$("{register}", "{register_flag}")'
 31    UPDATE_OBJ_HDR_VAL = 'SetObjHdrVal "{register}", "{register_flag}", {val}'
 32    UPDATE_OBJ_HDR_TEXT = 'SetObjHdrText "{register}", "{register_flag}", "{val}"'
 33    NEW_COL_TEXT = 'NewColText {register}, "{table_name}", "{col_name}", "{val}"'
 34    NEW_COL_VAL = 'NewColVal {register}, "{table_name}", "{col_name}", {val}'
 35
 36
 37class RegisterFlag(Enum):
 38    """
 39    Flags for accessing Chemstation parameters.
 40    """
 41
 42    def __str__(self):
 43        return "%s" % self.value
 44
 45    # sample info
 46    VIAL_NUMBER = "VialNumber"
 47
 48    # for table
 49    NUM_ROWS = "NumberOfRows"
 50
 51    # for Method
 52    SOLVENT_A_COMPOSITION = "PumpChannel_CompositionPercentage"
 53    SOLVENT_B_COMPOSITION = "PumpChannel2_CompositionPercentage"
 54    SOLVENT_C_COMPOSITION = "PumpChannel3_CompositionPercentage"
 55    SOLVENT_D_COMPOSITION = "PumpChannel4_CompositionPercentage"
 56    FLOW = "Flow"
 57    MAX_TIME = "StopTime_Time"
 58    POST_TIME = "PostTime_Time"
 59    COLUMN_OVEN_TEMP1 = "TemperatureControl_Temperature"
 60    COLUMN_OVEN_TEMP2 = "TemperatureControl2_Temperature"
 61    STOPTIME_MODE = "StopTime_Mode"
 62    POSTIME_MODE = "PostTime_Mode"
 63    TIME = "Time"
 64    TIMETABLE_SOLVENT_B_COMPOSITION = "SolventCompositionPumpChannel2_Percentage"
 65    TIMETABLE_FLOW = "FlowFlow"
 66
 67    # for Method Timetable
 68    SOLVENT_COMPOSITION = "SolventComposition"
 69    PRESSURE = "Pressure"
 70    EXTERNAL_CONTACT = "ExternalContact"
 71    FUNCTION = "Function"
 72
 73    # for Sequence
 74    VIAL_LOCATION = "Vial"
 75    NAME = "SampleName"
 76    METHOD = "Method"
 77    INJ_VOL = "InjVolume"
 78    INJ_SOR = "InjectionSource"
 79    NUM_INJ = "InjVial"
 80    SAMPLE_TYPE = "SampleType"
 81    DATA_FILE = "DataFileName"
 82
 83    # for Injector Table
 84    ## Draw
 85    DRAW_SOURCE = "DrawSource"
 86    DRAW_VOLUME = "DrawVolume_Mode"
 87    DRAW_SPEED = "DrawSpeed_Mode"
 88    DRAW_OFFSET = "DrawOffset_Mode"
 89    DRAW_VOLUME_VALUE = "DrawVolume_Value"
 90    DRAW_LOCATION = "DrawLocation"
 91    DRAW_LOCATION_TRAY = "DrawLocationPlus_Tray"
 92    DRAW_LOCATION_UNIT = "DrawLocationPlus_Unit"
 93    DRAW_LOCATION_ROW = "DrawLocationPlus_Row"
 94    DRAW_LOCATION_COLUMN = "DrawLocationPlus_Column"
 95    ## Inject
 96    ## Wait
 97    ## Remote
 98    REMOTE = "RemoteLine"
 99    REMOTE_DUR = "RemoteDuration"
100    # Injection Volume
101    INJECTION_VOLUME = "Injection_Volume"
102
103    ## For Pump
104    ### Volume Status
105    BOTTLE_A1_ABSOLUTE_FILLING = "BottleFilling_CurrentAbsolute"
106    BOTTLE_A1_PERCENT_FILLING = "BottleFilling_CurrentPercent"
107    BOTTLE_A1_MAX = "BottleFilling_MaximumAbsolute"
108
109    BOTTLE_A2_ABSOLUTE_FILLING = "BottleFilling2_CurrentAbsolute"
110    BOTTLE_A2_PERCENT_FILLING = "BottleFilling2_CurrentPercent"
111    BOTTLE_A2_MAX = "BottleFilling2_MaximumAbsolute"
112
113    BOTTLE_B1_ABSOLUTE_FILLING = "BottleFilling3_CurrentAbsolute"
114    BOTTLE_B1_PERCENT_FILLING = "BottleFilling3_CurrentPercent"
115    BOTTLE_B1_MAX = "BottleFilling3_MaximumAbsolute"
116
117    BOTTLE_B2_ABSOLUTE_FILLING = "BottleFilling4_CurrentAbsolute"
118    BOTTLE_B2_PERCENT_FILLING = "BottleFilling4_CurrentPercent"
119    BOTTLE_B2_MAX = "BottleFilling4_MaximumAbsolute"
120
121    WASTE_BOTTLE_ABSOLUTE = "WasteBottleFilling_CurrentAbsolute"
122    WASTE_BOTTLE_PERCENT = "WasteBottleFilling_CurrentPercent"
123    WASTE_BOTTLE_MAX = "WasteBottleFilling_MaximumPercent"
124
125    ### Switching Solvent Bottles
126    PUMPCHANNEL_USED = "PumpChannel_IsUsed"
127    PUMPCHANNEL_SELECTION = "PumpChannel_SolventSelectionValvePosition"
128    BOTTLE_A1_USER_NAME = "PumpChannel_Position1_UserName"
129    BOTTLE_A2_USER_NAME = "PumpChannel_Position2_UserName"
130    PUMPCHANNEL2_USED = "PumpChannel_IsUsed"
131    PUMPCHANNEL2_SELECTION = "PumpChannel2_SolventSelectionValvePosition"
132    BOTTLE_B1_USER_NAME = "PumpChannel2_Position1_UserName"
133    BOTTLE_B2_USER_NAME = "PumpChannel2_Position2_UserName"
134
135    # For Column
136    AVAIL_COLUMN_DISPLAY_VALUES = "ColumnSwitchingValve_PositionDisplayValues"
137    AVAIL_COLUMN_POSITIONS = "ColumnSwitchingValve_PositionValues"
138    COLUMN_POSITION = "ColumnSwitchingValve_Position"
139
140    # For DAD
141    SIGNAL_A = "Signal_Wavelength"
142    SIGNAL_B = "Signal2_Wavelength"
143    SIGNAL_C = "Signal3_Wavelength"
144    SIGNAL_D = "Signal4_Wavelength"
145    SIGNAL_E = "Signal5_Wavelength"
146    SIGNAL_A_USED = "Signal_IsUsed"
147    SIGNAL_B_USED = "Signal2_IsUsed"
148    SIGNAL_C_USED = "Signal3_IsUsed"
149    SIGNAL_D_USED = "Signal4_IsUsed"
150    SIGNAL_E_USED = "Signal5_IsUsed"
151
152
153@dataclass
154class Table:
155    """
156    Class for storing the keys needed to access certain register tables.
157    """
158
159    register: str
160    name: str
161
162
163@dataclass
164class Device:
165    """
166    Class for storing the keys needed to access certain devices
167    """
168
169    register: str
170
171
172T = TypeVar("T")