Class Process

  • All Implemented Interfaces:
    java.io.Serializable

    
    public abstract class Process
     implements Serializable
                        

    An abstract class for stochastic processes

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
    • Constructor Summary

      Constructors 
      Constructor Description
      Process(String name, int numParam) Creates a new process with the specified name and number of parameters.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Method Summary

      Modifier and Type Method Description
      abstract Object sample() Sample a value from the process
      String getName() Get the name of this process
      int getNumParams() Get the number of parameters
      void setParam(int id, String paramName, Object paramValue) Set a parameter by id, name and value
      NamedParam getParam(int id) Get a parameter by id
      String name() Kotlin-style property alias for getName()
      int numParams() Kotlin-style property alias for getNumParams()
      NamedParam param(int id) Kotlin-style property alias for getParam(int id)
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • Process

        Process(String name, int numParam)
        Creates a new process with the specified name and number of parameters.
        Parameters:
        name - the name of this process type
        numParam - the number of parameters required
    • Method Detail

      • sample

         abstract Object sample()

        Sample a value from the process

        Returns:

        sampled value

      • getName

         String getName()

        Get the name of this process

        Returns:

        process name

      • getNumParams

         int getNumParams()

        Get the number of parameters

        Returns:

        number of parameters

      • setParam

         void setParam(int id, String paramName, Object paramValue)

        Set a parameter by id, name and value

        Parameters:
        id - parameter index (1-based)
        paramName - parameter name
        paramValue - parameter value
      • getParam

         NamedParam getParam(int id)

        Get a parameter by id

        Parameters:
        id - parameter index (1-based)
        Returns:

        the named parameter

      • name

         String name()

        Kotlin-style property alias for getName()

      • numParams

         int numParams()

        Kotlin-style property alias for getNumParams()

      • param

         NamedParam param(int id)

        Kotlin-style property alias for getParam(int id)