Represents a User Defined Weld feature. More...

Inheritance diagram for NXOpen::Weld::UserDefinedWeld:

Public Member Functions
virtual void	GetFeatureDiagnostics (std::vector< int > &diagnosticCodes)
	Returns the feature diagnostic information, warning, or error codes. More...

virtual NXString	GetFeatureIconName ()
	Gets the feature icon name. More...

virtual int	GetFeatureLayer ()
	Gets the feature layer. More...

virtual int	GetFeatureObjectColor ()
	Gets the feature color. More...

virtual void	GetFeatureReferenceSets (std::vector< NXOpen::ReferenceSet * > &refSet)
	Gets all the reference sets that this feature is a member of. More...

virtual void	GetFeatureReferenceSetStrings (std::vector< NXString > &refSet)
	Gets all the reference sets that this feature is a member of. More...

Public Member Functions inherited from NXOpen::Features::BodyFeature
std::vector< NXOpen::Body * >	GetBodies ()
	Returns the bodies created by the feature. More...

std::vector< NXOpen::Edge * >	GetEdges ()
	Returns the edges created by the feature. More...

std::vector< NXOpen::Face * >	GetFaces ()
	Returns the faces created by the feature. More...

Public Member Functions inherited from NXOpen::Features::Feature
int	AlgorithmVersion ()
	Returns the algorithm version of the feature More...

bool	BreakWaveLink ()
	Break Wave Link Feature. More...

void	ChangeBooleanType ()
	Change Boolean Type Created in NX9.0.0. More...

NXOpen::Features::IContainerFeature *	ContainerFeature ()
	Returns the container feature for this feature. More...

void	DeleteClueAlerts ()
	Delete all clue alerts from the features Created in NX8.0.1. More...

void	DeleteHintAlerts ()
	Delete all clue alerts from the features Created in NX8.0.1. More...

void	DeleteInformationalAlerts ()
	Delete all informational alerts from the features Created in NX5.0.0. More...

void	DeleteWarningAlerts ()
	Delete all warning alerts from the features Created in NX10.0.0. More...

NXString	FeatureType ()
	Returns the feature type Created in NX3.0.0. More...

std::vector < NXOpen::Features::Feature * >	GetAllChildren ()
	Returns all immediate child features. More...

std::vector < NXOpen::Features::Feature * >	GetChildren ()
	Returns the immediate child features. More...

std::vector< NXOpen::NXObject * >	GetEntities ()
	Returns the entities created by the feature. More...

std::vector< NXOpen::Expression * >	GetExpressions ()
	Returns the expressions created by the feature. More...

std::vector< NXString >	GetFeatureClueHintMessages ()
	Returns both clue and hint messages of the feature. More...

std::vector< NXString >	GetFeatureClueMessages ()
	Returns the feature clue messages. More...

NXOpen::NXColor *	GetFeatureColor ()
	The feature color. More...

std::vector< NXString >	GetFeatureErrorMessages ()
	Returns the feature error messages. More...

std::vector< NXString >	GetFeatureHintMessages ()
	Returns the feature hint messages. More...

std::vector< NXString >	GetFeatureInformationalMessages ()
	Returns the feature informational messages. More...

NXString	GetFeatureName ()
	Returns the displayed name of the feature. More...

std::vector< NXString >	GetFeatureWarningMessages ()
	Returns the feature warning messages. More...

std::vector < NXOpen::Features::Feature * >	GetParents ()
	Returns the immediate parent features. More...

std::vector< NXOpen::Section * >	GetSections ()
	Queries a feature for list of its sections. More...

void	HideBody ()
	Hide the body created by the feature Created in NX3.0.0. More...

void	HideParents ()
	Hide the body created by the parent feature Created in NX3.0.0. More...

void	Highlight ()
	Highlight the body created by the feature Created in NX3.0.0. More...

bool	IsContainedFeature ()
	Returns true if the feature is a contained feature. More...

bool	IsInternal ()
	Returns true if the feature is internal. More...

NXOpen::Point3d	Location ()
	Returns the location of the feature Created in NX3.0.0. More...

