com.simplifiedlogic.nitro.jshell.json.help

Class JLJsonFeatureHelp

java.lang.Object

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

com.simplifiedlogic.nitro.jshell.json.help.JLJsonFeatureHelp

All Implemented Interfaces:

JLFeatureRequestParams, JLFeatureResponseParams

public class JLJsonFeatureHelp
extends JLJsonCommandHelp
implements JLFeatureRequestParams, JLFeatureResponseParams

Generate help doc for "feature" functions

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OBJ_FEAT_SELECT_DATA
static java.lang.String	OBJ_FEATURE_DATA

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

COMMAND, FUNC_DELETE, FUNC_DELETE_PARAM, FUNC_LIST, FUNC_LIST_GROUP_FEATURES, FUNC_LIST_PARAMS, FUNC_LIST_PATTERN_FEATURES, FUNC_LIST_SELECTED, FUNC_PARAM_EXISTS, FUNC_RENAME, FUNC_RESUME, FUNC_SET_PARAM, FUNC_SUPPRESS, FUNC_USER_SELECT_CSYS, PARAM_CLIP, PARAM_GROUP_NAME, PARAM_ID, PARAM_INC_UNNAMED, PARAM_MAX, PARAM_MODEL, PARAM_NAME, PARAM_NAMES, PARAM_NEWNAME, PARAM_NO_COMP, PARAM_NO_DATUM, PARAM_PARAM, PARAM_PARAMS, PARAM_PATH, PARAM_PATHS, PARAM_PATTERN_NAME, PARAM_RELCOMMENT, PARAM_RELDELETE, PARAM_STATUS, PARAM_TYPE, PARAM_WCHILDREN

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

OUTPUT_EXISTS, OUTPUT_FEATLIST, OUTPUT_FEATNO, OUTPUT_ID, OUTPUT_PARAMLIST, OUTPUT_PATH

Constructor Summary

Constructors

Constructor and Description
JLJsonFeatureHelp()

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_FEATURE_DATA

public static final java.lang.String OBJ_FEATURE_DATA

See Also:

Constant Field Values

OBJ_FEAT_SELECT_DATA

public static final java.lang.String OBJ_FEAT_SELECT_DATA

See Also:

Constant Field Values

Constructor Detail

JLJsonFeatureHelp

public JLJsonFeatureHelp()

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