NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Member Functions | Properties | List of all members
NXOpen.Fields.Field Class Reference

Represents an Field abstract class. More...

Inheritance diagram for NXOpen.Fields.Field:
NXOpen.DisplayableObject NXOpen.NXObject NXOpen.IFitTo NXOpen.TaggedObject NXOpen.INXObject NXOpen.INXObject NXOpen.Utilities.NXRemotableObject IMessageSink NXOpen.CAE.NodalForceReport NXOpen.CAE.ResultProbe NXOpen.Fields.FieldExpression NXOpen.Fields.FieldFormula NXOpen.Fields.FieldLink NXOpen.Fields.FieldLinksTable NXOpen.Fields.FieldReference NXOpen.Fields.FieldTable

Public Member Functions

unsafe void AddApplicationData (NXOpen.Fields.IApplicationData applicationData)
 Adds the specified application data object to the field More...
 
unsafe NXOpen.Fields.Field CreateCopyInPart (NXOpen.BasePart targetPart)
 Copy the field to the target part. More...
 
unsafe
NXOpen.Fields.FieldDrawHelper 
CreateDrawHelper ()
 Creates a field drawhelper which can be used to get display attributes of this field. More...
 
unsafe NXOpen.Fields.FieldTable CreateTableInPart (NXOpen.BasePart targetPart)
 Create a new table field from this field (regardless of type). More...
 
unsafe void Delete ()
 Delete this field; destroys the field and removes all references to it. More...
 
unsafe
NXOpen.Fields.IApplicationData 
GetApplicationData (string applicationName)
 Retrieves the application data associated with the field for the specified application. More...
 
unsafe
NXOpen.Fields.FieldVariable[] 
GetDependentVariables ()
 Returns the dependent variables for this NXOpen.Fields.Field More...
 
unsafe string[] GetDescription ()
 Returns the description of the field. More...
 
unsafe
NXOpen.Fields.FieldDrawHelper 
GetFieldDrawhelper ()
 Returns a field drawhelper which can be used to get display attributes of this field. More...
 
unsafe NXOpen.Fields.FieldEvaluator GetFieldEvaluator ()
 Returns a field evaluator which can be used to evaluate this field. More...
 
unsafe int GetIdLabel ()
 Returns the ID/Label of the field. More...
 
unsafe
NXOpen.Fields.FieldVariable[] 
GetIndependentVariables ()
 Returns the independent variables for this NXOpen.Fields.Field More...
 
unsafe NXOpen.Fields.SpatialMap GetSpatialMap ()
 Returns the spatial map for the formula field if one exists. More...
 
unsafe void Reload ()
 Reloads the field from its data source. More...
 
unsafe void Rename (string newName)
 Update the name of the field. More...
 
unsafe void SetDescription (string[] lines)
 Update the description of the field. More...
 
unsafe void SetIdLabel (int idLabel)
 Update the ID/Label of the field. More...
 
unsafe void SetPartContext ()
 Set part context. More...
 
unsafe void SetSpatialMap (NXOpen.Fields.SpatialMap overrideMap)
 Set the spatial map for the formula field. More...
 
unsafe void XYGraph (NXOpen.Fields.FieldVariable indepVar, double abscissaMinimum, double abscissaMaximum, int abscissaPointCount, NXOpen.Fields.FieldVariable[] constantIndepVarArray, double[] constantIndepVarValueArray)
 Creates displayed graphs of the Field's specified independent variable versus all the Field's dependent variables More...
 
unsafe void XYGraph (NXOpen.Fields.FieldVariable indepVar, double abscissaMinimum, double abscissaMaximum, int abscissaPointCount, NXOpen.Fields.FieldVariable[] constantIndepVarArray, double[] constantIndepVarValueArray, int viewIndex, bool overlay)
 Plots or overlays graphs of the Field's specified independent variable versus all the Field's dependent variables More...
 
unsafe void XYGraph (NXOpen.Fields.FieldVariable indepVar, double abscissaMinimum, double abscissaMaximum, int abscissaPointCount, NXOpen.Fields.FieldVariable[] constantIndepVarArray, double[] constantIndepVarValueArray, int windowDevice, int viewIndex, bool overlay)
 Plots or overlays graphs of the Field's specified independent variable versus all the Field's dependent variables More...
 
