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

enables the ability to apply delta transforms on individual instances of a pattern within the pattern feature
To create a new instance of this class, use NXOpen::GeometricUtilities::PatternDefinition::CreateClockingBuilder
Default values. More...

Inheritance diagram for NXOpen::GeometricUtilities::PatternClockingBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  ClockingType { ClockingTypeWithinPatternDefinitionLinear, ClockingTypeWithinPatternDefinitionCircular, ClockingTypeUserDefined }
 type of pattern clocking to transform individual instances More...
 

Public Member Functions

void AddInstance (int index1, int index2)
 Adds an instance that will get this clocking
Created in NX8.0.0. More...
 
NXOpen::ExpressionAngularDelta ()
 Returns the angular delta for circular clocking
Created in NX8.0.0. More...
 
NXOpen::GeometricUtilities::PatternClockingBuilder::ClockingType ClockType ()
 Returns the clocking enum to determine if linear or angular clocking
Created in NX8.0.0. More...
 
NXOpen::ExpressionDirection1Delta ()
 Returns the x direction delta for linear clocking
Created in NX8.0.0. More...
 
NXOpen::ExpressionDirection2Delta ()
 Returns the y direction delta for linear clocking
Created in NX8.0.0. More...
 
NXOpen::GeometricUtilities::ModlMotionMotion ()
 Returns the user defined transform motion
Created in NX8.0.0. More...
 
NXOpen::ExpressionRadialDelta ()
 Returns the radial delta for circular clocking
Created in NX8.0.0. More...
 
void RemoveInstance (int index1, int index2)
 Removes an instance from this clocking
Created in NX8.0.0. More...
 
void SetClockType (NXOpen::GeometricUtilities::PatternClockingBuilder::ClockingType clockType)
 Sets the clocking enum to determine if linear or angular clocking
Created in NX8.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

enables the ability to apply delta transforms on individual instances of a pattern within the pattern feature
To create a new instance of this class, use NXOpen::GeometricUtilities::PatternDefinition::CreateClockingBuilder
Default values.

Property Value

Motion.DeltaEnum

ReferenceWcsWorkPart

Motion.DeltaXc.Value

0.0

Motion.DeltaYc.Value

0.0

Motion.DeltaZc.Value

0.0


Created in NX8.0.0.

Member Enumeration Documentation

type of pattern clocking to transform individual instances

Enumerator
ClockingTypeWithinPatternDefinitionLinear 

within pattern definition linear

ClockingTypeWithinPatternDefinitionCircular 

within pattern definition circular

ClockingTypeUserDefined 

user defined

Member Function Documentation

void NXOpen::GeometricUtilities::PatternClockingBuilder::AddInstance ( int  index1,
int  index2 
)

Adds an instance that will get this clocking
Created in NX8.0.0.



License requirements : None

Parameters
index1first index into the instance array to add clocking
index2second index into the instance array to add clocking
NXOpen::Expression* NXOpen::GeometricUtilities::PatternClockingBuilder::AngularDelta ( )

Returns the angular delta for circular clocking
Created in NX8.0.0.



License requirements : None

NXOpen::GeometricUtilities::PatternClockingBuilder::ClockingType NXOpen::GeometricUtilities::PatternClockingBuilder::ClockType ( )

Returns the clocking enum to determine if linear or angular clocking
Created in NX8.0.0.



License requirements : None

NXOpen::Expression* NXOpen::GeometricUtilities::PatternClockingBuilder::Direction1Delta ( )

Returns the x direction delta for linear clocking
Created in NX8.0.0.



License requirements : None

NXOpen::Expression* NXOpen::GeometricUtilities::PatternClockingBuilder::Direction2Delta ( )

Returns the y direction delta for linear clocking
Created in NX8.0.0.



License requirements : None

NXOpen::GeometricUtilities::ModlMotion* NXOpen::GeometricUtilities::PatternClockingBuilder::Motion ( )

Returns the user defined transform motion
Created in NX8.0.0.



License requirements : None

NXOpen::Expression* NXOpen::GeometricUtilities::PatternClockingBuilder::RadialDelta ( )

Returns the radial delta for circular clocking
Created in NX8.0.0.



License requirements : None

void NXOpen::GeometricUtilities::PatternClockingBuilder::RemoveInstance ( int  index1,
int  index2 
)

Removes an instance from this clocking
Created in NX8.0.0.



License requirements : None

Parameters
index1first index into the instance array to drop this clocking
index2second index into the instance array to drop this clocking
void NXOpen::GeometricUtilities::PatternClockingBuilder::SetClockType ( NXOpen::GeometricUtilities::PatternClockingBuilder::ClockingType  clockType)

Sets the clocking enum to determine if linear or angular clocking
Created in NX8.0.0.



License requirements : None

Parameters
clockTypeclocking type

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