com.simplifiedlogic.nitro.jshell.json.help

Class JLJsonConnectionHelp

java.lang.Object

com.simplifiedlogic.nitro.jshell.json.help.JLJsonCommandHelp

com.simplifiedlogic.nitro.jshell.json.help.JLJsonConnectionHelp

All Implemented Interfaces:

JLConnectRequestParams, JLConnectResponseParams

public class JLJsonConnectionHelp
extends JLJsonCommandHelp
implements JLConnectRequestParams, JLConnectResponseParams

Generate help doc for "connection" functions

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OBJ_SERVICE_STATUS

Fields inherited from interface com.simplifiedlogic.nitro.jshell.json.request.JLConnectRequestParams

ALLOWED_PROE_CMD, APP_PROE, COMMAND, FUNC_CONNECT, FUNC_DISCONNECT, FUNC_IS_RUNNING, FUNC_KILL_PROE, FUNC_START_PROE, FUNC_STOP_PROE, PARAM_COMMANDLOG, PARAM_PRODUCT, PARAM_RETRIES, PARAM_START_COMMAND, PARAM_START_DIR, PARAM_SYSTEM, PARAM_USE_DESKTOP

Fields inherited from interface com.simplifiedlogic.nitro.jshell.json.response.JLConnectResponseParams

OUTPUT_RUNNING, OUTPUT_SESSIONID

Constructor Summary

Constructors

Constructor and Description
JLJsonConnectionHelp()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getCommand() Get the command for this family of functions
java.util.List<FunctionTemplate>	getHelp() Get a list of function templates for this family of functions.
java.util.List<FunctionObject>	getHelpObjects() Get a list of data objects used in function templates for this family of functions.

Methods inherited from class com.simplifiedlogic.nitro.jshell.json.help.JLJsonCommandHelp

makeInertia, makePoint, makeTransform, makeTransform

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OBJ_SERVICE_STATUS

public static final java.lang.String OBJ_SERVICE_STATUS

See Also:

Constant Field Values

Constructor Detail

JLJsonConnectionHelp

public JLJsonConnectionHelp()

Method Detail

getCommand

public java.lang.String getCommand()

Description copied from class: JLJsonCommandHelp

Get the command for this family of functions

Specified by:

getCommand in class JLJsonCommandHelp

Returns:

The command (function family) name

getHelp

public java.util.List<FunctionTemplate> getHelp()

Description copied from class: JLJsonCommandHelp

Get a list of function templates for this family of functions.

Specified by:

getHelp in class JLJsonCommandHelp

Returns:

A list of function templates

getHelpObjects

public java.util.List<FunctionObject> getHelpObjects()

Description copied from class: JLJsonCommandHelp

Get a list of data objects used in function templates for this family of functions.

Specified by:

getHelpObjects in class JLJsonCommandHelp

Returns:

A list of data objects