Class PiMeterCellHandle


  • @Beta
    public final class PiMeterCellHandle
    extends PiHandle
    Global identifier of a PI meter cell instantiated on a device, uniquely defined by a device ID and meter cell ID.
    • Method Detail

      • of

        public static PiMeterCellHandle of​(DeviceId deviceId,
                                           PiMeterCellId meterCellId)
        Creates a new handle for the given device ID and PI meter cell ID.
        Parameters:
        deviceId - device ID
        meterCellId - meter cell ID
        Returns:
        PI meter handle
      • of

        public static PiMeterCellHandle of​(DeviceId deviceId,
                                           PiMeterCellConfig meterCellConfig)
        Creates a new handle for the given device ID and PI meter cell configuration.
        Parameters:
        deviceId - device ID
        meterCellConfig - meter config
        Returns:
        PI meter handle
      • cellId

        public PiMeterCellId cellId()
        Returns the cell ID associated with this handle.
        Returns:
        cell ID
      • entityType

        public PiEntityType entityType()
        Description copied from class: PiHandle
        Returns the type of entity identified by this handle.
        Specified by:
        entityType in class PiHandle
        Returns:
        PI entity type
      • equals

        public boolean equals​(java.lang.Object o)
        Specified by:
        equals in class PiHandle
      • toString

        public java.lang.String toString()
        Specified by:
        toString in class PiHandle