NX Open C++ Reference Guide
Classes | Public Types | Public Member Functions | List of all members
NXOpen::Weld::CustomManager Class Reference

Represents weld interface to customize the creation of welding joint features. More...

Inheritance diagram for NXOpen::Weld::CustomManager:
NXOpen::TaggedObjectCollection

Classes

class  iterator
 Iterator for accessing the contents of the collection. More...
 

Public Types

typedef NXOpen::Callback1
< void,
NXOpen::Weld::DatumIconBuilder * > 
DatumIconHandler
 Method called from the part navigator to define the datum surface and pin icon. More...
 
typedef NXOpen::Callback1
< void,
NXOpen::Weld::WeldObjectBuilder * > 
ModifyFeatureHandler
 User defined method that is called whenever a welding joints are created or edited
Created in NX8.0.1. More...
 
typedef NXOpen::Callback1
< void,
NXOpen::Weld::JointItemBuilder * > 
PipeJointSetType
 User defined method that is called whenever a welding joint is created. More...
 
typedef NXOpen::Callback1
< void,
NXOpen::Weld::WeldPointExitBuilder * > 
PointExitHandler
 User defined method that is called whenever a welding features are created through Weld Point command. More...
 
typedef NXOpen::Callback2
< void,
NXOpen::Weld::WeldJointBuilder
*, NXOpen::Curve * > 
VariableBevelHandler
 User defined method that returns the angle divisions for a variable bevel. More...
 
typedef NXOpen::Callback1
< void,
NXOpen::Weld::JointExitBuilder * > 
WeldJointHandler
 User defined method that is called whenever a welding joint is created or updated
Created in NX8.0.0. More...
 

Public Member Functions

int AddDatumIconHandler (const NXOpen::Weld::CustomManager::DatumIconHandler &handler)
 Registers a user defined method to be notified when the part navigator is updating the surface or pin datum icon. More...
 
int AddModifyFeatureHandler (const NXOpen::Weld::CustomManager::ModifyFeatureHandler &handler)
 Registers a user defined method to be notified when weld features are created or edited. More...
 
int AddPipeJointSetType (const NXOpen::Weld::CustomManager::PipeJointSetType &handler)
 Registers a user defined method that is called whenever a welding joint is created. More...
 
int AddPointExitHandler (const NXOpen::Weld::CustomManager::PointExitHandler &handler)
 Registers a user defined method to be notified when weld point features are created. More...
 
int AddVariableBevelHandler (const NXOpen::Weld::CustomManager::VariableBevelHandler &handler)
 Registers a user defined method to define variable bevel angles. More...
 
int AddWeldJointHandler (const NXOpen::Weld::CustomManager::WeldJointHandler &handler)
 Registers a user defined method that is called whenever a welding joint is created or updated. More...
 
NXOpen::Weld::ConnectedPartAskConnectedParts (NXOpen::NXObject *weldTag)
 Find the connected part information for the weld feature, curve, point or body. More...
 
iterator begin ()
 Returns an iterator addressing the first element. More...
 
void ConvertLegacy ()
 Method to convert all legacy weld points to the NXOpen::Weld::PointMarkPoint class
Created in NX10.0.0. More...
 
void ConvertLegacy (const std::vector< NXOpen::Features::Feature * > &fsetFeatures)
 Method to convert selected legacy weld point feature sets to the NXOpen::Weld::PointMarkPoint class
Created in NX10.0.1. More...
 
void ConvertLegacy (const std::vector< NXOpen::Features::Feature * > &fsetFeatures, bool createSingleFeatures)
 Method to convert weld point feature sets to the NXOpen::Weld::PointMarkPoint class
Created in NX10.0.3. More...
 
void ConvertTransformWeld (const std::vector< NXOpen::Features::Feature * > &selectedObjects)
 Method to convert NXOpen::Weld::Transform to their parent type. More...
 
void CreateFeatureGroupsForCommonConnectedParts (const std::vector< NXOpen::Weld::JointmarkElement * > &weldFeatures)
 Method to creates Feature Groups to collect individual weld point features that have the same connected part attributes. More...
 
iterator end ()
 Returns an iterator addressing one past the last element. More...
 
std::vector< bool > HasSourceFacesInWeldPart (NXOpen::Features::Feature *weldFeature)
 Method to determine if a NXOpen::Weld::JointmarkElement feature has source faces in the weld part. More...
 
