ResultProbeBuilder Class¶
-
class
NXOpen.CAE.
ResultProbeBuilder
¶ Bases:
NXOpen.Builder
Result probe Builder
An instance of this class can not be obtained
New in version NX10.0.0.
Properties¶
Property | Description |
---|---|
CombineAcross | Returns or sets the combine across |
CombineAcrossIteration | Returns or sets the combine geom |
CombineIterOption | Returns or sets the combine option |
CombinedValue | Returns or sets the combined value |
EdgeIntegralOption | Returns or sets the face integral option |
EndIterIndex | Returns or sets the end iter index |
EndIterValue | Returns or sets the end iter value |
ErrorHndl | Returns or sets the error handel value |
FaceIntegralOption | Returns or sets the face integral option |
Formula | Returns or sets the formula |
GeometryAverageValue | Returns or sets the geometry average value |
IterNearValue | Returns or sets the iteration value |
Iteration | Returns or sets the iteration |
IterationIndex | Returns or sets the iteration index |
IterationTypeOption | Returns or sets the iteration type |
Loadcase | Returns or sets the loadcase |
LoadcaseIndex | Returns or sets the loadcase index |
ModelSelectionType | Returns or sets the model selection type |
NodalAveraging | Returns or sets the nodal combinatione |
PickSequentially | Returns or sets the pick sequentially |
ProbeName | Returns or sets the probe name |
ResultReferenceType | Returns or sets the result reference type |
ResultType | Returns or sets the output result type value |
SkipSteps | Returns or sets the skip steps |
StartIterIndex | Returns or sets the start iter index |
StartIterValue | Returns or sets the start iter value |
Tag | Returns the Tag for this object. |
Unit | Returns or sets the unit |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
GetDescription | Returns the description @return |
GetObject | Returns the object currently being edited by this builder. |
SetDescription | Sets the description |
SetEntityObjects | Sets the entity objects for extracting result data. |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
ResultProbeBuilderCombineAcrossEntities Enumeration | Options to combine multiple geometry values |
ResultProbeBuilderCombineAcrossIterations Enumeration | Iteration combination types |
ResultProbeBuilderEdgeIntegral Enumeration | Options to calculate CAE.ResultProbeBuilderGeometryValue.WeightedAverage or CAE.ResultProbeBuilderGeometryValue.Integral over elements on an edge |
ResultProbeBuilderErrorHandling Enumeration | Options to handel errornious conditions |
ResultProbeBuilderFaceIntegral Enumeration | Options to calculate CAE.ResultProbeBuilderGeometryValue.WeightedAverage or CAE.ResultProbeBuilderGeometryValue.Integral over elements on an face |
ResultProbeBuilderGeometryValue Enumeration | Options to combine geometry value |
ResultProbeBuilderIterationSelection Enumeration | Iteration definition method |
ResultProbeBuilderIterationType Enumeration | Iteration type filter |
ResultProbeBuilderLoadcaseSelection Enumeration | Loadcase definition method |
ResultProbeBuilderNodalCombination Enumeration | Options to combine multiple geometry values |
ResultProbeBuilderSelectionType Enumeration | Type of objects where probe value will be calculated |
Property Detail¶
CombineAcross¶
-
ResultProbeBuilder.
CombineAcross
¶ Returns or sets the combine across
-------------------------------------
Getter Method
Signature
CombineAcross()
Returns: Return type: bool New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------
Setter Method
Signature
CombineAcross(combineAcross)
Parameters: combineAcross (bool) – New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
CombineAcrossIteration¶
-
ResultProbeBuilder.
CombineAcrossIteration
¶ Returns or sets the combine geom
-------------------------------------
Getter Method
Signature
CombineAcrossIteration()
Returns: Return type: bool New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------
Setter Method
Signature
CombineAcrossIteration(combineIteration)
Parameters: combineIteration (bool) – New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
CombineIterOption¶
-
ResultProbeBuilder.
CombineIterOption
¶ Returns or sets the combine option
-------------------------------------
Getter Method
Signature
CombineIterOption()
Returns: Return type: NXOpen.CAE.ResultProbeBuilderCombineAcrossIterations
New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------
Setter Method
Signature
CombineIterOption(combineOption)
Parameters: combineOption ( NXOpen.CAE.ResultProbeBuilderCombineAcrossIterations
) –New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
CombinedValue¶
-
ResultProbeBuilder.
CombinedValue
¶ Returns or sets the combined value
-------------------------------------
Getter Method
Signature
CombinedValue()
Returns: Return type: NXOpen.CAE.ResultProbeBuilderCombineAcrossEntities
New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------
Setter Method
Signature
CombinedValue(combinedValue)
Parameters: combinedValue ( NXOpen.CAE.ResultProbeBuilderCombineAcrossEntities
) –New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
EdgeIntegralOption¶
-
ResultProbeBuilder.
EdgeIntegralOption
¶ Returns or sets the face integral option
-------------------------------------
Getter Method
Signature
EdgeIntegralOption()
Returns: Return type: NXOpen.CAE.ResultProbeBuilderEdgeIntegral
New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------
Setter Method
Signature
EdgeIntegralOption(edgeIntegral)
Parameters: edgeIntegral ( NXOpen.CAE.ResultProbeBuilderEdgeIntegral
) –New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
EndIterIndex¶
-
ResultProbeBuilder.
EndIterIndex
¶ Returns or sets the end iter index
-------------------------------------
Getter Method
Signature
EndIterIndex()
Returns: Return type: int New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------
Setter Method
Signature
EndIterIndex(endIterIndex)
Parameters: endIterIndex (int) – New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
EndIterValue¶
-
ResultProbeBuilder.
EndIterValue
¶ Returns or sets the end iter value
-------------------------------------
Getter Method
Signature
EndIterValue()
Returns: Return type: float New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------
Setter Method
Signature
EndIterValue(endIterValue)
Parameters: endIterValue (float) – New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
ErrorHndl¶
-
ResultProbeBuilder.
ErrorHndl
¶ Returns or sets the error handel value
-------------------------------------
Getter Method
Signature
ErrorHndl()
Returns: Return type: NXOpen.CAE.ResultProbeBuilderErrorHandling
New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------
Setter Method
Signature
ErrorHndl(errorHndl)
Parameters: errorHndl ( NXOpen.CAE.ResultProbeBuilderErrorHandling
) –New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
FaceIntegralOption¶
-
ResultProbeBuilder.
FaceIntegralOption
¶ Returns or sets the face integral option
-------------------------------------
Getter Method
Signature
FaceIntegralOption()
Returns: Return type: NXOpen.CAE.ResultProbeBuilderFaceIntegral
New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------
Setter Method
Signature
FaceIntegralOption(faceIntegral)
Parameters: faceIntegral ( NXOpen.CAE.ResultProbeBuilderFaceIntegral
) –New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
Formula¶
-
ResultProbeBuilder.
Formula
¶ Returns or sets the formula
-------------------------------------
Getter Method
Signature
Formula()
Returns: Return type: str New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------
Setter Method
Signature
Formula(formula)
Parameters: formula (str) – New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
GeometryAverageValue¶
-
ResultProbeBuilder.
GeometryAverageValue
¶ Returns or sets the geometry average value
-------------------------------------
Getter Method
Signature
GeometryAverageValue()
Returns: Return type: NXOpen.CAE.ResultProbeBuilderGeometryValue
New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------
Setter Method
Signature
GeometryAverageValue(geometryAverageValue)
Parameters: geometryAverageValue ( NXOpen.CAE.ResultProbeBuilderGeometryValue
) –New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
IterNearValue¶
-
ResultProbeBuilder.
IterNearValue
¶ Returns or sets the iteration value
-------------------------------------
Getter Method
Signature
IterNearValue()
Returns: Return type: float New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------
Setter Method
Signature
IterNearValue(iterValue)
Parameters: iterValue (float) – New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
Iteration¶
-
ResultProbeBuilder.
Iteration
¶ Returns or sets the iteration
-------------------------------------
Getter Method
Signature
Iteration()
Returns: Return type: NXOpen.CAE.ResultProbeBuilderIterationSelection
New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------
Setter Method
Signature
Iteration(iteration)
Parameters: iteration ( NXOpen.CAE.ResultProbeBuilderIterationSelection
) –New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
IterationIndex¶
-
ResultProbeBuilder.
IterationIndex
¶ Returns or sets the iteration index
-------------------------------------
Getter Method
Signature
IterationIndex()
Returns: Return type: int New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------
Setter Method
Signature
IterationIndex(iterationIndex)
Parameters: iterationIndex (int) – New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
IterationTypeOption¶
-
ResultProbeBuilder.
IterationTypeOption
¶ Returns or sets the iteration type
-------------------------------------
Getter Method
Signature
IterationTypeOption()
Returns: Return type: NXOpen.CAE.ResultProbeBuilderIterationType
New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------
Setter Method
Signature
IterationTypeOption(iterationType)
Parameters: iterationType ( NXOpen.CAE.ResultProbeBuilderIterationType
) –New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
Loadcase¶
-
ResultProbeBuilder.
Loadcase
¶ Returns or sets the loadcase
-------------------------------------
Getter Method
Signature
Loadcase()
Returns: Return type: NXOpen.CAE.ResultProbeBuilderLoadcaseSelection
New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------
Setter Method
Signature
Loadcase(loadcase)
Parameters: loadcase ( NXOpen.CAE.ResultProbeBuilderLoadcaseSelection
) –New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
LoadcaseIndex¶
-
ResultProbeBuilder.
LoadcaseIndex
¶ Returns or sets the loadcase index
-------------------------------------
Getter Method
Signature
LoadcaseIndex()
Returns: Return type: int New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------
Setter Method
Signature
LoadcaseIndex(loadcaseIndex)
Parameters: loadcaseIndex (int) – New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
ModelSelectionType¶
-
ResultProbeBuilder.
ModelSelectionType
¶ Returns or sets the model selection type
-------------------------------------
Getter Method
Signature
ModelSelectionType()
Returns: Return type: NXOpen.CAE.ResultProbeBuilderSelectionType
New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------
Setter Method
Signature
ModelSelectionType(modelSelectionType)
Parameters: modelSelectionType ( NXOpen.CAE.ResultProbeBuilderSelectionType
) –New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
NodalAveraging¶
-
ResultProbeBuilder.
NodalAveraging
¶ Returns or sets the nodal combinatione
-------------------------------------
Getter Method
Signature
NodalAveraging()
Returns: Return type: NXOpen.CAE.ResultProbeBuilderNodalCombination
New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------
Setter Method
Signature
NodalAveraging(nodalCombination)
Parameters: nodalCombination ( NXOpen.CAE.ResultProbeBuilderNodalCombination
) –New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
PickSequentially¶
-
ResultProbeBuilder.
PickSequentially
¶ Returns or sets the pick sequentially
-------------------------------------
Getter Method
Signature
PickSequentially()
Returns: Return type: bool New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------
Setter Method
Signature
PickSequentially(pickSequentially)
Parameters: pickSequentially (bool) – New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
ProbeName¶
-
ResultProbeBuilder.
ProbeName
¶ Returns or sets the probe name
-------------------------------------
Getter Method
Signature
ProbeName()
Returns: Return type: str New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------
Setter Method
Signature
ProbeName(probeName)
Parameters: probeName (str) – New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
ResultReferenceType¶
-
ResultProbeBuilder.
ResultReferenceType
¶ Returns or sets the result reference type
-------------------------------------
Getter Method
Signature
ResultReferenceType()
Returns: Return type: NXOpen.CAE.SimResultReferenceType
New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------
Setter Method
Signature
ResultReferenceType(type)
Parameters: type ( NXOpen.CAE.SimResultReferenceType
) –New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
ResultType¶
-
ResultProbeBuilder.
ResultType
¶ Returns or sets the output result type value
-------------------------------------
Getter Method
Signature
ResultType()
Returns: Return type: NXOpen.CAE.ResultQuantity
New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------
Setter Method
Signature
ResultType(resultType)
Parameters: resultType ( NXOpen.CAE.ResultQuantity
) –New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
SkipSteps¶
-
ResultProbeBuilder.
SkipSteps
¶ Returns or sets the skip steps
-------------------------------------
Getter Method
Signature
SkipSteps()
Returns: Return type: int New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------
Setter Method
Signature
SkipSteps(skipSteps)
Parameters: skipSteps (int) – New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
StartIterIndex¶
-
ResultProbeBuilder.
StartIterIndex
¶ Returns or sets the start iter index
-------------------------------------
Getter Method
Signature
StartIterIndex()
Returns: Return type: int New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------
Setter Method
Signature
StartIterIndex(startIterIndex)
Parameters: startIterIndex (int) – New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
StartIterValue¶
-
ResultProbeBuilder.
StartIterValue
¶ Returns or sets the start iter value
-------------------------------------
Getter Method
Signature
StartIterValue()
Returns: Return type: float New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------
Setter Method
Signature
StartIterValue(startIterValue)
Parameters: startIterValue (float) – New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
Unit¶
-
ResultProbeBuilder.
Unit
¶ Returns or sets the unit
-------------------------------------
Getter Method
Signature
Unit()
Returns: Return type: NXOpen.Unit
New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------
Setter Method
Signature
Unit(unit)
Parameters: unit ( NXOpen.Unit
) –New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
Method Detail¶
GetDescription¶
-
ResultProbeBuilder.
GetDescription
¶ Returns the description
Signature
GetDescription()
Returns: Return type: list of str New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
SetDescription¶
-
ResultProbeBuilder.
SetDescription
¶ Sets the description
Signature
SetDescription(description)
Parameters: description (list of str) – New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
SetEntityObjects¶
-
ResultProbeBuilder.
SetEntityObjects
¶ Sets the entity objects for extracting result data.
Objects passed to this method are of the type defined by
CAE.ResultProbeBuilder.ModelSelectionType
. The types of objects allowed to be set are is defined by theNXOpen.CAE.ResultProbeBuilderSelectionType
.Signature
SetEntityObjects(entityObjs)
Parameters: entityObjs (list of NXOpen.TaggedObject
) –New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
Validate¶
-
ResultProbeBuilder.
Validate
¶ Validate whether the inputs to the component are sufficient for commit to be called.
If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.
Signature
Validate()
Returns: Was self validation successful Return type: bool New in version NX3.0.1.
License requirements: None.