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

Represents a NXOpen.CAE.FreeBodyResultsBuilder More...

Inheritance diagram for NXOpen.CAE.FreeBodyResultsBuilder:
NXOpen.Builder NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  LocationMethod { Id, Coords, Csysorigin }
 Location definition method More...
 
enum  OutputUnits {
  Default, MilliNewton, MilliMillinewton, MeterNewton,
  FtPoundForce, InPoundForce
}
 User Specified output units More...
 
enum  VectorDisplay { Magnitude, Components }
 Vector display option More...
 

Public Member Functions

unsafe bool GetDisplayForce ()
 Display Force More...
 
unsafe bool GetDisplayMoment ()
 Display Moment More...
 
unsafe int[] GetElements ()
 The free body elements More...
 
unsafe NXOpen.NXColor GetForceColor ()
 Force Color More...
 
unsafe
NXOpen.CAE.FreeBodyResultsBuilder.VectorDisplay 
GetForceVectorDisplay ()
 Force vector display More...
 
unsafe NXOpen.CAE.BaseIteration GetIteration ()
 The iteration containing the grid point force results More...
 
unsafe NXOpen.Point3d GetLocationCoords ()
 The location definition method by coordinates More...
 
unsafe int GetLocationCsys ()
 The location definition method by coordinate system origin More...
 
unsafe
NXOpen.CAE.Result.CoordinateSystemSource 
GetLocationCsysSource ()
 The source for the location coordinate system More...
 
unsafe int GetLocationId ()
 The location definition method by node id More...
 
unsafe
NXOpen.CAE.FreeBodyResultsBuilder.LocationMethod 
GetLocationMethod ()
 The location definition method More...
 
unsafe NXOpen.NXColor GetMomentColor ()
 Moment Color More...
 
unsafe
NXOpen.CAE.FreeBodyResultsBuilder.VectorDisplay 
GetMomentVectorDisplay ()
 Moment vector display More...
 
unsafe int[] GetNodes ()
 The interface nodes More...
 
unsafe
NXOpen.CAE.FreeBodyResultsBuilder.OutputUnits 
GetOutputUnits ()
 Output Units More...
 
unsafe int GetPostview ()
 The view where graphics will be displayed More...
 
unsafe bool GetPrintOutput ()
 Print Output More...
 
unsafe
NXOpen.CAE.Result.CoordinateSystem 
GetReferenceCsys ()
 The reference coordinate system More...
 
unsafe int GetSelectedReferenceCsys ()
 The selected reference coordinate system More...
 
unsafe
NXOpen.CAE.Result.CoordinateSystemSource 
GetSelectedReferenceCsysSource ()
 The source for the selected reference coordinate system More...
 
unsafe void SetDisplayForce (bool display)
 Display Force More...
 
unsafe void SetDisplayMoment (bool display)
 Display Moment More...
 
unsafe void SetElements (int[] elements)
 The free body elements More...
 
unsafe void SetForceColor (NXOpen.NXColor display)
 Force Color More...
 
unsafe void SetForceVectorDisplay (NXOpen.CAE.FreeBodyResultsBuilder.VectorDisplay vectorDisplay)
 Force vector display More...
 
unsafe void SetIteration (NXOpen.CAE.BaseIteration iteration)
 The iteration containing the grid point force results More...
 
unsafe void SetLocationCoords (NXOpen.Point3d coordinates)
 The location definition method by coordinates More...
 
unsafe void SetLocationCsys (int id)
 The location definition method by coordinate system origin More...
 
unsafe void SetLocationCsysSource (NXOpen.CAE.Result.CoordinateSystemSource source)
 The source for the location coordinate system More...
 
unsafe void SetLocationId (int nodeId)
 The location definition method by node id More...
 
unsafe void SetLocationMethod (NXOpen.CAE.FreeBodyResultsBuilder.LocationMethod method)
 The location definition method More...
 