void ImpactAnalysisCheck (const std::vector< NXOpen::NXObject * > &selectedObjects)
 Method to perform the Weld Impace Analysis command. More...
 
void ImpactAnalysisConfirm (const std::vector< NXOpen::NXObject * > &selectedObjects)
 Method to approve all alerts generated by the Weld Assistant Impact Analysis command. More...
 
void LocateWelds (bool searchEntireAssembly, bool wantSolids, bool wantCurves, bool wantPoints, std::vector< NXOpen::NXObject * > &foundObjectsArray)
 Method to search all fully loaded parts for welding objects in an assembly or part file. More...
 
void LocateWelds (bool searchEntireAssembly, bool excludeInvisibleComponents, bool wantSolids, bool wantCurves, bool wantPoints, std::vector< NXOpen::NXObject * > &foundObjectsArray)
 Method to search all fully loaded parts for welding objects in an assembly or part file. More...
 
void LocateWelds (bool searchEntireAssembly, bool excludeInvisibleComponents, bool wantSolids, bool wantCurves, bool wantPoints, bool wantStructureWelds, std::vector< NXOpen::NXObject * > &foundObjectsArray)
 Method to search all fully loaded parts for welding objects in an assembly or part file. More...
 
void RemoveDatumIconHandler (int id)
 Unregisters the datum common icon handler
Created in NX9.0.0. More...
 
void RemoveModifyFeatureHandler (int id)
 Unregisters the modify feature handler
Created in NX8.0.1. More...
 
void RemovePipeJointSetType (int id)
 Unregisters the pipe joint set type handler
Created in NX10.0.0. More...
 
void RemovePointExitHandler (int id)
 Unregisters the point feature handler
Created in NX8.0.2. More...
 
void RemoveVariableBevelHandler (int id)
 Unregisters the variable bevel handler
Created in NX8.0.0. More...
 
void RemoveWeldJointHandler (int id)
 Unregisters the welding joint handler
Created in NX8.0.0. More...
 
void ShowSolids (bool showSolids)
 Method to change display mode of all Weld.PointMarkPoint feature that are fully loaded in an assembly
Created in NX10.0.0. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents weld interface to customize the creation of welding joint features.


The "welding joint handler" customization callback is called after the feature is created. One can then set edge preparation parameters, change the color of the feature output curve, add attributes to the feature, or any additional customization.

The "variable bevel handler" customization callback is used to define the limits where a welding joint should be split at.



To obtain an instance of this class, refer to NXOpen::Session

Created in NX8.0.0.

Member Typedef Documentation

Method called from the part navigator to define the datum surface and pin icon.


Created in NX9.0.0.

License requirements : None

User defined method that is called whenever a welding joints are created or edited
Created in NX8.0.1.



License requirements : None

User defined method that is called whenever a welding joint is created.

Used to set the joint type for pipe welding application.
Created in NX10.0.0.

License requirements : None

User defined method that is called whenever a welding features are created through Weld Point command.


Created in NX8.0.2.

License requirements : None

User defined method that returns the angle divisions for a variable bevel.

The first value must be 0.0, and the last value 90.0
Created in NX8.0.0.

License requirements : None

User defined method that is called whenever a welding joint is created or updated
Created in NX8.0.0.



License requirements : None

Member Function Documentation

int NXOpen::Weld::CustomManager::AddDatumIconHandler ( const NXOpen::Weld::CustomManager::DatumIconHandler handler)

Registers a user defined method to be notified when the part navigator is updating the surface or pin datum icon.

Returns
identifier of registered method (used to unregister the method)
Created in NX9.0.0.

License requirements : None
Parameters
handlermethod to register
int NXOpen::Weld::CustomManager::AddModifyFeatureHandler ( const NXOpen::Weld::CustomManager::ModifyFeatureHandler handler)

Registers a user defined method to be notified when weld features are created or edited.

Returns
identifier of registered method (used to unregister the method)
Created in NX8.0.1.

License requirements : None
Parameters
handlermethod to register
int NXOpen::Weld::CustomManager::AddPipeJointSetType ( const NXOpen::Weld::CustomManager::PipeJointSetType handler)

Registers a user defined method that is called whenever a welding joint is created.

Returns
identifier of registered method (used to unregister the method)
Created in NX10.0.0.

License requirements : None
Parameters
handlermethod to register
int NXOpen::Weld::CustomManager::AddPointExitHandler ( const NXOpen::Weld::CustomManager::PointExitHandler handler)

Registers a user defined method to be notified when weld point features are created.

