ecl-logo Documentation

Object[Sensor]

A device used to interrogate the state of a sample or the surrounding environment.

Organizational Information

    Name

    Name of this Object.
    Format: Single
    Class: String
    Programmatic Pattern: _String
    Pattern Description: A string.

    ID

    ID of this Object.
    Format: Single
    Class: String
    Programmatic Pattern: _String
    Pattern Description: The ID of this object.

    Object

    Object of this Object.
    Format: Single
    Class: Expression
    Programmatic Pattern: Object[Sensor, _String]
    Pattern Description: The object reference of this object.

    Type

    Type of this Object.
    Format: Single
    Class: Expression
    Programmatic Pattern: Object[Sensor]
    Pattern Description: Object[Sensor]

    Notebook

    Notebook this object belongs to.
    Format: Single
    Class: Link
    Programmatic Pattern: _Link
    Pattern Description: An object of that matches ObjectP[Object[LaboratoryNotebook]].

    Model

    Theoretical model that this object is an instance of.
    Format: Single
    Class: Link
    Programmatic Pattern: _Link

    CurrentProtocol

    The experiment, maintenance, or qualification that is currently using this sensor.
    Format: Single
    Class: Link
    Programmatic Pattern: _Link

    ModelName

    The name of model of sensor that defines this sensor.
    Format: Computable
    Programmatic Pattern: _String
    Expression: SafeEvaluate[{Field[Model]}, Download[Field[Model], Name]]

    Status

    The currnet status of the sensor.
    Format: Single
    Class: Expression
    Programmatic Pattern: SensorStatusP

    DateStocked

    Date the sensor was received and stocked in inventory.
    Format: Single
    Class: Date
    Programmatic Pattern: _?DateObjectQ

    DateUnsealed

    Date the packaging on the sensor was first opened in the lab.
    Format: Single
    Class: Date
    Programmatic Pattern: _?DateObjectQ

    DateInstalled

    Date the sensor was installed on site.
    Format: Single
    Class: Date
    Programmatic Pattern: _?DateObjectQ

    DateDiscarded

    Date the sensor was shut down and removed from use on site.
    Format: Single
    Class: Date
    Programmatic Pattern: _?DateObjectQ

    ExpirationDate

    The date by which the sensor should be replaced.
    Format: Single
    Class: Date
    Programmatic Pattern: _?DateObjectQ

    Restricted

    Indicates if this sensor must be specified directly in order to be used in experiments or if instead it can be used by any experiments that request a model matching this sensor's model.
    Format: Single
    Class: Boolean
    Programmatic Pattern: BooleanP

    RestrictedLog

    A log of changes made to this sensor's restricted status.
    Format: Multiple

    [[1]] Date

      Header: Date
      Class: Date
      Programmatic Pattern: _?DateObjectQ

    [[2]] Restricted

      Header: Restricted
      Class: Boolean
      Programmatic Pattern: BooleanP

    [[3]] Responsible Party

    ImageFile

    A photo of this sensor.
    Format: Single
    Class: Link
    Programmatic Pattern: _Link

    UserManualFiles

    PDFs for the manuals or instruction guides for this model of sensor.
    Format: Computable
    Programmatic Pattern: PDFFileP
    Expression: SafeEvaluate[{Field[Model]}, Download[Field[Model], UserManualFiles]]

    Site

    The ECL site at which this sensor currently resides.
    Format: Single
    Class: Link
    Programmatic Pattern: _Link

Inventory