unsafe void SetMomentColor (NXOpen.NXColor color)
 Moment Color More...
 
unsafe void SetMomentVectorDisplay (NXOpen.CAE.FreeBodyResultsBuilder.VectorDisplay vectorDisplay)
 Moment vector display More...
 
unsafe void SetNodes (int[] nodes)
 The interface nodes More...
 
unsafe void SetOutputUnits (NXOpen.CAE.FreeBodyResultsBuilder.OutputUnits units)
 Output Units More...
 
unsafe void SetPostview (int postviewId)
 The view where graphics will be displayed More...
 
unsafe void SetPrintOutput (bool print)
 Print Output More...
 
unsafe void SetReferenceCsys (NXOpen.CAE.Result.CoordinateSystem csys)
 The reference coordinate system More...
 
unsafe void SetSelectedReferenceCsys (int id)
 The selected reference coordinate system More...
 
unsafe void SetSelectedReferenceCsysSource (NXOpen.CAE.Result.CoordinateSystemSource source)
 The source for the selected reference coordinate system More...
 
- Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject Commit ()
 Commits any edits that have been applied to the builder. More...
 
unsafe void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
unsafe NXOpen.NXObject[] GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
unsafe NXOpen.NXObject GetObject ()
 Returns the object currently being edited by this builder. More...
 
unsafe void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. 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.TaggedObject
Tag Tag [get]
 Returns the tag of this object. More...
 

Detailed Description

Represents a NXOpen.CAE.FreeBodyResultsBuilder

To obtain an instance of this class use NXOpen.Session.ResultManager .

Created in NX7.5.1

Member Enumeration Documentation

Location definition method

Enumerator
Id 

location is defined by node id

Coords 

location is defined by coordinates

Csysorigin 

location is defined by coordinate system origin

User Specified output units

Enumerator
Default 

same as Solver Deck Unit

MilliNewton 

Load unit = "N", Moment unit N-mm

MilliMillinewton 

Load unit = "mN", Moment unit N-mm

MeterNewton 

Load unit = "N", Moment unit N-m

FtPoundForce 

Load unit = "lbf", Moment unit lbf-ft

InPoundForce 

Load unit = "lbf", Moment unit lbf-in

Vector display option

Enumerator
Magnitude 

display single magnitude vector

Components 

display individual components

Member Function Documentation

unsafe bool NXOpen.CAE.FreeBodyResultsBuilder.GetDisplayForce ( )
inline

Display Force

Created in NX7.5.1

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

Returns
Ask Display
unsafe bool NXOpen.CAE.FreeBodyResultsBuilder.GetDisplayMoment ( )
inline

Display Moment

Created in NX7.5.1

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

Returns
Ask Moment
unsafe int [] NXOpen.CAE.FreeBodyResultsBuilder.GetElements ( )
inline

The free body elements

Created in NX7.5.1

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

Returns
Ask Elements
unsafe NXOpen.NXColor NXOpen.CAE.FreeBodyResultsBuilder.GetForceColor ( )
inline

Force Color

Created in NX7.5.1

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

Returns
Ask Color
unsafe NXOpen.CAE.FreeBodyResultsBuilder.VectorDisplay NXOpen.CAE.FreeBodyResultsBuilder.GetForceVectorDisplay ( )
inline

Force vector display

Created in NX7.5.1

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

Returns
Ask force vector display
unsafe NXOpen.CAE.BaseIteration NXOpen.CAE.FreeBodyResultsBuilder.GetIteration ( )
inline

The iteration containing the grid point force results

Created in NX7.5.1

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

Returns
Ask Iteration
unsafe NXOpen.Point3d NXOpen.CAE.FreeBodyResultsBuilder.GetLocationCoords ( )
inline

The location definition method by coordinates

Created in NX7.5.1

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

Returns
Ask Coordinates
unsafe int NXOpen.CAE.FreeBodyResultsBuilder.GetLocationCsys ( )
inline

