public interface FunctionBuilder extends Builder
Function
objects.
All:
setName(java.lang.String)
,
setTypes(nxopen.cae.Function.Type, nxopen.cae.XyFunctionMacroType, nxopen.cae.XyFunctionGeneralType)
,
setUnits(nxopen.cae.XyFunctionUnit, nxopen.cae.XyFunctionUnit, nxopen.cae.XyFunctionUnit)
;
formula:
setDefinitions(java.lang.String[])
,
setReferencedObjects(nxopen.cae.Function[])
,
setMathPlotData(int, double, double)
;
table function:
setTableData(int, java.lang.String, java.lang.String, nxopen.cae.Function.InterpolationMethod)
.
FunctionCollection.createFunctionBuilder(nxopen.cae.Function)
Modifier and Type | Interface and Description |
---|---|
static class |
FunctionBuilder.MathPlotData
This class holds the data returned from
getMathPlotData() |
static class |
FunctionBuilder.TableData
This class holds the data returned from
getTableData() |
static class |
FunctionBuilder.TypesData
This class holds the data returned from
getTypes() |
static class |
FunctionBuilder.UnitsData
This class holds the data returned from
getUnits() |
Modifier and Type | Method and Description |
---|---|
String[] |
getDefinitions()
Returns definition strings of a math function.
|
FunctionBuilder.MathPlotData |
getMathPlotData()
Returns plot data setting of a math function.
|
Function[] |
getReferencedObjects()
Returns referenced objects of a math function.
|
FunctionBuilder.TableData |
getTableData()
Returns data of a table function.
|
FunctionBuilder.TypesData |
getTypes()
Returns types of a function
License requirements: None. |
FunctionBuilder.UnitsData |
getUnits()
Returns units of a function
License requirements: None. |
double |
initialEstimateValue()
Returns the initial value for function
License requirements: None. |
String |
name()
Returns the function name.
|
void |
setDefinitions(String[] definitions)
Sets definition strings of a math function.
|
void |
setInitialEstimateValue(double val)
License requirements: None. |
void |
setMathPlotData(int dataCount,
double xMinimum,
double xIncrement)
Sets plot data setting for a math function.
|
void |
setName(String name)
License requirements: None. |
void |
setReferencedObjects(Function[] objects)
Sets referenced objects of a math function.
|
void |
setTableData(int recordIndex,
String recordName,
String recordTimestamp,
Function.InterpolationMethod interpolateMethod)
Sets data for a table function.
|
void |
setTypes(Function.Type functionType,
XyFunctionMacroType macroType,
XyFunctionGeneralType generalType)
Sets types of a function
License requirements: None. |
void |
setUnits(XyFunctionUnit xUnit,
XyFunctionUnit yUnit,
XyFunctionUnit frfUnit)
Sets units of a function
License requirements: None. |
commit, destroy, getCommittedObjects, getObject, showResults
printTestData, printTestData, tag, tagValue
validate
void setName(String name) throws NXException, RemoteException
name
- NXException
RemoteException
String name() throws NXException, RemoteException
NXException
RemoteException
void setTypes(Function.Type functionType, XyFunctionMacroType macroType, XyFunctionGeneralType generalType) throws NXException, RemoteException
functionType
- Math function or Table function.macroType
- For Motion Simulation or Advanced Simulation or General Purpose.generalType
- Data type of function.
If macro_type is XyFunctionMacroType.MOTION
,
it must be XyFunctionGeneralType.GENERAL
or
XyFunctionGeneralType.TIME
.
If macro_type is XyFunctionMacroType.LOAD
or
it must be XyFunctionGeneralType.GENERAL
or
XyFunctionGeneralType.TIME
or
XyFunctionGeneralType.SPECTRUM
or
XyFunctionGeneralType.POWER_SPECTRAL_DENSITY
or
XyFunctionGeneralType.SHOCK_RESPONSE_SPECTRUM
.
If macro_type is XyFunctionMacroType.MATERIAL
,
it must be XyFunctionGeneralType.GENERAL
or
XyFunctionGeneralType.TIME
or
XyFunctionGeneralType.TEMPERATURE
or
XyFunctionGeneralType.STRESS_STRAIN
or
XyFunctionGeneralType.LIFE
.
If macro_type is XyFunctionMacroType.RESPONSE
,
it must be XyFunctionGeneralType.GENERAL
or
XyFunctionGeneralType.TIME
or
XyFunctionGeneralType.SPECTRUM
or
XyFunctionGeneralType.POWER_SPECTRAL_DENSITY
or
XyFunctionGeneralType.SHOCK_RESPONSE_SPECTRUM
or
XyFunctionGeneralType.CROSS_SPECTRUM
or
XyFunctionGeneralType.TRANSMISSIBILITY
.NXException
RemoteException
FunctionBuilder.TypesData getTypes() throws NXException, RemoteException
NXException
RemoteException
void setUnits(XyFunctionUnit xUnit, XyFunctionUnit yUnit, XyFunctionUnit frfUnit) throws NXException, RemoteException
xUnit
- yUnit
- frfUnit
- NXException
RemoteException
FunctionBuilder.UnitsData getUnits() throws NXException, RemoteException
NXException
RemoteException
void setDefinitions(String[] definitions) throws NXException, RemoteException
Function.Type.MATH
definitions
- NXException
RemoteException
String[] getDefinitions() throws NXException, RemoteException
Function.Type.MATH
NXException
RemoteException
void setReferencedObjects(Function[] objects) throws NXException, RemoteException
Function.Type.MATH
objects
- NXException
RemoteException
Function[] getReferencedObjects() throws NXException, RemoteException
Function.Type.MATH
NXException
RemoteException
void setMathPlotData(int dataCount, double xMinimum, double xIncrement) throws NXException, RemoteException
Function.Type.MATH
dataCount
- xMinimum
- xIncrement
- NXException
RemoteException
FunctionBuilder.MathPlotData getMathPlotData() throws NXException, RemoteException
Function.Type.MATH
NXException
RemoteException
void setTableData(int recordIndex, String recordName, String recordTimestamp, Function.InterpolationMethod interpolateMethod) throws NXException, RemoteException
Function.Type.TABLE
recordIndex
- Begins with onerecordName
- recordTimestamp
- A time string indicating the creating or editing time of an afu record.
The string could be returned by AfuManager.createRecord(nxopen.cae.XyFunctionMacroType, nxopen.cae.XyFunctionGeneralType, nxopen.cae.AfuData)
or AfuManager.editRecord(nxopen.cae.XyFunctionMacroType, nxopen.cae.XyFunctionGeneralType, int, nxopen.cae.AfuData)
or AfuManager.getAfuData(java.lang.String, int)
interpolateMethod
- NXException
RemoteException
FunctionBuilder.TableData getTableData() throws NXException, RemoteException
Function.Type.TABLE
NXException
RemoteException
void setInitialEstimateValue(double val) throws NXException, RemoteException
val
- NXException
RemoteException
double initialEstimateValue() throws NXException, RemoteException
NXException
RemoteException
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.