com.simplifiedlogic.nitro.jshell.json.help

Class JLJsonCreoHelp

java.lang.Object

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

com.simplifiedlogic.nitro.jshell.json.help.JLJsonCreoHelp

All Implemented Interfaces:

JLCreoRequestParams, JLCreoResponseParams

public class JLJsonCreoHelp
extends JLJsonCommandHelp
implements JLCreoRequestParams, JLCreoResponseParams

Generate help doc for "creo" functions

Field Summary

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

COMMAND, FUNC_CD, FUNC_DELETE_FILES, FUNC_GET_CONFIG, FUNC_GET_STD_COLOR, FUNC_LIST_DIRS, FUNC_LIST_FILES, FUNC_MKDIR, FUNC_PWD, FUNC_RMDIR, FUNC_SET_CONFIG, FUNC_SET_CREO_VERSION, FUNC_SET_STD_COLOR, PARAM_BLUE, PARAM_COLOR_TYPE, PARAM_DIRNAME, PARAM_FILENAME, PARAM_FILENAMES, PARAM_GREEN, PARAM_IGNORE_ERRORS, PARAM_NAME, PARAM_RED, PARAM_VALUE, PARAM_VERSION, STD_COLOR_BACKGROUND, STD_COLOR_CURVE, STD_COLOR_DATUM, STD_COLOR_DIMMED, STD_COLOR_DRAWING, STD_COLOR_EDGE_HIGHLIGHT, STD_COLOR_ERROR, STD_COLOR_HALF_TONE, STD_COLOR_HIGHLIGHT, STD_COLOR_LETTER, STD_COLOR_PRESEL_HIGHLIGHT, STD_COLOR_PREVIEW, STD_COLOR_QUILT, STD_COLOR_SECONDARY_PREVIEW, STD_COLOR_SECONDARY_SELECTED, STD_COLOR_SELECTED, STD_COLOR_SHEETMETAL, STD_COLOR_WARNING

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

OUTPUT_BLUE, OUTPUT_DIRLIST, OUTPUT_DIRNAME, OUTPUT_FILELIST, OUTPUT_GREEN, OUTPUT_RED, OUTPUT_VALUES

Constructor Summary

Constructors

Constructor and Description
JLJsonCreoHelp()

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

JLJsonCreoHelp

public JLJsonCreoHelp()

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