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
Modifier and Type | Method and Description |
---|---|
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.
|
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.
|
FieldVariable[] |
getDependentVariables()
Returns the dependent variables for this
Field
License requirements: None. |
String[] |
getDescription()
Returns the description of the 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 |
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[] |
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[] |
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
deleteAllAttributesByType, deleteAllAttributesByType, deleteAttributeByTypeAndTitle, deleteAttributeByTypeAndTitle, deleteUserAttribute, deleteUserAttributes, getAttributeTitlesByType, getBooleanUserAttribute, getComputationalTimeUserAttribute, getIntegerAttribute, getIntegerUserAttribute, getRealAttribute, getRealUserAttribute, getReferenceAttribute, getStringAttribute, getStringUserAttribute, getTimeAttribute, getTimeUserAttribute, getUserAttribute, getUserAttribute, getUserAttributeAsString, getUserAttributeCount, getUserAttributeCount, getUserAttributeLock, getUserAttributes, getUserAttributes, getUserAttributes, getUserAttributesAsStrings, getUserAttributeSize, getUserAttributeSourceObjects, hasUserAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setBooleanUserAttribute, 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
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 name NXException
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
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
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.