The location definition method by coordinate system origin

Created in NX7.5.1

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

Returns
Ask Coordinate System
unsafe NXOpen.CAE.Result.CoordinateSystemSource NXOpen.CAE.FreeBodyResultsBuilder.GetLocationCsysSource ( )
inline

The source for the location coordinate system

Created in NX7.5.1

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

Returns
Ask Source
unsafe int NXOpen.CAE.FreeBodyResultsBuilder.GetLocationId ( )
inline

The location definition method by node id

Created in NX7.5.1

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

Returns
Ask Node ID
unsafe NXOpen.CAE.FreeBodyResultsBuilder.LocationMethod NXOpen.CAE.FreeBodyResultsBuilder.GetLocationMethod ( )
inline

The location definition method

Created in NX7.5.1

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

Returns
Ask Method
unsafe NXOpen.NXColor NXOpen.CAE.FreeBodyResultsBuilder.GetMomentColor ( )
inline

Moment Color

Created in NX7.5.1

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

Returns
Ask Color
unsafe NXOpen.CAE.FreeBodyResultsBuilder.VectorDisplay NXOpen.CAE.FreeBodyResultsBuilder.GetMomentVectorDisplay ( )
inline

Moment vector display

Created in NX7.5.1

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

Returns
Ask moment vector display
unsafe int [] NXOpen.CAE.FreeBodyResultsBuilder.GetNodes ( )
inline

The interface nodes

Created in NX7.5.1

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

Returns
Ask Nodes
unsafe NXOpen.CAE.FreeBodyResultsBuilder.OutputUnits NXOpen.CAE.FreeBodyResultsBuilder.GetOutputUnits ( )
inline

Output Units

Created in NX7.5.1

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

Returns
Ask Units
unsafe int NXOpen.CAE.FreeBodyResultsBuilder.GetPostview ( )
inline

The view where graphics will be displayed

Created in NX7.5.1

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

Returns
Ask View
unsafe bool NXOpen.CAE.FreeBodyResultsBuilder.GetPrintOutput ( )
inline

Print Output

Created in NX7.5.1

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

Returns
Ask Print
unsafe NXOpen.CAE.Result.CoordinateSystem NXOpen.CAE.FreeBodyResultsBuilder.GetReferenceCsys ( )
inline

The reference coordinate system

Created in NX7.5.1

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

Returns
Ask Coordinate System
unsafe int NXOpen.CAE.FreeBodyResultsBuilder.GetSelectedReferenceCsys ( )
inline

The selected reference coordinate system

Created in NX7.5.1

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

Returns
Ask Coordinate System
unsafe NXOpen.CAE.Result.CoordinateSystemSource NXOpen.CAE.FreeBodyResultsBuilder.GetSelectedReferenceCsysSource ( )
inline

The source for the selected reference coordinate system

Created in NX7.5.1

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

Returns
Ask Source
unsafe void NXOpen.CAE.FreeBodyResultsBuilder.SetDisplayForce ( bool  display)
inline

Display Force

Created in NX7.5.1

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

Parameters
displaySet Display
unsafe void NXOpen.CAE.FreeBodyResultsBuilder.SetDisplayMoment ( bool  display)
inline

Display Moment

Created in NX7.5.1

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

Parameters
displaySet Moment
unsafe void NXOpen.CAE.FreeBodyResultsBuilder.SetElements ( int[]  elements)
inline

The free body elements

Created in NX7.5.1

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

Parameters
elementsSet Elements
unsafe void NXOpen.CAE.FreeBodyResultsBuilder.SetForceColor ( NXOpen.NXColor  display)
inline

Force Color

Created in NX7.5.1

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

Parameters
displaySet Color
unsafe void NXOpen.CAE.FreeBodyResultsBuilder.SetForceVectorDisplay ( NXOpen.CAE.FreeBodyResultsBuilder.VectorDisplay  vectorDisplay)
inline

