NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::GeometricUtilities::PatternDefinition Class Reference

pattern spacing for several pattern based commands. More...

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

List of all members.

Public Types

enum  PatternEnum {
  PatternEnumLinear, PatternEnumCircular, PatternEnumPolygon, PatternEnumSpiral,
  PatternEnumAlongPath, PatternEnumGeneral, PatternEnumReference, PatternEnumMirror
}
 pattern types available. More...

Public Member Functions

NXOpen::GeometricUtilities::AlongPathPatternAlongPathDefinition ()
 Returns the along path definition.
NXOpen::GeometricUtilities::CircularPatternCircularDefinition ()
 Returns the circular definition.
NXOpen::GeometricUtilities::PatternClockingBuilderCreateClockingBuilder (int ix, int iy)
 Creates a pattern clocking object.
NXOpen::GeometricUtilities::PatternInstanceEditBuilderCreatePatternInstanceEditBuilder ()
 This is the default creator for GeometricUtilities::PatternInstanceEditBuilder .
bool FrameOnlyToggle ()
 Returns the frameOnlyToggle, a logical flag to indicate if the we need only instances on the boundary.
NXOpen::GeometricUtilities::GeneralPatternGeneralDefinition ()
 Returns the general definition.
NXOpen::GeometricUtilities::PatternClockingGetClocking (int index1, int index2)
 Returns the clocking data for a GeometricUtilities::PatternDefinition instance.
bool GetDeleteState (int index1, int index2)
 Gets the delete state for the instance at the specified indicies.
bool GetSuppressState (int index1, int index2)
 Gets the suppress state for the instance at the specified indicies.
NXOpen::GeometricUtilities::MirrorPatternMirrorDefinition ()
 Returns the mirror definition.
NXOpen::GeometricUtilities::PatternFillPatternFill ()
 Returns the pattern fill definition.
NXOpen::GeometricUtilities::PatternIncrementsBuilderPatternIncrementsBuilder ()
 Returns the pattern increments definition.
NXOpen::GeometricUtilities::PatternOrientationPatternOrientation ()
 Returns the pattern orientation definition.
NXOpen::GeometricUtilities::PatternDefinition::PatternEnum PatternType ()
 Returns the pattern type
Created in NX7.5.0.
NXOpen::GeometricUtilities::PolygonPatternPolygonDefinition ()
 Returns the polygon definition.
NXOpen::GeometricUtilities::RectangularPatternRectangularDefinition ()
 Returns the linear definition.
NXOpen::GeometricUtilities::ReferencePatternReferenceDefinition ()
 Returns the reference definition.
void RemoveClocking (int index1, int index2)
 Removes clocking from pattern definition instance
Created in NX7.5.0.
void RemoveVariance (int index1, int index2)
 Removes variance from pattern definition instance
Created in NX8.0.0.
bool SeedOnlyToggle ()
 Returns the seedOnlyToggle, a logical flag to indicate if the we need only instances for the seed along the second direction.
void SetDeleteState (int index1, int index2, bool deleteState)
 Sets the delete state for the instance at the specified indicies.
void SetFrameOnlyToggle (bool frameOnlyToggle)
 Sets the frameOnlyToggle, a logical flag to indicate if the we need only instances on the boundary.
void SetPatternType (NXOpen::GeometricUtilities::PatternDefinition::PatternEnum patternType)
 Sets the pattern type
Created in NX7.5.0.
void SetSeedOnlyToggle (bool seedOnlyToggle)
 Sets the seedOnlyToggle, a logical flag to indicate if the we need only instances for the seed along the second direction.
void SetSpreadsheetData (const std::vector< double > &spreadsheetTableArray, const std::vector< double > &locationTableArray, const std::vector< bool > &defaultTableArray)
 Sets the spreadsheet data
Created in NX8.0.0.
void SetSuppressState (int index1, int index2, bool suppressState)
 Sets the suppress state for the instance at the specified indicies.
NXOpen::GeometricUtilities::SpiralPatternSpiralDefinition ()
 Returns the spiral definition.
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called.

Detailed Description

pattern spacing for several pattern based commands.

See PatternEnum definition below for a listing of the various pattern definitions available.
Created in NX7.5.0.


Member Enumeration Documentation

pattern types available.

For details on the interface of each type, visit the corresponding definition class for each type.

Enumerator:
PatternEnumLinear 

pattern along single linear direction.

PatternEnumCircular 

pattern in angular and radial directions.

PatternEnumPolygon 

polygon pattern.

PatternEnumSpiral 

spiral pattern.

