NXOpen C++ Reference Guide
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Types | Public Member Functions | List of all members
NXOpen::Motion::BeamForceBuilder Class Reference

Represents a Motion::BeamForceBuilder builder
To create a new instance of this class, use NXOpen::Motion::BeamForceCollection::CreateBeamForceBuilder
Default values. More...

Inheritance diagram for NXOpen::Motion::BeamForceBuilder:
NXOpen::Motion::MotionBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  DampingTypes { DampingTypesViscous, DampingTypesStructural }
 the damping type More...
 
enum  VectorTypes { VectorTypesY, VectorTypesZ }
 the vector direction of the beam force More...
 

Public Member Functions

NXOpen::Motion::SelectLinkActionLink ()
 Returns the action motion body object
Created in NX12.0.0. More...
 
NXOpen::Motion::ParamOverrideState ActionLinkOvrCtrl ()
 Returns. More...
 
NXOpen::PointActionPoint ()
 Returns the action point. More...
 
NXOpen::Motion::ParamOverrideState ActionPointOvrCtrl ()
 Returns. More...
 
NXOpen::ExpressionArea ()
 Returns the area
Created in NX12.0.0. More...
 
NXOpen::ExpressionAsyTimoshenkoCorrection ()
 Returns the ASY Timoshenko correction
Created in NX12.0.0. More...
 
NXOpen::ExpressionAszTimoshenkoCorrection ()
 Returns the ASZ Timoshenko correction
Created in NX12.0.0. More...
 
NXOpen::Motion::SelectLinkBaseLink ()
 Returns the base Motion body object
Created in NX12.0.0. More...
 
NXOpen::Motion::ParamOverrideState BaseLinkOvrCtrl ()
 Returns. More...
 
NXOpen::PointBasePoint ()
 Returns the base point. More...
 
NXOpen::Motion::ParamOverrideState BasePointOvrCtrl ()
 Returns. More...
 
NXOpen::Motion::CustomizedMaterialBuilderCustomizedMaterial ()
 Returns the customized material
Created in NX12.0.0. More...
 
NXOpen::ExpressionDampingRatio ()
 Returns the damping ratio
Created in NX12.0.0. More...
 
NXOpen::Motion::BeamForceBuilder::DampingTypes DampingType ()
 Returns the damping method
Created in NX12.0.0. More...
 
NXOpen::DirectionDirection ()
 Returns the direction
Created in NX12.0.0. More...
 
NXOpen::Motion::ParamOverrideState DirectionOvrCtrl ()
 Returns. More...
 
NXOpen::ExpressionFreeLength ()
 Returns the free length
Created in NX12.0.0. More...
 
NXOpen::ExpressionInertiaIyy ()
 Returns the inertia Iyy
Created in NX12.0.0. More...
 
NXOpen::ExpressionInertiaIzz ()
 Returns the inertia Izz
Created in NX12.0.0. More...
 
NXOpen::ExpressionInertiaK ()
 Returns the inertia K
Created in NX12.0.0. More...
 
bool IsBeamCrossDamping ()
 Returns the beam cross damping flag
Created in NX12.0.0. More...
 
NXString Name ()
 Returns the name of the beam force object
Created in NX12.0.0. More...
 
void SetActionLinkOvrCtrl (NXOpen::Motion::ParamOverrideState overrideState)
 Sets. More...
 
void SetActionPoint (NXOpen::Point *actionPoint)
 Sets the action point. More...
 
void SetActionPointOvrCtrl (NXOpen::Motion::ParamOverrideState overrideState)
 Sets. More...
 
void SetBaseLinkOvrCtrl (NXOpen::Motion::ParamOverrideState overrideState)
 Sets. More...
 
void SetBasePoint (NXOpen::Point *basePoint)
 Sets the base point. More...
 
void SetBasePointOvrCtrl (NXOpen::Motion::ParamOverrideState overrideState)
 Sets. More...
 
void SetBeamCrossDamping (bool type)
 Sets the beam cross damping flag
Created in NX12.0.0. More...
 
void SetDampingType (NXOpen::Motion::BeamForceBuilder::DampingTypes type)
 Sets the damping method
Created in NX12.0.0. More...
 
void SetDirection (NXOpen::Direction *direction)
 Sets the direction
Created in NX12.0.0. More...
 
void SetDirectionOvrCtrl (NXOpen::Motion::ParamOverrideState overrideState)
 Sets. More...
 
void SetName (const NXString &name)
 Sets the name of the beam force object
Created in NX12.0.0. More...
 
void SetName (const char *name)
 Sets the name of the beam force object