Storage Information

    Expires

    Indicates if this sensor expires after a given amount of time.
    Format: Single
    Class: Expression
    Programmatic Pattern: BooleanP

    ShelfLife

    The length of time after DateCreated this sensor is recommended for use before it should be discarded.
    Format: Single
    Class: Real
    Unit: 1 day
    Programmatic Pattern: GreaterP[0 Day]

    UnsealedShelfLife

    The length of time after DateUnsealed this sensor is recommended for use before it should be discarded.
    Format: Single
    Class: Real
    Unit: 1 day
    Programmatic Pattern: GreaterP[0 Day]

    StorageCondition

    The conditions under which this sensor should be kept when not in use by an experiment.
    Format: Single
    Class: Link
    Programmatic Pattern: _Link

    StorageConditionLog

    A record of changes made to the conditions under which this sensor should be kept when not in use by an experiment.
    Format: Multiple

    [[1]] Date

      Header: Date
      Class: Date
      Programmatic Pattern: _?DateObjectQ

    [[2]] Condition

    [[3]] Responsible Party

    StorageSchedule

    The planned storage condition changes to be performed.
    Format: Multiple

    [[1]] Date

      Header: Date
      Class: Date
      Programmatic Pattern: _?DateObjectQ

    [[2]] Condition

    [[3]] Responsible Party

    AwaitingDisposal

    Indicates if this sensor is marked for disposal once it is no longer required for any outstanding experiments.
    Format: Single
    Class: Boolean
    Programmatic Pattern: BooleanP

    DisposalLog

    A log of changes made to when this sensor is marked as awaiting disposal by the AwaitingDisposal Boolean.
    Format: Multiple

    [[1]] Date

      Header: Date
      Class: Expression
      Programmatic Pattern: _?DateObjectQ

    [[2]] Awaiting Disposal

      Header: Awaiting Disposal
      Class: Boolean
      Programmatic Pattern: BooleanP

    [[3]] Responsible Party

    LocationLog

    The location history of the part. Lines recording a movement to container and position of Null, Null respectively indicate the item being discarded.
    Format: Multiple

    [[1]] Date

      Header: Date
      Class: Date
      Programmatic Pattern: _?DateObjectQ

    [[2]] In or Out

      Header: In or Out
      Class: Expression
      Programmatic Pattern: In|Out

    [[3]] Container moved into or out of

    [[4]] Position moved into or out Of

      Header: Position moved into or out Of
      Class: String
      Programmatic Pattern: _String

    [[5]] Person who moved the part

Sensor Information

Dimensions & Positions

    Dimensions

    The external dimensions of this sensor, in the form: {DimensionX, DimensionY, DimensionZ}.
    Format: Computable
    Programmatic Pattern: {GreaterP[0 Meter], GreaterP[0 Meter], GreaterP[0 Meter]}
    Expression: SafeEvaluate[{Field[Model]}, Download[Field[Model], Dimensions]]

    CrossSectionalShape

    The shape of this sensor in the X-Y plane.
    Format: Computable
    Programmatic Pattern: CrossSectionalShapeP
    Expression: SafeEvaluate[{Field[Model]}, Download[Field[Model], CrossSectionalShape]]

    Container

    The container which houses this sensor.
    Format: Single
    Class: Link
    Programmatic Pattern: _Link

    Position

    The name of the position this sensor occupies in its nearest Container.
    Format: Single
    Class: String
    Programmatic Pattern: LocationPositionP

Container Specifications

    ResourcePickingGrouping

    The parent container of this object which can be used to give the object's approximate location and to see show its proximity to other objects which may be resource picked at the same time or in use by the same protocol.
    Format: Single
    Class: Link
    Programmatic Pattern: _Link

