Package org.scictrl.csshell

Interface MetaData

All Known Implementing Classes:
MetaDataImpl
public interface MetaData
Base interface for a sample's meta data.
Author:
igor@scictrl.com

  • Field Details

  • Method Details

    • getMinimum

      double getMinimum()

      getMinimum.

      Returns:
      Suggested lower control limit

    • getMaximum

      double getMaximum()

      getMaximum.

      Returns:
      Suggested upper control limit

    • getDisplayMin

      double getDisplayMin()

      getDisplayMin.

      Returns:
      Suggested lower display limit

    • getDisplayMax

      double getDisplayMax()

      getDisplayMax.

      Returns:
      Suggested upper display limit

    • getWarnMin

      double getWarnMin()

      getWarnMin.

      Returns:
      Low warning limit

    • getWarnMax

      double getWarnMax()

      getWarnMax.

      Returns:
      High warning limit

    • getAlarmMin

      double getAlarmMin()

      getAlarmMin.

      Returns:
      Low alarm limit

    • getAlarmMax

      double getAlarmMax()

      getAlarmMax.

      Returns:
      High alarm limit

    • getPrecision

      int getPrecision()

      getPrecision.

      Returns:
      Suggested display precision (fractional digits)

    • getUnits

      String getUnits()

      getUnits.

      Returns:
      The engineering units string

    • getStates

      String[] getStates()
      Obtains the states.

      The array element i represents enum number i.

      Returns:
      an array of String objects

    • getState

      String getState(int index)
      Convenience routine for getting the state.
      Parameters:
      index - a int
      Returns:
      a String object

    • getStateValues

      Object[] getStateValues()
      Obtains the enumeration values.

      The array element i represents enum number i.

      Returns:
      an array of Object objects

    • getStateValue

      Object getStateValue(int index)
      Convenience routine for getting a state value.
      Parameters:
      index - a int
      Returns:
      a Object object

    • getFormat

      String getFormat()
      Return the display format for the numerical values.
      Returns:
      the display format

    • isReadAccess

      boolean isReadAccess()
      Returns the access type.
      Returns:
      the access type

    • isWriteAccess

      boolean isWriteAccess()
      Returns the access type.
      Returns:
      the access type

    • isValid

      boolean isValid()
      Returns true if contains valid data.
      Returns:
      true if contained data is valid

    • getHostname

      String getHostname()
      Returns the host name of the channel that this meta data belongs to.
      Returns:
      the host name

    • getDataType

      DataType getDataType()
      Returns the datatype of the channel. This method returns one of the string in DataType.
      Returns:
      the datatype

    • getDescription

      String getDescription()
      Returns the description of the channel.
      Returns:
      the description

    • getName

      String getName()
      Returns the name of the channel.
      Returns:
      the name of the channel

    • getSequenceLength

      int getSequenceLength()
      Returns the sequence length
      Returns:
      the sequence length

    • getRemoteDataType

      Class<?> getRemoteDataType()

      getRemoteDataType.

      Returns:
      a Class object