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

Represents a NXOpen::Features::MatchedReferenceBuilder. More...

Inheritance diagram for NXOpen::Features::MatchedReferenceBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  ResolvedStatus { ResolvedStatusInitial, ResolvedStatusUnresolved, ResolvedStatusBySystem, ResolvedStatusByUser }
 Matched status. More...
 
enum  Types {
  TypesCurve, TypesFace, TypesCurveCollector, TypesFaceCollector,
  TypesSection, TypesPoint, TypesVector, TypesObject,
  TypesBodyCollector, TypesCsys, TypesPlane, TypesAxis,
  TypesUndefined
}
 MatchedReference block type. More...
 

Public Member Functions

NXOpen::NXObjectMatchedEntity ()
 Returns the matched entity
Created in NX6.0.0. More...
 
NXOpen::Features::MatchedReferenceBuilder::ResolvedStatus MatchedStatus ()
 Returns the matchedReference matched status
Created in NX8.0.0. More...
 
NXOpen::NXObjectParentEntity ()
 Returns the matchedReference parent entity
Created in NX8.0.1. More...
 
bool ReverseDirection ()
 Returns the reverse direction
Created in NX6.0.0. More...
 
void SetMatchedEntity (NXOpen::NXObject *matchedEntity)
 Sets the matched entity
Created in NX6.0.0. More...
 
void SetMatchedStatus (NXOpen::Features::MatchedReferenceBuilder::ResolvedStatus matchedStatus)
 Sets the matchedReference matched status
Created in NX8.0.0. More...
 
void SetReverseDirection (bool reverseDirection)
 Sets the reverse direction
Created in NX6.0.0. More...
 
void SetType (NXOpen::Features::MatchedReferenceBuilder::Types type)
 Sets the matchedReference type
Created in NX6.0.0. More...
 
NXOpen::Features::MatchedReferenceBuilder::Types Type ()
 Returns the matchedReference type
Created in NX6.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

Represents a NXOpen::Features::MatchedReferenceBuilder.


Created in NX6.0.0.

Member Enumeration Documentation

Matched status.

Enumerator
ResolvedStatusInitial 

initial state

ResolvedStatusUnresolved 

user unresolved

ResolvedStatusBySystem 

system automatic resolve

ResolvedStatusByUser 

resolve by user

MatchedReference block type.

Enumerator
TypesCurve 

single curve or edge

TypesFace 

single face or datum plane

TypesCurveCollector 

curve collector or edge collector

TypesFaceCollector 

face collector

TypesSection 

section

TypesPoint 

point

TypesVector 

vector

TypesObject 

general geometry such as the target body and the tool body for copying unite feature

TypesBodyCollector 

body collector

TypesCsys 

csys

TypesPlane 

plane

TypesAxis 

axis

TypesUndefined 

default type for feature name lable

Member Function Documentation

NXOpen::NXObject* NXOpen::Features::MatchedReferenceBuilder::MatchedEntity ( )

Returns the matched entity
Created in NX6.0.0.



License requirements : None

NXOpen::Features::MatchedReferenceBuilder::ResolvedStatus NXOpen::Features::MatchedReferenceBuilder::MatchedStatus ( )

Returns the matchedReference matched status
Created in NX8.0.0.



License requirements : None

NXOpen::NXObject* NXOpen::Features::MatchedReferenceBuilder::ParentEntity ( )

Returns the matchedReference parent entity
Created in NX8.0.1.



License requirements : None

bool NXOpen::Features::MatchedReferenceBuilder::ReverseDirection ( )

Returns the reverse direction
Created in NX6.0.0.



License requirements : None

void NXOpen::Features::MatchedReferenceBuilder::SetMatchedEntity ( NXOpen::NXObject matchedEntity)

Sets the matched entity
Created in NX6.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
matchedEntitymatched entity
void NXOpen::Features::MatchedReferenceBuilder::SetMatchedStatus ( NXOpen::Features::MatchedReferenceBuilder::ResolvedStatus  matchedStatus)

Sets the matchedReference matched status
Created in NX8.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
matchedStatusmatchedstatus
void NXOpen::Features::MatchedReferenceBuilder::SetReverseDirection ( bool  reverseDirection)

Sets the reverse direction
Created in NX6.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
reverseDirectionreversedirection
void NXOpen::Features::MatchedReferenceBuilder::SetType ( NXOpen::Features::MatchedReferenceBuilder::Types  type)

Sets the matchedReference type
Created in NX6.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
typetype
NXOpen::Features::MatchedReferenceBuilder::Types NXOpen::Features::MatchedReferenceBuilder::Type ( )

Returns the matchedReference type
Created in NX6.0.0.



License requirements : None

virtual bool NXOpen::Features::MatchedReferenceBuilder::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.