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...
 
iterator begin ()
 Returns an iterator addressing the first element. More...
 
void ConvertLegacy ()
 Method to convert all WeldPtParms class welds to the Weld_PointMarkPoint class
Created in NX10.0.0. More...
 
iterator end ()
 Returns an iterator addressing one past the last element. 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 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
iterator NXOpen::Weld::CustomManager::begin ( )

Returns an iterator addressing the first element.

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

Method to convert all WeldPtParms class welds to the Weld_PointMarkPoint class
Created in NX10.0.0.



License requirements : None

iterator NXOpen::Weld::CustomManager::end ( )

Returns an iterator addressing one past the last element.

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::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 2012 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.