void	LogDiagnostic (int errorCode, const NXString &message, NXOpen::Features::Feature::DiagnosticType diagnosticType)
	Log a diagnostic alert for this feature Created in NX8.0.0. More...

void	LogDiagnostic (int errorCode, const char *message, NXOpen::Features::Feature::DiagnosticType diagnosticType)
	Log a diagnostic alert for this feature Created in NX8.0.0. More...

void	MakeCurrentFeature ()
	Make current feature Created in NX3.0.0. More...

void	MakeSketchExternal ()
	Make the parent sketch external for reuse by other features. More...

void	MakeSketchInternal ()
	Make the parent sketch internal if referenced only by this feature. More...

void	RemoveForEdit (bool dependent)
	Remove all the feature faces before a NoHistory mode edit. More...

void	RemoveParameters ()
	Remove Local feature parameters in history free mode. More...

void	SetGroupActive (bool active)
	Set a feature group as active group. More...

void	ShowBody (bool moveCurves)
	Show the body created by the feature. More...

void	ShowDimensions ()
	Show all feature dimensions of a feature. More...

void	ShowParents (bool moveCurves)
	Show the body created by the parent feature. More...

void	Suppress ()
	Suppress the feature Created in NX3.0.0. More...

bool	Suppressed ()
	Returns the suppression status of the feature Created in NX3.0.0. More...

int	Timestamp ()
	Returns the timestamp of the feature Created in NX3.0.0. More...

void	Unhighlight ()
	Unhighlight the body created by the feature Created in NX3.0.0. More...

void	Unsuppress ()
	Unsuppress the feature Created in NX3.0.0. More...

Public Member Functions inherited from NXOpen::NXObject
NXOpen::AttributeIterator *	CreateAttributeIterator ()
	Create an attribute iterator. More...

void	DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type)
	Deletes all attributes of a specific type. More...

void	DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option)
	Deletes all attributes of a specific type with the option to update or not. More...

void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const NXString &title)
	Deletes an attribute by type and title. More...

void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title)
	Deletes an attribute by type and title. More...

void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const NXString &title, NXOpen::Update::Option option)
	Deletes an attribute by type and title with the option to update or not. More...

void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title, NXOpen::Update::Option option)
	Deletes an attribute by type and title with the option to update or not. More...

void	DeleteUserAttribute (NXOpen::NXObject::AttributeType type, const NXString &title, bool deleteEntireArray, NXOpen::Update::Option option)
	Deletes the first attribute encountered with the given Type, Title. More...

void	DeleteUserAttribute (NXOpen::NXObject::AttributeType type, const char *title, bool deleteEntireArray, NXOpen::Update::Option option)
	Deletes the first attribute encountered with the given Type, Title. More...

void	DeleteUserAttributes (NXOpen::AttributeIterator *iterator, NXOpen::Update::Option option)
	Deletes the attributes on the object, if any, that satisfy the given iterator Created in NX8.0.0. More...

void	DeleteUserAttributes (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option)
	Deletes the attributes encountered with the given Type with option to update or not. More...

virtual NXOpen::INXObject *	FindObject (const NXString &journalIdentifier)
	Finds the NXOpen::NXObject with the given identifier as recorded in a journal. More...

virtual NXOpen::INXObject *	FindObject (const char *journalIdentifier)
	Finds the NXOpen::NXObject with the given identifier as recorded in a journal. More...

std::vector < NXOpen::NXObject::AttributeInformation >	GetAttributeTitlesByType (NXOpen::NXObject::AttributeType type)
	Gets all the attribute titles of a specific type. More...

bool	GetBooleanUserAttribute (const NXString &title, int index)
	Gets a boolean attribute by Title and array Index. More...

bool	GetBooleanUserAttribute (const char *title, int index)
	Gets a boolean attribute by Title and array Index. More...

NXOpen::NXObject::ComputationalTime	GetComputationalTimeUserAttribute (const NXString &title, int index)
	Gets a time attribute by Title and array Index. More...

NXOpen::NXObject::ComputationalTime	GetComputationalTimeUserAttribute (const char *title, int index)
	Gets a time attribute by Title and array Index. More...

int	GetIntegerAttribute (const NXString &title)
	Gets an integer attribute by title. More...

