public interface Field extends DisplayableObject
FieldVariable
) based on relationships
to one or more independent domains/variables (time, temperature, etc.). DisplayableObject.ObjectFont, DisplayableObject.ObjectWidth
NXObject.AttributeInformation, NXObject.AttributeType, NXObject.ComputationalTime, NXObject.DateAndTimeFormat, NXObject.NextUserAttributeData
Modifier and Type | Method and Description |
---|---|
void |
addApplicationData(IApplicationData applicationData)
Adds the specified application data object to the field
NOTE: Only one application data object per IApplication can be added
and the data must be owned by an IApplication with the same Part::Field::Main
as the field.
|
void |
copyAsTableToPart(BasePart targetPart)
Deprecated.
Deprecated in NX6.0.1. Use
createTableInPart(nxopen.BasePart) instead.
|
void |
copyToPart(BasePart targetPart)
Deprecated.
Deprecated in NX6.0.1. Use
createCopyInPart(nxopen.BasePart) instead.
|
Field |
createCopyInPart(BasePart targetPart)
Copy the field to the target part.
|
FieldDrawHelper |
createDrawHelper()
Creates a field drawhelper which can be used to get display attributes of this field.
|
FieldTable |
createTableInPart(BasePart targetPart)
Create a new table field from this field (regardless of type).
|
void |
delete()
Delete this field; destroys the field and removes all references to it.
|
IApplicationData |
getApplicationData(String applicationName)
Retrieves the application data associated with the field for the specified application.
|
FieldVariable[] |
getDependentVariables()
Returns the dependent variables for this
Field
License requirements: None. |
String[] |
getDescription()
Returns the description of the field.
|
FieldDrawHelper |
getFieldDrawhelper()
Returns a field drawhelper which can be used to get display attributes of this field.
|
FieldEvaluator |
getFieldEvaluator()
Returns a field evaluator which can be used to evaluate this field.
|
int |
getIdLabel()
Returns the ID/Label of the field.
|
FieldVariable[] |
getIndependentVariables()
Returns the independent variables for this
Field
License requirements: None. |
SpatialMap |
getSpatialMap()
Returns the spatial map for the formula field if one exists.
|
boolean |
isLocked()
Returns a value that indicates whether this field is locked against edits.
|
boolean |
isUserField()
Returns a value that indicates whether this field is a user created/managed field.
|
void |
rename(String newName)
Update the name of the field.
|
void |
setDescription(String[] lines)
Update the description of the field.
|
void |
setIdLabel(int idLabel)
Update the ID/Label of the field.
|
void |
setPartContext()
Set part context.
|
void |
setSpatialMap(SpatialMap overrideMap)
Set the spatial map for the formula field.
|
void |
xygraph(FieldVariable indepVar,
double abscissaMinimum,
double abscissaMaximum,
int abscissaPointCount,
FieldVariable[] constantIndepVarArray,
double[] constantIndepVarValueArray)
Creates displayed graphs of the Field's specified independent variable
versus all the Field's dependent variables
License requirements: None. |
void |
xygraph(FieldVariable indepVar,
double abscissaMinimum,
double abscissaMaximum,
int abscissaPointCount,
FieldVariable[] constantIndepVarArray,
double[] constantIndepVarValueArray,
int viewIndex,
boolean overlay)
Plots or overlays graphs of the Field's specified independent variable
versus all the Field's dependent variables
License requirements: None. |
void |
xygraph(FieldVariable indepVar,
double abscissaMinimum,
double abscissaMaximum,
int abscissaPointCount,
FieldVariable[] constantIndepVarArray,
double[] constantIndepVarValueArray,
int windowDevice,
int viewIndex,
boolean overlay)
Plots or overlays graphs of the Field's specified independent variable
versus all the Field's dependent variables
License requirements: None. |
Plot |
xygraph3DScaleAndReturnPlots(FieldVariable xAxisIndepVar,
double xAxisBndsMinimum,
double xAxisBndsMaximum,
int xAxisBndsSampleSize,
FieldVariable zAxisIndepVar,
double zAxisBndsMinimum,
double zAxisBndsMaximum,
int zAxisBndsSampleSize,
FieldVariable yAxisDepVar,
FieldVariable[] constantIndepVarArray,
double[] constantIndepVarValueArray,
boolean interpolateTableData,
int windowDevice,
int viewIndex,
boolean overlay,
double scaleFactor)
Plots or overlays graphs of the Field's specified x-axis and z-axis independent variables
versus the Field's specified y-axis dependent variable ; returns newly created plot object.
|
Plot[] |
xygraphAndReturnPlots(FieldVariable indepVar,
double abscissaMinimum,
double abscissaMaximum,
int abscissaPointCount,
FieldVariable[] constantIndepVarArray,
double[] constantIndepVarValueArray,
int windowDevice,
int viewIndex,
boolean overlay)
Plots or overlays graphs of the Field's specified independent variable
versus all the Field's dependent variables; returns newly created plot object(s).
|
Plot[] |
xygraphArgand(FieldVariable indepVar,
double abscissaMinimum,
double abscissaMaximum,
int abscissaPointCount,
FieldVariable[] constantIndepVarArray,
double[] constantIndepVarValueArray,
int windowDevice,
int viewIndex)
Plots the Field's specified independent variable
versus all the Field's scaled dependent variables as an Argand graph; returns newly created plot object(s).
|
Plot[] |
xygraphScaleAndReturnPlots(FieldVariable indepVar,
double abscissaMinimum,
double abscissaMaximum,
int abscissaPointCount,
FieldVariable[] constantIndepVarArray,
double[] constantIndepVarValueArray,
int windowDevice,
int viewIndex,
boolean overlay,
double scaleFactor)
Plots or overlays graphs of the Field's specified independent variable
versus all the Field's scaled dependent variables; returns newly created plot object(s).
|
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
FieldEvaluator getFieldEvaluator() throws NXException, RemoteException
NXException
RemoteException
FieldDrawHelper getFieldDrawhelper() throws NXException, RemoteException
NXException
RemoteException
void setPartContext() throws NXException, RemoteException
NXException
RemoteException
FieldDrawHelper createDrawHelper() throws NXException, RemoteException
NXException
RemoteException
void copyToPart(BasePart targetPart) throws NXException, RemoteException
createCopyInPart(nxopen.BasePart)
instead.
targetPart
- target part
NXException
RemoteException
Field createCopyInPart(BasePart targetPart) throws NXException, RemoteException
targetPart
- target partNXException
RemoteException
void copyAsTableToPart(BasePart targetPart) throws NXException, RemoteException
createTableInPart(nxopen.BasePart)
instead.
targetPart
- target part
NXException
RemoteException
FieldTable createTableInPart(BasePart targetPart) throws NXException, RemoteException
targetPart
- target partNXException
RemoteException
void rename(String newName) throws NXException, RemoteException
newName
- new field nameNXException
RemoteException
void setSpatialMap(SpatialMap overrideMap) throws NXException, RemoteException
overrideMap
- spatial map to setNXException
RemoteException
SpatialMap getSpatialMap() throws NXException, RemoteException
NXException
RemoteException
void delete() throws NXException, RemoteException
NXException
RemoteException
void xygraph(FieldVariable indepVar, double abscissaMinimum, double abscissaMaximum, int abscissaPointCount, FieldVariable[] constantIndepVarArray, double[] constantIndepVarValueArray) throws NXException, RemoteException
indepVar
- the specified independent variable for which to create the graphabscissaMinimum
- the minimum bounds along the abscissaabscissaMaximum
- the maximum bounds along the abscissaabscissaPointCount
- the number of points to graph along the abscissa.
the number of times to evaluate the graphed independent variableconstantIndepVarArray
- independent variables to hold constant
If the field has only 1 independent variable, this parameter is NULLconstantIndepVarValueArray
- independent variables constant values
If the field has only 1 independent variable, this parameter is NULLNXException
RemoteException
void xygraph(FieldVariable indepVar, double abscissaMinimum, double abscissaMaximum, int abscissaPointCount, FieldVariable[] constantIndepVarArray, double[] constantIndepVarValueArray, int viewIndex, boolean overlay) throws NXException, RemoteException
indepVar
- the specified independent variable for which to create the graphabscissaMinimum
- the minimum bounds along the abscissaabscissaMaximum
- the maximum bounds along the abscissaabscissaPointCount
- the number of points to graph along the abscissa.
the number of times to evaluate the graphed independent variableconstantIndepVarArray
- independent variables to hold constant
If the field has only 1 independent variable, this parameter is NULLconstantIndepVarValueArray
- independent variables constant values
If the field has only 1 independent variable, this parameter is NULLviewIndex
- 0 thru 8, viewport number to place the graph inoverlay
- create a new plot or add to existingNXException
RemoteException
void xygraph(FieldVariable indepVar, double abscissaMinimum, double abscissaMaximum, int abscissaPointCount, FieldVariable[] constantIndepVarArray, double[] constantIndepVarValueArray, int windowDevice, int viewIndex, boolean overlay) throws NXException, RemoteException
indepVar
- the specified independent variable for which to create the graphabscissaMinimum
- the minimum bounds along the abscissaabscissaMaximum
- the maximum bounds along the abscissaabscissaPointCount
- the number of points to graph along the abscissa.
the number of times to evaluate the graphed independent variableconstantIndepVarArray
- independent variables to hold constant
If the field has only 1 independent variable, this parameter is NULLconstantIndepVarValueArray
- independent variables constant values
If the field has only 1 independent variable, this parameter is NULLwindowDevice
- great than 0. the index of display device to show the graph. 1 represents main graphic windowviewIndex
- 0 thru 8, viewport number to place the graph inoverlay
- create a new plot or add to existingNXException
RemoteException
Plot[] xygraphAndReturnPlots(FieldVariable indepVar, double abscissaMinimum, double abscissaMaximum, int abscissaPointCount, FieldVariable[] constantIndepVarArray, double[] constantIndepVarValueArray, int windowDevice, int viewIndex, boolean overlay) throws NXException, RemoteException
indepVar
- the specified independent variable for which to create the graphabscissaMinimum
- the minimum bounds along the abscissaabscissaMaximum
- the maximum bounds along the abscissaabscissaPointCount
- the number of points to graph along the abscissa.
the number of times to evaluate the graphed independent variableconstantIndepVarArray
- independent variables to hold constant
If the field has only 1 independent variable, this parameter is NULLconstantIndepVarValueArray
- independent variables constant values
If the field has only 1 independent variable, this parameter is NULLwindowDevice
- great than 0. the index of display device to show the graph. 1 represents main graphic windowviewIndex
- 0 thru 8, viewport number to place the graph inoverlay
- create a new plot or add to existingNXException
RemoteException
Plot[] xygraphScaleAndReturnPlots(FieldVariable indepVar, double abscissaMinimum, double abscissaMaximum, int abscissaPointCount, FieldVariable[] constantIndepVarArray, double[] constantIndepVarValueArray, int windowDevice, int viewIndex, boolean overlay, double scaleFactor) throws NXException, RemoteException
indepVar
- the specified independent variable for which to create the graphabscissaMinimum
- the minimum bounds along the abscissaabscissaMaximum
- the maximum bounds along the abscissaabscissaPointCount
- the number of points to graph along the abscissa.
the number of times to evaluate the graphed independent variableconstantIndepVarArray
- independent variables to hold constant
If the field has only 1 independent variable, this parameter is NULLconstantIndepVarValueArray
- independent variables constant values
If the field has only 1 independent variable, this parameter is NULLwindowDevice
- great than 0. the index of display device to show the graph. 1 represents main graphic windowviewIndex
- 0 thru 8, viewport number to place the graph inoverlay
- create a new plot or add to existingscaleFactor
- scale dependent variable(s)NXException
RemoteException
Plot[] xygraphArgand(FieldVariable indepVar, double abscissaMinimum, double abscissaMaximum, int abscissaPointCount, FieldVariable[] constantIndepVarArray, double[] constantIndepVarValueArray, int windowDevice, int viewIndex) throws NXException, RemoteException
indepVar
- the specified independent variable for which to create the graphabscissaMinimum
- the minimum bounds along the abscissaabscissaMaximum
- the maximum bounds along the abscissaabscissaPointCount
- the number of points to graph along the abscissa.
the number of times to evaluate the graphed independent variableconstantIndepVarArray
- independent variables to hold constant
If the field has only 1 independent variable, this parameter is NULLconstantIndepVarValueArray
- independent variables constant values
If the field has only 1 independent variable, this parameter is NULLwindowDevice
- great than 0. the index of display device to show the graph. 1 represents main graphic windowviewIndex
- 0 thru 8, viewport number to place the graph inNXException
RemoteException
void setDescription(String[] lines) throws NXException, RemoteException
lines
- new descriptionNXException
RemoteException
String[] getDescription() throws NXException, RemoteException
NXException
RemoteException
void setIdLabel(int idLabel) throws NXException, RemoteException
idLabel
- ID/LabelNXException
RemoteException
int getIdLabel() throws NXException, RemoteException
NXException
RemoteException
boolean isUserField() throws NXException, RemoteException
NXException
RemoteException
boolean isLocked() throws NXException, RemoteException
NXException
RemoteException
FieldVariable[] getDependentVariables() throws NXException, RemoteException
FieldVariable
NXException
RemoteException
FieldVariable[] getIndependentVariables() throws NXException, RemoteException
FieldVariable
NXException
RemoteException
Plot xygraph3DScaleAndReturnPlots(FieldVariable xAxisIndepVar, double xAxisBndsMinimum, double xAxisBndsMaximum, int xAxisBndsSampleSize, FieldVariable zAxisIndepVar, double zAxisBndsMinimum, double zAxisBndsMaximum, int zAxisBndsSampleSize, FieldVariable yAxisDepVar, FieldVariable[] constantIndepVarArray, double[] constantIndepVarValueArray, boolean interpolateTableData, int windowDevice, int viewIndex, boolean overlay, double scaleFactor) throws NXException, RemoteException
xAxisIndepVar
- the specified x-axis independent variable for which to create the graphxAxisBndsMinimum
- the minimum bounds along the x-axisxAxisBndsMaximum
- the maximum bounds along the x-axisxAxisBndsSampleSize
- the sample size to graph along the x-axis.
the number of times to evaluate the x-axis independent variablezAxisIndepVar
- the specified z-Axis independent variable for which to create the graphzAxisBndsMinimum
- the minimum bounds along the z-AxiszAxisBndsMaximum
- the maximum bounds along the z-AxiszAxisBndsSampleSize
- the sample size to graph along the z-Axis.
the number of times to evaluate the z-Axis independent variableyAxisDepVar
- the specified y-Axis dependent variable for which to create the graphconstantIndepVarArray
- independent variables to hold constant
If the field has only 2 independent variables, this parameter is NULLconstantIndepVarValueArray
- independent variables constant values
If the field has only 2 independent variables, this parameter is NULLinterpolateTableData
- a true value means that the table field data will be interpolated if there are more than 2 independent variables.
a false value means that the data is plotted directly from the table and the constant values will be ignored.
this value is only used for table fields with over 2 independent variables.windowDevice
- greater than 0. the index of display device to show the graph. 1 represents main graphic windowviewIndex
- 0 thru 8, viewport number to place the graph inoverlay
- create a new plot or add to existingscaleFactor
- scale dependent variableNXException
RemoteException
IApplicationData getApplicationData(String applicationName) throws NXException, RemoteException
applicationName
- NXException
RemoteException
void addApplicationData(IApplicationData applicationData) throws NXException, RemoteException
applicationData
- NXException
RemoteException
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.