NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Classes | Public Types | Public Member Functions | Protected Member Functions | Properties | 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 NXOpen.Utilities.NXRemotableObject IEnumerable IMessageSink

Classes

class  _CustomManagerDatumIconHandlerAdapter
 
class  _CustomManagerModifyFeatureHandlerAdapter
 
class  _CustomManagerPipeJointSetTypeAdapter
 
class  _CustomManagerPointExitHandlerAdapter
 
class  _CustomManagerVariableBevelHandlerAdapter
 
class  _CustomManagerWeldJointHandlerAdapter
 

Public Types

enum  DeleteOption { All, InputOnly }
 Delete option for NXOpen.Weld.CustomManager.DeleteDesignFeatures . More...
 

Public Member Functions

unsafe int AddDatumIconHandler (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...
 
unsafe int AddModifyFeatureHandler (NXOpen.Weld.CustomManager.ModifyFeatureHandler handler)
 Registers a user defined method to be notified when weld features are created or edited. More...
 
unsafe int AddPipeJointSetType (NXOpen.Weld.CustomManager.PipeJointSetType handler)
 Registers a user defined method that is called whenever a welding joint is created More...
 
unsafe int AddPointExitHandler (NXOpen.Weld.CustomManager.PointExitHandler handler)
 Registers a user defined method to be notified when weld point features are created. More...
 
unsafe int AddVariableBevelHandler (NXOpen.Weld.CustomManager.VariableBevelHandler handler)
 Registers a user defined method to define variable bevel angles. More...
 
unsafe int AddWeldJointHandler (NXOpen.Weld.CustomManager.WeldJointHandler handler)
 Registers a user defined method that is called whenever a welding joint is created or updated More...
 
unsafe NXOpen.Weld.ConnectedPart AskConnectedParts (NXOpen.NXObject weldTag)
 Find the connected part information for the weld feature, curve, point or body. More...
 
unsafe void ConvertLegacy ()
 Method to convert all legacy weld points to the NXOpen.Weld.PointMarkPoint class More...
 
unsafe void ConvertLegacy (NXOpen.Features.Feature[] fsetFeatures)
 Method to convert selected legacy weld point feature sets to the NXOpen.Weld.PointMarkPoint class More...
 
unsafe void ConvertLegacy (NXOpen.Features.Feature[] fsetFeatures, bool createSingleFeatures)
 Method to convert weld point feature sets to the NXOpen.Weld.PointMarkPoint class More...
 
unsafe void ConvertTransformWeld (NXOpen.Features.Feature[] selectedObjects)
 Method to convert NXOpen.Weld.Transform to their parent type. More...
 
unsafe void CreateFeatureGroupsForCommonConnectedParts (NXOpen.Weld.JointmarkElement[] weldFeatures)
 Method to creates Feature Groups to collect individual weld point features that have the same connected part attributes. More...
 
delegate void DatumIconHandler (NXOpen.Weld.DatumIconBuilder iconBuilder)
 Method called from the part navigator to define the datum surface and pin icon. More...
 
unsafe void DeleteDesignFeatures (NXOpen.Weld.CustomManager.DeleteOption deleteOption, NXOpen.TaggedObject designObject)
 Delete design features (DF) under a design control element (DCE). More...
 
unsafe bool[] HasSourceFacesInWeldPart (NXOpen.Features.Feature weldFeature)
 Method to determine if a NXOpen.Weld.JointmarkElement feature has source faces in the weld part. More...
 
unsafe void ImpactAnalysisCheck (NXOpen.NXObject[] selectedObjects)
 Method to perform the Weld Impace Analysis command. More...
 
unsafe void ImpactAnalysisCheckConnectedParts (NXOpen.NXObject[] selectedObjects)
 Method to perform check if a features connected parts are missing. More...
 
unsafe void ImpactAnalysisConfirm (NXOpen.NXObject[] selectedObjects)
 Method to approve all alerts generated by the Weld Assistant Impact Analysis command. More...
 
unsafe void LocateWelds (bool searchEntireAssembly, bool wantSolids, bool wantCurves, bool wantPoints, out NXOpen.NXObject[] foundObjectsArray)
 Method to search all fully loaded parts for welding objects in an assembly or part file. More...
 
unsafe void LocateWelds (bool searchEntireAssembly, bool excludeInvisibleComponents, bool wantSolids, bool wantCurves, bool wantPoints, out NXOpen.NXObject[] foundObjectsArray)
 Method to search all fully loaded parts for welding objects in an assembly or part file. More...
 
unsafe void LocateWelds (bool searchEntireAssembly, bool excludeInvisibleComponents, bool wantSolids, bool wantCurves, bool wantPoints, bool wantStructureWelds, out NXOpen.NXObject[] foundObjectsArray)
 Method to search all fully loaded parts for welding objects in an assembly or part file. More...
 
delegate void ModifyFeatureHandler (NXOpen.Weld.WeldObjectBuilder modifiedFeatures)
 User defined method that is called whenever a welding joints are created or edited More...
 
delegate void PipeJointSetType (NXOpen.Weld.JointItemBuilder joint)
 User defined method that is called whenever a welding joint is created. More...
 
delegate void PointExitHandler (NXOpen.Weld.WeldPointExitBuilder createdFeatures)
 User defined method that is called whenever a welding features are created through Weld Point command. More...
 
unsafe void RemoveDatumIconHandler (int id)
 Unregisters the datum common icon handler More...
 
unsafe void RemoveModifyFeatureHandler (int id)
 Unregisters the modify feature handler More...
 
unsafe void RemovePipeJointSetType (int id)
 Unregisters the pipe joint set type handler More...
 
unsafe void RemovePointExitHandler (int id)
 Unregisters the point feature handler More...
 
unsafe void RemoveVariableBevelHandler (int id)
 Unregisters the variable bevel handler More...
 
unsafe void RemoveWeldJointHandler (int id)
 Unregisters the welding joint handler More...
 
unsafe void ShowSolids (bool showSolids)
 Method to change display mode of all Weld. More...
 
NXOpen.Weld.EdgePrep[] ToArray ()
 Returns an array of NXOpen.Weld.EdgePrep objects. More...
 
delegate void VariableBevelHandler (NXOpen.Weld.WeldJointBuilder jointBuilder, NXOpen.Curve jointCurve)
 User defined method that returns the angle divisions for a variable bevel. More...
 
delegate void WeldJointHandler (NXOpen.Weld.JointExitBuilder joint)
 User defined method that is called whenever a welding joint is created or updated More...
 
- Public Member Functions inherited from NXOpen.TaggedObjectCollection
IEnumerator GetEnumerator ()
 Returns an enumerator that iterates through a collection. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Protected Member Functions

override int EnumerateMoveNext (ref Tag currentTag, byte[] state)
 Advances the enumerator to the next element of the collection. More...
 
- Protected Member Functions inherited from NXOpen.TaggedObjectCollection
new void initialize ()
 <exclude> More...
 
- Protected Member Functions inherited from NXOpen.Utilities.NXRemotableObject
void initialize ()
 <exclude> More...
 

Properties

Tag Tag [get]
 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 Enumeration Documentation

Delete option for NXOpen.Weld.CustomManager.DeleteDesignFeatures .

Enumerator
All 

Delete all design features under design control feature.

InputOnly 

Delete only the input design feature.

Only valid if design feature is input.

Member Function Documentation

unsafe int NXOpen.Weld.CustomManager.AddDatumIconHandler ( NXOpen.Weld.CustomManager.DatumIconHandler  handler)
inline

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

Created in NX9.0.0

License requirements: None.

Parameters
handlermethod to register
Returns
identifier of registered method (used to unregister the method)
unsafe int NXOpen.Weld.CustomManager.AddModifyFeatureHandler ( NXOpen.Weld.CustomManager.ModifyFeatureHandler  handler)
inline

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

Created in NX8.0.1

License requirements: None.

Parameters
handlermethod to register
Returns
identifier of registered method (used to unregister the method)
unsafe int NXOpen.Weld.CustomManager.AddPipeJointSetType ( NXOpen.Weld.CustomManager.PipeJointSetType  handler)
inline

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

Created in NX10.0.0

License requirements: None.

Parameters
handlermethod to register
Returns
identifier of registered method (used to unregister the method)
unsafe int NXOpen.Weld.CustomManager.AddPointExitHandler ( NXOpen.Weld.CustomManager.PointExitHandler  handler)
inline

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

Created in NX8.0.2

License requirements: None.

Parameters
handlermethod to register
Returns
identifier of registered method (used to unregister the method)
unsafe int NXOpen.Weld.CustomManager.AddVariableBevelHandler ( NXOpen.Weld.CustomManager.VariableBevelHandler  handler)
inline

Registers a user defined method to define variable bevel angles.

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

Created in NX8.0.0

License requirements: None.

Parameters
handlermethod to register
Returns
identifier of registered method (used to unregister the method)
unsafe int NXOpen.Weld.CustomManager.AddWeldJointHandler ( NXOpen.Weld.CustomManager.WeldJointHandler  handler)
inline

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

Created in NX8.0.0

License requirements: None.

Parameters
handlermethod to register
Returns
identifier of registered method (used to unregister the method)
unsafe NXOpen.Weld.ConnectedPart NXOpen.Weld.CustomManager.AskConnectedParts ( NXOpen.NXObject  weldTag)
inline

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.

Created in NX11.0.0

License requirements: None.

Parameters
weldTagWeld feature, curve, point or solid body.
Returns
Connected parts information. a null reference (Nothing in Visual Basic) if none are found.
unsafe void NXOpen.Weld.CustomManager.ConvertLegacy ( )
inline

Method to convert all legacy weld points to the NXOpen.Weld.PointMarkPoint class

Created in NX10.0.0

License requirements: None.

unsafe void NXOpen.Weld.CustomManager.ConvertLegacy ( NXOpen.Features.Feature[]  fsetFeatures)
inline

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
unsafe void NXOpen.Weld.CustomManager.ConvertLegacy ( NXOpen.Features.Feature[]  fsetFeatures,
bool  createSingleFeatures 
)
inline

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.
unsafe void NXOpen.Weld.CustomManager.ConvertTransformWeld ( NXOpen.Features.Feature[]  selectedObjects)
inline

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.
unsafe void NXOpen.Weld.CustomManager.CreateFeatureGroupsForCommonConnectedParts ( NXOpen.Weld.JointmarkElement[]  weldFeatures)
inline

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 .
delegate void NXOpen.Weld.CustomManager.DatumIconHandler ( NXOpen.Weld.DatumIconBuilder  iconBuilder)

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

Created in NX9.0.0

License requirements: None.

Parameters
iconBuilderbuilder containing information to set the datum surface and pin icon.
unsafe void NXOpen.Weld.CustomManager.DeleteDesignFeatures ( NXOpen.Weld.CustomManager.DeleteOption  deleteOption,
NXOpen.TaggedObject  designObject 
)
inline

Delete design features (DF) under a design control element (DCE).

Function takes either a DCE or DF as input. If a DCE is passed in, all DFs under the DCE will be deleted. If a DF is passed in, the deletion will be done according to the setting of NXOpen.Weld.CustomManager.DeleteOption

Created in NX12.0.2

License requirements: None.

Parameters
deleteOptionOption to use if Design Feature is passed in as designObject.
designObjectDesign Control Element or Design Feature.
override int NXOpen.Weld.CustomManager.EnumerateMoveNext ( ref Tag  currentTag,
byte[]  state 
)
inlineprotectedvirtual

Advances the enumerator to the next element of the collection.

Implements NXOpen.TaggedObjectCollection.

unsafe bool [] NXOpen.Weld.CustomManager.HasSourceFacesInWeldPart ( NXOpen.Features.Feature  weldFeature)
inline

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

Created in NX11.0.1

License requirements: None.

Parameters
weldFeatureThe feature to check
Returns
Indicates if source faces are in the weld part.
unsafe void NXOpen.Weld.CustomManager.ImpactAnalysisCheck ( NXOpen.NXObject[]  selectedObjects)
inline

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.
unsafe void NXOpen.Weld.CustomManager.ImpactAnalysisCheckConnectedParts ( NXOpen.NXObject[]  selectedObjects)
inline

Method to perform check if a features connected parts are missing.

This will generate navigator alert messages if connected parts are missing.

Created in NX12.0.2

License requirements: None.

Parameters
selectedObjectsArray of objects to check connected parts for.
unsafe void NXOpen.Weld.CustomManager.ImpactAnalysisConfirm ( NXOpen.NXObject[]  selectedObjects)
inline

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.
unsafe void NXOpen.Weld.CustomManager.LocateWelds ( bool  searchEntireAssembly,
bool  wantSolids,
bool  wantCurves,
bool  wantPoints,
out NXOpen.NXObject[]  foundObjectsArray 
)
inline

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
searchEntireAssembly
wantSolids
wantCurves
wantPoints
foundObjectsArrayArray of objects passing the search criteria specified.
unsafe void NXOpen.Weld.CustomManager.LocateWelds ( bool  searchEntireAssembly,
bool  excludeInvisibleComponents,
bool  wantSolids,
bool  wantCurves,
bool  wantPoints,
out NXOpen.NXObject[]  foundObjectsArray 
)
inline

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
searchEntireAssembly
excludeInvisibleComponents
wantSolids
wantCurves
wantPoints
foundObjectsArrayArray of objects passing the search criteria specified.
unsafe void NXOpen.Weld.CustomManager.LocateWelds ( bool  searchEntireAssembly,
bool  excludeInvisibleComponents,
bool  wantSolids,
bool  wantCurves,
bool  wantPoints,
bool  wantStructureWelds,
out NXOpen.NXObject[]  foundObjectsArray 
)
inline

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
searchEntireAssembly
excludeInvisibleComponents
wantSolids
wantCurves
wantPoints
wantStructureWelds
foundObjectsArrayArray of objects passing the search criteria specified.
delegate void NXOpen.Weld.CustomManager.ModifyFeatureHandler ( NXOpen.Weld.WeldObjectBuilder  modifiedFeatures)

User defined method that is called whenever a welding joints are created or edited

Created in NX8.0.1

License requirements: None.

Parameters
modifiedFeaturesbuilder containing the weld features that were created or edited.
delegate void NXOpen.Weld.CustomManager.PipeJointSetType ( NXOpen.Weld.JointItemBuilder  joint)

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.

Parameters
jointcreated or updated welding joint
delegate void NXOpen.Weld.CustomManager.PointExitHandler ( NXOpen.Weld.WeldPointExitBuilder  createdFeatures)

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

Created in NX8.0.2

License requirements: None.

Parameters
createdFeaturesbuilder containing the create weld features.
unsafe void NXOpen.Weld.CustomManager.RemoveDatumIconHandler ( int  id)
inline

Unregisters the datum common icon handler

Created in NX9.0.0

License requirements: None.

Parameters
ididentifier for method to unregister
unsafe void NXOpen.Weld.CustomManager.RemoveModifyFeatureHandler ( int  id)
inline

Unregisters the modify feature handler

Created in NX8.0.1

License requirements: None.

Parameters
ididentifier for method to unregister
unsafe void NXOpen.Weld.CustomManager.RemovePipeJointSetType ( int  id)
inline

Unregisters the pipe joint set type handler

Created in NX10.0.0

License requirements: None.

Parameters
ididentifier for method to unregister
unsafe void NXOpen.Weld.CustomManager.RemovePointExitHandler ( int  id)
inline

Unregisters the point feature handler

Created in NX8.0.2

License requirements: None.

Parameters
ididentifier for method to unregister
unsafe void NXOpen.Weld.CustomManager.RemoveVariableBevelHandler ( int  id)
inline

Unregisters the variable bevel handler

Created in NX8.0.0

License requirements: None.

Parameters
ididentifier for method to unregister
unsafe void NXOpen.Weld.CustomManager.RemoveWeldJointHandler ( int  id)
inline

Unregisters the welding joint handler

Created in NX8.0.0

License requirements: None.

Parameters
ididentifier for method to unregister
unsafe void NXOpen.Weld.CustomManager.ShowSolids ( bool  showSolids)
inline

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.
NXOpen.Weld.EdgePrep [] NXOpen.Weld.CustomManager.ToArray ( )
inline

Returns an array of NXOpen.Weld.EdgePrep objects.

delegate void NXOpen.Weld.CustomManager.VariableBevelHandler ( NXOpen.Weld.WeldJointBuilder  jointBuilder,
NXOpen.Curve  jointCurve 
)

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.

Parameters
jointBuilderbuilder to get thickness and set bevel angles with
jointCurvethe joint curve with attributes
delegate void NXOpen.Weld.CustomManager.WeldJointHandler ( NXOpen.Weld.JointExitBuilder  joint)

User defined method that is called whenever a welding joint is created or updated

Created in NX8.0.0

License requirements: None.

Parameters
jointcreated or updated welding joint

Property Documentation

Tag NXOpen.Weld.CustomManager.Tag
get

Returns the tag of this object.


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