com.simplifiedlogic.nitro.jshell.json.help

Class JLJsonBomHelp

java.lang.Object

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

com.simplifiedlogic.nitro.jshell.json.help.JLJsonBomHelp

All Implemented Interfaces:

JLBomRequestParams, JLBomResponseParams

public class JLJsonBomHelp
extends JLJsonCommandHelp
implements JLBomRequestParams, JLBomResponseParams

Generate help doc for "bom" functions

Field Summary

Fields

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

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

COMMAND, FUNC_GET_PATHS, PARAM_EXCLUDE_INACTIVE, PARAM_MODEL, PARAM_PATHS, PARAM_SIMPREP, PARAM_SKELETON, PARAM_TOPLEVEL, PARAM_TRANSFORMS

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

OUTPUT_CHILDREN, OUTPUT_GENERIC, OUTPUT_HAS_SIMPREP, OUTPUT_ID, OUTPUT_PATH, OUTPUT_SEQ_PATH, OUTPUT_TRANSFORM

Constructor Summary

Constructors

Constructor and Description
JLJsonBomHelp()

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_BOM_CHILD

public static final java.lang.String OBJ_BOM_CHILD

See Also:

Constant Field Values

Constructor Detail

JLJsonBomHelp

public JLJsonBomHelp()

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