unsafe void XYGraph (NXOpen.Fields.FieldVariable indepVar, double abscissaMinimum, double abscissaMaximum, int abscissaPointCount, NXOpen.Fields.FieldVariable[] constantIndepVarArray, double[] constantIndepVarValueArray, int windowDevice, int viewIndex, bool overlay, out NXOpen.CAE.Xyplot.Plot[] plots)
 Plots or overlays graphs of the Field's specified independent variable versus all the Field's dependent variables; returns newly created plot object(s). More...
 
unsafe void XYGraph (NXOpen.Fields.FieldVariable indepVar, double abscissaMinimum, double abscissaMaximum, int abscissaPointCount, NXOpen.Fields.FieldVariable[] constantIndepVarArray, double[] constantIndepVarValueArray, int windowDevice, int viewIndex, bool overlay, double scaleFactor, out NXOpen.CAE.Xyplot.Plot[] plots)
 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). More...
 
unsafe NXOpen.CAE.Xyplot.Plot XYGraph3D (NXOpen.Fields.FieldVariable xAxisIndepVar, double xAxisBndsMinimum, double xAxisBndsMaximum, int xAxisBndsSampleSize, NXOpen.Fields.FieldVariable zAxisIndepVar, double zAxisBndsMinimum, double zAxisBndsMaximum, int zAxisBndsSampleSize, NXOpen.Fields.FieldVariable yAxisDepVar, NXOpen.Fields.FieldVariable[] constantIndepVarArray, double[] constantIndepVarValueArray, bool interpolateTableData, int windowDevice, int viewIndex, bool 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. More...
 
unsafe void XYGraphArgand (NXOpen.Fields.FieldVariable indepVar, double abscissaMinimum, double abscissaMaximum, int abscissaPointCount, NXOpen.Fields.FieldVariable[] constantIndepVarArray, double[] constantIndepVarValueArray, int windowDevice, int viewIndex, out NXOpen.CAE.Xyplot.Plot[] plots)
 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). More...
 
- Public Member Functions inherited from NXOpen.DisplayableObject
unsafe void Blank ()
 Blanks the object. More...
 
unsafe void Highlight ()
 Highlights the object. More...
 
unsafe void RedisplayObject ()
 Redisplays the object in all views. More...
 
unsafe void RemoveViewDependency ()
 Remove dependency on all views from an object. More...
 
unsafe void SetNameLocation (NXOpen.Point3d location)
 Sets the location of the object's name. More...
 
unsafe void Unblank ()
 Unblanks the object. More...
 
unsafe void Unhighlight ()
 Unhighlights the object. More...
 
- Public Member Functions inherited from NXOpen.NXObject
unsafe NXOpen.AttributeIterator CreateAttributeIterator ()
 Create an attribute iterator More...
 
unsafe void DeleteAllAttributesByType (NXOpen.NXObject.AttributeType type)
 Deletes all attributes of a specific type. More...
 
unsafe void DeleteAllAttributesByType (NXOpen.NXObject.AttributeType type, NXOpen.Update.Option option)
 Deletes all attributes of a specific type with the option to update or not. More...
 
unsafe void DeleteAttributeByTypeAndTitle (NXOpen.NXObject.AttributeType type, string title)
 Deletes an attribute by type and title. More...
 
unsafe void DeleteAttributeByTypeAndTitle (NXOpen.NXObject.AttributeType type, string title, NXOpen.Update.Option option)
 Deletes an attribute by type and title with the option to update or not. More...
 
unsafe void DeleteUserAttribute (NXOpen.NXObject.AttributeType type, string title, bool deleteEntireArray, NXOpen.Update.Option option)
 Deletes the first attribute encountered with the given Type, Title. More...
 
unsafe void DeleteUserAttributes (NXOpen.AttributeIterator iterator, NXOpen.Update.Option option)
 Deletes the attributes on the object, if any, that satisfy the given iterator More...
 
unsafe void DeleteUserAttributes (NXOpen.NXObject.AttributeType type, NXOpen.Update.Option option)
 Deletes the attributes encountered with the given Type with option to update or not. More...
 
