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

enables the ability to apply delta transforms on individual instances of a pattern
More...

Inheritance diagram for NXOpen::GeometricUtilities::PatternClocking:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

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

Public Member Functions

NXOpen::ExpressionAngularDelta ()
 Returns the angular delta for circular clocking
More...
 
NXOpen::GeometricUtilities::PatternClocking::ClockingType ClockType ()
 Returns the clocking enum to determine if linear or angular clocking
More...
 
NXOpen::ExpressionDirection1Delta ()
 Returns the x direction delta for linear clocking
More...
 
NXOpen::ExpressionDirection2Delta ()
 Returns the y direction delta for linear clocking
More...
 
NXOpen::ExpressionRadialDelta ()
 Returns the radial delta for circular clocking
More...
 
void SetAngularDelta (const NXString &angularDeltaExp)
 Sets a angular delta for circular clocking
More...
 
void SetAngularDelta (const char *angularDeltaExp)
 Sets a angular delta for circular clocking
More...
 
void SetRadialDelta (const NXString &radialDelta)
 Sets a radial delta for circular clocking
More...
 
void SetRadialDelta (const char *radialDelta)
 Sets a radial delta for circular clocking
More...
 
void SetXDirectionDelta (const NXString &direction1Exp)
 Sets an x direction delta for linear clocking
More...
 
void SetXDirectionDelta (const char *direction1Exp)
 Sets an x direction delta for linear clocking
More...
 
void SetYDirectionDelta (const NXString &direction2Exp)
 Sets a y direction delta for linear clocking
More...
 
void SetYDirectionDelta (const char *direction2Exp)
 Sets a y direction delta for linear clocking
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

Deprecated:
Deprecated in NX8.0.0.

This functionality is no longer supported.


Created in NX7.5.0.

Member Enumeration Documentation

type of pattern clocking to transform individual instances

Enumerator
ClockingTypeWithinPatternDefinitionLinear 

within pattern definition linear

ClockingTypeWithinPatternDefinitionCircular 

within pattern definition circular

Member Function Documentation

NXOpen::Expression* NXOpen::GeometricUtilities::PatternClocking::AngularDelta ( )

Returns the angular delta for circular clocking

Deprecated:
Deprecated in NX8.0.0.

This functionality is no longer supported.


Created in NX7.5.0.

License requirements : None

NXOpen::GeometricUtilities::PatternClocking::ClockingType NXOpen::GeometricUtilities::PatternClocking::ClockType ( )

Returns the clocking enum to determine if linear or angular clocking

Deprecated:
Deprecated in NX8.0.0.

This functionality is no longer supported.


Created in NX7.5.0.

License requirements : None

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

Returns the x direction delta for linear clocking

Deprecated:
Deprecated in NX8.0.0.

This functionality is no longer supported.


Created in NX7.5.0.

License requirements : None

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

Returns the y direction delta for linear clocking

Deprecated:
Deprecated in NX8.0.0.

This functionality is no longer supported.


Created in NX7.5.0.

License requirements : None

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

Returns the radial delta for circular clocking

Deprecated:
Deprecated in NX8.0.0.

This functionality is no longer supported.


Created in NX7.5.0.

License requirements : None

void NXOpen::GeometricUtilities::PatternClocking::SetAngularDelta ( const NXString angularDeltaExp)

Sets a angular delta for circular clocking

Deprecated:
Deprecated in NX8.0.0.

This functionality is no longer supported.


Created in NX7.5.0.

License requirements : None

Parameters
angularDeltaExpangular delta in degrees
void NXOpen::GeometricUtilities::PatternClocking::SetAngularDelta ( const char *  angularDeltaExp)

Sets a angular delta for circular clocking

Deprecated:
Deprecated in NX8.0.0.

This functionality is no longer supported.


Created in NX7.5.0.

License requirements : None

Parameters
angularDeltaExpangular delta in degrees
void NXOpen::GeometricUtilities::PatternClocking::SetRadialDelta ( const NXString radialDelta)

Sets a radial delta for circular clocking

Deprecated:
Deprecated in NX8.0.0.

This functionality is no longer supported.


Created in NX7.5.0.

License requirements : None

Parameters
radialDeltadistance radial delta
void NXOpen::GeometricUtilities::PatternClocking::SetRadialDelta ( const char *  radialDelta)

Sets a radial delta for circular clocking

Deprecated:
Deprecated in NX8.0.0.

This functionality is no longer supported.


Created in NX7.5.0.

License requirements : None

Parameters
radialDeltadistance radial delta
void NXOpen::GeometricUtilities::PatternClocking::SetXDirectionDelta ( const NXString direction1Exp)

Sets an x direction delta for linear clocking

Deprecated:
Deprecated in NX8.0.0.

This functionality is no longer supported.


Created in NX7.5.0.

License requirements : None

Parameters
direction1Expdistance delta
void NXOpen::GeometricUtilities::PatternClocking::SetXDirectionDelta ( const char *  direction1Exp)

Sets an x direction delta for linear clocking

Deprecated:
Deprecated in NX8.0.0.

This functionality is no longer supported.


Created in NX7.5.0.

License requirements : None

Parameters
direction1Expdistance delta
void NXOpen::GeometricUtilities::PatternClocking::SetYDirectionDelta ( const NXString direction2Exp)

Sets a y direction delta for linear clocking

Deprecated:
Deprecated in NX8.0.0.

This functionality is no longer supported.


Created in NX7.5.0.

License requirements : None

Parameters
direction2Expdistance delta
void NXOpen::GeometricUtilities::PatternClocking::SetYDirectionDelta ( const char *  direction2Exp)

Sets a y direction delta for linear clocking

Deprecated:
Deprecated in NX8.0.0.

This functionality is no longer supported.


Created in NX7.5.0.

License requirements : None

Parameters
direction2Expdistance delta
virtual bool NXOpen::GeometricUtilities::PatternClocking::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.