com.simplifiedlogic.nitro.jshell.json.help

Class JLJsonFileHelp

java.lang.Object

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

com.simplifiedlogic.nitro.jshell.json.help.JLJsonFileHelp

All Implemented Interfaces:

JLFileRequestParams, JLFileResponseParams

public class JLJsonFileHelp
extends JLJsonCommandHelp
implements JLFileRequestParams, JLFileResponseParams

Generate help doc for "file" functions

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OBJ_CONSTRAINT
static java.lang.String	OBJ_FILEMATERIAL
static java.lang.String	OBJ_INERTIA
static java.lang.String	OBJ_POINT
static java.lang.String	OBJ_TRANSFORM

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

COMMAND, DATUM_SIDE_RED, DATUM_SIDE_YELLOW, FUNC_ASSEMBLE, FUNC_BACKUP, FUNC_CLOSE_WINDOW, FUNC_CREATE_UNIT_SYSTEM, FUNC_DELETE_MATERIAL, FUNC_DISPLAY, FUNC_ERASE, FUNC_ERASE_NOT_DISP, FUNC_EXISTS, FUNC_GET_ACCURACY, FUNC_GET_ACTIVE, FUNC_GET_CUR_MATL, FUNC_GET_CUR_MATL_WILDCARD, FUNC_GET_FILEINFO, FUNC_GET_LENGTH_UNITS, FUNC_GET_MASS_UNITS, FUNC_GET_TRANSFORM, FUNC_GET_UNIT_SYSTEM, FUNC_HAS_INSTANCES, FUNC_IS_ACTIVE, FUNC_LIST, FUNC_LIST_INSTANCES, FUNC_LIST_MATERIALS, FUNC_LIST_MATERIALS_WILDCARD, FUNC_LIST_SIMP_REPS, FUNC_LOAD_MATL_FILE, FUNC_MASSPROPS, FUNC_OPEN, FUNC_OPEN_ERRORS, FUNC_POST_REGEN_RELATIONS_GET, FUNC_POST_REGEN_RELATIONS_SET, FUNC_REFRESH, FUNC_REGENERATE, FUNC_RELATIONS_GET, FUNC_RELATIONS_SET, FUNC_RENAME, FUNC_REPAINT, FUNC_SAVE, FUNC_SET_CUR_MATL, FUNC_SET_LENGTH_UNITS, FUNC_SET_MASS_UNITS, FUNC_SET_UNIT_SYSTEM, PARAM_ACTIVATE, PARAM_ASM, PARAM_ASMDATUM, PARAM_ASMREF, PARAM_ASSEMBLE_TO_ROOT, PARAM_COMPDATUM, PARAM_COMPREF, PARAM_CONSTRAINT, PARAM_CONSTRAINT1, PARAM_CONSTRAINT10, PARAM_CONSTRAINT2, PARAM_CONSTRAINT3, PARAM_CONSTRAINT4, PARAM_CONSTRAINT5, PARAM_CONSTRAINT6, PARAM_CONSTRAINT7, PARAM_CONSTRAINT8, PARAM_CONSTRAINT9, PARAM_CONSTRAINTS, PARAM_CONVERT, PARAM_CSYS, PARAM_DIRNAME, PARAM_DISPLAY, PARAM_ERASE_CHILDREN, PARAM_FORCE, PARAM_GENERIC, PARAM_INCLUDE_NON_MATCHING, PARAM_INTOASM, PARAM_MASS, PARAM_MATERIAL, PARAM_MODEL, PARAM_MODELS, PARAM_NAME, PARAM_NEWNAME, PARAM_NEWWIN, PARAM_OFFSET, PARAM_ONLYSESSION, PARAM_ORIGIN, PARAM_PACKAGE_ASSEMBLY, PARAM_PATH, PARAM_REF_MODEL, PARAM_RELATIONS, PARAM_REP, PARAM_SUPPRESS, PARAM_TARGETDIR, PARAM_TRANSFORM, PARAM_TYPE, PARAM_UNIT_LENGTH, PARAM_UNIT_MASS_FORCE, PARAM_UNIT_TEMP, PARAM_UNIT_TIME, PARAM_UNITS, PARAM_WALK_CHILDREN, PARAM_X, PARAM_X_ROT, PARAM_XAXIS, PARAM_Y, PARAM_Y_ROT, PARAM_YAXIS, PARAM_Z, PARAM_Z_ROT, PARAM_ZAXIS

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

OUTPUT_ACCURACY, OUTPUT_ACTIVE, OUTPUT_COORD_SYS_INERTIA, OUTPUT_COORD_SYS_INERTIA_TENSOR, OUTPUT_CTR_GRAV, OUTPUT_CTR_GRAV_INERTIA_TENSOR, OUTPUT_DENSITY, OUTPUT_DIRNAME, OUTPUT_ERRORS, OUTPUT_EXISTS, OUTPUT_FEATUREID, OUTPUT_FILES, OUTPUT_GENERIC, OUTPUT_INSTANCES, OUTPUT_MASS, OUTPUT_MATERIAL, OUTPUT_MATERIALS, OUTPUT_MODEL, OUTPUT_MODELS, OUTPUT_NAME, OUTPUT_ORIGIN, OUTPUT_RELATIONS, OUTPUT_RELATIVE, OUTPUT_REPS, OUTPUT_REVISION, OUTPUT_SURFACE_AREA, OUTPUT_TRANSFORM, OUTPUT_UNITS, OUTPUT_VOLUME, OUTPUT_X, OUTPUT_X_ROT, OUTPUT_XAXIS, OUTPUT_Y, OUTPUT_Y_ROT, OUTPUT_YAXIS, OUTPUT_Z, OUTPUT_Z_ROT, OUTPUT_ZAXIS

Constructor Summary

Constructors

Constructor and Description
JLJsonFileHelp()

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.
protected static OrderedMap<java.lang.String,java.lang.Object>	writePoint(double x, double y, double z) Convert a 3D coordinate into a generic JSON structure

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_CONSTRAINT

public static final java.lang.String OBJ_CONSTRAINT

See Also:

Constant Field Values

OBJ_POINT

public static final java.lang.String OBJ_POINT

See Also:

Constant Field Values

OBJ_TRANSFORM

public static final java.lang.String OBJ_TRANSFORM

See Also:

Constant Field Values

OBJ_INERTIA

public static final java.lang.String OBJ_INERTIA

See Also:

Constant Field Values

OBJ_FILEMATERIAL

public static final java.lang.String OBJ_FILEMATERIAL

See Also:

Constant Field Values

Constructor Detail

JLJsonFileHelp

public JLJsonFileHelp()

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

writePoint

protected static OrderedMap<java.lang.String,java.lang.Object> writePoint(double x,
                                                       double y,
                                                       double z)

Convert a 3D coordinate into a generic JSON structure

Parameters:

x -

y -

z -

Returns:

The JSON data as a Hashtable