unsafe NXOpen.INXObject FindObject (string journalIdentifier)
 Finds the NXOpen.NXObject with the given identifier as recorded in a journal. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetAttributeTitlesByType (NXOpen.NXObject.AttributeType type)
 Gets all the attribute titles of a specific type. More...
 
unsafe bool GetBooleanUserAttribute (string title, int index)
 Gets a boolean attribute by Title and array Index. More...
 
unsafe
NXOpen.NXObject.ComputationalTime 
GetComputationalTimeUserAttribute (string title, int index)
 Gets a time attribute by Title and array Index. More...
 
unsafe int GetIntegerAttribute (string title)
 Gets an integer attribute by title. More...
 
unsafe int GetIntegerUserAttribute (string title, int index)
 Gets an integer attribute by Title and array Index. More...
 
unsafe bool GetNextUserAttribute (NXOpen.AttributeIterator iterator, out NXOpen.NXObject.AttributeInformation info)
 Gets the next attribute encountered on the object, if any, that satisfies the given iterator. More...
 
unsafe string GetPdmReferenceAttributeValue (string attributeTitle)
 Gets the value of PDM Reference attribute for given object. More...
 
unsafe double GetRealAttribute (string title)
 Gets a real attribute by title. More...
 
unsafe double GetRealUserAttribute (string title, int index)
 Gets a real attribute by Title and array Index. More...
 
unsafe string GetReferenceAttribute (string title)
 Gets the reference string (not the calculated value) of a string attribute that uses a reference string. More...
 
unsafe string GetStringAttribute (string title)
 Gets a string attribute value by title. More...
 
unsafe string GetStringUserAttribute (string title, int index)
 Gets a string attribute by Title and array Index. More...
 
unsafe string GetTimeAttribute (NXOpen.NXObject.DateAndTimeFormat format, string title)
 Gets a time attribute by title. More...
 
unsafe string GetTimeUserAttribute (string title, int index)
 Gets a time attribute by Title and array Index. More...
 
unsafe
NXOpen.NXObject.AttributeInformation 
GetUserAttribute (string title, NXOpen.NXObject.AttributeType type, int index)
 Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttribute (string title, bool includeUnset, bool addStringValues, NXOpen.NXObject.AttributeType type)
 Gets the first attribute (or attribute array) encountered on the object, if any, with a given Title and Type. More...
 
unsafe string GetUserAttributeAsString (string title, NXOpen.NXObject.AttributeType type, int index)
 Gets the first attribute encountered on the object, if any, with a given title, type and array index. More...
 
unsafe int GetUserAttributeCount (NXOpen.AttributeIterator iterator)
 Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...
 
unsafe int GetUserAttributeCount (NXOpen.AttributeIterator iterator, bool countArrayAsOneAttribute)
 Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...
 
unsafe int GetUserAttributeCount (NXOpen.NXObject.AttributeType type)
 Gets the count of set attributes on the object, if any, of the given type. More...
 
unsafe int GetUserAttributeCount (NXOpen.NXObject.AttributeType type, bool includeUnset, bool countArrayAsOneAttribute)
 Gets the count of attributes on the object, if any, of the given type. More...
 
unsafe bool GetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type)
 Determine the lock of the given attribute. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttributes (NXOpen.AttributeIterator iterator)
 Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttributes ()
 Gets all the attributes that have been set on the given object. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttributes (bool includeUnset)
 Gets all the attributes of the given object. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttributes (bool includeUnset, bool addStringValues)
 Gets all the attributes of the given object. More...
 
unsafe string[] GetUserAttributesAsStrings ()
 Gets all the attributes that have been set on the given object. More...
 
unsafe int GetUserAttributeSize (string title, NXOpen.NXObject.AttributeType type)
 Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. More...
 
unsafe NXOpen.NXObject[] GetUserAttributeSourceObjects ()
 Returns an array of objects from which this object presents attributes. More...
 
unsafe bool HasUserAttribute (NXOpen.AttributeIterator iterator)
 Determines if an attribute exists on the object, that satisfies the given iterator More...
 
unsafe bool HasUserAttribute (string title, NXOpen.NXObject.AttributeType type, int index)
 Determines if an attribute with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. More...
 