Force vector display

Created in NX7.5.1

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

Parameters
vectorDisplaySet force vector display
unsafe void NXOpen.CAE.FreeBodyResultsBuilder.SetIteration ( NXOpen.CAE.BaseIteration  iteration)
inline

The iteration containing the grid point force results

Created in NX7.5.1

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

Parameters
iterationSet Iteration
unsafe void NXOpen.CAE.FreeBodyResultsBuilder.SetLocationCoords ( NXOpen.Point3d  coordinates)
inline

The location definition method by coordinates

Created in NX7.5.1

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

Parameters
coordinatesSet Coordinates
unsafe void NXOpen.CAE.FreeBodyResultsBuilder.SetLocationCsys ( int  id)
inline

The location definition method by coordinate system origin

Created in NX7.5.1

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

Parameters
idSet Node Coordinate System
unsafe void NXOpen.CAE.FreeBodyResultsBuilder.SetLocationCsysSource ( NXOpen.CAE.Result.CoordinateSystemSource  source)
inline

The source for the location coordinate system

Created in NX7.5.1

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

Parameters
sourceSet Source
unsafe void NXOpen.CAE.FreeBodyResultsBuilder.SetLocationId ( int  nodeId)
inline

The location definition method by node id

Created in NX7.5.1

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

Parameters
nodeIdSet Node ID
unsafe void NXOpen.CAE.FreeBodyResultsBuilder.SetLocationMethod ( NXOpen.CAE.FreeBodyResultsBuilder.LocationMethod  method)
inline

The location definition method

Created in NX7.5.1

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

Parameters
methodSet Method
unsafe void NXOpen.CAE.FreeBodyResultsBuilder.SetMomentColor ( NXOpen.NXColor  color)
inline

Moment Color

Created in NX7.5.1

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

Parameters
colorSet Color
unsafe void NXOpen.CAE.FreeBodyResultsBuilder.SetMomentVectorDisplay ( NXOpen.CAE.FreeBodyResultsBuilder.VectorDisplay  vectorDisplay)
inline

Moment vector display

Created in NX7.5.1

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

Parameters
vectorDisplaySet moment vector display
unsafe void NXOpen.CAE.FreeBodyResultsBuilder.SetNodes ( int[]  nodes)
inline

The interface nodes

Created in NX7.5.1

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

Parameters
nodesSet Nodes
unsafe void NXOpen.CAE.FreeBodyResultsBuilder.SetOutputUnits ( NXOpen.CAE.FreeBodyResultsBuilder.OutputUnits  units)
inline

Output Units

Created in NX7.5.1

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

Parameters
unitsSet Units
unsafe void NXOpen.CAE.FreeBodyResultsBuilder.SetPostview ( int  postviewId)
inline

The view where graphics will be displayed

Created in NX7.5.1

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

Parameters
postviewIdSet View
unsafe void NXOpen.CAE.FreeBodyResultsBuilder.SetPrintOutput ( bool  print)
inline

Print Output

Created in NX7.5.1

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

Parameters
printSet Print
unsafe void NXOpen.CAE.FreeBodyResultsBuilder.SetReferenceCsys ( NXOpen.CAE.Result.CoordinateSystem  csys)
inline

The reference coordinate system

Created in NX7.5.1

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

Parameters
csysSet Coordinate System
unsafe void NXOpen.CAE.FreeBodyResultsBuilder.SetSelectedReferenceCsys ( int  id)
inline

The selected reference coordinate system

Created in NX7.5.1

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

Parameters
idSet Coordinate System
unsafe void NXOpen.CAE.FreeBodyResultsBuilder.SetSelectedReferenceCsysSource ( NXOpen.CAE.Result.CoordinateSystemSource  source)
inline

The source for the selected reference coordinate system

Created in NX7.5.1

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

Parameters
sourceSet Source

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