com.simplifiedlogic.nitro.jshell.json.help

Class JLJsonCommandHelp

java.lang.Object

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

Direct Known Subclasses:

JLJsonBomHelp, JLJsonConnectionHelp, JLJsonCreoHelp, JLJsonDimensionHelp, JLJsonDrawingHelp, JLJsonFamilyTableHelp, JLJsonFeatureHelp, JLJsonFileHelp, JLJsonGeometryHelp, JLJsonInterfaceHelp, JLJsonLayerHelp, JLJsonNoteHelp, JLJsonParameterHelp, JLJsonViewHelp, JLJsonWindchillHelp

public abstract class JLJsonCommandHelp
extends java.lang.Object

Parent class for any help-doc generator class for a family of functions.

Constructor Summary

Constructors

Constructor and Description
JLJsonCommandHelp()

Method Summary

Methods

Modifier and Type	Method and Description
abstract java.lang.String	getCommand() Get the command for this family of functions
abstract java.util.List<FunctionTemplate>	getHelp() Get a list of function templates for this family of functions.
abstract java.util.List<FunctionObject>	getHelpObjects() Get a list of data objects used in function templates for this family of functions.
protected java.util.Map<java.lang.String,java.lang.Object>	makeInertia(java.util.Map<java.lang.String,java.lang.Object> xvector, java.util.Map<java.lang.String,java.lang.Object> yvector, java.util.Map<java.lang.String,java.lang.Object> zvector)
protected java.util.Map<java.lang.String,java.lang.Object>	makePoint(double x, double y, double z)
protected void	makeTransform(FunctionExample ex, java.util.Map<java.lang.String,java.lang.Object> origin, java.util.Map<java.lang.String,java.lang.Object> xvector, java.util.Map<java.lang.String,java.lang.Object> yvector, java.util.Map<java.lang.String,java.lang.Object> zvector, double xrot, double yrot, double zrot)
protected java.util.Map<java.lang.String,java.lang.Object>	makeTransform(java.util.Map<java.lang.String,java.lang.Object> origin, java.util.Map<java.lang.String,java.lang.Object> xvector, java.util.Map<java.lang.String,java.lang.Object> yvector, java.util.Map<java.lang.String,java.lang.Object> zvector, double xrot, double yrot, double zrot)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JLJsonCommandHelp

public JLJsonCommandHelp()

Method Detail

getHelp

public abstract java.util.List<FunctionTemplate> getHelp()

Get a list of function templates for this family of functions.

Returns:

A list of function templates

getCommand

public abstract java.lang.String getCommand()

Get the command for this family of functions

Returns:

The command (function family) name

getHelpObjects

public abstract java.util.List<FunctionObject> getHelpObjects()

Get a list of data objects used in function templates for this family of functions.

Returns:

A list of data objects

makeTransform

protected java.util.Map<java.lang.String,java.lang.Object> makeTransform(java.util.Map<java.lang.String,java.lang.Object> origin,
                                                             java.util.Map<java.lang.String,java.lang.Object> xvector,
                                                             java.util.Map<java.lang.String,java.lang.Object> yvector,
                                                             java.util.Map<java.lang.String,java.lang.Object> zvector,
                                                             double xrot,
                                                             double yrot,
                                                             double zrot)

makeTransform

protected void makeTransform(FunctionExample ex,
                 java.util.Map<java.lang.String,java.lang.Object> origin,
                 java.util.Map<java.lang.String,java.lang.Object> xvector,
                 java.util.Map<java.lang.String,java.lang.Object> yvector,
                 java.util.Map<java.lang.String,java.lang.Object> zvector,
                 double xrot,
                 double yrot,
                 double zrot)

makePoint

protected java.util.Map<java.lang.String,java.lang.Object> makePoint(double x,
                                                         double y,
                                                         double z)

makeInertia

protected java.util.Map<java.lang.String,java.lang.Object> makeInertia(java.util.Map<java.lang.String,java.lang.Object> xvector,
                                                           java.util.Map<java.lang.String,java.lang.Object> yvector,
                                                           java.util.Map<java.lang.String,java.lang.Object> zvector)