This builder allows you to define the attribute values to be set on the output of the weld feature. More...

Inheritance diagram for NXOpen::Weld::CharacteristicsBuilder:

Public Types
enum	Type { TypeNone, TypeFilletFeature = 24, TypeGrooveFeature, TypeResistanceSpotFeature, TypeArcSpotFeature, TypeClinchFeature, TypeDollopFeature, TypeWeldNutFeature, TypeWeldStudFeature, TypeCustom1PointFeature, TypeCustom2PointFeature, TypeCustom3PointFeature, TypeCustom4PointFeature, TypeCustom5PointFeature, TypeDatumSurfaceFeature, TypeDatumPinFeature, TypeDatumCustom1Feature, TypeDatumCustom2Feature, TypeDatumCustom3Feature, TypeMeasurementSurfaceFeature, TypeMeasurementHoleFeature, TypeMeasurementSlotFeature, TypeMeasurementStudFeature, TypeMeasurementTrimFeature, TypeMeasurementHemFeature, TypeMeasurementCustom1Feature, TypeMeasurementCustom2Feature, TypeMeasurementCustom3Feature, TypeUserDefinedFeature, TypeSealerFillFeature, TypeSealerBeadFeature, TypeJointFeature, TypePlugSlotFeature, TypeShipHull = 57, TypeShipDeck, TypeShipTransverseBulkhead, TypeShipLongitudinalBulkhead, TypeShipGenericPlate, TypeShipStiffener, TypeShipEdgeReinforcement, TypeShipSeam, TypeDatumSurfaceCustom0, TypeDatumSurfaceCustom1, TypeDatumSurfaceCustom2, TypeDatumSurfaceCustom3, TypeDatumSurfaceCustom4, TypeDatumSurfaceCustom5, TypeDatumSurfaceCustom6, TypeDatumSurfaceCustom7, TypeDatumPinCustom0, TypeDatumPinCustom1, TypeDatumPinCustom2, TypeDatumPinCustom3, TypeDatumPinCustom4, TypeDatumPinCustom5, TypeDatumPinCustom6, TypeDatumPinCustom7, TypeSurfaceWeld, TypeShipProfileCutOut, TypeJointmarkFeature }
	The custom type of the datum specified for creation. More...

Public Member Functions
void	ApplyAttributes (const std::vector< NXOpen::NXObject * > &objects)
	Apply the selected attributes to the objects.

void	ApplyAttributesToSelected ()
	Apply the selected attributes to the objects that were selected.

bool	AreAttributesDefault (int weldType)
	Returns true if the characteristics builder contains all attributes with default values.

bool	AreAttributesDefault (NXOpen::Weld::CharacteristicsBuilder::Type charxType)
	Returns true if the characteristics builder contains all attributes with default values.

void	ChangeFeatureType (int weldType)
	Change the type of feature defining the attributes.

void	ChangeFeatureType (NXOpen::Weld::CharacteristicsBuilder::Type charxType)
	Change the type of feature defining the attributes.

void	CopyAttributesFromObject (NXOpen::NXObject *object)
	Copy the attributes that are on the object to the selection.

void	CopyNonActiveAttributesFromObject (NXOpen::NXObject *object)
	Copy the non active attributes that are on the object to the selection.

NXOpen::Weld::CharacteristicsSelectionBuilder *	CreateSelectionSet (int weldType, NXOpen::NXObject *data)
	Create a new selection set and add it to the list.

NXOpen::Weld::CharacteristicsSelectionBuilder *	CreateSelectionSet (NXOpen::Weld::CharacteristicsBuilder::Type charxType, NXOpen::NXObject *data)
	Create a new selection set and add it to the list.

bool	DoesObjectHaveAttributes (NXOpen::NXObject *object)
	Copy the attributes that are on the object to the selection and returns a flag indicating whether the object actually has attributes.

bool	HasActiveValues ()
	Returns true if the characteristics builder has any active values.

void	InheritAttributesFromObject (NXOpen::NXObject *object)
	Inherit the attributes that are on the object to the selection.

NXOpen::SelectNXObject *	InheritObject ()
	Returns the selection object containing data that is used to define the attribute values.

void	RemoveAllAttributes (const std::vector< NXOpen::NXObject * > &objects)
	Remove all attributes from the objects.

void	RemoveInheritedAttributes ()
	Remove any attributes that are inherited from other objects (for example, edges).

NXOpen::Weld::CharacteristicsValueBuilder *	Selected ()
	Returns the selected characteristic value.

NXOpen::NXObjectList *	SelectionList ()
	Returns the list of potential attributes and objects selected for this weld feature.

void	SetAllAttributesChanged ()
	Sets all attributes to be changed.

void	SetAllAttributesChanged (bool status)
	Sets all attributes changed value to the status value.

void	SetSelected (NXOpen::Weld::CharacteristicsValueBuilder *valueBuilder)
	Sets the selected characteristic value.

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

This builder allows you to define the attribute values to be set on the output of the weld feature.

To create a new instance of this class, use Weld::WeldManager::CreateCharacteristicsBuilder

Created in NX7.5.0.

Member Enumeration Documentation

enum NXOpen::Weld::CharacteristicsBuilder::Type

The custom type of the datum specified for creation.

Enumerator:

TypeNone	none
TypeGrooveFeature	groove feature
TypeResistanceSpotFeature	resistance spot feature
TypeArcSpotFeature	arc spot feature
TypeClinchFeature	clinch feature
TypeDollopFeature	dollop feature
TypeWeldNutFeature	weld nut feature
TypeWeldStudFeature	weld stud feature
TypeCustom1PointFeature	custom1point feature
TypeCustom2PointFeature	custom2point feature
TypeCustom3PointFeature	custom3point feature
TypeCustom4PointFeature	custom4point feature
TypeCustom5PointFeature	custom5point feature
TypeDatumSurfaceFeature	datum surface feature
TypeDatumPinFeature	datum pin feature
TypeDatumCustom1Feature	datum custom1feature
TypeDatumCustom2Feature	datum custom2feature
TypeDatumCustom3Feature	datum custom3feature
TypeMeasurementSurfaceFeature	measurement surface feature
TypeMeasurementHoleFeature	measurement hole feature
TypeMeasurementSlotFeature	measurement slot feature
TypeMeasurementStudFeature	measurement stud feature
TypeMeasurementTrimFeature	measurement trim feature
TypeMeasurementHemFeature	measurement hem feature
TypeMeasurementCustom1Feature	measurement custom1feature
TypeMeasurementCustom2Feature	measurement custom2feature
TypeMeasurementCustom3Feature	measurement custom3feature
TypeUserDefinedFeature	user defined feature
TypeSealerFillFeature	sealer fill feature
TypeSealerBeadFeature	sealer bead feature
TypeJointFeature	joint feature
TypePlugSlotFeature	plug slot feature
TypeShipDeck	ship deck
TypeShipTransverseBulkhead	ship transverse bulkhead
TypeShipLongitudinalBulkhead	ship longitudinal bulkhead
TypeShipGenericPlate	ship generic plate
TypeShipStiffener	ship stiffener
TypeShipEdgeReinforcement	ship edge reinforcement
TypeShipSeam	ship seam
TypeDatumSurfaceCustom0	datum surface custom0
TypeDatumSurfaceCustom1	datum surface custom1
TypeDatumSurfaceCustom2	datum surface custom2
TypeDatumSurfaceCustom3	datum surface custom3
TypeDatumSurfaceCustom4	datum surface custom4
TypeDatumSurfaceCustom5	datum surface custom5
TypeDatumSurfaceCustom6	datum surface custom6
TypeDatumSurfaceCustom7	datum surface custom7
TypeDatumPinCustom0	datum pin custom0
TypeDatumPinCustom1	datum pin custom1
TypeDatumPinCustom2	datum pin custom2
TypeDatumPinCustom3	datum pin custom3
TypeDatumPinCustom4	datum pin custom4
TypeDatumPinCustom5	datum pin custom5
TypeDatumPinCustom6	datum pin custom6
TypeDatumPinCustom7	datum pin custom7
TypeSurfaceWeld	surface weld
TypeShipProfileCutOut	ship profile cut out
TypeJointmarkFeature	jointmark feature

Member Function Documentation

void NXOpen::Weld::CharacteristicsBuilder::ApplyAttributes ( const std::vector< NXOpen::NXObject * > & objects )

Apply the selected attributes to the objects.

Created in NX7.5.0.

License requirements : None

Parameters

objects The objects to apply the attributes to.

void NXOpen::Weld::CharacteristicsBuilder::ApplyAttributesToSelected ( )

Apply the selected attributes to the objects that were selected.

Created in NX7.5.0.

License requirements : None

bool NXOpen::Weld::CharacteristicsBuilder::AreAttributesDefault ( int weldType )

Returns true if the characteristics builder contains all attributes with default values.

Returns

Deprecated:: Deprecated in NX9.0.0. Use overloaded function with enum instead.

Created in NX8.0.0.

License requirements : None

Parameters

weldType The type of welding feature being processed, see uf_weld_types.h.

bool NXOpen::Weld::CharacteristicsBuilder::AreAttributesDefault ( NXOpen::Weld::CharacteristicsBuilder::Type charxType )

Returns true if the characteristics builder contains all attributes with default values.

Returns: Created in NX9.0.0.

License requirements : None

Parameters

charxType The type of characteristics being processed

void NXOpen::Weld::CharacteristicsBuilder::ChangeFeatureType ( int weldType )

Change the type of feature defining the attributes.

       Note after calling this method, the WeldJA::CharacteristicsValueBuilder objects 
       previously retrieved will be invalid. You need to reaccess them if you want to
       make any changes to them.

Deprecated:: Deprecated in NX9.0.0. Use overloaded function with enum instead.

