com.simplifiedlogic.nitro.jshell.json.help

Class JLJsonParameterHelp

java.lang.Object

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

com.simplifiedlogic.nitro.jshell.json.help.JLJsonParameterHelp

All Implemented Interfaces:

JLParameterRequestParams, JLParameterResponseParams

public class JLJsonParameterHelp
extends JLJsonCommandHelp
implements JLParameterRequestParams, JLParameterResponseParams

Generate help doc for "parameter" functions

Field Summary

Fields

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

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

COMMAND, FUNC_COPY, FUNC_DELETE, FUNC_EXISTS, FUNC_LIST, FUNC_SET, FUNC_SET_DESIGNATED, PARAM_DESCRIPTION, PARAM_DESIGNATE, PARAM_ENCODED, PARAM_MODEL, PARAM_NAME, PARAM_NAMES, PARAM_NO_CREATE, PARAM_TOMODEL, PARAM_TONAME, PARAM_TYPE, PARAM_VALUE

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

OUTPUT_EXISTS, OUTPUT_OWNER_ID, OUTPUT_OWNER_NAME, OUTPUT_OWNER_TYPE, OUTPUT_PARAMLIST

Constructor Summary

Constructors

Constructor and Description
JLJsonParameterHelp()

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_PARAMETER_DATA

public static final java.lang.String OBJ_PARAMETER_DATA

See Also:

Constant Field Values

Constructor Detail

JLJsonParameterHelp

public JLJsonParameterHelp()

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