Skip to content

Plate

Description

Represents a plate object within the system. Plates are associated with a specific machine and have a name for identification. Provides utility functions related to the machine and project structure.

Constructor

python
Plate(machine, name: str)

Initializes a Plate object tied to a machine instance and a plate name.

ParameterTypeDescription
machineobjectReference to the associated machine.
namestrName or identifier for the plate.

Properties

(No dedicated properties defined — internal attributes _machine and _name are managed privately.)

Methods

MethodReturnsDescription
get_root_dir()PathReturns the root directory path of the project by traversing up three levels from the current file's location.

Short Example

python
# Example usage of Plate
plate = Plate(machine=my_machine, name="sample_plate")

# Get root directory
root_dir = plate.get_root_dir()
print(root_dir)

Important Notes

  • Plate depends on a machine object being passed during initialization. It does not manage machine control itself.
  • get_root_dir() is typically used for file or configuration path resolution relative to project structure.
  • PlateStateError and PlateConfigurationError are related exceptions that may be used by other Plate operations (currently not triggered in basic usage).

Pre-release documentation · Internal research use only · Not authorized for redistribution.