monitorframe.idl

Go to the documentation of this file.

#ifndef CARMA_MONITOR_IDL
#define CARMA_MONITOR_IDL

#include "carma/util/UserException.idl"

module carma
{

module monitor
{

  const string MONITOR_CHANNEL_NAME = "CARMAmonitor";

  typedef short MonitorValueType;
  const MonitorValueType MONITOR_VALUE_TYPE_BYTE = 0;
  const MonitorValueType MONITOR_VALUE_TYPE_SHORT = 1;
  const MonitorValueType MONITOR_VALUE_TYPE_INTEGER = 2;
  const MonitorValueType MONITOR_VALUE_TYPE_BOOLEAN = 3;
  const MonitorValueType MONITOR_VALUE_TYPE_FLOAT = 4;
  const MonitorValueType MONITOR_VALUE_TYPE_DOUBLE = 5;
  const MonitorValueType MONITOR_VALUE_TYPE_COMPLEX = 6;
  const MonitorValueType MONITOR_VALUE_TYPE_STRING = 7;
  const MonitorValueType MONITOR_VALUE_TYPE_SERIAL_NUMBER = 8;

  union TransportMonitorValue switch (MonitorValueType)
  {
      case MONITOR_VALUE_TYPE_BYTE:             char c;
      case MONITOR_VALUE_TYPE_SHORT:            short s;
      case MONITOR_VALUE_TYPE_INTEGER:          long i;
      case MONITOR_VALUE_TYPE_BOOLEAN:          boolean b;
      case MONITOR_VALUE_TYPE_FLOAT:            float f;
      case MONITOR_VALUE_TYPE_DOUBLE:           double d;
      case MONITOR_VALUE_TYPE_COMPLEX:          float complex[2];
      case MONITOR_VALUE_TYPE_STRING:           char str[8];
      case MONITOR_VALUE_TYPE_SERIAL_NUMBER:    long sn;
  };

  typedef sequence<TransportMonitorValue> TransportMonitorValueSeq;

  // A monitor point is a combination of a MonitorHeader and a sequence of
  // one or more MonitorSampleValues

  struct TransportMonitorValueMetadata
  {

      MonitorValueType dataType;

      unsigned long sequenceIdx;

      unsigned short pointID;

      octet     validityFlags;

      octet     iSample;
  };

  struct ComplexFloat
  {
      float real;
      float imag;
  };

  typedef sequence<MonitorValueType> MonitorValueTypeSeq;
  typedef sequence<unsigned short> UShortSeq;
  typedef sequence<octet> ValidityFlagSeq;
  typedef sequence<octet> iSampleSeq;
  typedef sequence<char,8> Char8;
  typedef sequence<char>  CharSeq;
  typedef sequence<short> ShortSeq;
  typedef sequence<long> LongSeq;
  typedef sequence<boolean> BoolSeq;
  typedef sequence<float> FloatSeq;
  typedef sequence<double> DoubleSeq;
  typedef sequence<ComplexFloat> ComplexSeq;
  typedef sequence<Char8> StringSeq;
  typedef sequence<long> SerialNumberSeq;
  typedef sequence<TransportMonitorValueMetadata> MonitorSampleValueMetadataSeq;

  // For local (subsystem to FSP) transport as well as publishing (FSP to ACC)
  struct MonitorSampleValues
  {
      // Metadata
      MonitorValueTypeSeq dataType;
      LongSeq sequenceIdx;
      UShortSeq pointID;
      ValidityFlagSeq validityFlags;
      iSampleSeq iSample;

      // MonitorSampleValueMetadataSeq metadata;
      // Values
      CharSeq charValues;
      ShortSeq shortValues;
      LongSeq longValues;
      BoolSeq boolValues;
      FloatSeq floatValues;
      DoubleSeq doubleValues;
      ComplexSeq complexValues;
      StringSeq stringValues;
      SerialNumberSeq serialNumberValues;
  };

  struct TransportSubsystemFrame
  {
      unsigned short    numMonitorPoints; // specified as # of monitor points

      unsigned short    numSamples; // specified as # of sample values

      unsigned short    subsystemID; // same as the subsystemID

      unsigned short    statusFlags; // bit flags for bookkeepping

      unsigned short    maxMonitorPoints; // specified as # of monitor points

      unsigned short    maxSamples; // specified as # of sample values

      unsigned short    numSingleSamplePoints; // specified as # of monitor points

      unsigned long     frameCount;


      double                lastWriterDelay;

      double                lastWriteTime;

      double                scriberWriteDelay;

      double                scriberWriteTime;

      double    publishTime;

      double    receiveTime;

    // array of header offsets - once header is accessed, then monitor
    // point definitions are accessible

      MonitorSampleValues monitorValues;
  };


  interface MonitorPointUpdate
  {
      double monitorPointSampleUpdate(
        in MonitorSampleValues values,
        in long frameTime,
        in double writeDelay ) raises( carma::util::UserException );
  };

}; // End module monitor

}; // End module carma


#endif  /* CARMA_MONITOR_IDL */