Interface SimulationConfig

    • Field Detail

      • AL_SIMULATE_PROXY_NAME

        static final java.lang.String AL_SIMULATE_PROXY_NAME
        See Also:
        Constant Field Values
      • AL_SIMULATE_PROXY_SERVER

        static final java.lang.String AL_SIMULATE_PROXY_SERVER
        See Also:
        Constant Field Values
      • AL_SIMULATE_PROXY_CONFIG

        static final java.lang.String AL_SIMULATE_PROXY_CONFIG
        See Also:
        Constant Field Values
      • AL_SIMULATE_PROXY_MODE

        static final java.lang.String AL_SIMULATE_PROXY_MODE
        See Also:
        Constant Field Values
      • AL_SIMULATE_PROXY_DEBUG

        static final java.lang.String AL_SIMULATE_PROXY_DEBUG
        See Also:
        Constant Field Values
      • SIM_OP_AS_STRING

        static final java.lang.String[] SIM_OP_AS_STRING
      • METHODS_FC_PERFORM

        static final java.lang.String[] METHODS_FC_PERFORM
      • METHODS_CON_UPDATE

        static final java.lang.String[] METHODS_CON_UPDATE
      • METHODS_CON_DELETE

        static final java.lang.String[] METHODS_CON_DELETE
      • METHODS_CON_DELTA

        static final java.lang.String[] METHODS_CON_DELTA
      • METHODS_CON_ITERATOR

        static final java.lang.String[] METHODS_CON_ITERATOR
      • METHODS_CON_REPLY

        static final java.lang.String[] METHODS_CON_REPLY
      • METHODS_CON_CALL_REPLY

        static final java.lang.String[] METHODS_CON_CALL_REPLY
      • METHODS_CON_SERVER

        static final java.lang.String[] METHODS_CON_SERVER
      • METHODS_CON_LOOKUP

        static final java.lang.String[] METHODS_CON_LOOKUP
      • METHODS_CON_ADDONLY

        static final java.lang.String[] METHODS_CON_ADDONLY
    • Method Detail

      • setProxyALName

        void setProxyALName​(java.lang.String name)
        Sets the name of the AL to use as proxy.
        Parameters:
        name - The name of the AL
      • getProxyALName

        java.lang.String getProxyALName()
        Returns the name of the AL set as a proxy.
        Returns:
        The name of the AL used as proxy or null if nothing was set.
      • setProxyALServer

        void setProxyALServer​(java.lang.String server)
        Sets the remote server host name.
        Parameters:
        server - The name of the server
      • getProxyALServer

        java.lang.String getProxyALServer()
        Returns the name of the remote server.
        Returns:
        The name of the server
      • setProxyALConfigInstance

        void setProxyALConfigInstance​(java.lang.String config)
        Sets the ID of the configInstance to use
        Parameters:
        config - The ID of the ConfigInstance
      • getProxyALConfigInstance

        java.lang.String getProxyALConfigInstance()
        Returns the configInstance ID
        Returns:
        The ID of the configInstance
      • setProxyALMode

        void setProxyALMode​(int mode)
        Sets the mode the proxy AL will run in
        • 0 - Run and wait for result
        • 1 - Run in background
        • 2 - Run in Manual mode
        Parameters:
        mode - The mode the AL will run in
      • getProxyALMode

        int getProxyALMode()
        Gets the mode the proxy AL will run in
        • 0 - Run and wait for result
        • 1 - Run in background
        • 2 - Run in Manual mode
        Returns:
        The mode the AL will run in
      • setProxyALDebug

        void setProxyALDebug​(boolean debug)
        Sets proxy AL debug flag on/off
        Parameters:
        debug - The new value of the debug flag
      • getProxyALDebug

        boolean getProxyALDebug()
        Gets the debug flag state
        Returns:
        The value of the proxy AL debug flag
      • getProxySettings

        BaseConfiguration getProxySettings()
                                    throws java.lang.Exception
        Gets the proxySettings Config holder
        Returns:
        The proxySettings
        Throws:
        java.lang.Exception
      • createOrUpdateProxyAL

        AssemblyLineConfig createOrUpdateProxyAL()
                                          throws java.lang.Exception
        This method checks the current simulation config settings and uses the ProxyAL setting to lookup the ProxyAL's AssibmlyLineConfig object. If that object is found it is updated with the missing BranchingConfig components. Any of the existing component in the AssemblyLineConfig that are user defined are not changed. If that object could not be found during the lookup process it is created.
        Returns:
        the object that was updated with the necessary branching components
        Throws:
        java.lang.Exception
      • getHook

        HookConfig getHook​(java.lang.String name)
        Return the simulation hook config object for the specified by name component
        Parameters:
        name - The name of the component which hook configuration to get
        Returns:
        The simulation hook specified by the name parameter or null if the component is not found. If it is found but the requested HookConfig does not exist then it is created and returned.
      • getComponentSimState

        java.lang.String getComponentSimState​(java.lang.String name)
        Returns the state of the specified by the name parameter Component
        Parameters:
        name - The name of the component
        Returns:
        the simulation state of the component as String or null if undefined
      • setComponentSimState

        void setComponentSimState​(java.lang.String name,
                                  java.lang.String state)
        Set the state of the Component specified by the name parameter
        Parameters:
        name - The name of the Component
        state - The new state of the Component