PatternEnumAlongPath 

pattern along a section path.

PatternEnumGeneral 

general pattern.

PatternEnumReference 

reference pattern.

PatternEnumMirror 

mirror pattern.


Member Function Documentation

Returns the along path definition.

See AlongPathPattern for details.
Created in NX7.5.0.

License requirements : None

Returns the circular definition.

See CircularPattern for details.
Created in NX7.5.0.

License requirements : None

Creates a pattern clocking object.

Returns:

Created in NX7.5.0.

License requirements : None
Parameters:
ixx index of instance to initialize to
iyy index of instance to initialize to

This is the default creator for GeometricUtilities::PatternInstanceEditBuilder .

Returns:

Created in NX7.5.0.

License requirements : None

Returns the frameOnlyToggle, a logical flag to indicate if the we need only instances on the boundary.


Created in NX7.5.0.

License requirements : None

Returns the general definition.

See GeneralPattern for details.
Created in NX8.0.0.

License requirements : None

Returns the clocking data for a GeometricUtilities::PatternDefinition instance.

Returns:

Deprecated:
Deprecated in NX8.0.0.


Created in NX7.5.0.

License requirements : None

Parameters:
index1First index into pattern instance array
index2Second index into pattern instance array

Gets the delete state for the instance at the specified indicies.

Returns:

Created in NX8.0.0.

License requirements : None
Parameters:
index1First index of instance
index2Second index of instance

Gets the suppress state for the instance at the specified indicies.

Returns:

Created in NX7.5.0.

License requirements : None
Parameters:
index1First index of instance
index2Second index of instance

Returns the mirror definition.

See MirrorPattern for details.
Created in NX8.0.0.

License requirements : None

Returns the pattern fill definition.

See PatternFill for details.
Created in NX7.5.0.

License requirements : None

Returns the pattern increments definition.

See GeometricUtilities::PatternIncrementsBuilder for details.
Created in NX7.5.0.

License requirements : None

Returns the pattern orientation definition.

See PatternOrientation for details.
Created in NX7.5.0.

License requirements : None

Returns the pattern type
Created in NX7.5.0.



License requirements : None

Returns the polygon definition.

See PolygonPattern for details.
Created in NX8.0.0.

License requirements : None

Returns the linear definition.

See LinearPattern for details.
Created in NX7.5.0.

License requirements : None

Returns the reference definition.

See ReferencePattern for details.
Created in NX8.0.0.

License requirements : None

Removes clocking from pattern definition instance
Created in NX7.5.0.



License requirements : None

Parameters:
index1First index into pattern instance array
index2Second index into pattern instance array

Removes variance from pattern definition instance
Created in NX8.0.0.



License requirements : None

Parameters:
index1First index into pattern instance array
index2Second index into pattern instance array

Returns the seedOnlyToggle, a logical flag to indicate if the we need only instances for the seed along the second direction.


Created in NX8.0.0.

License requirements : None

void NXOpen::GeometricUtilities::PatternDefinition::SetDeleteState ( int  index1,
int  index2,
bool  deleteState 
)

Sets the delete state for the instance at the specified indicies.


Created in NX8.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
index1First index of instance
index2Second index of instance
deleteStateInput suppress state

Sets the frameOnlyToggle, a logical flag to indicate if the we need only instances on the boundary.


Created in NX7.5.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
frameOnlyToggleframeonlytoggle

Sets the pattern type
Created in NX7.5.0.



License requirements : None

Parameters:
patternTypepatterntype

Sets the seedOnlyToggle, a logical flag to indicate if the we need only instances for the seed along the second direction.


Created in NX8.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
seedOnlyToggleseedonlytoggle
void NXOpen::GeometricUtilities::PatternDefinition::SetSpreadsheetData ( const std::vector< double > &  spreadsheetTableArray,
const std::vector< double > &  locationTableArray,
const std::vector< bool > &  defaultTableArray 
)

Sets the spreadsheet data
Created in NX8.0.0.



License requirements : None

Parameters:
spreadsheetTableArrayspreadsheettablearray
locationTableArraylocationtablearray
defaultTableArraydefaulttablearray
void NXOpen::GeometricUtilities::PatternDefinition::SetSuppressState ( int  index1,
int  index2,
bool  suppressState 
)

Sets the suppress state for the instance at the specified indicies.


Created in NX7.5.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
index1First index of instance
index2Second index of instance
suppressStateInput suppress state

Returns the spiral definition.

See SpiralPattern for details.
Created in NX8.0.0.

License requirements : None

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 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.