Created in NX7.5.0.

License requirements : None

Parameters

weldType The type of welding feature being processed, see uf_weld_types.h.

void NXOpen::Weld::CharacteristicsBuilder::ChangeFeatureType ( NXOpen::Weld::CharacteristicsBuilder::Type charxType )

Change the type of feature defining the attributes.

       Note after calling this method, the WeldJA::CharacteristicsValueBuilder objects 
       previously retrieved will be invalid. You need to reaccess them if you want to
       make any changes to them.

Created in NX9.0.0.

License requirements : None

Parameters

charxType The type of characteristics being processed

void NXOpen::Weld::CharacteristicsBuilder::CopyAttributesFromObject ( NXOpen::NXObject * object )

Copy the attributes that are on the object to the selection.

Created in NX8.0.0.

License requirements : None

Parameters

object The object from which to copy the attributes.

void NXOpen::Weld::CharacteristicsBuilder::CopyNonActiveAttributesFromObject ( NXOpen::NXObject * object )

Copy the non active attributes that are on the object to the selection.

Created in NX8.0.0.

License requirements : None

Parameters

object The object from which to copy the attributes.

NXOpen::Weld::CharacteristicsSelectionBuilder* NXOpen::Weld::CharacteristicsBuilder::CreateSelectionSet	(	int	weldType,
		NXOpen::NXObject *	data
	)

Create a new selection set and add it to the list.

Returns

Deprecated:: Deprecated in NX9.0.0. Use overloaded function with enum instead.

Created in NX7.5.0.

License requirements : None

Parameters

weldType	The type of welding feature being processed, see uf_weld_types.h.
data	An object to retrieve the current attribute settings.

NXOpen::Weld::CharacteristicsSelectionBuilder* NXOpen::Weld::CharacteristicsBuilder::CreateSelectionSet	(	NXOpen::Weld::CharacteristicsBuilder::Type	charxType,
		NXOpen::NXObject *	data
	)

Create a new selection set and add it to the list.

Returns: Created in NX9.0.0.

License requirements : None

Parameters

charxType	The type of characteristics being processed
data	An object to retrieve the current attribute settings.

bool NXOpen::Weld::CharacteristicsBuilder::DoesObjectHaveAttributes ( NXOpen::NXObject * object )

Copy the attributes that are on the object to the selection and returns a flag indicating whether the object actually has attributes.

Returns: Created in NX8.0.1.

License requirements : None

Parameters

object The object from which to copy the attributes.

bool NXOpen::Weld::CharacteristicsBuilder::HasActiveValues ( )

Returns true if the characteristics builder has any active values.

Returns: Created in NX8.0.0.

License requirements : None

void NXOpen::Weld::CharacteristicsBuilder::InheritAttributesFromObject ( NXOpen::NXObject * object )

Inherit the attributes that are on the object to the selection.

Created in NX8.5.0.

License requirements : None

Parameters

object The object from which to inherit the attributes.

NXOpen::SelectNXObject* NXOpen::Weld::CharacteristicsBuilder::InheritObject ( )

Returns the selection object containing data that is used to define the attribute values.

Created in NX7.5.0.

License requirements : None

void NXOpen::Weld::CharacteristicsBuilder::RemoveAllAttributes ( const std::vector< NXOpen::NXObject * > & objects )

Remove all attributes from the objects.

Created in NX8.0.0.

License requirements : None

Parameters

objects The objects to remove the attributes from.

void NXOpen::Weld::CharacteristicsBuilder::RemoveInheritedAttributes ( )

Remove any attributes that are inherited from other objects (for example, edges).

These will be attributes that are not required and are not in a category.
Created in NX8.0.1.

License requirements : None

NXOpen::Weld::CharacteristicsValueBuilder* NXOpen::Weld::CharacteristicsBuilder::Selected ( )

Returns the selected characteristic value.

Created in NX7.5.0.

License requirements : None

NXOpen::NXObjectList* NXOpen::Weld::CharacteristicsBuilder::SelectionList ( )

Returns the list of potential attributes and objects selected for this weld feature.

Created in NX7.5.0.

License requirements : None

void NXOpen::Weld::CharacteristicsBuilder::SetAllAttributesChanged ( )

Sets all attributes to be changed.

Created in NX8.5.0.

License requirements : None

void NXOpen::Weld::CharacteristicsBuilder::SetAllAttributesChanged ( bool status )

Sets all attributes changed value to the status value.

Created in NX9.0.0.

License requirements : None

Parameters

status The value to set changed value. true means attribute has been changed, false means attribute has not been changed

void NXOpen::Weld::CharacteristicsBuilder::SetSelected ( NXOpen::Weld::CharacteristicsValueBuilder * valueBuilder )

Sets the selected characteristic value.

Created in NX7.5.0.

License requirements : None

Parameters

valueBuilder valuebuilder

The documentation for this class was generated from the following file:

Weld_CharacteristicsBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation