com.simplifiedlogic.nitro.jshell.json.help

Class JLJsonViewHelp

java.lang.Object

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

com.simplifiedlogic.nitro.jshell.json.help.JLJsonViewHelp

All Implemented Interfaces:

JLViewRequestParams, JLViewResponseParams

public class JLJsonViewHelp
extends JLJsonCommandHelp
implements JLViewRequestParams, JLViewResponseParams

Generate help doc for "view" functions

Field Summary

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

COMMAND, FUNC_ACTIVATE, FUNC_LIST, FUNC_LIST_EXPLODED, FUNC_SAVE, PARAM_MODEL, PARAM_NAME

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

OUTPUT_VIEWLIST

Constructor Summary

Constructors

Constructor and Description
JLJsonViewHelp()

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

Constructor Detail

JLJsonViewHelp

public JLJsonViewHelp()

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