unsafe void Print ()
 Prints a representation of this object to the system log file. More...
 
unsafe void SetAttribute (string title, int value)
 Creates or modifies an integer attribute. More...
 
unsafe void SetAttribute (string title, int value, NXOpen.Update.Option option)
 Creates or modifies an integer attribute with the option to update or not. More...
 
unsafe void SetAttribute (string title, double value)
 Creates or modifies a real attribute. More...
 
unsafe void SetAttribute (string title, double value, NXOpen.Update.Option option)
 Creates or modifies a real attribute with the option to update or not. More...
 
unsafe void SetAttribute (string title, string value)
 Creates or modifies a string attribute. More...
 
unsafe void SetAttribute (string title, string value, NXOpen.Update.Option option)
 Creates or modifies a string attribute with the option to update or not. More...
 
unsafe void SetAttribute (string title)
 Creates or modifies a null attribute which is an attribute with a title and no value. More...
 
unsafe void SetAttribute (string title, NXOpen.Update.Option option)
 Creates or modifies a null attribute with the option to update or not. More...
 
unsafe void SetBooleanUserAttribute (string title, int index, bool value, NXOpen.Update.Option option)
 Creates or modifies a boolean attribute with the option to update or not. More...
 
unsafe void SetName (string name)
 Sets the custom name of the object. More...
 
unsafe void SetPdmReferenceAttribute (string attributeTitle, string attributeValue)
 Sets the value of PDM Reference attribute on the object. More...
 
unsafe void SetReferenceAttribute (string title, string value)
 Creates or modifies a string attribute which uses a reference string. More...
 
unsafe void SetReferenceAttribute (string title, string value, NXOpen.Update.Option option)
 Creates or modifies a string attribute which uses a reference string, with the option to update or not. More...
 
unsafe void SetTimeAttribute (string title, string value)
 Creates or modifies a time attribute. More...
 
unsafe void SetTimeAttribute (string title, string value, NXOpen.Update.Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
unsafe void SetTimeUserAttribute (string title, int index, string value, NXOpen.Update.Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
unsafe void SetTimeUserAttribute (string title, int index, NXOpen.NXObject.ComputationalTime value, NXOpen.Update.Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
unsafe void SetUserAttribute (NXOpen.NXObject.AttributeInformation info, NXOpen.Update.Option option)
 Creates or modifies an attribute with the option to update or not. More...
 
unsafe void SetUserAttribute (string title, int index, int value, NXOpen.Update.Option option)
 Creates or modifies an integer attribute with the option to update or not. More...
 
unsafe void SetUserAttribute (string title, int index, double value, NXOpen.Update.Option option)
 Creates or modifies a real attribute with the option to update or not. More...
 
unsafe void SetUserAttribute (string title, int index, string value, NXOpen.Update.Option option)
 Creates or modifies a string attribute with the option to update or not. More...
 
unsafe void SetUserAttribute (string title, int index, NXOpen.Update.Option option)
 Creates or modifies a null attribute with the option to update or not. More...
 
unsafe void SetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type, bool @lock)
 Lock or unlock the given attribute. More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override string ToString ()
 Returns a String that represents the current Object. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Properties

unsafe bool IsLocked [get]
 Returns a value that indicates whether this field is locked against edits. More...
 
unsafe bool IsUserField [get]
 Returns a value that indicates whether this field is a user created/managed field. More...
 
- Properties inherited from NXOpen.DisplayableObject
unsafe int Color [get, set]
 Returns or sets the color of the object. More...
 
unsafe bool IsBlanked [get]
 Returns the blank status of this object. More...
 
unsafe int Layer [get, set]
 Returns or sets the layer that the object is in. More...
 
unsafe
NXOpen.DisplayableObject.ObjectFont 
LineFont [get, set]
 Returns or sets the line font of the object. More...
 
unsafe
NXOpen.DisplayableObject.ObjectWidth 
LineWidth [get, set]
 Returns or sets the line width of the object. More...
 
unsafe NXOpen.Point3d NameLocation [get]
 Returns the location of the object's name. More...
 
- Properties inherited from NXOpen.NXObject
unsafe bool IsOccurrence [get]
 Returns whether this object is an occurrence or not. More...
 
unsafe string JournalIdentifier [get]
 Returns the identifier that would be recorded in a journal for this object. More...
 
unsafe string Name [get]
 Returns the custom name of the object. More...
 
unsafe NXOpen.Assemblies.Component OwningComponent [get]
 Returns the owning component, if this object is an occurrence. More...
 
unsafe NXOpen.BasePart OwningPart [get]
 Returns the owning part of this object More...
 
unsafe NXOpen.INXObject Prototype [get]
 Returns the prototype of this object if it is an occurrence. More...
 
- Properties inherited from NXOpen.TaggedObject
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 
- Properties inherited from NXOpen.INXObject
bool IsOccurrence [get]
 Returns whether this object is an occurrence or not. More...
 
string JournalIdentifier [get]
 Returns the identifier that would be recorded in a journal for this object. More...
 
string Name [get]
 Returns the custom name of the object. More...
 
NXOpen.Assemblies.Component OwningComponent [get]
 Returns the owning component, if this object is an occurrence. More...
 
NXOpen.BasePart OwningPart [get]
 Returns the owning part of this object More...
 
NXOpen.INXObject Prototype [get]
 Returns the prototype of this object if it is an occurrence. More...
 

Additional Inherited Members

- Public Types inherited from NXOpen.DisplayableObject
enum  ObjectFont {
  Solid = 1, Dashed, Phantom, Centerline,
  Dotted, LongDashed, DottedDashed, Eight = 11,
  Nine, Ten, Eleven
}
 specifies the object font for objects such as lines More...
 
enum  ObjectWidth {
  Normal, Thick, Thin, One = 5,
  Two, Three, Four, Five,
  Six, Seven, Eight, Nine
}
 specifies object width for objects such as lines and text More...
 
- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

Represents an Field abstract class.

Fields represent a way of defining a function for one or more dependent domains/variables (see NXOpen.Fields.FieldVariable ) based on relationships to one or more independent domains/variables (time, temperature, etc.).

Fields are a generic, reusable concept that crosses many areas of functionality. Defined properly, they provide an extendable concept that can service both simple and complicated needs, for example, modeling elements, properties, materials, boundary conditions in CAE/FEM applications.

Created in NX4.0.0

Member Function Documentation

unsafe void NXOpen.Fields.Field.AddApplicationData ( NXOpen.Fields.IApplicationData  applicationData)
inline

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.

Created in NX12.0.0

License requirements: None.

Parameters
applicationData
unsafe NXOpen.Fields.Field NXOpen.Fields.Field.CreateCopyInPart ( NXOpen.BasePart  targetPart)
inline

Copy the field to the target part.

Created in NX6.0.1

License requirements: None.

Parameters
targetParttarget part
Returns
newly created field
unsafe NXOpen.Fields.FieldDrawHelper NXOpen.Fields.Field.CreateDrawHelper ( )
inline

Creates a field drawhelper which can be used to get display attributes of this field.

Created in NX12.0.0

License requirements: None.

Returns
Field DrawHelper
unsafe NXOpen.Fields.FieldTable NXOpen.Fields.Field.CreateTableInPart ( NXOpen.BasePart  targetPart)
inline

Create a new table field from this field (regardless of type).

Note * that the table will be created have the N number of rows, where * N is the product of the number of points for each independent variable, * resulting in a grid (or lattice). The resulting field will be in the * same part.

Created in NX6.0.1

License requirements: None.

Parameters
targetParttarget part
Returns
newly created table
unsafe void NXOpen.Fields.Field.Delete ( )
inline

Delete this field; destroys the field and removes all references to it.

Created in NX6.0.0

License requirements: None.

unsafe NXOpen.Fields.IApplicationData NXOpen.Fields.Field.GetApplicationData ( string  applicationName)
inline

Retrieves the application data associated with the field for the specified application.

Created in NX12.0.0

License requirements: None.

Parameters
applicationName
Returns
unsafe NXOpen.Fields.FieldVariable [] NXOpen.Fields.Field.GetDependentVariables ( )
inline

Returns the dependent variables for this NXOpen.Fields.Field

Created in NX7.5.2

License requirements: None.

Returns
dependent variables for this NXOpen.Fields.FieldVariable
unsafe string [] NXOpen.Fields.Field.GetDescription ( )
inline

Returns the description of the field.

Created in NX7.5.2

License requirements: None.

Returns
description
unsafe NXOpen.Fields.FieldDrawHelper NXOpen.Fields.Field.GetFieldDrawhelper ( )
inline

Returns a field drawhelper which can be used to get display attributes of this field.

Created in NX12.0.0

License requirements: None.

Returns
Field DrawHelper
unsafe NXOpen.Fields.FieldEvaluator NXOpen.Fields.Field.GetFieldEvaluator ( )
inline

Returns a field evaluator which can be used to evaluate this field.

Created in NX7.5.2

License requirements: None.

Returns
Field Evaluator
unsafe int NXOpen.Fields.Field.GetIdLabel ( )
inline

Returns the ID/Label of the field.

Created in NX9.0.0

License requirements: None.

Returns
ID/Label
unsafe NXOpen.Fields.FieldVariable [] NXOpen.Fields.Field.GetIndependentVariables ( )
inline

Returns the independent variables for this NXOpen.Fields.Field

Created in NX7.5.2

License requirements: None.

Returns
independent variables for this NXOpen.Fields.FieldVariable
unsafe NXOpen.Fields.SpatialMap NXOpen.Fields.Field.GetSpatialMap ( )
inline

Returns the spatial map for the formula field if one exists.

Created in NX7.5.2

License requirements: None.

Returns
spatial map
unsafe void NXOpen.Fields.Field.Reload ( )
inline

Reloads the field from its data source.

If the data source does not support reload functionality or if the field does not have a data source the function will do nothing.

Created in NX1847.0.0

License requirements: None.

unsafe void NXOpen.Fields.Field.Rename ( string  newName)
inline

Update the name of the field.

Created in NX6.0.0

License requirements: None.

Parameters
newNamenew field name
unsafe void NXOpen.Fields.Field.SetDescription ( string[]  lines)
inline

Update the description of the field.

Created in NX6.0.1

License requirements: None.

Parameters
linesnew description
unsafe void NXOpen.Fields.Field.SetIdLabel ( int  idLabel)
inline

Update the ID/Label of the field.

Created in NX9.0.0

License requirements: None.

Parameters
idLabelID/Label
unsafe void NXOpen.Fields.Field.SetPartContext ( )
inline

Set part context.

Created in NX12.0.0

License requirements: None.

unsafe void NXOpen.Fields.Field.SetSpatialMap ( NXOpen.Fields.SpatialMap  overrideMap)
inline

Set the spatial map for the formula field.

Created in NX6.0.0

License requirements: None.

Parameters
overrideMapspatial map to set
unsafe void NXOpen.Fields.Field.XYGraph ( NXOpen.Fields.FieldVariable  indepVar,
double  abscissaMinimum,
double  abscissaMaximum,
int  abscissaPointCount,
NXOpen.Fields.FieldVariable[]  constantIndepVarArray,
double[]  constantIndepVarValueArray 
)
inline

Creates displayed graphs of the Field's specified independent variable versus all the Field's dependent variables

Created in NX6.0.0

License requirements: None.

Parameters
indepVarthe specified independent variable for which to create the graph
abscissaMinimumthe minimum bounds along the abscissa
abscissaMaximumthe maximum bounds along the abscissa
abscissaPointCountthe number of points to graph along the abscissa. the number of times to evaluate the graphed independent variable
constantIndepVarArrayindependent variables to hold constant If the field has only 1 independent variable, this parameter is NULL
constantIndepVarValueArrayindependent variables constant values If the field has only 1 independent variable, this parameter is NULL
unsafe void NXOpen.Fields.Field.XYGraph ( NXOpen.Fields.FieldVariable  indepVar,
double  abscissaMinimum,
double  abscissaMaximum,
int  abscissaPointCount,
NXOpen.Fields.FieldVariable[]  constantIndepVarArray,
double[]  constantIndepVarValueArray,
int  viewIndex,
bool  overlay 
)
inline

Plots or overlays graphs of the Field's specified independent variable versus all the Field's dependent variables

Created in NX8.5.0

License requirements: None.

Parameters
indepVarthe specified independent variable for which to create the graph
abscissaMinimumthe minimum bounds along the abscissa
abscissaMaximumthe maximum bounds along the abscissa
abscissaPointCountthe number of points to graph along the abscissa. the number of times to evaluate the graphed independent variable
constantIndepVarArrayindependent variables to hold constant If the field has only 1 independent variable, this parameter is NULL
constantIndepVarValueArrayindependent variables constant values If the field has only 1 independent variable, this parameter is NULL
viewIndex0 thru 8, viewport number to place the graph in
overlaycreate a new plot or add to existing
unsafe void NXOpen.Fields.Field.XYGraph ( NXOpen.Fields.FieldVariable  indepVar,
double  abscissaMinimum,
double  abscissaMaximum,
int  abscissaPointCount,
NXOpen.Fields.FieldVariable[]  constantIndepVarArray,
double[]  constantIndepVarValueArray,
int  windowDevice,
int  viewIndex,
bool  overlay 
)
inline

Plots or overlays graphs of the Field's specified independent variable versus all the Field's dependent variables

Created in NX9.0.0

License requirements: None.

Parameters
indepVarthe specified independent variable for which to create the graph
abscissaMinimumthe minimum bounds along the abscissa
abscissaMaximumthe maximum bounds along the abscissa
abscissaPointCountthe number of points to graph along the abscissa. the number of times to evaluate the graphed independent variable
constantIndepVarArrayindependent variables to hold constant If the field has only 1 independent variable, this parameter is NULL
constantIndepVarValueArrayindependent variables constant values If the field has only 1 independent variable, this parameter is NULL
windowDevicegreat than 0. the index of display device to show the graph. 1 represents main graphic window
viewIndex0 thru 8, viewport number to place the graph in
overlaycreate a new plot or add to existing
unsafe void NXOpen.Fields.Field.XYGraph ( NXOpen.Fields.FieldVariable  indepVar,
double  abscissaMinimum,
double  abscissaMaximum,
int  abscissaPointCount,
NXOpen.Fields.FieldVariable[]  constantIndepVarArray,
double[]  constantIndepVarValueArray,
int  windowDevice,
int  viewIndex,
bool  overlay,
out NXOpen.CAE.Xyplot.Plot[]  plots 
)
inline

Plots or overlays graphs of the Field's specified independent variable versus all the Field's dependent variables; returns newly created plot object(s).

Created in NX9.0.1

License requirements: None.

Parameters
indepVarthe specified independent variable for which to create the graph
abscissaMinimumthe minimum bounds along the abscissa
abscissaMaximumthe maximum bounds along the abscissa
abscissaPointCountthe number of points to graph along the abscissa. the number of times to evaluate the graphed independent variable
constantIndepVarArrayindependent variables to hold constant If the field has only 1 independent variable, this parameter is NULL
constantIndepVarValueArrayindependent variables constant values If the field has only 1 independent variable, this parameter is NULL
windowDevicegreat than 0. the index of display device to show the graph. 1 represents main graphic window
viewIndex0 thru 8, viewport number to place the graph in
overlaycreate a new plot or add to existing
plotsCreated plot(s)
unsafe void NXOpen.Fields.Field.XYGraph ( NXOpen.Fields.FieldVariable  indepVar,
double  abscissaMinimum,
double  abscissaMaximum,
int  abscissaPointCount,
NXOpen.Fields.FieldVariable[]  constantIndepVarArray,
double[]  constantIndepVarValueArray,
int  windowDevice,
int  viewIndex,
bool  overlay,
double  scaleFactor,
out NXOpen.CAE.Xyplot.Plot[]  plots 
)
inline

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).

Created in NX10.0.0

License requirements: None.

Parameters
indepVarthe specified independent variable for which to create the graph
abscissaMinimumthe minimum bounds along the abscissa
abscissaMaximumthe maximum bounds along the abscissa
abscissaPointCountthe number of points to graph along the abscissa. the number of times to evaluate the graphed independent variable
constantIndepVarArrayindependent variables to hold constant If the field has only 1 independent variable, this parameter is NULL
constantIndepVarValueArrayindependent variables constant values If the field has only 1 independent variable, this parameter is NULL
windowDevicegreat than 0. the index of display device to show the graph. 1 represents main graphic window
viewIndex0 thru 8, viewport number to place the graph in
overlaycreate a new plot or add to existing
scaleFactorscale dependent variable(s)
plotsCreated plot(s)
unsafe NXOpen.CAE.Xyplot.Plot NXOpen.Fields.Field.XYGraph3D ( NXOpen.Fields.FieldVariable  xAxisIndepVar,
double  xAxisBndsMinimum,
double  xAxisBndsMaximum,
int  xAxisBndsSampleSize,
NXOpen.Fields.FieldVariable  zAxisIndepVar,
double  zAxisBndsMinimum,
double  zAxisBndsMaximum,
int  zAxisBndsSampleSize,
NXOpen.Fields.FieldVariable  yAxisDepVar,
NXOpen.Fields.FieldVariable[]  constantIndepVarArray,
double[]  constantIndepVarValueArray,
bool  interpolateTableData,
int  windowDevice,
int  viewIndex,
bool  overlay,
double  scaleFactor 
)
inline

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.

Created in NX11.0.0

License requirements: None.

Parameters
xAxisIndepVarthe specified x-axis independent variable for which to create the graph
xAxisBndsMinimumthe minimum bounds along the x-axis
xAxisBndsMaximumthe maximum bounds along the x-axis
xAxisBndsSampleSizethe sample size to graph along the x-axis. the number of times to evaluate the x-axis independent variable
zAxisIndepVarthe specified z-Axis independent variable for which to create the graph
zAxisBndsMinimumthe minimum bounds along the z-Axis
zAxisBndsMaximumthe maximum bounds along the z-Axis
zAxisBndsSampleSizethe sample size to graph along the z-Axis. the number of times to evaluate the z-Axis independent variable
yAxisDepVarthe specified y-Axis dependent variable for which to create the graph
constantIndepVarArrayindependent variables to hold constant If the field has only 2 independent variables, this parameter is NULL
constantIndepVarValueArrayindependent variables constant values If the field has only 2 independent variables, this parameter is NULL
interpolateTableDataa 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.
windowDevicegreater than 0. the index of display device to show the graph. 1 represents main graphic window
viewIndex0 thru 8, viewport number to place the graph in
overlaycreate a new plot or add to existing
scaleFactorscale dependent variable
Returns
Created plot(s)
unsafe void NXOpen.Fields.Field.XYGraphArgand ( NXOpen.Fields.FieldVariable  indepVar,
double  abscissaMinimum,
double  abscissaMaximum,
int  abscissaPointCount,
NXOpen.Fields.FieldVariable[]  constantIndepVarArray,
double[]  constantIndepVarValueArray,
int  windowDevice,
int  viewIndex,
out NXOpen.CAE.Xyplot.Plot[]  plots 
)
inline

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).

Created in NX11.0.0

License requirements: None.

Parameters
indepVarthe specified independent variable for which to create the graph
abscissaMinimumthe minimum bounds along the abscissa
abscissaMaximumthe maximum bounds along the abscissa
abscissaPointCountthe number of points to graph along the abscissa. the number of times to evaluate the graphed independent variable
constantIndepVarArrayindependent variables to hold constant If the field has only 1 independent variable, this parameter is NULL
constantIndepVarValueArrayindependent variables constant values If the field has only 1 independent variable, this parameter is NULL
windowDevicegreat than 0. the index of display device to show the graph. 1 represents main graphic window
viewIndex0 thru 8, viewport number to place the graph in
plotsCreated plot(s)

Property Documentation

unsafe bool NXOpen.Fields.Field.IsLocked
get

Returns a value that indicates whether this field is locked against edits.

Created in NX7.5.2

License requirements: None.

unsafe bool NXOpen.Fields.Field.IsUserField
get

Returns a value that indicates whether this field is a user created/managed field.

Many fields are created automatically by the system for internal uses. The life of these fields is managed by the objects that own them and so these fields are not consider user fields.

Created in NX7.5.2

License requirements: None.


The documentation for this class was generated from the following file:
Copyright 2019 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.