Factory:org.bzdev.devqsim.SimFunctionFactory
Parameter Types
(optional keytype)
(value type)
Range RV Mode Add/Set
fName
Function Name
java.lang.String N/A false set
The name of the scripting-language function, or a function provided by an object-namer launcher, providing the values of the function
This parameter provides the name of the scripting-language function with one real-valued argument, returning a real number providing the values of the function. It should not be provided if the object parameter is provided.
fpName
Derivative Function Name
java.lang.String N/A false set
The name of the scripting-language function, or a function provided by an object-namer launcher, providing the first derivative of the function
This parameter provides the name of the scripting-language function with one real-valued argument, returning a real number providing the values of the function's first derivative. It should not be provided if the object parameter is provided.
fppName
Second Derivative Function Name
java.lang.String N/A false set
The name of the scripting-language function, or a function provided by an object-namer launcher, providing the second derivative of the function
This parameter provides the name of the scripting-language function with one real-valued argument, returning a real number providing the value of the function's second derivative. It should not be provided if the object parameter is provided.
object
Specification for Functions
java.lang.String N/A false set
A scripting-language object or string that provides an object with valueAt, derivAt, and secondDerivAt methods (the last two are optional)
This parameter's values is an object representing the function and its derivatives. The object may be
  • An instance of RealValuedFunction. the value is used directly.
  • An instance of RealValuedFunctOps. the value is used to construct an instance of RealValuedFunction, which is then used directly.
  • A String. The string will be evaluated as a script, and must produce a scripting-language object with methods named "valueAt", "derivAt", and "secondDerivAt". These methods provide the value of the function, the value of its derivative, and the value of its second derivative respectively.
  • A scripting-language object with methods named "valueAt", "derivAt", and "secondDerivAt". These methods provide the value of the function, the value of its derivative, and the value of its second derivative respectively. These methods provide the value of the function and the values of its first and second derivatives. If any are missing, the corresponding operation is not supported.
All the methods and functions return a double-precision number and take a single double-precision number as the only argument. If null, the fname, fpName, and/or fppName parameters must be provided.

While the type of the value is listed as String, an additional overridden setmethod allows the type to be an arbitrary object to handle some of the values described above.

timeline
Timeline
int N/A false add
Timeline entries (use only to clear)
This is an integer-keyed set of values that define changes in an object's configuration. Subclasses may provide additional timeline parameters.
timeline.time
Time
int
java.lang.Double
[-∞, ∞] false set
The time for a timeline entry
This parameter must be provided if a timeline entry exists. The units are those used by the double-precession time unit for the simulation (for animations, this is generally seconds).
timeline.traceSetMode
TraceSet Mode
int
org.bzdev.devqsim.TraceSetMode
N/A false set
The trace-set mode for a timeline entry
This parameter indicates how the trace sets associated with a timeline entry should be interpreted. The values are an enumeration whose type is org.bzdev.devqsim.TraceSetMode and are used as follows:
  • KEEP - keep the existing trace sets, adding additional ones specified by the parameter timeline.traceSets.
  • REMOVE - remove the trace sets specified by the parameter timeline.traceSets.
  • REPLACE - remove all existing trace sets and replace those with the ones specified by the timeline.traceSets parameter.
timeline.traceSets
Trace Sets
int
org.bzdev.devqsim.TraceSet
N/A false add
The trace sets for a timeline entry
This parameter represents a set of TraceSet objects (the three-argument add method is used to add entries). How the entries are interpreted depends on the trace set mode for this timeline entry.
traceSets
Trace Sets
org.bzdev.devqsim.TraceSet N/A false add
A set of TraceSet objects, used for tracing
This parameter provides a set of TraceSets a SimObject will use for tracing. One should use the add and remove factory methods as this parameter refers to a set of values.