Returns
identifier of registered method (used to unregister the method)
Created in NX8.0.2.

License requirements : None
Parameters
handlermethod to register
int NXOpen::Weld::CustomManager::AddVariableBevelHandler ( const NXOpen::Weld::CustomManager::VariableBevelHandler handler)

Registers a user defined method to define variable bevel angles.

The method will be called from the Weld Joint user Interface.

Returns
identifier of registered method (used to unregister the method)
Created in NX8.0.0.

License requirements : None
Parameters
handlermethod to register
int NXOpen::Weld::CustomManager::AddWeldJointHandler ( const NXOpen::Weld::CustomManager::WeldJointHandler handler)

Registers a user defined method that is called whenever a welding joint is created or updated.

Returns
identifier of registered method (used to unregister the method)
Created in NX8.0.0.

License requirements : None
Parameters
handlermethod to register
NXOpen::Weld::ConnectedPart* NXOpen::Weld::CustomManager::AskConnectedParts ( NXOpen::NXObject weldTag)

Find the connected part information for the weld feature, curve, point or body.

NXOpen::Weld::CustomManager::LocateWelds can be used to retrieve weld data from a part.
The data is stored in NXOpen::Weld::ConnectedPart containing the appropriate connected part information. If the weld input is an occurrence then a body or part occurences will be returned in the output structures for reading the attributes on the connected parts.

Returns
Connected parts information. NULL if none are found.
Created in NX11.0.0.

License requirements : None
Parameters
weldTagWeld feature, curve, point or solid body.
iterator NXOpen::Weld::CustomManager::begin ( )

Returns an iterator addressing the first element.

void NXOpen::Weld::CustomManager::ConvertLegacy ( )

Method to convert all legacy weld points to the NXOpen::Weld::PointMarkPoint class
Created in NX10.0.0.



License requirements : None

void NXOpen::Weld::CustomManager::ConvertLegacy ( const std::vector< NXOpen::Features::Feature * > &  fsetFeatures)

Method to convert selected legacy weld point feature sets to the NXOpen::Weld::PointMarkPoint class
Created in NX10.0.1.



License requirements : None

Parameters
fsetFeaturesThe pre-NX10 weld feature sets to convert
void NXOpen::Weld::CustomManager::ConvertLegacy ( const std::vector< NXOpen::Features::Feature * > &  fsetFeatures,
bool  createSingleFeatures 
)

Method to convert weld point feature sets to the NXOpen::Weld::PointMarkPoint class
Created in NX10.0.3.



License requirements : None

Parameters
fsetFeaturesThe pre-NX10 weld feature sets to convert
createSingleFeaturestrue to create single features with no master feature, false to create a master feature.
void NXOpen::Weld::CustomManager::ConvertTransformWeld ( const std::vector< NXOpen::Features::Feature * > &  selectedObjects)

Method to convert NXOpen::Weld::Transform to their parent type.

For example, if a NXOpen::Weld::WeldBead is the parent, this function will convert the NXOpen::Weld::Transform to a NXOpen::Weld::WeldBead in the location of the the NXOpen::Weld::Transform .
Created in NX11.0.1.

License requirements : None

Parameters
selectedObjectsArray of features to convert.
void NXOpen::Weld::CustomManager::CreateFeatureGroupsForCommonConnectedParts ( const std::vector< NXOpen::Weld::JointmarkElement * > &  weldFeatures)

Method to creates Feature Groups to collect individual weld point features that have the same connected part attributes.


Calling with numWeldFeatures equal to zero will cause all NXOpen::Weld::JointmarkElement in the work part to be grouped. Connected parts A-B-C and C-B-A will be in the same group.

Created in NX11.0.2.

License requirements : None

Parameters
weldFeaturesIndividual features (those without a master feature) to group .
iterator NXOpen::Weld::CustomManager::end ( )

Returns an iterator addressing one past the last element.

std::vector<bool> NXOpen::Weld::CustomManager::HasSourceFacesInWeldPart ( NXOpen::Features::Feature weldFeature)

Method to determine if a NXOpen::Weld::JointmarkElement feature has source faces in the weld part.

Returns
Indicates if source faces are in the weld part.
Created in NX11.0.1.

License requirements : None
Parameters
weldFeatureThe feature to check
void NXOpen::Weld::CustomManager::ImpactAnalysisCheck ( const std::vector< NXOpen::NXObject * > &  selectedObjects)

Method to perform the Weld Impace Analysis command.

This will fully load connected parts of the selected objects and generate navigator alert messages if input faces, or feature specific parameters have changed.
Created in NX11.0.0.

License requirements : None

Parameters
selectedObjectsArray of objects to perform an Impact Analysis for.
void NXOpen::Weld::CustomManager::ImpactAnalysisConfirm ( const std::vector< NXOpen::NXObject * > &  selectedObjects)

Method to approve all alerts generated by the Weld Assistant Impact Analysis command.

New alert messages are based on the approved objects.
Created in NX11.0.0.

License requirements : None

Parameters
selectedObjectsArray of objects to approve Impact Analysis alerts for.
void NXOpen::Weld::CustomManager::LocateWelds ( bool  searchEntireAssembly,
bool  wantSolids,
bool  wantCurves,
bool  wantPoints,
std::vector< NXOpen::NXObject * > &  foundObjectsArray 
)

Method to search all fully loaded parts for welding objects in an assembly or part file.

An array of solids, curves and points can be output
Created in NX10.0.0.

License requirements : None

Parameters
searchEntireAssemblysearchentireassembly
wantSolidswantsolids
wantCurveswantcurves
wantPointswantpoints
foundObjectsArrayArray of objects passing the search criteria specified.
void NXOpen::Weld::CustomManager::LocateWelds ( bool  searchEntireAssembly,
bool  excludeInvisibleComponents,
bool  wantSolids,
bool  wantCurves,
bool  wantPoints,
std::vector< NXOpen::NXObject * > &  foundObjectsArray 
)

Method to search all fully loaded parts for welding objects in an assembly or part file.

An array of solids, curves and points can be output
Created in NX11.0.0.

License requirements : None

Parameters
searchEntireAssemblysearchentireassembly
excludeInvisibleComponentsexcludeinvisiblecomponents
wantSolidswantsolids
wantCurveswantcurves
wantPointswantpoints
foundObjectsArrayArray of objects passing the search criteria specified.
void NXOpen::Weld::CustomManager::LocateWelds ( bool  searchEntireAssembly,
bool  excludeInvisibleComponents,
bool  wantSolids,
bool  wantCurves,
bool  wantPoints,
bool  wantStructureWelds,
std::vector< NXOpen::NXObject * > &  foundObjectsArray 
)

Method to search all fully loaded parts for welding objects in an assembly or part file.

An array of solids, curves and points can be output. Structure welds can also be included in the search.
Created in NX11.0.2.

License requirements : None

Parameters
searchEntireAssemblysearchentireassembly
excludeInvisibleComponentsexcludeinvisiblecomponents
wantSolidswantsolids
wantCurveswantcurves
wantPointswantpoints
wantStructureWeldswantstructurewelds
foundObjectsArrayArray of objects passing the search criteria specified.
void NXOpen::Weld::CustomManager::RemoveDatumIconHandler ( int  id)

Unregisters the datum common icon handler
Created in NX9.0.0.



License requirements : None

Parameters
ididentifier for method to unregister
void NXOpen::Weld::CustomManager::RemoveModifyFeatureHandler ( int  id)

Unregisters the modify feature handler
Created in NX8.0.1.



License requirements : None

Parameters
ididentifier for method to unregister
void NXOpen::Weld::CustomManager::RemovePipeJointSetType ( int  id)

Unregisters the pipe joint set type handler
Created in NX10.0.0.



License requirements : None

Parameters
ididentifier for method to unregister
void NXOpen::Weld::CustomManager::RemovePointExitHandler ( int  id)

Unregisters the point feature handler
Created in NX8.0.2.



License requirements : None

Parameters
ididentifier for method to unregister
void NXOpen::Weld::CustomManager::RemoveVariableBevelHandler ( int  id)

Unregisters the variable bevel handler
Created in NX8.0.0.



License requirements : None

Parameters
ididentifier for method to unregister
void NXOpen::Weld::CustomManager::RemoveWeldJointHandler ( int  id)

Unregisters the welding joint handler
Created in NX8.0.0.



License requirements : None

Parameters
ididentifier for method to unregister
void NXOpen::Weld::CustomManager::ShowSolids ( bool  showSolids)

Method to change display mode of all Weld.PointMarkPoint feature that are fully loaded in an assembly
Created in NX10.0.0.



License requirements : None

Parameters
showSolidstrue to show solids, false to show points.
tag_t NXOpen::Weld::CustomManager::Tag ( ) const

Returns the tag of this object.


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.