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

Inheritance diagram for NXOpen::GeometricUtilities::PatternDefinition:

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

Public Member Functions
NXOpen::GeometricUtilities::AlongPathPattern *	AlongPathDefinition ()
	Returns the along path definition.

NXOpen::GeometricUtilities::CircularPattern *	CircularDefinition ()
	Returns the circular definition.

NXOpen::GeometricUtilities::PatternClockingBuilder *	CreateClockingBuilder (int ix, int iy)
	Creates a pattern clocking object.

NXOpen::GeometricUtilities::PatternInstanceEditBuilder *	CreatePatternInstanceEditBuilder ()
	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::GeneralPattern *	GeneralDefinition ()
	Returns the general definition.

NXOpen::GeometricUtilities::PatternClocking *	GetClocking (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::HelixPattern *	HelixDefinition ()
	Returns the helix definition.

NXOpen::GeometricUtilities::MirrorPattern *	MirrorDefinition ()
	Returns the mirror definition.

NXOpen::GeometricUtilities::PatternFill *	PatternFill ()
	Returns the pattern fill definition.

NXOpen::GeometricUtilities::PatternIncrementsBuilder *	PatternIncrementsBuilder ()
	Returns the pattern increments definition.

NXOpen::GeometricUtilities::PatternOrientation *	PatternOrientation ()
	Returns the pattern orientation definition.

NXOpen::GeometricUtilities::PatternDefinition::PatternEnum	PatternType ()
	Returns the pattern type Created in NX7.5.0.

NXOpen::GeometricUtilities::PolygonPattern *	PolygonDefinition ()
	Returns the polygon definition.

NXOpen::GeometricUtilities::RectangularPattern *	RectangularDefinition ()
	Returns the linear definition.

NXOpen::GeometricUtilities::ReferencePattern *	ReferenceDefinition ()
	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::SpiralPattern *	SpiralDefinition ()
	Returns the spiral definition.

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

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

enum NXOpen::GeometricUtilities::PatternDefinition::PatternEnum

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.
PatternEnumHelix	helix pattern.

Member Function Documentation

NXOpen::GeometricUtilities::AlongPathPattern* NXOpen::GeometricUtilities::PatternDefinition::AlongPathDefinition ( )

Returns the along path definition.

See AlongPathPattern for details.
Created in NX7.5.0.

License requirements : None

NXOpen::GeometricUtilities::CircularPattern* NXOpen::GeometricUtilities::PatternDefinition::CircularDefinition ( )

Returns the circular definition.

See CircularPattern for details.
Created in NX7.5.0.

License requirements : None

NXOpen::GeometricUtilities::PatternClockingBuilder* NXOpen::GeometricUtilities::PatternDefinition::CreateClockingBuilder	(	int	ix,
		int	iy
	)

Creates a pattern clocking object.

Returns: Created in NX7.5.0.

License requirements : None

Parameters

ix	x index of instance to initialize to
iy	y index of instance to initialize to

NXOpen::GeometricUtilities::PatternInstanceEditBuilder* NXOpen::GeometricUtilities::PatternDefinition::CreatePatternInstanceEditBuilder ( )

This is the default creator for GeometricUtilities::PatternInstanceEditBuilder .

Returns: Created in NX7.5.0.

License requirements : None

bool NXOpen::GeometricUtilities::PatternDefinition::FrameOnlyToggle ( )

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

NXOpen::GeometricUtilities::GeneralPattern* NXOpen::GeometricUtilities::PatternDefinition::GeneralDefinition ( )

Returns the general definition.

See GeneralPattern for details.
Created in NX8.0.0.

License requirements : None

NXOpen::GeometricUtilities::PatternClocking* NXOpen::GeometricUtilities::PatternDefinition::GetClocking	(	int	index1,
		int	index2
	)

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

Returns

Deprecated:: Deprecated in NX8.0.0. Use GeometricUtilities::PatternDefinition::CreateClockingBuilder instead.

Created in NX7.5.0.

License requirements : None

Parameters

index1	First index into pattern instance array
index2	Second index into pattern instance array

bool NXOpen::GeometricUtilities::PatternDefinition::GetDeleteState	(	int	index1,
		int	index2
	)

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

Returns: Created in NX8.0.0.

License requirements : None

Parameters

index1	First index of instance
index2	Second index of instance

bool NXOpen::GeometricUtilities::PatternDefinition::GetSuppressState	(	int	index1,
		int	index2
	)

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

Returns: Created in NX7.5.0.

License requirements : None

Parameters

index1	First index of instance
index2	Second index of instance

NXOpen::GeometricUtilities::HelixPattern* NXOpen::GeometricUtilities::PatternDefinition::HelixDefinition ( )

Returns the helix definition.

See HelixPattern for details.
Created in NX9.0.0.

License requirements : None

NXOpen::GeometricUtilities::MirrorPattern* NXOpen::GeometricUtilities::PatternDefinition::MirrorDefinition ( )

Returns the mirror definition.

See MirrorPattern for details.
Created in NX8.0.0.

License requirements : None

NXOpen::GeometricUtilities::PatternFill* NXOpen::GeometricUtilities::PatternDefinition::PatternFill ( )

Returns the pattern fill definition.

See PatternFill for details.
Created in NX7.5.0.

License requirements : None

NXOpen::GeometricUtilities::PatternIncrementsBuilder* NXOpen::GeometricUtilities::PatternDefinition::PatternIncrementsBuilder ( )

Returns the pattern increments definition.

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

License requirements : None

NXOpen::GeometricUtilities::PatternOrientation* NXOpen::GeometricUtilities::PatternDefinition::PatternOrientation ( )

Returns the pattern orientation definition.

See PatternOrientation for details.
Created in NX7.5.0.

License requirements : None

NXOpen::GeometricUtilities::PatternDefinition::PatternEnum NXOpen::GeometricUtilities::PatternDefinition::PatternType ( )

Returns the pattern type
Created in NX7.5.0.

License requirements : None

NXOpen::GeometricUtilities::PolygonPattern* NXOpen::GeometricUtilities::PatternDefinition::PolygonDefinition ( )

Returns the polygon definition.

See PolygonPattern for details.
Created in NX8.0.0.

License requirements : None

NXOpen::GeometricUtilities::RectangularPattern* NXOpen::GeometricUtilities::PatternDefinition::RectangularDefinition ( )

Returns the linear definition.

See LinearPattern for details.
Created in NX7.5.0.

License requirements : None

NXOpen::GeometricUtilities::ReferencePattern* NXOpen::GeometricUtilities::PatternDefinition::ReferenceDefinition ( )

Returns the reference definition.

See ReferencePattern for details.
Created in NX8.0.0.

License requirements : None

void NXOpen::GeometricUtilities::PatternDefinition::RemoveClocking	(	int	index1,
		int	index2
	)

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

License requirements : None

Parameters

index1	First index into pattern instance array
index2	Second index into pattern instance array

void NXOpen::GeometricUtilities::PatternDefinition::RemoveVariance	(	int	index1,
		int	index2
	)

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

License requirements : None

Parameters

index1	First index into pattern instance array
index2	Second index into pattern instance array

bool NXOpen::GeometricUtilities::PatternDefinition::SeedOnlyToggle ( )

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") OR cam_base ("CAM BASE")

Parameters

index1	First index of instance
index2	Second index of instance
deleteState	Input suppress state

void NXOpen::GeometricUtilities::PatternDefinition::SetFrameOnlyToggle ( bool frameOnlyToggle )

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") OR cam_base ("CAM BASE")

Parameters

frameOnlyToggle frameonlytoggle

void NXOpen::GeometricUtilities::PatternDefinition::SetPatternType ( NXOpen::GeometricUtilities::PatternDefinition::PatternEnum patternType )

Sets the pattern type
Created in NX7.5.0.

License requirements : None

Parameters

patternType patterntype

void NXOpen::GeometricUtilities::PatternDefinition::SetSeedOnlyToggle ( bool seedOnlyToggle )

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") OR cam_base ("CAM BASE")

Parameters

seedOnlyToggle seedonlytoggle

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

spreadsheetTableArray	spreadsheettablearray
locationTableArray	locationtablearray
defaultTableArray	defaulttablearray

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") OR cam_base ("CAM BASE")

Parameters

index1	First index of instance
index2	Second index of instance
suppressState	Input suppress state

NXOpen::GeometricUtilities::SpiralPattern* NXOpen::GeometricUtilities::PatternDefinition::SpiralDefinition ( )

Returns the spiral definition.

See SpiralPattern for details.
Created in NX8.0.0.

License requirements : None

virtual bool NXOpen::GeometricUtilities::PatternDefinition::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:

GeometricUtilities_PatternDefinition.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation