public interface FieldTable extends Field
Field
) defined in terms of tabular data involving
one or more look-up independent columns and one or more dependent variables (see
FieldVariable
) which depend on the look-up columns. FieldManager
. Modifier and Type | Interface and Description |
---|---|
static class |
FieldTable.IdwOptionsData
This class holds the data returned from
getIdwOptions() |
static class |
FieldTable.InterpolationEnum
Deprecated.
Deprecated in NX7.5.2. Use
FieldEvaluator.InterpolationEnum instead.
|
static class |
FieldTable.LoadFileOption
Load file options
|
DisplayableObject.ObjectFont, DisplayableObject.ObjectWidth
NXObject.AttributeInformation, NXObject.AttributeType, NXObject.ComputationalTime, NXObject.DateAndTimeFormat, NXObject.NextUserAttributeData
Modifier and Type | Method and Description |
---|---|
double |
annTolerance()
Returns
the approximate nearest neighbor (ANN) interpolation tolerance
License requirements: None. |
boolean |
discontinuities()
Returns a flag specifying if the table has discontinuites
License requirements: None. |
void |
editFieldTable(FieldVariable[] indepVarArray,
FieldVariable[] depVarArray,
double[] datapoints)
Edit the table field.
|
void |
editFieldTableComplexDisplay(boolean[] indepVarArrayComplexDisplay,
boolean[] depVarArrayComplexDisplay)
Edit the table field complex display.
|
void |
editFieldTableComplexUnits(Unit[] depVarArrayComplexUnits)
Edit the table field complex units array.
|
void |
editTableVariables(FieldVariable[] indepVarArray,
FieldVariable[] depExpArray)
Edit the table field dependent variables.
|
double[] |
getData(FieldVariable variable)
Returns the values for the given
FieldVariable in this FieldTable . |
FieldTable.IdwOptionsData |
getIdwOptions()
Get the inverse distance weighting (IDW) interpolation options
License requirements: None. |
double |
independentValueDivisor()
Returns the linear interpolation divisor for field independent value, the zero value represents no divisor used
License requirements: None. |
boolean |
independentValueDivisorOption()
Returns a value indicating whether to set the linear interpolation divisor for field independent value
License requirements: None. |
double |
independentValueShift()
Returns the linear interpolation shift for field independent value
License requirements: None. |
boolean |
independentValueShiftOption()
Returns a value indicating whether to set the linear interpolation shift for field independent value
License requirements: None. |
FieldEvaluator.InterpolationEnum |
interpolationMethod()
Returns
the interpolation method used when this table data is evaluated.
|
boolean |
latticeDataOption()
Returns
the lattice data option check used when this table data is in lattice format.
|
FieldEvaluator.LinearLogOptionEnum |
linearLogOption()
Returns
the linear/log option used when this table data is evaluated using the linear 1d interpolator.
|
void |
loadFromFile(String filename,
FieldTable.LoadFileOption loadFileOption)
Populate the table from a file replacing or appending data
License requirements: None. |
int |
numLatticeDataColumn()
Returns
the number of lattice data column option check used when this table data is in lattice format.
|
boolean |
persistentInterpolator()
Returns
a flag specifying if interpolator is persistent between session
License requirements: None. |
void |
setAnnTolerance(double annTolerance)
License requirements: None. |
void |
setIdwOptions(FieldEvaluator.InverseDistanceWeightingEnum nearestOption,
double nearestFraction)
Set the inverse distance weighting (IDW) interpolation options
License requirements: None. |
void |
setIndependentValueDivisor(double divisor)
License requirements: None. |
void |
setIndependentValueDivisorOption(boolean divisorOption)
License requirements: None. |
void |
setIndependentValueShift(double shift)
License requirements: None. |
void |
setIndependentValueShiftOption(boolean shiftOption)
License requirements: None. |
void |
setInterpolation(int interpolationMethod)
Deprecated.
Deprecated in NX7.5.2. Use
interpolationMethod() and setInterpolationMethod(nxopen.fields.FieldEvaluator.InterpolationEnum) instead.
|
void |
setInterpolationMethod(FieldEvaluator.InterpolationEnum interpolationMethod)
License requirements: None. |
void |
setLatticeDataOption(boolean latticeDataOption)
License requirements: None. |
void |
setLinearLogOption(FieldEvaluator.LinearLogOptionEnum linearOption)
License requirements: None. |
void |
setNumLatticeDataColumn(int numLatticeDataColumn)
License requirements: None. |
void |
setPersistentInterpolator(boolean persistentInterpolator)
License requirements: None. |
void |
setValuesOutsideTableInterpolation(FieldEvaluator.ValuesOutsideTableInterpolationEnum interpolationMethod)
License requirements: None. |
FieldEvaluator.ValuesOutsideTableInterpolationEnum |
valuesOutsideTableInterpolation()
Returns the outside table values interpolation method for standard linear interpolation
License requirements: None. |
addApplicationData, copyAsTableToPart, copyToPart, createCopyInPart, createDrawHelper, createTableInPart, delete, getApplicationData, getDependentVariables, getDescription, getFieldDrawhelper, getFieldEvaluator, getIdLabel, getIndependentVariables, getSpatialMap, isLocked, isUserField, rename, setDescription, setIdLabel, setPartContext, setSpatialMap, xygraph, xygraph, xygraph, xygraph3DScaleAndReturnPlots, xygraphAndReturnPlots, xygraphArgand, xygraphScaleAndReturnPlots
blank, color, highlight, isBlanked, layer, lineFont, lineWidth, nameLocation, redisplayObject, removeViewDependency, setColor, setLayer, setLineFont, setLineWidth, setNameLocation, unblank, unhighlight
createAttributeIterator, deleteAllAttributesByType, deleteAllAttributesByType, deleteAttributeByTypeAndTitle, deleteAttributeByTypeAndTitle, deleteUserAttribute, deleteUserAttributes, deleteUserAttributes, getAttributeTitlesByType, getBooleanUserAttribute, getComputationalTimeUserAttribute, getIntegerAttribute, getIntegerUserAttribute, getNextUserAttribute, getPdmReferenceAttributeValue, getRealAttribute, getRealUserAttribute, getReferenceAttribute, getStringAttribute, getStringUserAttribute, getTimeAttribute, getTimeUserAttribute, getUserAttribute, getUserAttribute, getUserAttributeAsString, getUserAttributeCount, getUserAttributeCount, getUserAttributeCount, getUserAttributeCount, getUserAttributeLock, getUserAttributes, getUserAttributes, getUserAttributes, getUserAttributes, getUserAttributesAsStrings, getUserAttributeSize, getUserAttributeSourceObjects, hasUserAttribute, hasUserAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setBooleanUserAttribute, setPdmReferenceAttribute, setReferenceAttribute, setReferenceAttribute, setTimeAttribute, setTimeAttribute, setTimeUserAttribute, setTimeUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttributeLock
printTestData, printTestData, tag, tagValue
findObject, isOccurrence, journalIdentifier, name, owningComponent, owningPart, print, prototype, setName
void editFieldTable(FieldVariable[] indepVarArray, FieldVariable[] depVarArray, double[] datapoints) throws NXException, RemoteException
FieldVariable
s for
independent and dependent variables, as well as the new double values.
indepVarArray
- independent variables to be associated with the fielddepVarArray
- dependent expression fields to be associated with the formula fielddatapoints
- row based array of double values representing the table; then number of points should equal the number of independent variables * the number of dependent variables * the number of rows.NXException
RemoteException
void editFieldTableComplexDisplay(boolean[] indepVarArrayComplexDisplay, boolean[] depVarArrayComplexDisplay) throws NXException, RemoteException
indepVarArrayComplexDisplay
- independent variable complex display flags to be associated with the fielddepVarArrayComplexDisplay
- dependent variable complex display flags to be associated with the fieldNXException
RemoteException
void editFieldTableComplexUnits(Unit[] depVarArrayComplexUnits) throws NXException, RemoteException
depVarArrayComplexUnits
- NXException
RemoteException
void setInterpolation(int interpolationMethod) throws NXException, RemoteException
interpolationMethod()
and setInterpolationMethod(nxopen.fields.FieldEvaluator.InterpolationEnum)
instead.
interpolationMethod
- specified interpolation method; FieldTable
interpolation enum values for builtin methods.
NXException
RemoteException
boolean persistentInterpolator() throws NXException, RemoteException
NXException
RemoteException
void setPersistentInterpolator(boolean persistentInterpolator) throws NXException, RemoteException
persistentInterpolator
- persistent interpolator indicatorNXException
RemoteException
FieldTable.IdwOptionsData getIdwOptions() throws NXException, RemoteException
NXException
RemoteException
void setIdwOptions(FieldEvaluator.InverseDistanceWeightingEnum nearestOption, double nearestFraction) throws NXException, RemoteException
nearestOption
- nearest optionnearestFraction
- fractionNXException
RemoteException
double annTolerance() throws NXException, RemoteException
NXException
RemoteException
void setAnnTolerance(double annTolerance) throws NXException, RemoteException
annTolerance
- approximate nearest neighbor (ANN) interpolation toleranceNXException
RemoteException
FieldEvaluator.InterpolationEnum interpolationMethod() throws NXException, RemoteException
NXException
RemoteException
void setInterpolationMethod(FieldEvaluator.InterpolationEnum interpolationMethod) throws NXException, RemoteException
interpolationMethod
- the interpolation methodNXException
RemoteException
void loadFromFile(String filename, FieldTable.LoadFileOption loadFileOption) throws NXException, RemoteException
filename
- file to read rows fromloadFileOption
- append or replaceNXException
RemoteException
double[] getData(FieldVariable variable) throws NXException, RemoteException
FieldVariable
in this FieldTable
.
The input FieldVariable
should be retrieved from the field using
Field.getIndependentVariables()
or Field.getDependentVariables()
.
The values are in the same Unit
as specified on the FieldVariable
.
variable
- variable whose table values are to be returnedNXException
RemoteException
FieldEvaluator.ValuesOutsideTableInterpolationEnum valuesOutsideTableInterpolation() throws NXException, RemoteException
NXException
RemoteException
void setValuesOutsideTableInterpolation(FieldEvaluator.ValuesOutsideTableInterpolationEnum interpolationMethod) throws NXException, RemoteException
interpolationMethod
- the outside table values interpolation methodNXException
RemoteException
boolean independentValueShiftOption() throws NXException, RemoteException
NXException
RemoteException
void setIndependentValueShiftOption(boolean shiftOption) throws NXException, RemoteException
shiftOption
- the interpolation shift flag for independent valueNXException
RemoteException
double independentValueShift() throws NXException, RemoteException
NXException
RemoteException
void setIndependentValueShift(double shift) throws NXException, RemoteException
shift
- the interpolation shift for independent valueNXException
RemoteException
boolean independentValueDivisorOption() throws NXException, RemoteException
NXException
RemoteException
void setIndependentValueDivisorOption(boolean divisorOption) throws NXException, RemoteException
divisorOption
- the interpolation divisor flag for independent valueNXException
RemoteException
double independentValueDivisor() throws NXException, RemoteException
NXException
RemoteException
void setIndependentValueDivisor(double divisor) throws NXException, RemoteException
divisor
- the interpolation divisor for independent valueNXException
RemoteException
boolean discontinuities() throws NXException, RemoteException
NXException
RemoteException
FieldEvaluator.LinearLogOptionEnum linearLogOption() throws NXException, RemoteException
NXException
RemoteException
void setLinearLogOption(FieldEvaluator.LinearLogOptionEnum linearOption) throws NXException, RemoteException
linearOption
- the log optionNXException
RemoteException
boolean latticeDataOption() throws NXException, RemoteException
NXException
RemoteException
void setLatticeDataOption(boolean latticeDataOption) throws NXException, RemoteException
latticeDataOption
- the lattice data check optionNXException
RemoteException
int numLatticeDataColumn() throws NXException, RemoteException
NXException
RemoteException
void setNumLatticeDataColumn(int numLatticeDataColumn) throws NXException, RemoteException
numLatticeDataColumn
- the lattice data column numberNXException
RemoteException
void editTableVariables(FieldVariable[] indepVarArray, FieldVariable[] depExpArray) throws NXException, RemoteException
FieldVariable
array. If retain number of rows is specified, the total number of rows will remain the same. Columns with zeros will be added
as necessary, or data will be truncated. This process will be handled for each set of variables, independent and dependent.
Thus, if the number of independent columns increases and the dependent columns decrease, a column of zeros will be added for the
new independent variable, and data will be dropped from the dependent values.
indepVarArray
- independent variables to be associated with the fielddepExpArray
- dependent field variables to be associated with the fieldNXException
RemoteException
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.