public interface FieldManager extends NXObject
Field
within a part,
as well as the collection of domains FieldDomain
. NXObject.AttributeInformation, NXObject.AttributeType, NXObject.ComputationalTime, NXObject.DateAndTimeFormat
Modifier and Type | Method and Description |
---|---|
FieldVariable |
createDependentVariable(Field ownerField,
NameVariable nameVariable,
Unit unitType)
Create a dependent variable to be added to the field
License requirements: None. |
DisplayPropertiesBuilder |
createDisplayPropertiesBuilder(Field[] fieldArray)
Creates a
DisplayPropertiesBuilder
License requirements: None. |
ExportData |
createExportData()
Creates a Fields.ExportData
License requirements: None. |
FieldExpression |
createFieldExpression(String fieldExpString,
Unit unitType)
Creates a system
FieldExpression object. |
FieldExpression |
createFieldExpression(String fieldExpString,
Unit unitType,
FieldVariable[] indepVarArray)
Deprecated.
Deprecated in NX10.0.0. Field expressions are owned by other objects. They are managed by the creation and editing of the owning object and should not be created independently.
|
FieldFormula |
createFieldFormula(String fieldName,
FieldVariable[] indepVarArray,
FieldExpression[] depExpArray)
Creates a
FieldFormula object with dependent FieldExpression . |
FieldLink |
createFieldLink(String fieldName,
Field fieldToLink)
Creates a
FieldLink . |
FieldLinksTable |
createFieldLinksTable(String fieldName,
FieldVariable[] indepVarArray,
FieldVariable[] depVarArray,
double[] datapoints,
Field[] linkFieldsArray)
Creates a
nxopen.fields.FieldLinksTable object with dependent and independent variables
FieldVariable . |
FieldTable |
createFieldTable(String fieldName,
FieldVariable[] indepVarArray,
FieldVariable[] depVarArray,
double[] datapoints)
Creates a
nxopen.fields.FieldTable object with dependent and independent variables
FieldVariable . |
FieldTable |
createFieldTableFromData(String fieldNamePrefix,
Unit ivarUnit,
Unit dvarUnit,
FieldVariable.ValueType dvarType,
double[] datapoints)
Creates a
nxopen.fields.FieldTable object with dependent and independent variables
FieldVariable . |
FieldWrapper |
createFieldWrapper(Field field)
Create a field wrapper backed up by a field
License requirements: None. |
ImportData |
createImportData()
Creates a Fields.ImportData
License requirements: None. |
FieldVariable |
createIndependentVariable(Field ownerField,
NameVariable nameVariable,
Unit unitType,
boolean minValueSet,
boolean minValueInclusive,
double minValue,
boolean maxValueSet,
boolean maxValueInclusive,
double maxValue,
boolean numPtsSet,
int numPts,
boolean defaultValueSet,
double defaultValue)
Create an independent variable to be added to the field
License requirements: None. |
PathObjects |
createPathObjects()
Creates a
PathObjects
License requirements: None. |
ScalarFieldWrapper |
createScalarFieldWrapperWithExpression(Expression expression)
Create a field wrapper backed by a scalar expression
License requirements: None. |
ScalarFieldWrapper |
createScalarFieldWrapperWithField(Field field,
double scaleFactor)
Create a scalar field wrapper backed up by a scaled scalar field
License requirements: None. |
SpatialMapBuilder |
createSpatialMapBuilder(SpatialMap spatialmap)
Creates a
SpatialMapBuilder
License requirements: None. |
FieldExpression |
createSubFieldExpression(FieldVariable depVar)
Creates a system
FieldExpression object with independent variables. |
VectorFieldWrapper |
createVectorFieldWrapperWithExpressions(Expression[] expressions)
Create a vector field wrapper backed by three scalar expressions
License requirements: None. |
VectorFieldWrapper |
createVectorFieldWrapperWithField(Field field,
double[] scaleFactors)
Create a vector field wrapper backed up by a scaled vector field
License requirements: None. |
Field |
deleteField(Field field)
Deletes the specified
Field object; if the object cannot be deleted
it is returned. |
FieldDomainCollection |
domains()
Returns a collection of Units .
|
void |
editDependentVariable(FieldVariable depVar,
String varName,
Unit unitType)
Edit dependent variable
License requirements: None. |
void |
editIndependentVariable(FieldVariable indepVar,
String varName,
Unit unitType,
boolean minValueSet,
boolean minValueInclusive,
double minValue,
boolean maxValueSet,
boolean maxValueInclusive,
double maxValue,
boolean numPtsSet,
int numPts,
boolean defaultValueSet,
double defaultValue)
Edit an independent variable
License requirements: None. |
void |
exportFields(ExportData exportData)
Exports fields to a text file as defined by export_data parameter
License requirements: None. |
NameVariable |
getNameVariable(String variableName,
String measureName)
Locate an existing, or create a new
NameVariable object
License requirements: None. |
int |
getValidFieldId()
Get the next available ID for
Field object
License requirements: None. |
void |
importFields(ImportData importData)
Imports fields from a text file as defined by import_data parameter
License requirements: None. |
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
FieldDomainCollection domains() throws RemoteException
RemoteException
FieldExpression createFieldExpression(String fieldExpString, Unit unitType) throws NXException, RemoteException
FieldExpression
object. Specifies the new expression
string.
fieldExpString
- expression string to be associated with the field unitType
- unit of the fieldNXException
RemoteException
FieldExpression createFieldExpression(String fieldExpString, Unit unitType, FieldVariable[] indepVarArray) throws NXException, RemoteException
FieldExpression
object with independent variables.
Specifies the new expression string.
FieldFormula
and should not be created independently. fieldExpString
- expression string to be associated with the field unitType
- unit of the fieldindepVarArray
- independent variables to be associated with the fieldNXException
RemoteException
FieldExpression createSubFieldExpression(FieldVariable depVar) throws NXException, RemoteException
FieldExpression
object with independent variables.
Specifies the new expression string.
FieldFormula
. depVar
- dependent variables to be associated with the fieldNXException
RemoteException
FieldFormula createFieldFormula(String fieldName, FieldVariable[] indepVarArray, FieldExpression[] depExpArray) throws NXException, RemoteException
FieldFormula
object with dependent FieldExpression
.
fieldName
- field name indepVarArray
- independent variables to be associated with the fielddepExpArray
- dependent expression fields to be associated with the formula fieldNXException
RemoteException
FieldTable createFieldTable(String fieldName, FieldVariable[] indepVarArray, FieldVariable[] depVarArray, double[] datapoints) throws NXException, RemoteException
nxopen.fields.FieldTable
object with dependent and independent variables
FieldVariable
.
fieldName
- field name indepVarArray
- independent variables to be associated with the table fielddepVarArray
- dependent variables to be associated with the table 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
FieldTable createFieldTableFromData(String fieldNamePrefix, Unit ivarUnit, Unit dvarUnit, FieldVariable.ValueType dvarType, double[] datapoints) throws NXException, RemoteException
nxopen.fields.FieldTable
object with dependent and independent variables
FieldVariable
. This will create a 2 dimensional table, with the option to specify
the value type for the dependent variable.
fieldNamePrefix
- field name prefix; e.g. "AFU Record"; field will have a unique generated name begining with this string ivarUnit
- unit of the independent variabledvarUnit
- unit of the dependent variabledvarType
- dependent variable type (real/imaginary/complex...)datapoints
- 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
FieldLink createFieldLink(String fieldName, Field fieldToLink) throws NXException, RemoteException
fieldName
- field name fieldToLink
- field to linkNXException
RemoteException
Field deleteField(Field field) throws NXException, RemoteException
Field
object; if the object cannot be deleted
it is returned.
field
- field to deleteNXException
RemoteException
FieldVariable createIndependentVariable(Field ownerField, NameVariable nameVariable, Unit unitType, boolean minValueSet, boolean minValueInclusive, double minValue, boolean maxValueSet, boolean maxValueInclusive, double maxValue, boolean numPtsSet, int numPts, boolean defaultValueSet, double defaultValue) throws NXException, RemoteException
ownerField
- owner fieldnameVariable
- existing name variableunitType
- unit of the independent variableminValueSet
- logical value whether minimum value setminValueInclusive
- minimum value is itself included in rangeminValue
- minimum value of the variable rangemaxValueSet
- logical value whether maximum value setmaxValueInclusive
- maximum value is itself included in rangemaxValue
- maximum value of the variable rangenumPtsSet
- logical value whether num_pts setnumPts
- num_pts of the variable rangedefaultValueSet
- logical value whether default value setdefaultValue
- default value of the variable rangeNXException
RemoteException
void editIndependentVariable(FieldVariable indepVar, String varName, Unit unitType, boolean minValueSet, boolean minValueInclusive, double minValue, boolean maxValueSet, boolean maxValueInclusive, double maxValue, boolean numPtsSet, int numPts, boolean defaultValueSet, double defaultValue) throws NXException, RemoteException
indepVar
- indep var to editvarName
- name of the independent variable to be created unitType
- unit of the independent variableminValueSet
- logical value whether minimum value setminValueInclusive
- minimum value is itself included in rangeminValue
- minimum value of the variable rangemaxValueSet
- logical value whether maximum value setmaxValueInclusive
- maximum value is itself included in rangemaxValue
- maximum value of the variable rangenumPtsSet
- logical value whether num_pts setnumPts
- num_pts of the variable rangedefaultValueSet
- logical value whether default value setdefaultValue
- default value of the variable rangeNXException
RemoteException
FieldVariable createDependentVariable(Field ownerField, NameVariable nameVariable, Unit unitType) throws NXException, RemoteException
ownerField
- owner fieldnameVariable
- existing name variableunitType
- unit of the dependent variableNXException
RemoteException
void editDependentVariable(FieldVariable depVar, String varName, Unit unitType) throws NXException, RemoteException
depVar
- dep variable to editvarName
- new name for variable, or NULL to skip updating name unitType
- new unit of the dependent variableNXException
RemoteException
FieldWrapper createFieldWrapper(Field field) throws NXException, RemoteException
field
- an existing field that will be this wrapper's valueNXException
RemoteException
ScalarFieldWrapper createScalarFieldWrapperWithExpression(Expression expression) throws NXException, RemoteException
expression
- an existing expression that will be this wrapper's valueNXException
RemoteException
ScalarFieldWrapper createScalarFieldWrapperWithField(Field field, double scaleFactor) throws NXException, RemoteException
field
- an existing field that will be this wrapper's valuescaleFactor
- the field will be multiplied by this scale factor when being evaluatedNXException
RemoteException
VectorFieldWrapper createVectorFieldWrapperWithExpressions(Expression[] expressions) throws NXException, RemoteException
expressions
- existing expressions that will be this wrapper's valueNXException
RemoteException
VectorFieldWrapper createVectorFieldWrapperWithField(Field field, double[] scaleFactors) throws NXException, RemoteException
field
- an existing field that will be this wrapper's valuescaleFactors
- the field will be multiplied by this scale factor when being evaluatedNXException
RemoteException
DisplayPropertiesBuilder createDisplayPropertiesBuilder(Field[] fieldArray) throws NXException, RemoteException
fieldArray
- fields to edit display propertiesNXException
RemoteException
SpatialMapBuilder createSpatialMapBuilder(SpatialMap spatialmap) throws NXException, RemoteException
spatialmap
- Existing SpatialMap to edit; NULL to createNXException
RemoteException
ExportData createExportData() throws NXException, RemoteException
NXException
RemoteException
void exportFields(ExportData exportData) throws NXException, RemoteException
exportData
- Export dataNXException
RemoteException
ImportData createImportData() throws NXException, RemoteException
NXException
RemoteException
void importFields(ImportData importData) throws NXException, RemoteException
importData
- Import dataNXException
RemoteException
PathObjects createPathObjects() throws NXException, RemoteException
NXException
RemoteException
NameVariable getNameVariable(String variableName, String measureName) throws NXException, RemoteException
NameVariable
object
variableName
- alphanumeric string; if it matches an existing name variable, the measures must also match measureName
- must match an existing measure name, or "Unitless" NXException
RemoteException
int getValidFieldId() throws NXException, RemoteException
NXException
RemoteException
FieldLinksTable createFieldLinksTable(String fieldName, FieldVariable[] indepVarArray, FieldVariable[] depVarArray, double[] datapoints, Field[] linkFieldsArray) throws NXException, RemoteException
nxopen.fields.FieldLinksTable
object with dependent and independent variables
FieldVariable
.
fieldName
- field name indepVarArray
- independent variables to be associated with the fielddepVarArray
- dependent variables of this and all linked fieldsdatapoints
- row based array of double values representing the first independent variable; the number of points should equal the number of rows.linkFieldsArray
- row based array of link field values representing the table; the number of fields should equal the number of rows.NXException
RemoteException
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.