int	GetIntegerAttribute (const char *title)
	Gets an integer attribute by title. More...

int	GetIntegerUserAttribute (const NXString &title, int index)
	Gets an integer attribute by Title and array Index. More...

int	GetIntegerUserAttribute (const char *title, int index)
	Gets an integer attribute by Title and array Index. More...

bool	GetNextUserAttribute (NXOpen::AttributeIterator iterator, NXOpen::NXObject::AttributeInformation info)
	Gets the next attribute encountered on the object, if any, that satisfies the given iterator. More...

NXString	GetPdmReferenceAttributeValue (const NXString &attributeTitle)
	Gets the value of PDM Reference attribute for given object. More...

NXString	GetPdmReferenceAttributeValue (const char *attributeTitle)
	Gets the value of PDM Reference attribute for given object. More...

double	GetRealAttribute (const NXString &title)
	Gets a real attribute by title. More...

double	GetRealAttribute (const char *title)
	Gets a real attribute by title. More...

double	GetRealUserAttribute (const NXString &title, int index)
	Gets a real attribute by Title and array Index. More...

double	GetRealUserAttribute (const char *title, int index)
	Gets a real attribute by Title and array Index. More...

NXString	GetReferenceAttribute (const NXString &title)
	Gets the reference string (not the calculated value) of a string attribute that uses a reference string. More...

NXString	GetReferenceAttribute (const char *title)
	Gets the reference string (not the calculated value) of a string attribute that uses a reference string. More...

NXString	GetStringAttribute (const NXString &title)
	Gets a string attribute value by title. More...

NXString	GetStringAttribute (const char *title)
	Gets a string attribute value by title. More...

NXString	GetStringUserAttribute (const NXString &title, int index)
	Gets a string attribute by Title and array Index. More...

NXString	GetStringUserAttribute (const char *title, int index)
	Gets a string attribute by Title and array Index. More...

NXString	GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const NXString &title)
	Gets a time attribute by title. More...

NXString	GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const char *title)
	Gets a time attribute by title. More...

NXString	GetTimeUserAttribute (const NXString &title, int index)
	Gets a time attribute by Title and array Index. More...

NXString	GetTimeUserAttribute (const char *title, int index)
	Gets a time attribute by Title and array Index. More...