Qualifications & Maintenance

    Qualifications

    The Qualification(s) this sensor is involved with.
    Format: Multiple
    Class: Link
    Programmatic Pattern: _Link

    QualificationFrequency

    A list of the Qualifications which should be run on this sensor and their required frequencies.
    Format: Computable
    Header: ['Model Qualification Object', 'Time']
    Programmatic Pattern: {{ObjectReferenceP[Model[Qualification]], GreaterP[0 Day]}..}
    Expression: SafeEvaluate[{Field[Model]}, Computables`Private`qualificationFrequency[Field[Model]]]

    RecentQualifications

    List of the most recent Qualifications run on this sensor for each model Qualification in QualificationFrequency .
    Format: Multiple

    [[1]] Date Completed

      Header: Date Completed
      Class: Expression
      Programmatic Pattern: _?DateObjectQ

    [[2]] Qualification Object

    [[3]] Qualification Model Object

      Header: Qualification Model Object
      Class: Link
      Programmatic Pattern: _Link

    QualificationResultsLog

    A record of the qualifications run on this sensor and their results.
    Format: Multiple

    [Date]

      Header: Date
      Class: Date

    [Qualification]

    [Result]

      Header: Result
      Class: Expression

    QualificationExtensionLog

    A list of amendments made to the regular qualification schedule of this sensor, and the reason for the deviation.
    Format: Multiple

    [[1]] Qualification Model

      Header: Qualification Model
      Class: Link
      Programmatic Pattern: _Link

    [[2]] Original Due Date

      Header: Original Due Date
      Class: Expression
      Programmatic Pattern: _?DateObjectQ

    [[3]] Revised Due Date

      Header: Revised Due Date
      Class: Expression
      Programmatic Pattern: _?DateObjectQ

    [[4]] Responsible Party

      Header: Responsible Party
      Class: Link
      Programmatic Pattern: _Link
      Relation: Object[User]

    [[5]] Extension Category

      Header: Extension Category
      Class: Expression
      Programmatic Pattern: QualificationExtensionCategoryP

    [[6]] Extension Reason

      Header: Extension Reason
      Class: String
      Programmatic Pattern: _String

    Maintenance

    A list of all the maintenances that have used this sensor or were performed on this sensor.
    Format: Multiple
    Class: Link
    Programmatic Pattern: _Link

    Calibration

    A list of all the calibrations that have used this sensor or were performed on this sensor.
    Format: Multiple
    Class: Link
    Programmatic Pattern: _Link

    MaintenanceLog

    List of all the maintenances that target this sensor and are not an unlisted protocol.
    Format: Multiple

    [[1]] Date Run

      Header: Date Run
      Class: Expression
      Programmatic Pattern: _?DateObjectQ

    [[2]] Maintenance Object

      Header: Maintenance Object
      Class: Link
      Programmatic Pattern: _Link

    [[3]] Maintenance Object Model

      Header: Maintenance Object Model
      Class: Link
      Programmatic Pattern: _Link

    MaintenanceFrequency

    A list of the maintenances which are run on this sensor and their required frequencies.
    Format: Computable
    Header: ['Model Maintenance Object', 'Time']
    Programmatic Pattern: {{ObjectReferenceP[Model[Maintenance]], GreaterP[0 Day] | Null}..}
    Expression: SafeEvaluate[{Field[Model]}, Computables`Private`maintenanceFrequency[Field[Model]]]

    RecentMaintenance

    List of the most recent maintenances run on this sensor for each modelMaintenance in MaintenanceFrequency.
    Format: Multiple

    [[1]] Date

      Header: Date
      Class: Expression
      Programmatic Pattern: _?DateObjectQ

    [[2]] Maintenance

    [[3]] Maintenance Model

      Header: Maintenance Model
      Class: Link
      Programmatic Pattern: _Link

    MaintenanceExtensionLog

    A list of amendments made to the regular maintenance schedule of this sensor, and the reason for the deviation.
    Format: Multiple

    [[1]] Maintenance Model

      Header: Maintenance Model
      Class: Link
      Programmatic Pattern: _Link

    [[2]] Original Due Date

      Header: Original Due Date
      Class: Expression
      Programmatic Pattern: _?DateObjectQ

    [[3]] Revised Due Date

      Header: Revised Due Date
      Class: Expression
      Programmatic Pattern: _?DateObjectQ

    [[4]] Responsible Party

      Header: Responsible Party
      Class: Link
      Programmatic Pattern: _Link
      Relation: Object[User]

    [[5]] Extension Category

      Header: Extension Category
      Class: Expression
      Programmatic Pattern: MaintenanceExtensionCategoryP

    [[6]] Extension Reason

      Header: Extension Reason
      Class: String
      Programmatic Pattern: _String
Last modified on Mon 26 Sep 2022 15:43:53