SimBcXyPlotBuilder Class

class NXOpen.CAE.SimBcXyPlotBuilder

Bases: NXOpen.Builder

Represents a NXOpen.CAE.SimBcXyPlotBuilder builder which can be used to generate a XY plot of a NXOpen.CAE.SimBC in the graphics area.

This is limited to NXOpen.CAE.SimBC objects in the active solution. To create a new instance of this class, use NXOpen.CAE.SimSimulation.CreateSimBcXyPlotBuilder()

New in version NX9.0.0.

Properties

Property Description
MultipleMatches Returns or sets a NXOpen.CAE.SimBcXyPlotBuilderResolveMultipleMatches used in plot to resolve multiple values
Tag Returns the Tag for this object.

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.
GetAvailableBcsToPlot Returns all available NXOpen.CAE.SimBC to plot
GetAvailablePropertyNamesToPlot Returns all available property names that can be plotted for the specified NXOpen.CAE.SimBC
GetCommittedObjects For builders that create more than one object, this method returns the objects that are created by commit.
GetObject Returns the object currently being edited by this builder.
Plot Creates XY plot
SetBcsToPlot Sets NXOpen.CAE.SimBC objects to plot.
SetLocationElement Sets location at an element
SetLocationElementEdge Sets location at an element edge
SetLocationElementFace Sets location at an element face
SetLocationNode Sets location at a node
SetPropertyNameToPlot Sets property name to plot.
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

SimBcXyPlotBuilderResolveMultipleMatches Enumeration Resolve multiple matches when the location specified matches multiple items in the boundary condition’s target set

Property Detail

MultipleMatches

SimBcXyPlotBuilder.MultipleMatches

Returns or sets a NXOpen.CAE.SimBcXyPlotBuilderResolveMultipleMatches used in plot to resolve multiple values

-------------------------------------

Getter Method

Signature MultipleMatches

Returns:
Return type:NXOpen.CAE.SimBcXyPlotBuilderResolveMultipleMatches

New in version NX9.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”)

-------------------------------------

Setter Method

Signature MultipleMatches

Parameters:resolveMultipleMatches (NXOpen.CAE.SimBcXyPlotBuilderResolveMultipleMatches) –

New in version NX9.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”)

Method Detail

GetAvailableBcsToPlot

SimBcXyPlotBuilder.GetAvailableBcsToPlot

Returns all available NXOpen.CAE.SimBC to plot

Signature GetAvailableBcsToPlot()

Returns:
Return type:list of NXOpen.CAE.SimBC

New in version NX9.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”)

GetAvailablePropertyNamesToPlot

SimBcXyPlotBuilder.GetAvailablePropertyNamesToPlot

Returns all available property names that can be plotted for the specified NXOpen.CAE.SimBC

Signature GetAvailablePropertyNamesToPlot(tBc)

Parameters:tBc (NXOpen.CAE.SimBC) –
Returns:
Return type:list of str

New in version NX9.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”)

Plot

SimBcXyPlotBuilder.Plot

Creates XY plot

Signature Plot(deviceIndex, viewIndex)

Parameters:
  • deviceIndex (int) – device index
  • viewIndex (int) – view index
Returns:

Created plot
Return type:

NXOpen.CAE.Xyplot.Plot

New in version NX9.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”)

SetBcsToPlot

SimBcXyPlotBuilder.SetBcsToPlot

Overloaded method SetBcsToPlot

  • SetBcsToPlot(bcs, propertyNames)
  • SetBcsToPlot(bcs)

-------------------------------------

Sets NXOpen.CAE.SimBC objects to plot.

Signature SetBcsToPlot(bcs, propertyNames)

Parameters:
  • bcs (list of NXOpen.CAE.SimBC) – boundary conditions to plot
  • propertyNames (list of str) – property names to plot

New in version NX9.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”)

-------------------------------------

Sets NXOpen.CAE.SimBC objects to plot.

Signature SetBcsToPlot(bcs)

Parameters:bcs (list of NXOpen.CAE.SimBC) – boundary conditions to plot

New in version NX9.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”)

-------------------------------------

SetLocationElement

SimBcXyPlotBuilder.SetLocationElement

Sets location at an element

Signature SetLocationElement(element)

Parameters:element (NXOpen.CAE.FEElement) – element

New in version NX9.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”)

SetLocationElementEdge

SimBcXyPlotBuilder.SetLocationElementEdge

Sets location at an element edge

Signature SetLocationElementEdge(elementEdge)

Parameters:elementEdge (NXOpen.CAE.FEElemEdge) – element edge

New in version NX9.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”)

SetLocationElementFace

SimBcXyPlotBuilder.SetLocationElementFace

Sets location at an element face

Signature SetLocationElementFace(elementFace)

Parameters:elementFace (NXOpen.CAE.FEElemFace) – element face

New in version NX9.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”)

SetLocationNode

SimBcXyPlotBuilder.SetLocationNode

Sets location at a node

Signature SetLocationNode(node)

Parameters:node (NXOpen.CAE.FENode) – node

New in version NX9.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”)

SetPropertyNameToPlot

SimBcXyPlotBuilder.SetPropertyNameToPlot

Sets property name to plot.

Signature SetPropertyNameToPlot(pPropertyName)

Parameters:pPropertyName (str) –

New in version NX9.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”)

Validate

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