NXOpen::NXObject::AttributeInformation	GetUserAttribute (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. More...

NXOpen::NXObject::AttributeInformation	GetUserAttribute (const char *title, NXOpen::NXObject::AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. More...

std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttribute (const NXString &title, bool includeUnset, bool addStringValues, NXOpen::NXObject::AttributeType type)
	Gets the first attribute (or attribute array) encountered on the object, if any, with a given Title and Type. More...

std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttribute (const char *title, bool includeUnset, bool addStringValues, NXOpen::NXObject::AttributeType type)
	Gets the first attribute (or attribute array) encountered on the object, if any, with a given Title and Type. More...

NXString	GetUserAttributeAsString (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given title, type and array index. More...

NXString	GetUserAttributeAsString (const char *title, NXOpen::NXObject::AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given title, type and array index. More...

int	GetUserAttributeCount (NXOpen::AttributeIterator *iterator)
	Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...

int	GetUserAttributeCount (NXOpen::AttributeIterator *iterator, bool countArrayAsOneAttribute)
	Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...

int	GetUserAttributeCount (NXOpen::NXObject::AttributeType type)
	Gets the count of set attributes on the object, if any, of the given type. More...

int	GetUserAttributeCount (NXOpen::NXObject::AttributeType type, bool includeUnset, bool countArrayAsOneAttribute)
	Gets the count of attributes on the object, if any, of the given type. More...

bool	GetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type)
	Determine the lock of the given attribute. More...

bool	GetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type)
	Determine the lock of the given attribute. More...

std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes (NXOpen::AttributeIterator *iterator)
	Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator. More...

std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes ()
	Gets all the attributes that have been set on the given object. More...

std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes (bool includeUnset)
	Gets all the attributes of the given object. More...

std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes (bool includeUnset, bool addStringValues)
	Gets all the attributes of the given object. More...

std::vector< NXString >	GetUserAttributesAsStrings ()
	Gets all the attributes that have been set on the given object. More...

int	GetUserAttributeSize (const NXString &title, NXOpen::NXObject::AttributeType type)
	Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. More...

int	GetUserAttributeSize (const char *title, NXOpen::NXObject::AttributeType type)
	Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. More...

std::vector< NXOpen::NXObject * >	GetUserAttributeSourceObjects ()
	Returns an array of objects from which this object presents attributes. More...

bool	HasUserAttribute (NXOpen::AttributeIterator *iterator)
	Determines if an attribute exists on the object, that satisfies the given iterator. More...

bool	HasUserAttribute (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
	Determines if an attribute with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. More...

bool	HasUserAttribute (const char *title, NXOpen::NXObject::AttributeType type, int index)
	Determines if an attribute with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. More...

virtual bool	IsOccurrence ()
	Returns whether this object is an occurrence or not. More...

virtual NXString	JournalIdentifier ()
	Returns the identifier that would be recorded in a journal for this object. More...

virtual NXString	Name ()
	Returns the custom name of the object. More...

virtual NXOpen::Assemblies::Component *	OwningComponent ()
	Returns the owning component, if this object is an occurrence. More...

virtual NXOpen::BasePart *	OwningPart ()
	Returns the owning part of this object Created in NX3.0.0. More...

virtual void	Print ()
	Prints a representation of this object to the system log file. More...

virtual NXOpen::INXObject *	Prototype ()
	Returns the prototype of this object if it is an occurrence. More...

void	SetAttribute (const NXString &title, int value)
	Creates or modifies an integer attribute. More...

void	SetAttribute (const char *title, int value)
	Creates or modifies an integer attribute. More...

void	SetAttribute (const NXString &title, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not. More...

void	SetAttribute (const char *title, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not. More...

void	SetAttribute (const NXString &title, double value)
	Creates or modifies a real attribute. More...

void	SetAttribute (const char *title, double value)
	Creates or modifies a real attribute. More...

void	SetAttribute (const NXString &title, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not. More...

void	SetAttribute (const char *title, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not. More...

void	SetAttribute (const NXString &title, const NXString &value)
	Creates or modifies a string attribute. More...

void	SetAttribute (const char title, const char value)
	Creates or modifies a string attribute. More...

void	SetAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a string attribute with the option to update or not. More...

void	SetAttribute (const char title, const char value, NXOpen::Update::Option option)
	Creates or modifies a string attribute with the option to update or not. More...

void	SetAttribute (const NXString &title)
	Creates or modifies a null attribute which is an attribute with a title and no value. More...

void	SetAttribute (const char *title)
	Creates or modifies a null attribute which is an attribute with a title and no value. More...

void	SetAttribute (const NXString &title, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not. More...

void	SetAttribute (const char *title, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not. More...

void	SetBooleanUserAttribute (const NXString &title, int index, bool value, NXOpen::Update::Option option)
	Creates or modifies a boolean attribute with the option to update or not. More...

void	SetBooleanUserAttribute (const char *title, int index, bool value, NXOpen::Update::Option option)
	Creates or modifies a boolean attribute with the option to update or not. More...

virtual void	SetName (const NXString &name)
	Sets the custom name of the object. More...

virtual void	SetName (const char *name)
	Sets the custom name of the object. More...

void	SetPdmReferenceAttribute (const NXString &attributeTitle, const NXString &attributeValue)
	Sets the value of PDM Reference attribute on the object. More...

void	SetPdmReferenceAttribute (const char attributeTitle, const char attributeValue)
	Sets the value of PDM Reference attribute on the object. More...

void	SetReferenceAttribute (const NXString &title, const NXString &value)
	Creates or modifies a string attribute which uses a reference string. More...

void	SetReferenceAttribute (const char title, const char value)
	Creates or modifies a string attribute which uses a reference string. More...

void	SetReferenceAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a string attribute which uses a reference string, with the option to update or not. More...

void	SetReferenceAttribute (const char title, const char value, NXOpen::Update::Option option)
	Creates or modifies a string attribute which uses a reference string, with the option to update or not. More...

void	SetTimeAttribute (const NXString &title, const NXString &value)
	Creates or modifies a time attribute. More...

void	SetTimeAttribute (const char title, const char value)
	Creates or modifies a time attribute. More...

void	SetTimeAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not. More...

void	SetTimeAttribute (const char title, const char value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not. More...

void	SetTimeUserAttribute (const NXString &title, int index, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not. More...

void	SetTimeUserAttribute (const char title, int index, const char value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not. More...

void	SetTimeUserAttribute (const NXString &title, int index, const NXOpen::NXObject::ComputationalTime &value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not. More...

void	SetTimeUserAttribute (const char *title, int index, const NXOpen::NXObject::ComputationalTime &value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not. More...

void	SetUserAttribute (const NXOpen::NXObject::AttributeInformation &info, NXOpen::Update::Option option)
	Creates or modifies an attribute with the option to update or not. More...

void	SetUserAttribute (const NXString &title, int index, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not. More...

void	SetUserAttribute (const char *title, int index, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not. More...

void	SetUserAttribute (const NXString &title, int index, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not. More...

void	SetUserAttribute (const char *title, int index, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not. More...

void	SetUserAttribute (const NXString &title, int index, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a string attribute with the option to update or not. More...

void	SetUserAttribute (const char title, int index, const char value, NXOpen::Update::Option option)
	Creates or modifies a string attribute with the option to update or not. More...

void	SetUserAttribute (const NXString &title, int index, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not. More...

void	SetUserAttribute (const char *title, int index, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not. More...

void	SetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type, bool lock)
	Lock or unlock the given attribute. More...

void	SetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type, bool lock)
	Lock or unlock the given attribute. More...

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

Additional Inherited Members
Public Types inherited from NXOpen::Features::Feature
enum	BooleanType { BooleanTypeCreate, BooleanTypeUnite, BooleanTypeSubtract, BooleanTypeIntersect, BooleanTypeEmbossNormalSide = 8, BooleanTypeEmbossOppositeNormalSide }
	Boolean operation type. More...

enum	DiagnosticType { DiagnosticTypeInformation = 1, DiagnosticTypeWarning }
	Diagnostic type. More...

Detailed Description

Represents a User Defined Weld feature.

To create or edit an instance of this class, use NXOpen::Weld::UserDefinedWeldBuilder

Created in NX7.5.0.

Member Function Documentation

virtual void NXOpen::Weld::UserDefinedWeld::GetFeatureDiagnostics ( std::vector< int > & diagnosticCodes )

virtual

Returns the feature diagnostic information, warning, or error codes.

Created in NX11.0.0.

License requirements : None

Parameters

diagnosticCodes the information, warning, or error codes for this feature.

Implements NXOpen::Weld::IFeature.

virtual NXString NXOpen::Weld::UserDefinedWeld::GetFeatureIconName ( )

virtual

Gets the feature icon name.

Returns: Created in NX12.0.0.

License requirements : None

Implements NXOpen::Weld::IFeature.

virtual int NXOpen::Weld::UserDefinedWeld::GetFeatureLayer ( )

virtual

Gets the feature layer.

Returns: Created in NX12.0.0.

License requirements : None

Implements NXOpen::Weld::IFeature.

virtual int NXOpen::Weld::UserDefinedWeld::GetFeatureObjectColor ( )

virtual

Gets the feature color.

Returns: Created in NX12.0.0.

License requirements : None

Implements NXOpen::Weld::IFeature.

virtual void NXOpen::Weld::UserDefinedWeld::GetFeatureReferenceSets ( std::vector< NXOpen::ReferenceSet * > & refSet )

virtual

Gets all the reference sets that this feature is a member of.

Created in NX12.0.0.

License requirements : None

Parameters

refSet refset

Implements NXOpen::Weld::IFeature.

virtual void NXOpen::Weld::UserDefinedWeld::GetFeatureReferenceSetStrings ( std::vector< NXString > & refSet )

virtual

Gets all the reference sets that this feature is a member of.

Created in NX12.0.0.

License requirements : None

Parameters

refSet refset

Implements NXOpen::Weld::IFeature.

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

Weld_UserDefinedWeld.hxx

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation