NXOpen C++ Reference Guide
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Classes | Public Types | Public Member Functions | List of all members
NXOpen::Weld::WeldPointExitBuilder Class Reference

Represents a NXOpen::Weld::WeldPointExitBuilder class used to pass welding object from the Weld Point command to a user callback. More...

Inheritance diagram for NXOpen::Weld::WeldPointExitBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Classes

struct  FeatureDetails
 Structure used to identify newly created, edited, and unused features. More...
 
struct  FeatureInfo
 Structure used to identify newly created features. More...
 

Public Types

enum  CommandName {
  CommandNameNone, CommandNameWeldPoint, CommandNameDatumLocator, CommandNameMeasurementLocator,
  CommandNameJointmark, CommandNameWeldPointWizard, CommandNameEasySpot
}
 The command name used for the newly created features. More...
 
enum  FeatureStatus { FeatureStatusModified, FeatureStatusNewlyCreated, FeatureStatusNotUsed }
 The information about whether the feature was modified, newly created, or unused. More...
 
enum  MethodUsed {
  MethodUsedNone, MethodUsedMirror, MethodUsedTranslate, MethodUsedGuideCurve,
  MethodUsedPoints, MethodUsedGuideCurveMovedOff
}
 The method use to create the features. More...
 

Public Member Functions

NXOpen::Weld::WeldPointExitBuilder::CommandName CommandUsed ()
 Returns the command name that was last used to create features. More...
 
void GetFeatureDetails (std::vector< NXOpen::Weld::WeldPointExitBuilder::FeatureDetails > &features)
 Gets the information for the newly created, edited or unused features. More...
 
void GetFeatureInformation (std::vector< NXOpen::Weld::WeldPointExitBuilder::FeatureInfo > &features)
 Gets the information for the newly created, or edited features. 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::Weld::WeldPointExitBuilder class used to pass welding object from the Weld Point command to a user callback.

This object is not used on edit.
Created in NX8.0.2.

Member Enumeration Documentation

The command name used for the newly created features.

Enumerator
CommandNameNone 

No command.

Used to initialize value.

CommandNameWeldPoint 

Weld Point command.

CommandNameDatumLocator 

Datum Locator command.

CommandNameMeasurementLocator 

Measurement Locator command.

CommandNameJointmark 

Joint Mark command.

CommandNameWeldPointWizard 

Weld Point Wizard command.

CommandNameEasySpot 

Easy Spot command.

The information about whether the feature was modified, newly created, or unused.

Enumerator
FeatureStatusModified 

An existing feature was modified.

FeatureStatusNewlyCreated 

A new feature was created.

FeatureStatusNotUsed 

A feature to move was specified, but changes to spacing options caused this feature not to be used.

The method use to create the features.

Enumerator
MethodUsedNone 

No method specified.

Used to initialize value.

MethodUsedMirror 

Feature was created using the mirror method.

MethodUsedTranslate 

Feature was created using the translate method.

MethodUsedGuideCurve 

Feature was created using the guide curves method.

MethodUsedPoints 

Feature was created using the points method.

MethodUsedGuideCurveMovedOff 

Feature was created using the guide curves method, but user moved it off.

Member Function Documentation

NXOpen::Weld::WeldPointExitBuilder::CommandName NXOpen::Weld::WeldPointExitBuilder::CommandUsed ( )

Returns the command name that was last used to create features.

This callback is not called on edit.
Created in NX8.0.2.

License requirements : None

void NXOpen::Weld::WeldPointExitBuilder::GetFeatureDetails ( std::vector< NXOpen::Weld::WeldPointExitBuilder::FeatureDetails > &  features)

Gets the information for the newly created, edited or unused features.


Created in NX12.0.1.

License requirements : None

Parameters
featuresfeatures created
void NXOpen::Weld::WeldPointExitBuilder::GetFeatureInformation ( std::vector< NXOpen::Weld::WeldPointExitBuilder::FeatureInfo > &  features)

Gets the information for the newly created, or edited features.


Deprecated:
Deprecated in NX12.0.1. Use NXOpen::Weld::WeldPointExitBuilder::GetFeatureDetails instead.


Created in NX8.0.2.

License requirements : None

Parameters
featuresfeatures created
virtual bool NXOpen::Weld::WeldPointExitBuilder::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 2019 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.