NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::CAE::NodalForceReportBuilder Class Reference

Nodal Force Report Builder
An instance of this class can not be obtained

Created in NX12.0.0. More...

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

Public Types

enum  CSType { CSTypeGlobal, CSTypeCartesian, CSTypeCylindrical, CSTypeSpherical }
 CSys type definition. More...
 
enum  Force {
  ForceGridPoint, ForceReaction, ForceMpc, ForceApplied,
  ForceGlue, ForceContact
}
 Force type definition. More...
 
enum  LoadcaseSelection { LoadcaseSelectionFirst, LoadcaseSelectionLast, LoadcaseSelectionSpecifyIndex, LoadcaseSelectionAll }
 Loadcase definition method. More...
 

Public Member Functions

bool AddAllForcesAndMoments ()
 Returns the add all forces and moments
Created in NX11.0.2. More...
 
bool AllElems ()
 Returns the all elems
Created in NX11.0.2. More...
 
bool AllNodes ()
 Returns the all nodes
Created in NX11.0.2. More...
 
bool CalculateMomentAboutPoint ()
 Returns the calculate moment about a point option
Created in NX12.0.0. More...
 
NXOpen::CoordinateSystemCsys ()
 Returns the csys
Created in NX11.0.2. More...
 
NXOpen::CAE::NodalForceReportBuilder::CSType CSysType ()
 Returns the csys type
Created in NX11.0.2. More...
 
bool Deformation ()
 Returns the deformation
Created in NX11.0.2. More...
 
NXOpen::CAE::SelectElementsBuilderElemRefs ()
 Returns the select elements
Created in NX11.0.2. More...
 
NXOpen::CAE::NodalForceReportBuilder::Force ForceType ()
 Returns the force type
Created in NX11.0.2. More...
 
bool GridPointAppliedForce ()
 Returns the grid point applied force
Created in NX11.0.2. More...
 
bool GridPointForce ()
 Returns the grid point force
Created in NX11.0.2. More...
 
bool GridPointReactionForce ()
 Returns the grid point reaction force
Created in NX11.0.2. More...
 
bool GridPointReactionForceMPC ()
 Returns the grid point reaction force mpc
Created in NX11.0.2. More...
 
int LoadCaseIndex ()
 Returns the loadcase index
Created in NX11.0.2. More...
 
NXOpen::CAE::NodalForceReportBuilder::LoadcaseSelection LoadCaseType ()
 Returns the loadcase setting
Created in NX11.0.2. More...
 
NXString NfrName ()
 Returns the nfr name
Created in NX11.0.2. More...
 
NXOpen::CAE::SelectFENodeListNodeRefs ()
 Returns the select nodes
Created in NX11.0.2. More...
 
NXOpen::PointRefPoint ()
 Returns the reference point
Created in NX11.0.2. More...
 
void SetAddAllForcesAndMoments (bool addAllForcesAndMoments)
 Sets the add all forces and moments
Created in NX11.0.2. More...
 
void SetAllElems (bool allElems)
 Sets the all elems
Created in NX11.0.2. More...
 
void SetAllNodes (bool allNodes)
 Sets the all nodes
Created in NX11.0.2. More...
 
void SetCalculateMomentAboutPoint (bool calculateMomentAboutPoint)
 Sets the calculate moment about a point option
Created in NX11.0.2. More...
 
void SetCsys (NXOpen::CoordinateSystem *csys)
 Sets the csys
Created in NX11.0.2. More...
 
void SetCSysType (NXOpen::CAE::NodalForceReportBuilder::CSType cSysType)
 Sets the csys type
Created in NX11.0.2. More...
 
void SetDeformation (bool deformation)
 Sets the deformation
Created in NX11.0.2. More...
 
void SetForceType (NXOpen::CAE::NodalForceReportBuilder::Force forceType)
 Sets the force type
Created in NX11.0.2. More...
 
void SetGridPointAppliedForce (bool gridPointAppliedForce)
 Sets the grid point applied force
Created in NX11.0.2. More...
 
void SetGridPointForce (bool gridPointForce)
 Sets the grid point force
Created in NX11.0.2. More...
 
void SetGridPointReactionForce (bool gridPointReactionForce)
 Sets the grid point reaction force
Created in NX11.0.2. More...
 
void SetGridPointReactionForceMPC (bool gridPointReactionForceMPC)
 Sets the grid point reaction force mpc
Created in NX11.0.2. More...
 
void SetLoadCaseIndex (int loadcaseIndex)
 Sets the loadcase index
Created in NX11.0.2. More...
 
void SetLoadCaseType (NXOpen::CAE::NodalForceReportBuilder::LoadcaseSelection loadcaseSetting)
 Sets the loadcase setting
Created in NX11.0.2. More...
 
void SetNfrName (const NXString &nfrName)
 Sets the nfr name
Created in NX11.0.2. More...
 
void SetNfrName (const char *nfrName)
 Sets the nfr name
Created in NX11.0.2. More...
 
void SetRefPoint (NXOpen::Point *refPoint)
 Sets the reference point
Created in NX11.0.2. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Nodal Force Report Builder
An instance of this class can not be obtained

Created in NX12.0.0.


Member Enumeration Documentation

CSys type definition.

Enumerator
CSTypeGlobal 

global

CSTypeCartesian 

cartesian

CSTypeCylindrical 

cylindrical

CSTypeSpherical 

spherical

Force type definition.

Enumerator
ForceGridPoint 

grid point

ForceReaction 

reaction

ForceMpc 

mpc

ForceApplied 

applied

ForceGlue 

glue

ForceContact 

contact

Loadcase definition method.

Enumerator
LoadcaseSelectionFirst 

first

LoadcaseSelectionLast 

last

LoadcaseSelectionSpecifyIndex 

specify index

LoadcaseSelectionAll 

all

Member Function Documentation

bool NXOpen::CAE::NodalForceReportBuilder::AddAllForcesAndMoments ( )

Returns the add all forces and moments
Created in NX11.0.2.



License requirements : None

bool NXOpen::CAE::NodalForceReportBuilder::AllElems ( )

Returns the all elems
Created in NX11.0.2.



License requirements : None

bool NXOpen::CAE::NodalForceReportBuilder::AllNodes ( )

Returns the all nodes
Created in NX11.0.2.



License requirements : None

bool NXOpen::CAE::NodalForceReportBuilder::CalculateMomentAboutPoint ( )

Returns the calculate moment about a point option
Created in NX12.0.0.



License requirements : None

NXOpen::CoordinateSystem* NXOpen::CAE::NodalForceReportBuilder::Csys ( )

Returns the csys
Created in NX11.0.2.



License requirements : None

NXOpen::CAE::NodalForceReportBuilder::CSType NXOpen::CAE::NodalForceReportBuilder::CSysType ( )

Returns the csys type
Created in NX11.0.2.



License requirements : None

bool NXOpen::CAE::NodalForceReportBuilder::Deformation ( )

Returns the deformation
Created in NX11.0.2.



License requirements : None

NXOpen::CAE::SelectElementsBuilder* NXOpen::CAE::NodalForceReportBuilder::ElemRefs ( )

Returns the select elements
Created in NX11.0.2.



License requirements : None

NXOpen::CAE::NodalForceReportBuilder::Force NXOpen::CAE::NodalForceReportBuilder::ForceType ( )

Returns the force type
Created in NX11.0.2.



License requirements : None

bool NXOpen::CAE::NodalForceReportBuilder::GridPointAppliedForce ( )

Returns the grid point applied force
Created in NX11.0.2.



License requirements : None

bool NXOpen::CAE::NodalForceReportBuilder::GridPointForce ( )

Returns the grid point force
Created in NX11.0.2.



License requirements : None

bool NXOpen::CAE::NodalForceReportBuilder::GridPointReactionForce ( )

Returns the grid point reaction force
Created in NX11.0.2.



License requirements : None

bool NXOpen::CAE::NodalForceReportBuilder::GridPointReactionForceMPC ( )

Returns the grid point reaction force mpc
Created in NX11.0.2.



License requirements : None

int NXOpen::CAE::NodalForceReportBuilder::LoadCaseIndex ( )

Returns the loadcase index
Created in NX11.0.2.



License requirements : None

NXOpen::CAE::NodalForceReportBuilder::LoadcaseSelection NXOpen::CAE::NodalForceReportBuilder::LoadCaseType ( )

Returns the loadcase setting
Created in NX11.0.2.



License requirements : None

NXString NXOpen::CAE::NodalForceReportBuilder::NfrName ( )

Returns the nfr name
Created in NX11.0.2.



License requirements : None

NXOpen::CAE::SelectFENodeList* NXOpen::CAE::NodalForceReportBuilder::NodeRefs ( )

Returns the select nodes
Created in NX11.0.2.



License requirements : None

NXOpen::Point* NXOpen::CAE::NodalForceReportBuilder::RefPoint ( )

Returns the reference point
Created in NX11.0.2.



License requirements : None

void NXOpen::CAE::NodalForceReportBuilder::SetAddAllForcesAndMoments ( bool  addAllForcesAndMoments)

Sets the add all forces and moments
Created in NX11.0.2.



License requirements : None

Parameters
addAllForcesAndMomentsaddallforcesandmoments
void NXOpen::CAE::NodalForceReportBuilder::SetAllElems ( bool  allElems)

Sets the all elems
Created in NX11.0.2.



License requirements : None

Parameters
allElemsallelems
void NXOpen::CAE::NodalForceReportBuilder::SetAllNodes ( bool  allNodes)

Sets the all nodes
Created in NX11.0.2.



License requirements : None

Parameters
allNodesallnodes
void NXOpen::CAE::NodalForceReportBuilder::SetCalculateMomentAboutPoint ( bool  calculateMomentAboutPoint)

Sets the calculate moment about a point option
Created in NX11.0.2.



License requirements : None

Parameters
calculateMomentAboutPointcalculatemomentaboutpoint
void NXOpen::CAE::NodalForceReportBuilder::SetCsys ( NXOpen::CoordinateSystem csys)

Sets the csys
Created in NX11.0.2.



License requirements : None

Parameters
csyscsys
void NXOpen::CAE::NodalForceReportBuilder::SetCSysType ( NXOpen::CAE::NodalForceReportBuilder::CSType  cSysType)

Sets the csys type
Created in NX11.0.2.



License requirements : None

Parameters
cSysTypecsystype
void NXOpen::CAE::NodalForceReportBuilder::SetDeformation ( bool  deformation)

Sets the deformation
Created in NX11.0.2.



License requirements : None

Parameters
deformationdeformation
void NXOpen::CAE::NodalForceReportBuilder::SetForceType ( NXOpen::CAE::NodalForceReportBuilder::Force  forceType)

Sets the force type
Created in NX11.0.2.



License requirements : None

Parameters
forceTypeforcetype
void NXOpen::CAE::NodalForceReportBuilder::SetGridPointAppliedForce ( bool  gridPointAppliedForce)

Sets the grid point applied force
Created in NX11.0.2.



License requirements : None

Parameters
gridPointAppliedForcegridpointappliedforce
void NXOpen::CAE::NodalForceReportBuilder::SetGridPointForce ( bool  gridPointForce)

Sets the grid point force
Created in NX11.0.2.



License requirements : None

Parameters
gridPointForcegridpointforce
void NXOpen::CAE::NodalForceReportBuilder::SetGridPointReactionForce ( bool  gridPointReactionForce)

Sets the grid point reaction force
Created in NX11.0.2.



License requirements : None

Parameters
gridPointReactionForcegridpointreactionforce
void NXOpen::CAE::NodalForceReportBuilder::SetGridPointReactionForceMPC ( bool  gridPointReactionForceMPC)

Sets the grid point reaction force mpc
Created in NX11.0.2.



License requirements : None

Parameters
gridPointReactionForceMPCgridpointreactionforcempc
void NXOpen::CAE::NodalForceReportBuilder::SetLoadCaseIndex ( int  loadcaseIndex)

Sets the loadcase index
Created in NX11.0.2.



License requirements : None

Parameters
loadcaseIndexloadcaseindex
void NXOpen::CAE::NodalForceReportBuilder::SetLoadCaseType ( NXOpen::CAE::NodalForceReportBuilder::LoadcaseSelection  loadcaseSetting)

Sets the loadcase setting
Created in NX11.0.2.



License requirements : None

Parameters
loadcaseSettingloadcasesetting
void NXOpen::CAE::NodalForceReportBuilder::SetNfrName ( const NXString nfrName)

Sets the nfr name
Created in NX11.0.2.



License requirements : None

Parameters
nfrNamenfrname
void NXOpen::CAE::NodalForceReportBuilder::SetNfrName ( const char *  nfrName)

Sets the nfr name
Created in NX11.0.2.



License requirements : None

Parameters
nfrNamenfrname
void NXOpen::CAE::NodalForceReportBuilder::SetRefPoint ( NXOpen::Point refPoint)

Sets the reference point
Created in NX11.0.2.



License requirements : None

Parameters
refPointrefpoint

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