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

the reference pattern definition. More...

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

Public Member Functions

NXOpen::SelectNXObjectReferencedPattern ()
 Returns the referenced pattern object. More...
 
void ResetBaseInstance ()
 Reset the base instance indices to an "undefined" state. More...
 
void SetBaseInstance (int firstIndex, int secondIndex)
 Set the base instance
Created in NX8.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

the reference pattern definition.


Created in NX8.0.0.

Member Function Documentation

NXOpen::SelectNXObject* NXOpen::GeometricUtilities::ReferencePattern::ReferencedPattern ( )

Returns the referenced pattern object.


Created in NX8.0.0.

License requirements : None

void NXOpen::GeometricUtilities::ReferencePattern::ResetBaseInstance ( )

Reset the base instance indices to an "undefined" state.

The base instance will be reset so that the indices do not correspond to indices from any instance of the referenced pattern selected. The base instance indices must be set after this call before commit.
Created in NX8.0.0.

License requirements : None

void NXOpen::GeometricUtilities::ReferencePattern::SetBaseInstance ( int  firstIndex,
int  secondIndex 
)

Set the base instance
Created in NX8.0.0.



License requirements : None

Parameters
firstIndexfirstindex
secondIndexsecondindex
virtual bool NXOpen::GeometricUtilities::ReferencePattern::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.