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

Inheritance diagram for NXOpen::CAE::FreeBodyResultsBuilder:

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::NXColor *	GetForceColor ()
	Force Color.

NXOpen::CAE::FreeBodyResultsBuilder::VectorDisplay	GetForceVectorDisplay ()
	Force vector display.

NXOpen::CAE::BaseIteration *	GetIteration ()
	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::NXColor *	GetMomentColor ()
	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.

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

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

Created in NX7.5.1.

Member Enumeration Documentation

enum NXOpen::CAE::FreeBodyResultsBuilder::LocationMethod

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

enum NXOpen::CAE::FreeBodyResultsBuilder::OutputUnits

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.

enum NXOpen::CAE::FreeBodyResultsBuilder::VectorDisplay

Vector display option.

Enumerator:

VectorDisplayMagnitude	display single magnitude vector
VectorDisplayComponents	display individual components

Member Function Documentation

bool NXOpen::CAE::FreeBodyResultsBuilder::GetDisplayForce ( )

Display Force.

Returns: Ask Display
Created in NX7.5.1.

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

bool NXOpen::CAE::FreeBodyResultsBuilder::GetDisplayMoment ( )

Display Moment.

Returns: Ask Moment
Created in NX7.5.1.

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

std::vector<int> NXOpen::CAE::FreeBodyResultsBuilder::GetElements ( )

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

NXOpen::NXColor* NXOpen::CAE::FreeBodyResultsBuilder::GetForceColor ( )

Force Color.

Returns: Ask Color
Created in NX7.5.1.

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

NXOpen::CAE::FreeBodyResultsBuilder::VectorDisplay NXOpen::CAE::FreeBodyResultsBuilder::GetForceVectorDisplay ( )

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

NXOpen::CAE::BaseIteration* NXOpen::CAE::FreeBodyResultsBuilder::GetIteration ( )

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

NXOpen::Point3d NXOpen::CAE::FreeBodyResultsBuilder::GetLocationCoords ( )

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

int NXOpen::CAE::FreeBodyResultsBuilder::GetLocationCsys ( )

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

NXOpen::CAE::Result::CoordinateSystemSource NXOpen::CAE::FreeBodyResultsBuilder::GetLocationCsysSource ( )

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

int NXOpen::CAE::FreeBodyResultsBuilder::GetLocationId ( )

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

NXOpen::CAE::FreeBodyResultsBuilder::LocationMethod NXOpen::CAE::FreeBodyResultsBuilder::GetLocationMethod ( )

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

NXOpen::NXColor* NXOpen::CAE::FreeBodyResultsBuilder::GetMomentColor ( )

Moment Color.

Returns: Ask Color
Created in NX7.5.1.

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

NXOpen::CAE::FreeBodyResultsBuilder::VectorDisplay NXOpen::CAE::FreeBodyResultsBuilder::GetMomentVectorDisplay ( )

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

std::vector<int> NXOpen::CAE::FreeBodyResultsBuilder::GetNodes ( )

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

NXOpen::CAE::FreeBodyResultsBuilder::OutputUnits NXOpen::CAE::FreeBodyResultsBuilder::GetOutputUnits ( )

Output Units.

Returns: Ask Units
Created in NX7.5.1.

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

int NXOpen::CAE::FreeBodyResultsBuilder::GetPostview ( )

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

bool NXOpen::CAE::FreeBodyResultsBuilder::GetPrintOutput ( )

Print Output.

Returns: Ask Print
Created in NX7.5.1.

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

NXOpen::CAE::Result::CoordinateSystem NXOpen::CAE::FreeBodyResultsBuilder::GetReferenceCsys ( )

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

int NXOpen::CAE::FreeBodyResultsBuilder::GetSelectedReferenceCsys ( )

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

NXOpen::CAE::Result::CoordinateSystemSource NXOpen::CAE::FreeBodyResultsBuilder::GetSelectedReferenceCsysSource ( )

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

void NXOpen::CAE::FreeBodyResultsBuilder::SetDisplayForce ( bool display )

Display Force
Created in NX7.5.1.