CharacteristicsValueBuilder Class

class NXOpen.Weld.CharacteristicsValueBuilder

Bases: NXOpen.NXObject

The object containing the information about the attribute to be placed on the output of the weld feature.

The inheritance option only applies to the NXOpen.Weld.WeldJoint.

New in version NX7.5.0.

Properties

Property Description
Active Returns or sets the indication if the attribute is to be placed on the output.
AttributeType Returns the type of this attribute.
Inherited Returns or sets the indication if the attribute value is inherited from the source object.
IsOccurrence Returns whether this object is an occurrence or not.
JournalIdentifier Returns the identifier that would be recorded in a journal for this object.
Name Returns the custom name of the object.
OwningComponent Returns the owning component, if this object is an occurrence.
OwningPart Returns the owning part of this object
Prototype Returns the prototype of this object if it is an occurrence.
Required Returns the indication if the attribute is required to be placed on the output.
Tag Returns the Tag for this object.
Title Returns the title of this attribute.
ValueChanged Returns or sets the indication if the attribute value has been changed.
ValueDouble Returns or sets the value of this attribute when AttributeType is Weld.CharacteristicsValueBuilderType.Double.
ValueInteger Returns or sets the value of this attribute when AttributeType is Weld.CharacteristicsValueBuilderType.Integer.
ValueString Returns or sets the value of this attribute when AttributeType is Weld.CharacteristicsValueBuilderType.String or Weld.CharacteristicsValueBuilderType.Option.

Methods

Method Description
CreateAttributeIterator Create an attribute iterator
DeleteAllAttributesByType Deletes all attributes of a specific type.
DeleteAttributeByTypeAndTitle Deletes an attribute by type and title.
DeleteUserAttribute Deletes the first attribute encountered with the given Type, Title.
DeleteUserAttributes Deletes the attributes on the object, if any, that satisfy the given iterator
FindObject Finds the NXOpen.NXObject with the given identifier as recorded in a journal.
GetAttributeTitlesByType Gets all the attribute titles of a specific type.
GetBooleanUserAttribute Gets a boolean attribute by Title and array Index.
GetComputationalTimeUserAttribute Gets a time attribute by Title and array Index.
GetIntegerAttribute Gets an integer attribute by title.
GetIntegerUserAttribute Gets an integer attribute by Title and array Index.
GetNextUserAttribute Gets the next attribute encountered on the object, if any, that satisfies the given iterator.
GetOptionStrings The list of strings that are available to be set when AttributeType is Weld.CharacteristicsValueBuilderType.Option.
GetPdmReferenceAttributeValue Gets the value of PDM Reference attribute for given object.
GetRealAttribute Gets a real attribute by title.
GetRealUserAttribute Gets a real attribute by Title and array Index.
GetReferenceAttribute Gets the reference string (not the calculated value) of a string attribute that uses a reference string.
GetStringAttribute Gets a string attribute value by title.
GetStringUserAttribute Gets a string attribute by Title and array Index.
GetTimeAttribute Gets a time attribute by title.
GetTimeUserAttribute Gets a time attribute by Title and array Index.
GetUserAttribute Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index.
GetUserAttributeAsString Gets the first attribute encountered on the object, if any, with a given title, type and array index.
GetUserAttributeCount Gets the count of set attributes on the object, if any, that satisfy the given iterator.
GetUserAttributeLock Determine the lock of the given attribute.
GetUserAttributeSize Gets the size of the first attribute encountered on the object, if any, with a given Title and Type.
GetUserAttributeSourceObjects Returns an array of objects from which this object presents attributes.
GetUserAttributes Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator.
GetUserAttributesAsStrings Gets all the attributes that have been set on the given object.
HasUserAttribute Determines if an attribute exists on the object, that satisfies the given iterator
Print Prints a representation of this object to the system log file.
SetAttribute Creates or modifies an integer attribute.
SetBooleanUserAttribute Creates or modifies a boolean attribute with the option to update or not.
SetName Sets the custom name of the object.
SetPdmReferenceAttribute Sets the value of PDM Reference attribute on the object.
SetReferenceAttribute Creates or modifies a string attribute which uses a reference string.
SetTimeAttribute Creates or modifies a time attribute.
SetTimeUserAttribute Creates or modifies a time attribute with the option to update or not.
SetUserAttribute Creates or modifies an attribute with the option to update or not.
SetUserAttributeLock Lock or unlock the given attribute.

Enumerations

CharacteristicsValueBuilderType Enumeration Settings to indicate the type of value contained in the attribute.

Property Detail

Active

CharacteristicsValueBuilder.Active

Returns or sets the indication if the attribute is to be placed on the output.

true indicates the attribute will be placed on the output, false indicates the attribute will not be placed on the output. Note that if Required is true, then this property cannot be set.

-------------------------------------

Getter Method

Signature Active

Returns:
Return type:bool

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Active

Parameters:active (bool) –

New in version NX7.5.0.

License requirements: ugweld (“UG WELD”)

AttributeType

CharacteristicsValueBuilder.AttributeType

Returns the type of this attribute.

-------------------------------------

Getter Method

Signature AttributeType

Returns:
Return type:NXOpen.Weld.CharacteristicsValueBuilderType

New in version NX7.5.0.

License requirements: None.

Inherited

CharacteristicsValueBuilder.Inherited

