com.simplifiedlogic.nitro.jshell.json.help

Class JLJsonGeometryHelp

java.lang.Object

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

com.simplifiedlogic.nitro.jshell.json.help.JLJsonGeometryHelp

All Implemented Interfaces:

JLGeometryRequestParams, JLGeometryResponseParams

public class JLJsonGeometryHelp
extends JLJsonCommandHelp
implements JLGeometryRequestParams, JLGeometryResponseParams

Generate help doc for "geometry" functions

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OBJ_CONTOUR_DATA
static java.lang.String	OBJ_EDGE_DATA
static java.lang.String	OBJ_SURFACE_DATA

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

COMMAND, FUNC_BOUND_BOX, FUNC_GET_EDGES, FUNC_GET_SURFACES, PARAM_MODEL, PARAM_SURFACE_IDS

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

OUTPUT_AREA, OUTPUT_CONTOURLIST, OUTPUT_EDGE_ID, OUTPUT_EDGELIST, OUTPUT_END, OUTPUT_FEATURE_ID, OUTPUT_LENGTH, OUTPUT_MAX_EXTENT, OUTPUT_MIN_EXTENT, OUTPUT_START, OUTPUT_SURFACE_ID, OUTPUT_SURFLIST, OUTPUT_TRAVERSAL, OUTPUT_XMAX, OUTPUT_XMIN, OUTPUT_YMAX, OUTPUT_YMIN, OUTPUT_ZMAX, OUTPUT_ZMIN, TRAVERSE_EXTERNAL, TRAVERSE_INTERNAL

Constructor Summary

Constructors

Constructor and Description
JLJsonGeometryHelp()

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_CONTOUR_DATA

public static final java.lang.String OBJ_CONTOUR_DATA

See Also:

Constant Field Values

OBJ_EDGE_DATA

public static final java.lang.String OBJ_EDGE_DATA

See Also:

Constant Field Values

OBJ_SURFACE_DATA

public static final java.lang.String OBJ_SURFACE_DATA

See Also:

Constant Field Values

Constructor Detail

JLJsonGeometryHelp

public JLJsonGeometryHelp()

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