com.simplifiedlogic.nitro.jshell.json.help

Class JLJsonDrawingHelp

java.lang.Object

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

com.simplifiedlogic.nitro.jshell.json.help.JLJsonDrawingHelp

All Implemented Interfaces:

JLDrawingRequestParams, JLDrawingResponseParams

public class JLJsonDrawingHelp
extends JLJsonCommandHelp
implements JLDrawingRequestParams, JLDrawingResponseParams

Generate help doc for "drawing" functions

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OBJ_SYMBOL_INST_DATA
static java.lang.String	OBJ_VIEW_DETAIL_DATA
static java.lang.String	OBJ_VIEW_DISPLAY_DATA

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

COMMAND, FUNC_ADD_MODEL, FUNC_ADD_SHEET, FUNC_CREATE, FUNC_CREATE_GEN_VIEW, FUNC_CREATE_PROJ_VIEW, FUNC_CREATE_SYMBOL, FUNC_DELETE_MODELS, FUNC_DELETE_SHEET, FUNC_DELETE_SYMBOL_DEF, FUNC_DELETE_SYMBOL_INST, FUNC_DELETE_VIEW, FUNC_GET_CUR_MODEL, FUNC_GET_CUR_SHEET, FUNC_GET_NUM_SHEETS, FUNC_GET_SHEET_FORMAT, FUNC_GET_SHEET_SCALE, FUNC_GET_SHEET_SIZE, FUNC_GET_VIEW_LOC, FUNC_GET_VIEW_SCALE, FUNC_GET_VIEW_SHEET, FUNC_IS_SYMBOL_DEF_LOADED, FUNC_LIST_MODELS, FUNC_LIST_SYMBOLS, FUNC_LIST_VIEW_DETAILS, FUNC_LIST_VIEWS, FUNC_LOAD_SYMBOL_DEF, FUNC_REGENERATE, FUNC_REGENERATE_SHEET, FUNC_RENAME_VIEW, FUNC_SCALE_SHEET, FUNC_SCALE_VIEW, FUNC_SELECT_SHEET, FUNC_SET_CUR_MODEL, FUNC_SET_SHEET_FORMAT, FUNC_SET_VIEW_LOC, FUNC_VIEW_BOUND_BOX, PARAM_ACTIVATE, PARAM_CABLE_STYLE, PARAM_DEL_CHILDREN, PARAM_DELETE_VIEWS, PARAM_DIRNAME, PARAM_DISPLAY, PARAM_DISPLAY_DATA, PARAM_DRAWING, PARAM_EXPLODED, PARAM_FILE, PARAM_MODEL, PARAM_MODEL_VIEW, PARAM_NEWVIEW, PARAM_NEWWIN, PARAM_PARENT_VIEW, PARAM_POINT, PARAM_POSITION, PARAM_RELATIVE, PARAM_REMOVE_QUILT_HIDDEN_LINES, PARAM_REPLACE_VALUES, PARAM_SCALE, PARAM_SHEET, PARAM_SHOW_CONCEPT_MODEL, PARAM_SHOW_WELD_XSECTION, PARAM_STYLE, PARAM_SYMBOL_DIR, PARAM_SYMBOL_FILE, PARAM_SYMBOL_ID, PARAM_TANGENT_STYLE, PARAM_TEMPLATE, PARAM_VIEW

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

OUTPUT_ATTACH_TYPE, OUTPUT_COMMONNAME, OUTPUT_DRAWING, OUTPUT_FAILED_VIEWS, OUTPUT_FULLNAME, OUTPUT_ID, OUTPUT_LOADED, OUTPUT_LOCATION, OUTPUT_MODEL, OUTPUT_MODELS, OUTPUT_NAME, OUTPUT_NUM_SHEETS, OUTPUT_SCALE, OUTPUT_SHEET, OUTPUT_SIMPREP, OUTPUT_SIZE, OUTPUT_SUCCESS_VIEWS, OUTPUT_SYMBOL_NAME, OUTPUT_SYMBOLS, OUTPUT_TEXT_HEIGHT, OUTPUT_VIEW_MODEL, OUTPUT_VIEW_NAME, OUTPUT_VIEWS, OUTPUT_XMAX, OUTPUT_XMIN, OUTPUT_YMAX, OUTPUT_YMIN

Constructor Summary

Constructors

Constructor and Description
JLJsonDrawingHelp()

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_VIEW_DISPLAY_DATA

public static final java.lang.String OBJ_VIEW_DISPLAY_DATA

See Also:

Constant Field Values

OBJ_VIEW_DETAIL_DATA

public static final java.lang.String OBJ_VIEW_DETAIL_DATA

See Also:

Constant Field Values

OBJ_SYMBOL_INST_DATA

public static final java.lang.String OBJ_SYMBOL_INST_DATA

See Also:

Constant Field Values

Constructor Detail

JLJsonDrawingHelp

public JLJsonDrawingHelp()

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