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

Represents a NXOpen::Motion::LinkCouplerCoupleBuilder
Created in NX12.0.0. More...

Inheritance diagram for NXOpen::Motion::LinkCouplerCoupleBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  MeasurementChoices { MeasurementChoicesTranslation, MeasurementChoicesRotation, MeasurementChoicesDistance }
 the Measurement type. More...
 
enum  ScaleChoices { ScaleChoicesExpression, ScaleChoicesFunction, ScaleChoicesProfile }
 the Scale type. More...
 

Public Member Functions

NXOpen::Motion::LinkAttachmentDataActionLinkAttachment ()
 Returns the Action Link Attachment
Created in NX11.0.0. More...
 
NXOpen::Motion::LinkAttachmentDataBaseLinkAttachment ()
 Returns the Base Link Attachment
Created in NX11.0.0. More...
 
NXOpen::Motion::LinkCouplerCoupleBuilder::MeasurementChoices MeasurementType ()
 Returns the measurement type
Created in NX12.0.0. More...
 
NXOpen::ExpressionScaleExpression ()
 Returns the scale expression
Created in NX12.0.0. More...
 
NXOpen::Motion::MotionFunctionScaleFunction ()
 Returns the scale spline curve
Created in NX12.0.0. More...
 
NXOpen::Motion::SelectFieldDataScaleProfile ()
 Returns the profile
Created in NX12.0.0. More...
 
NXOpen::Motion::LinkCouplerCoupleBuilder::ScaleChoices ScaleType ()
 Returns the scale type
Created in NX12.0.0. More...
 
void SetMeasurementType (NXOpen::Motion::LinkCouplerCoupleBuilder::MeasurementChoices type)
 Sets the measurement type
Created in NX12.0.0. More...
 
void SetScaleFunction (NXOpen::Motion::MotionFunction *spline)
 Sets the scale spline curve
Created in NX12.0.0. More...
 
void SetScaleType (NXOpen::Motion::LinkCouplerCoupleBuilder::ScaleChoices type)
 Sets the scale type
Created in NX12.0.0. 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::Motion::LinkCouplerCoupleBuilder
Created in NX12.0.0.


Member Enumeration Documentation

the Measurement type.

Enumerator
MeasurementChoicesTranslation 

Translation.

MeasurementChoicesRotation 

Rotation.

MeasurementChoicesDistance 

Distance.

the Scale type.

Enumerator
ScaleChoicesExpression 

Expression.

ScaleChoicesFunction 

Function.

ScaleChoicesProfile 

Profile.

Member Function Documentation

NXOpen::Motion::LinkAttachmentData* NXOpen::Motion::LinkCouplerCoupleBuilder::ActionLinkAttachment ( )

Returns the Action Link Attachment
Created in NX11.0.0.



License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::LinkAttachmentData* NXOpen::Motion::LinkCouplerCoupleBuilder::BaseLinkAttachment ( )

Returns the Base Link Attachment
Created in NX11.0.0.



License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::LinkCouplerCoupleBuilder::MeasurementChoices NXOpen::Motion::LinkCouplerCoupleBuilder::MeasurementType ( )

Returns the measurement type
Created in NX12.0.0.



License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::LinkCouplerCoupleBuilder::ScaleExpression ( )

Returns the scale expression
Created in NX12.0.0.



License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::MotionFunction* NXOpen::Motion::LinkCouplerCoupleBuilder::ScaleFunction ( )

Returns the scale spline curve
Created in NX12.0.0.



License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::SelectFieldData* NXOpen::Motion::LinkCouplerCoupleBuilder::ScaleProfile ( )

Returns the profile
Created in NX12.0.0.



License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::LinkCouplerCoupleBuilder::ScaleChoices NXOpen::Motion::LinkCouplerCoupleBuilder::ScaleType ( )

Returns the scale type
Created in NX12.0.0.



License requirements : mechanisms ("MECHANISMS")

void NXOpen::Motion::LinkCouplerCoupleBuilder::SetMeasurementType ( NXOpen::Motion::LinkCouplerCoupleBuilder::MeasurementChoices  type)

Sets the measurement type
Created in NX12.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
typetype
void NXOpen::Motion::LinkCouplerCoupleBuilder::SetScaleFunction ( NXOpen::Motion::MotionFunction spline)

Sets the scale spline curve
Created in NX12.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
splinespline
void NXOpen::Motion::LinkCouplerCoupleBuilder::SetScaleType ( NXOpen::Motion::LinkCouplerCoupleBuilder::ScaleChoices  type)

Sets the scale type
Created in NX12.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
typetype
virtual bool NXOpen::Motion::LinkCouplerCoupleBuilder::Validate ( )
virtual

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven't set it. This method throws a not-yet-implemented NXException for some components.

Returns
Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.


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