Package nl.tno.imb.mc

Class Parameter

  • public class Parameter
extends java.lang.Object
    IMB model control parameter.

    Copyright (c) 2013-2020 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
    BSD-style license. See OpenTrafficSim License.

    Version:
    $Revision$, $LastChangedDate$, by $Author$, initial version Oct 14, 2016
    Author:
    Alexander Verbraeck, Peter Knoppers, Wouter Schakel

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Parameter.ParameterType
      IMB integer numbers and our corresponding enum values.

    • Constructor Summary

      Constructors 
      Constructor Description
      Parameter​(java.lang.String name, double value)
      Construct a new float parameter.
      Parameter​(java.lang.String name, int value)
      Construct a new integer parameter.
      Parameter​(java.lang.String name, java.lang.Boolean value)
      Construct a Boolean parameter.
      Parameter​(java.lang.String name, java.lang.String value)
      Construct a String parameter.
      Parameter​(TByteBuffer payload)
      Construct a new Parameter from the next object in a TByteBuffer.

    • Constructor Detail

      • Parameter

        public Parameter​(java.lang.String name,
                 double value)
        Construct a new float parameter.
        Parameters:
        name - String; name of the new float parameter
        value - double; value of the new float parameter

      • Parameter

        public Parameter​(java.lang.String name,
                 java.lang.Boolean value)
        Construct a Boolean parameter.
        Parameters:
        name - String; the name of the new Boolean parameter
        value - Boolean; the value of the new Boolean parameter

      • Parameter

        public Parameter​(java.lang.String name,
                 int value)
        Construct a new integer parameter.
        Parameters:
        name - String; name of the new integer parameter
        value - int; value of the new integer parameter

      • Parameter

        public Parameter​(java.lang.String name,
                 java.lang.String value)
        Construct a String parameter.
        Parameters:
        name - String; the name of the new String parameter
        value - String; the value of the new String parameter

      • Parameter

        public Parameter​(TByteBuffer payload)
          throws IMBException
        Construct a new Parameter from the next object in a TByteBuffer.
        Parameters:
        payload - TByteBuffer; the received IMB data
        Throws:
        IMBException - when the received type cannot be converted to a Parameter sub-type

    • Method Detail

      • prepare

        public void prepare​(TByteBuffer payload)
        Prepare this parameter for transmission over IMB.
        Parameters:
        payload - TByteBuffer; the transmission buffer

      • qWrite

        public void qWrite​(TByteBuffer payload)
        Prepare this parameter for transmission over IMB.
        Parameters:
        payload - TByteBuffer; the transmission buffer

      • setValueList

        public void setValueList​(java.util.List<java.lang.String> list)
        Set the list of pre-defined options that the user may choose from.
        Parameters:
        list - List<String>; the list of options

      • toString

        public final java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • getName

        public java.lang.String getName()
        Returns:
        name.

      • getValue

        public java.lang.Object getValue()
        Returns:
        value.

      • getValueList

        public java.util.List<java.lang.String> getValueList()
        Returns:
        valueList.