NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::CAE::FreeBodyResultsBuilder Class Reference

Represents a CAE::FreeBodyResultsBuilder
To obtain an instance of this class use Session::ResultManager . More...

Inheritance diagram for NXOpen::CAE::FreeBodyResultsBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

Public Types

enum  LocationMethod { LocationMethodId, LocationMethodCoords, LocationMethodCsysorigin }
 Location definition method. More...
enum  OutputUnits {
  OutputUnitsDefault, OutputUnitsMilliNewton, OutputUnitsMilliMillinewton, OutputUnitsMeterNewton,
  OutputUnitsFtPoundForce, OutputUnitsInPoundForce
}
 User Specified output units. More...
enum  VectorDisplay { VectorDisplayMagnitude, VectorDisplayComponents }
 Vector display option. More...

Public Member Functions

bool GetDisplayForce ()
 Display Force.
bool GetDisplayMoment ()
 Display Moment.
std::vector< int > GetElements ()
 The free body elements.
NXOpen::NXColorGetForceColor ()
 Force Color.
NXOpen::CAE::FreeBodyResultsBuilder::VectorDisplay GetForceVectorDisplay ()
 Force vector display.
NXOpen::CAE::BaseIterationGetIteration ()
 The iteration containing the grid point force results.
NXOpen::Point3d GetLocationCoords ()
 The location definition method by coordinates.
int GetLocationCsys ()
 The location definition method by coordinate system origin.
NXOpen::CAE::Result::CoordinateSystemSource GetLocationCsysSource ()
 The source for the location coordinate system.
int GetLocationId ()
 The location definition method by node id.
NXOpen::CAE::FreeBodyResultsBuilder::LocationMethod GetLocationMethod ()
 The location definition method.
NXOpen::NXColorGetMomentColor ()
 Moment Color.
NXOpen::CAE::FreeBodyResultsBuilder::VectorDisplay GetMomentVectorDisplay ()
 Moment vector display.
std::vector< int > GetNodes ()
 The interface nodes.
NXOpen::CAE::FreeBodyResultsBuilder::OutputUnits GetOutputUnits ()
 Output Units.
int GetPostview ()
 The view where graphics will be displayed.
bool GetPrintOutput ()
 Print Output.
NXOpen::CAE::Result::CoordinateSystem GetReferenceCsys ()
 The reference coordinate system.
int GetSelectedReferenceCsys ()
 The selected reference coordinate system.
NXOpen::CAE::Result::CoordinateSystemSource GetSelectedReferenceCsysSource ()
 The source for the selected reference coordinate system.
void SetDisplayForce (bool display)
 Display Force
Created in NX7.5.1.
void SetDisplayMoment (bool display)
 Display Moment
Created in NX7.5.1.
void SetElements (const std::vector< int > &elements)
 The free body elements
Created in NX7.5.1.
void SetForceColor (NXOpen::NXColor *display)
 Force Color
Created in NX7.5.1.
void SetForceVectorDisplay (NXOpen::CAE::FreeBodyResultsBuilder::VectorDisplay vectorDisplay)
 Force vector display
Created in NX7.5.1.
void SetIteration (NXOpen::CAE::BaseIteration *iteration)
 The iteration containing the grid point force results
Created in NX7.5.1.
void SetLocationCoords (const NXOpen::Point3d &coordinates)
 The location definition method by coordinates
Created in NX7.5.1.
void SetLocationCsys (int id)
 The location definition method by coordinate system origin
Created in NX7.5.1.
void SetLocationCsysSource (NXOpen::CAE::Result::CoordinateSystemSource source)
 The source for the location coordinate system
Created in NX7.5.1.
void SetLocationId (int nodeId)
 The location definition method by node id
Created in NX7.5.1.
void SetLocationMethod (NXOpen::CAE::FreeBodyResultsBuilder::LocationMethod method)
 The location definition method
Created in NX7.5.1.
void SetMomentColor (NXOpen::NXColor *color)
 Moment Color
Created in NX7.5.1.
void SetMomentVectorDisplay (NXOpen::CAE::FreeBodyResultsBuilder::VectorDisplay vectorDisplay)
 Moment vector display
Created in NX7.5.1.
void SetNodes (const std::vector< int > &nodes)
 The interface nodes
Created in NX7.5.1.
void SetOutputUnits (NXOpen::CAE::FreeBodyResultsBuilder::OutputUnits units)
 Output Units
Created in NX7.5.1.
void SetPostview (int postviewId)
 The view where graphics will be displayed
Created in NX7.5.1.
void SetPrintOutput (bool print)
 Print Output
Created in NX7.5.1.
void SetReferenceCsys (NXOpen::CAE::Result::CoordinateSystem csys)
 The reference coordinate system
Created in NX7.5.1.
void SetSelectedReferenceCsys (int id)
 The selected reference coordinate system
Created in NX7.5.1.
void SetSelectedReferenceCsysSource (NXOpen::CAE::Result::CoordinateSystemSource source)
 The source for the selected reference coordinate system
Created in NX7.5.1.

Detailed Description

Represents a CAE::FreeBodyResultsBuilder
To obtain an instance of this class use Session::ResultManager .



Created in NX7.5.1.


Member Enumeration Documentation

Location definition method.

Enumerator:
LocationMethodId 

location is defined by node id

LocationMethodCoords 

location is defined by coordinates

LocationMethodCsysorigin 

location is defined by coordinate system origin

User Specified output units.

Enumerator:
OutputUnitsDefault 

same as Solver Deck Unit

OutputUnitsMilliNewton 

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

OutputUnitsMilliMillinewton 

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

OutputUnitsMeterNewton 

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

OutputUnitsFtPoundForce 

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

OutputUnitsInPoundForce 

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

Vector display option.

Enumerator:
VectorDisplayMagnitude 

display single magnitude vector

VectorDisplayComponents 

display individual components


Member Function Documentation

Display Force.

Returns:
Ask Display
Created in NX7.5.1.

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

Display Moment.

Returns:
Ask Moment
Created in NX7.5.1.

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

The free body elements.

Returns:
Ask Elements
Created in NX7.5.1.

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

Force Color.

Returns:
Ask Color
Created in NX7.5.1.

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

Force vector display.

Returns:
Ask force vector display
Created in NX7.5.1.

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

The iteration containing the grid point force results.

Returns:
Ask Iteration
Created in NX7.5.1.

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

The location definition method by coordinates.

Returns:
Ask Coordinates
Created in NX7.5.1.

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

The location definition method by coordinate system origin.

Returns:
Ask Coordinate System
Created in NX7.5.1.

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

The source for the location coordinate system.

Returns:
Ask Source
Created in NX7.5.1.

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

The location definition method by node id.

Returns:
Ask Node ID
Created in NX7.5.1.

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

The location definition method.

Returns:
Ask Method
Created in NX7.5.1.

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

Moment Color.

Returns:
Ask Color
Created in NX7.5.1.

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

Moment vector display.

Returns:
Ask moment vector display
Created in NX7.5.1.

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

The interface nodes.

Returns:
Ask Nodes
Created in NX7.5.1.

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

Output Units.

Returns:
Ask Units
Created in NX7.5.1.

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

The view where graphics will be displayed.

Returns:
Ask View
Created in NX7.5.1.

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

Print Output.

Returns:
Ask Print
Created in NX7.5.1.

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

The reference coordinate system.

Returns:
Ask Coordinate System
Created in NX7.5.1.

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

The selected reference coordinate system.

Returns:
Ask Coordinate System
Created in NX7.5.1.

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

The source for the selected reference coordinate system.

Returns:
Ask Source
Created in NX7.5.1.

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

Display Force
Created in NX7.5.1.



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

Parameters:
displaySet Display

Display Moment
Created in NX7.5.1.



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

Parameters:
displaySet Moment
void NXOpen::CAE::FreeBodyResultsBuilder::SetElements ( const std::vector< int > &  elements)

The free body elements
Created in NX7.5.1.



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

Parameters:
elementsSet Elements

Force Color
Created in NX7.5.1.



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

Parameters:
displaySet Color

Force vector display
Created in NX7.5.1.



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

Parameters:
vectorDisplaySet force vector display

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")

Parameters:
iterationSet Iteration

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")

Parameters:
coordinatesSet Coordinates

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")

Parameters:
idSet Node Coordinate System

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")

Parameters:
sourceSet Source

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")

Parameters:
nodeIdSet Node ID

The location definition method
Created in NX7.5.1.



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

Parameters:
methodSet Method

Moment Color
Created in NX7.5.1.



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

Parameters:
colorSet Color

Moment vector display
Created in NX7.5.1.



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

Parameters:
vectorDisplaySet moment vector display
void NXOpen::CAE::FreeBodyResultsBuilder::SetNodes ( const std::vector< int > &  nodes)

The interface nodes
Created in NX7.5.1.



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

Parameters:
nodesSet Nodes

Output Units
Created in NX7.5.1.



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

Parameters:
unitsSet Units

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")

Parameters:
postviewIdSet View

Print Output
Created in NX7.5.1.



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

Parameters:
printSet Print

The reference coordinate system
Created in NX7.5.1.



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

Parameters:
csysSet Coordinate System

The selected reference coordinate system
Created in NX7.5.1.



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

Parameters:
idSet Coordinate System

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")

Parameters:
sourceSet Source

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