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

Represents a NXOpen::Mechatronics::BreakingConstraint builder. More...

Inheritance diagram for NXOpen::Mechatronics::BreakingConstraintBuilder:
NXOpen::Mechatronics::PhysicsConstraintBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  BreakingModeType { BreakingModeTypeForce, BreakingModeTypeTorque }
 Represents the breaking mode. More...
 

Public Member Functions

NXOpen::Mechatronics::BreakingConstraintBuilder::BreakingModeType BreakingMode ()
 Returns the breaking mode. More...
 
NXOpen::DirectionDirection ()
 Returns the direction. More...
 
bool FixedDirection ()
 Returns the direction is fixed or not. More...
 
NXOpen::Mechatronics::SelectPhysicsJointJoint ()
 Returns the joint object. More...
 
NXOpen::ExpressionMaximumMagnitude ()
 Returns the maximum allowable magnitude, the joint will be broken if it exceeds this value. More...
 
void SetBreakingMode (NXOpen::Mechatronics::BreakingConstraintBuilder::BreakingModeType breakingMode)
 Sets the breaking mode. More...
 
void SetDirection (NXOpen::Direction *direction)
 Sets the direction. More...
 
void SetFixedDirection (bool fixedDirection)
 Sets the direction is fixed or not. More...
 
void SetJoint (NXOpen::Mechatronics::PhysicsJoint *joint)
 Sets the joint. More...
 
- Public Member Functions inherited from NXOpen::Mechatronics::PhysicsConstraintBuilder
NXString Name ()
 Returns the name. More...
 
void SetName (const NXString &name)
 Sets the name. More...
 
void SetName (const char *name)
 Sets the name. 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 NXOpen::Mechatronics::BreakingConstraint builder.


To create a new instance of this class, use NXOpen::Mechatronics::BreakingConstraintCollection::CreateBreakingConstraintBuilder

Created in NX7.5.1.

Member Enumeration Documentation

Represents the breaking mode.

Enumerator
BreakingModeTypeForce 

Force.

BreakingModeTypeTorque 

Torque.

Member Function Documentation

NXOpen::Mechatronics::BreakingConstraintBuilder::BreakingModeType NXOpen::Mechatronics::BreakingConstraintBuilder::BreakingMode ( )

Returns the breaking mode.


Created in NX7.5.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Direction* NXOpen::Mechatronics::BreakingConstraintBuilder::Direction ( )

Returns the direction.


Created in NX7.5.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

bool NXOpen::Mechatronics::BreakingConstraintBuilder::FixedDirection ( )

Returns the direction is fixed or not.


Created in NX7.5.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Mechatronics::SelectPhysicsJoint* NXOpen::Mechatronics::BreakingConstraintBuilder::Joint ( )

Returns the joint object.

It can be any type of joints.
Created in NX7.5.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Expression* NXOpen::Mechatronics::BreakingConstraintBuilder::MaximumMagnitude ( )

Returns the maximum allowable magnitude, the joint will be broken if it exceeds this value.


Created in NX7.5.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

void NXOpen::Mechatronics::BreakingConstraintBuilder::SetBreakingMode ( NXOpen::Mechatronics::BreakingConstraintBuilder::BreakingModeType  breakingMode)

Sets the breaking mode.


Created in NX7.5.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
breakingModebreakingmode
void NXOpen::Mechatronics::BreakingConstraintBuilder::SetDirection ( NXOpen::Direction direction)

Sets the direction.


Created in NX7.5.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
directiondirection
void NXOpen::Mechatronics::BreakingConstraintBuilder::SetFixedDirection ( bool  fixedDirection)

Sets the direction is fixed or not.


Created in NX7.5.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
fixedDirectionfixeddirection
void NXOpen::Mechatronics::BreakingConstraintBuilder::SetJoint ( NXOpen::Mechatronics::PhysicsJoint joint)

Sets the joint.


Created in NX7.5.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
jointjoint

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