PostGraphAcrossIterationsBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# PostGraphAcrossIterationsBuilder Class

class `NXOpen.CAE.``PostGraphAcrossIterationsBuilder`

  Bases: `NXOpen.CAE.PostGraphBuilder`

  Represents a `NXOpen.CAE.PostGraphAcrossIterationsBuilder`

  This is an abstract class and cannot be instantiated

  New in version NX9.0.0.

# Properties

Property | Description
--- | ---
CombineAcrossEntities | Returns or sets the combine across entities method to be used if `NXOpen.CAE.PostGraphAcrossIterationsBuilder.CombineAcrossEntities`()` is True
CombineValueFromEntitiesOption | Returns or sets the set combine across entities option type
ComplexGraphTypes | Returns or sets the complex plot display option while plotting complex result type
CreateFieldOption | Returns or sets the option to create field of the across iteration graph created by expression
EdgeIntegralOptionValue | Returns or sets the weighted average or integral option on selecting Edge
EvalutionErrorsOption | Returns or sets the error handling option when there are evaluation errors on selected entities or path
FaceIntegralOptionValue | Returns or sets the weighted average or integral option on selecting Face
GeometryCombinationValue | Returns or sets the geometry value option in case of edge, face or body selection
GraphTitle | Returns or sets the graph title
IncompatibleResultOption | Returns or sets the error handling option when results are not compatible on selected entities or path
IterationStepSpacing | Returns or sets the step spacing to be used between the start and end iteration.
IterationValueOption | Returns or sets the select iteration type to be set as x axis
NoDataOption | Returns or sets the error handling option when result is not present on selected entities or path
NodalCombinationValue | Returns or sets the nodal combination option for determining the nodal value for element and element-nodal results
SaveAfuOption | Returns or sets the save in AFU option to save graph data as AFU records
SelectedEntityType | Returns or sets the entity type of the tags of entities which passed using SetEntityObjects function
Tag | Returns the Tag for this object.
UserData | Returns or sets the error handling value used when error occurs or no data present on entities

# 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.
GetFieldTable | Gets the field which is created when user sets the `NXOpen.CAE.PostGraphBuilder.CreateFieldOption`()` to true for across iterations type of graphs
GetObject | Returns the object currently being edited by this builder.
SetEndIteration | Set end iteration
SetEntityIds | Set entity ids for extracting result data
SetEntityObjects | Sets the entity objects for extracting result data.
SetFreePoints | Set free points for extracting data
SetSelectionEntityObjects | Sets the selection entity object.
SetStartIteration | Set start iteration
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

PostGraphAcrossIterationsBuilderCombinationMethod Enumeration | Defines the methods that can be used to combine multiple values into a single value
PostGraphAcrossIterationsBuilderIterationLabelingOption Enumeration | Defines the Iteration labeling options

# Property Detail

## CombineAcrossEntities

`PostGraphAcrossIterationsBuilder.``CombineAcrossEntities`

  Returns or sets the combine across entities method to be used if `NXOpen.CAE.PostGraphAcrossIterationsBuilder.CombineAcrossEntities`()` is True

  `-------------------------------------`

  Getter Method

  Signature `CombineAcrossEntities`

  Returns: |
  Return type: | bool

  New in version NX9.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”) OR sc_results_viewer (” Simcenter Results Viewer”)

  `-------------------------------------`

  Setter Method

  Signature `CombineAcrossEntities`

  Parameters: | combineAcrossEntities (bool) –

  New in version NX9.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”) OR sc_results_viewer (” Simcenter Results Viewer”)

## CombineValueFromEntitiesOption

`PostGraphAcrossIterationsBuilder.``CombineValueFromEntitiesOption`

  Returns or sets the set combine across entities option type

  `-------------------------------------`

  Getter Method

  Signature `CombineValueFromEntitiesOption`

  Returns: |
  Return type: | `NXOpen.CAE.PostGraphAcrossIterationsBuilderCombinationMethod`

  New in version NX9.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”) OR sc_results_viewer (” Simcenter Results Viewer”)

  `-------------------------------------`

  Setter Method

  Signature `CombineValueFromEntitiesOption`

  Parameters: | combineOption (`NXOpen.CAE.PostGraphAcrossIterationsBuilderCombinationMethod`) –

  New in version NX9.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”) OR sc_results_viewer (” Simcenter Results Viewer”)

## IterationStepSpacing

`PostGraphAcrossIterationsBuilder.``IterationStepSpacing`

  Returns or sets the step spacing to be used between the start and end iteration.

  This option can be used to reduce the amount of data graphed.

  `-------------------------------------`

  Getter Method

  Signature `IterationStepSpacing`

  Returns: |
  Return type: | int

  New in version NX9.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”) OR sc_results_viewer (” Simcenter Results Viewer”)

  `-------------------------------------`

  Setter Method

  Signature `IterationStepSpacing`

  Parameters: | iterationStepSpacing (int) –

  New in version NX9.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”) OR sc_results_viewer (” Simcenter Results Viewer”)

## IterationValueOption

`PostGraphAcrossIterationsBuilder.``IterationValueOption`

  Returns or sets the select iteration type to be set as x axis

  `-------------------------------------`

  Getter Method

  Signature `IterationValueOption`

  Returns: |
  Return type: | `NXOpen.CAE.PostGraphAcrossIterationsBuilderIterationLabelingOption`

  New in version NX9.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”) OR sc_results_viewer (” Simcenter Results Viewer”)

  `-------------------------------------`

  Setter Method

  Signature `IterationValueOption`

  Parameters: | iterationValue (`NXOpen.CAE.PostGraphAcrossIterationsBuilderIterationLabelingOption`) –

  New in version NX9.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”) OR sc_results_viewer (” Simcenter Results Viewer”)

# Method Detail

## SetEndIteration

`PostGraphAcrossIterationsBuilder.``SetEndIteration`

  Set end iteration

  Signature `SetEndIteration(iteration)`

  Parameters: | iteration (`NXOpen.CAE.BaseIteration`) –

  New in version NX9.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”) OR sc_results_viewer (” Simcenter Results Viewer”)

## SetStartIteration

`PostGraphAcrossIterationsBuilder.``SetStartIteration`

  Set start iteration

  Signature `SetStartIteration(iteration)`

  Parameters: | iteration (`NXOpen.CAE.BaseIteration`) –

  New in version NX9.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”) OR sc_results_viewer (” Simcenter Results Viewer”)

## Validate

`PostGraphAcrossIterationsBuilder.``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.