Created in NX12.0.0. More...
 
void SetVectorType (NXOpen::Motion::BeamForceBuilder::VectorTypes vectorType)
 Sets the orientation of beam force
Created in NX12.0.0. More...
 
void SetVectorTypeOvrCtrl (NXOpen::Motion::ParamOverrideState overrideState)
 Sets. More...
 
NXOpen::Motion::BeamForceBuilder::VectorTypes VectorType ()
 Returns the orientation of beam force
Created in NX12.0.0. More...
 
NXOpen::Motion::ParamOverrideState VectorTypeOvrCtrl ()
 Returns. More...
 
- Public Member Functions inherited from NXOpen::Motion::MotionBuilder
double DisplayScale ()
 Returns the icon display scale
Created in NX5.0.0. More...
 
NXString GroupName ()
 Returns the group name
Created in NX5.0.0. More...
 
NXOpen::Motion::MotionObject::GroupType GroupType ()
 Returns the group type
Created in NX5.0.0. More...
 
void SetDisplayScale (double displayScale)
 Sets the icon display scale
Created in NX5.0.0. More...
 
void SetGroupName (const NXString &groupName)
 Sets the group name
Created in NX5.0.0. More...
 
void SetGroupName (const char *groupName)
 Sets the group name
Created in NX5.0.0. More...
 
void SetGroupType (NXOpen::Motion::MotionObject::GroupType groupType)
 Sets the group type
Created in NX5.0.0. 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

Represents a Motion::BeamForceBuilder builder
To create a new instance of this class, use NXOpen::Motion::BeamForceCollection::CreateBeamForceBuilder
Default values.

Property Value

Area.Value

100

CustomizedMaterial.Density.Value

7.8e-6 (millimeters part), 7.3e-4 (inches part)

CustomizedMaterial.PoissonRatio.Value

0.3

CustomizedMaterial.YoungModulus.Value

2e+8 (millimeters part), 2.9e+7 (inches part)

DampingType

Viscous


Created in NX12.0.0.

Member Enumeration Documentation

the damping type

Enumerator
DampingTypesViscous 

Viscous.

DampingTypesStructural 

Structural.

the vector direction of the beam force

Enumerator
VectorTypesY 

Y Vector.

VectorTypesZ 

Z Vector.

Member Function Documentation

NXOpen::Motion::SelectLink* NXOpen::Motion::BeamForceBuilder::ActionLink ( )

Returns the action motion body object
Created in NX12.0.0.



License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::ParamOverrideState NXOpen::Motion::BeamForceBuilder::ActionLinkOvrCtrl ( )

Returns.

the override state of the action link


Created in NX1847.0.0.

License requirements : None

NXOpen::Point* NXOpen::Motion::BeamForceBuilder::ActionPoint ( )

Returns the action point.


Created in NX12.0.0.

License requirements : None

NXOpen::Motion::ParamOverrideState NXOpen::Motion::BeamForceBuilder::ActionPointOvrCtrl ( )

Returns.

the override state of the action point


Created in NX1847.0.0.

License requirements : None

NXOpen::Expression* NXOpen::Motion::BeamForceBuilder::Area ( )

Returns the area
Created in NX12.0.0.



License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::BeamForceBuilder::AsyTimoshenkoCorrection ( )

Returns the ASY Timoshenko correction
Created in NX12.0.0.



License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::BeamForceBuilder::AszTimoshenkoCorrection ( )

Returns the ASZ Timoshenko correction
Created in NX12.0.0.



License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::SelectLink* NXOpen::Motion::BeamForceBuilder::BaseLink ( )

Returns the base Motion body object
Created in NX12.0.0.



License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::ParamOverrideState NXOpen::Motion::BeamForceBuilder::BaseLinkOvrCtrl ( )

Returns.

the override state of the Base link


Created in NX1847.0.0.

License requirements : None

NXOpen::Point* NXOpen::Motion::BeamForceBuilder::BasePoint ( )

Returns the base point.


Created in NX12.0.0.

License requirements : None

NXOpen::Motion::ParamOverrideState NXOpen::Motion::BeamForceBuilder::BasePointOvrCtrl ( )

Returns.

the override state of the base point


Created in NX1847.0.0.

License requirements : None

NXOpen::Motion::CustomizedMaterialBuilder* NXOpen::Motion::BeamForceBuilder::CustomizedMaterial ( )

Returns the customized material
Created in NX12.0.0.



License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::BeamForceBuilder::DampingRatio ( )

Returns the damping ratio
Created in NX12.0.0.



License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::BeamForceBuilder::DampingTypes NXOpen::Motion::BeamForceBuilder::DampingType ( )

