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

Result Probe Object. More...

Inheritance diagram for NXOpen.CAE.ResultProbe:
NXOpen.Fields.Field NXOpen.DisplayableObject NXOpen.NXObject NXOpen.IFitTo NXOpen.TaggedObject NXOpen.INXObject NXOpen.INXObject NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  OutputOption {
  Information, Graph, Graph3D, Field,
  UnvFile, PostView, ExportField
}
 Probe output options More...
 

Public Member Functions

unsafe NXOpen.CAE.ResultProbe CopyToSolution (NXOpen.CAE.SimSolution targetSolution)
 Copy the result probe to target solution More...
 
unsafe NXOpen.Fields.Field CreateTableField ()
 Create Table Field From Probe More...
 
unsafe
NXOpen.CAE.ResultProbe.OutputOption[] 
GetOutputOptions ()
 Get output options of result probe More...
 
unsafe NXOpen.CAE.ProbeOutputRecipe GetOutputRecipe (NXOpen.CAE.ProbeOutputRecipe.Type recipeType)
 Get Specific output recipe of result probe if exists More...
 
unsafe
NXOpen.CAE.ProbeOutputRecipe[] 
GetOutputRecipes ()
 Get output recipies of result probe More...
 
unsafe void Information ()
 Information of the probe results. More...
 
- Public Member Functions inherited from NXOpen.Fields.Field
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...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 
- Properties inherited from NXOpen.Fields.Field
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...
 

Detailed Description

Result Probe Object.

To obtain a instance of this class use an appropriate application data provider.

Created in NX10.0.0

Member Enumeration Documentation

Probe output options

Enumerator
Information 
Graph 
Graph3D 
Field 
UnvFile 
PostView 
ExportField 

Member Function Documentation

unsafe NXOpen.CAE.ResultProbe NXOpen.CAE.ResultProbe.CopyToSolution ( NXOpen.CAE.SimSolution  targetSolution)
inline

Copy the result probe to target solution

Created in NX11.0.0

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters
targetSolution
Returns
unsafe NXOpen.Fields.Field NXOpen.CAE.ResultProbe.CreateTableField ( )
inline

Create Table Field From Probe

Created in NX1847.0.0

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Returns
field
unsafe NXOpen.CAE.ResultProbe.OutputOption [] NXOpen.CAE.ResultProbe.GetOutputOptions ( )
inline

Get output options of result probe

Created in NX11.0.0

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Returns
Probe options
unsafe NXOpen.CAE.ProbeOutputRecipe NXOpen.CAE.ResultProbe.GetOutputRecipe ( NXOpen.CAE.ProbeOutputRecipe.Type  recipeType)
inline

Get Specific output recipe of result probe if exists

Created in NX1847.0.0

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters
recipeType
Returns
Probe output recipe
unsafe NXOpen.CAE.ProbeOutputRecipe [] NXOpen.CAE.ResultProbe.GetOutputRecipes ( )
inline

Get output recipies of result probe

Created in NX1847.0.0

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Returns
Probe output recipies
unsafe void NXOpen.CAE.ResultProbe.Information ( )
inline

Information of the probe results.

Created in NX10.0.0

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")


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