Returns or sets the indication if the attribute value is inherited from the source object.

-------------------------------------

Getter Method

Signature Inherited

Returns:
Return type:bool

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Inherited

Parameters:inherited (bool) –

New in version NX10.0.0.

License requirements: ugweld (“UG WELD”) OR structure_weld (“STRUCTURE WELD”)

IsOccurrence

CharacteristicsValueBuilder.IsOccurrence

Returns whether this object is an occurrence or not.

-------------------------------------

Getter Method

Signature IsOccurrence

Returns:This object is an occurrence
Return type:bool

New in version NX3.0.0.

License requirements: None.

JournalIdentifier

CharacteristicsValueBuilder.JournalIdentifier

Returns the identifier that would be recorded in a journal for this object.

This may not be the same across different releases of the software.

-------------------------------------

Getter Method

Signature JournalIdentifier

Returns:
Return type:str

New in version NX3.0.0.

License requirements: None.

Name

CharacteristicsValueBuilder.Name

Returns the custom name of the object.

-------------------------------------

Getter Method

Signature Name

Returns:
Return type:str

New in version NX3.0.0.

License requirements: None.

OwningComponent

CharacteristicsValueBuilder.OwningComponent

Returns the owning component, if this object is an occurrence.

-------------------------------------

Getter Method

Signature OwningComponent

Returns:
Return type:NXOpen.Assemblies.Component

New in version NX3.0.0.

License requirements: None.

OwningPart

CharacteristicsValueBuilder.OwningPart

Returns the owning part of this object

-------------------------------------

Getter Method

Signature OwningPart

Returns:The owning part of this object or null if it does not have an owner
Return type:NXOpen.BasePart

New in version NX3.0.0.

License requirements: None.

Prototype

CharacteristicsValueBuilder.Prototype

Returns the prototype of this object if it is an occurrence.

-------------------------------------

Getter Method

Signature Prototype

Returns:The prototype of this object or null if this object is not an occurrence
Return type:NXOpen.INXObject

New in version NX3.0.0.

License requirements: None.

Required

CharacteristicsValueBuilder.Required

Returns the indication if the attribute is required to be placed on the output.

true indicates the attribute will always be placed on the output, false indicates the attribute does not have to be placed on the output.

-------------------------------------

Getter Method

Signature Required

Returns:
Return type:bool

New in version NX7.5.0.

License requirements: None.

Title

CharacteristicsValueBuilder.Title

Returns the title of this attribute.

-------------------------------------

Getter Method

Signature Title

Returns:
Return type:str

New in version NX7.5.0.

License requirements: None.

ValueChanged

CharacteristicsValueBuilder.ValueChanged

Returns or sets the indication if the attribute value has been changed.

-------------------------------------

Getter Method

Signature ValueChanged

Returns:
Return type:bool

New in version NX8.0.1.

License requirements: None.

-------------------------------------

Setter Method

Signature ValueChanged

Parameters:status (bool) –

New in version NX8.0.1.

License requirements: ugweld (“UG WELD”)

ValueDouble

CharacteristicsValueBuilder.ValueDouble

Returns or sets the value of this attribute when AttributeType is Weld.CharacteristicsValueBuilderType.Double.

-------------------------------------

Getter Method

Signature ValueDouble

Returns:
Return type:float

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ValueDouble

Parameters:valueDouble (float) –

New in version NX7.5.0.

License requirements: ugweld (“UG WELD”)

ValueInteger

CharacteristicsValueBuilder.ValueInteger

Returns or sets the value of this attribute when AttributeType is Weld.CharacteristicsValueBuilderType.Integer.

-------------------------------------

Getter Method

Signature ValueInteger

Returns:
Return type:int

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ValueInteger

Parameters:valueInteger (int) –

New in version NX7.5.0.

License requirements: ugweld (“UG WELD”)

ValueString

CharacteristicsValueBuilder.ValueString

Returns or sets the value of this attribute when AttributeType is Weld.CharacteristicsValueBuilderType.String or Weld.CharacteristicsValueBuilderType.Option.

-------------------------------------

Getter Method

Signature ValueString

Returns:
Return type:str

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ValueString

Parameters:valueString (str) –

New in version NX7.5.0.

License requirements: ugweld (“UG WELD”)

Method Detail

FindObject

CharacteristicsValueBuilder.FindObject

Finds the NXOpen.NXObject with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

An exception will be thrown if no object can be found with the given journal identifier.

Signature FindObject(journalIdentifier)

Parameters:journalIdentifier (str) – Journal identifier of the object
Returns:
Return type:NXOpen.INXObject

New in version NX3.0.0.

License requirements: None.

GetOptionStrings

CharacteristicsValueBuilder.GetOptionStrings

The list of strings that are available to be set when AttributeType is Weld.CharacteristicsValueBuilderType.Option.

Signature GetOptionStrings()

Returns:Strings that are allowed for values.
Return type:list of str

New in version NX7.5.0.

License requirements: None.

Print

CharacteristicsValueBuilder.Print

Prints a representation of this object to the system log file.

Signature Print()

New in version NX3.0.0.

License requirements: None.

SetName

CharacteristicsValueBuilder.SetName

Sets the custom name of the object.

NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

Signature SetName(name)

Parameters:name (str) –

New in version NX3.0.0.

License requirements: None.