Returns the damping method
Created in NX12.0.0.



License requirements : mechanisms ("MECHANISMS")

NXOpen::Direction* NXOpen::Motion::BeamForceBuilder::Direction ( )

Returns the direction
Created in NX12.0.0.



License requirements : None

NXOpen::Motion::ParamOverrideState NXOpen::Motion::BeamForceBuilder::DirectionOvrCtrl ( )

Returns.

the override state of the direction


Created in NX1847.0.0.

License requirements : None

NXOpen::Expression* NXOpen::Motion::BeamForceBuilder::FreeLength ( )

Returns the free length
Created in NX12.0.0.



License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::BeamForceBuilder::InertiaIyy ( )

Returns the inertia Iyy
Created in NX12.0.0.



License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::BeamForceBuilder::InertiaIzz ( )

Returns the inertia Izz
Created in NX12.0.0.



License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::BeamForceBuilder::InertiaK ( )

Returns the inertia K
Created in NX12.0.0.



License requirements : mechanisms ("MECHANISMS")

bool NXOpen::Motion::BeamForceBuilder::IsBeamCrossDamping ( )

Returns the beam cross damping flag
Created in NX12.0.0.



License requirements : mechanisms ("MECHANISMS")

NXString NXOpen::Motion::BeamForceBuilder::Name ( )

Returns the name of the beam force object
Created in NX12.0.0.



License requirements : mechanisms ("MECHANISMS")

void NXOpen::Motion::BeamForceBuilder::SetActionLinkOvrCtrl ( NXOpen::Motion::ParamOverrideState  overrideState)

Sets.

the override state of the action link


Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
overrideStateoverridestate
void NXOpen::Motion::BeamForceBuilder::SetActionPoint ( NXOpen::Point actionPoint)

Sets the action point.


Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
actionPointactionpoint
void NXOpen::Motion::BeamForceBuilder::SetActionPointOvrCtrl ( NXOpen::Motion::ParamOverrideState  overrideState)

Sets.

the override state of the action point


Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
overrideStateoverridestate
void NXOpen::Motion::BeamForceBuilder::SetBaseLinkOvrCtrl ( NXOpen::Motion::ParamOverrideState  overrideState)

Sets.

the override state of the Base link


Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
overrideStateoverridestate
void NXOpen::Motion::BeamForceBuilder::SetBasePoint ( NXOpen::Point basePoint)

Sets the base point.


Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
basePointbasepoint
void NXOpen::Motion::BeamForceBuilder::SetBasePointOvrCtrl ( NXOpen::Motion::ParamOverrideState  overrideState)

Sets.

the override state of the base point


Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
overrideStateoverridestate
void NXOpen::Motion::BeamForceBuilder::SetBeamCrossDamping ( bool  type)

Sets the beam cross damping flag
Created in NX12.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
typetype
void NXOpen::Motion::BeamForceBuilder::SetDampingType ( NXOpen::Motion::BeamForceBuilder::DampingTypes  type)

Sets the damping method
Created in NX12.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
typetype
void NXOpen::Motion::BeamForceBuilder::SetDirection ( NXOpen::Direction direction)

Sets the direction
Created in NX12.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
directiondirection
void NXOpen::Motion::BeamForceBuilder::SetDirectionOvrCtrl ( NXOpen::Motion::ParamOverrideState  overrideState)

Sets.

the override state of the direction


Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
overrideStateoverridestate
void NXOpen::Motion::BeamForceBuilder::SetName ( const NXString name)

Sets the name of the beam force object
Created in NX12.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
namename
void NXOpen::Motion::BeamForceBuilder::SetName ( const char *  name)

Sets the name of the beam force object
Created in NX12.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
namename
void NXOpen::Motion::BeamForceBuilder::SetVectorType ( NXOpen::Motion::BeamForceBuilder::VectorTypes  vectorType)

Sets the orientation of beam force
Created in NX12.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
vectorTypevectortype
void NXOpen::Motion::BeamForceBuilder::SetVectorTypeOvrCtrl ( NXOpen::Motion::ParamOverrideState  overrideState)

Sets.

the override state of the VectorType


Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
overrideStateoverridestate
NXOpen::Motion::BeamForceBuilder::VectorTypes NXOpen::Motion::BeamForceBuilder::VectorType ( )

Returns the orientation of beam force
Created in NX12.0.0.



License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::ParamOverrideState NXOpen::Motion::BeamForceBuilder::VectorTypeOvrCtrl ( )

Returns.

the override state of the VectorType


Created in NX1847.0.0.

License requirements : None


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