Bolt Class

class NXOpen.CAE.Connections.Bolt

Bases: NXOpen.CAE.Connections.IConnection, NXOpen.CAE.Connections.IMaterial, NXOpen.CAE.Connections.IFlangesContainer, NXOpen.CAE.Connections.ILocationsContainer, NXOpen.CAE.Connections.IDiameter, NXOpen.CAE.Connections.ILocationsWithDirContainer

Bolt connection.

Use this interface to set/get properties and parameters of the spot weld connection. To obtain an instance of this object use the connection creators on the CAE.Connections.Folder

New in version NX12.0.0.

Properties

Property Description
Coefficient Returns the coefficient for formula defined diameter
Color Returns or sets the color of the object.
Diameter Returns the connection diameter
DiameterType Returns or sets the diameter type
HeadDiameter Returns the head diameter
HeadDiameterCoefficient Returns the head diameter coefficient
HeadDiameterType Returns or sets the head diameter type
IsBlanked Returns the blank status of this 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.
Layer Returns or sets the layer that the object is in.
LineFont Returns or sets the line font of the object.
LineWidth Returns or sets the line width of the object.
Material Returns or sets the connection material
MaxBoltLength Returns the maximum bolt length
Name Returns the custom name of the object.
NameLocation Returns the location of the object’s name.
NumberOfFlanges Returns or sets the number of flanges.
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.
TableFile Returns or sets the table file used to compute the diameter
Tag Returns the Tag for this object.
UserDescription Returns or sets the connection user description

Methods

Method Description
AddFlangeEntities Add entities to flange.
AddLocationCoordinatesWithDirectionCoordinates Adds a coordinates location with direction definited by coordinates to connection location list
AddLocationCoordinatesWithDirectionVector Adds a coordinates location with direction definited by vector to connection location list
Blank Blanks the object.
CanHaveNoMaterial Use this function to check if the connction supports having no material
CanInheritMaterial Use this function to check if the connction supports inherited material
ConvertLocationToCoordinatesType Convert a location to coordinates.
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.
GetFlangeEntities Gets entities from flange.
GetIntegerAttribute Gets an integer attribute by title.
GetIntegerUserAttribute Gets an integer attribute by Title and array Index.
GetLocation Get a node location to connection location list
GetMaxNumberOfFlanges Retrieve the max number of flanges supported by this connection
GetMinNumberOfFlanges Retrieve the minimmum number of flanges supported by this connection
GetNextUserAttribute Gets the next attribute encountered on the object, if any, that satisfies the given iterator.
GetNumberOfDefinitions Gets the number of line offset definitions
GetNumberOfLocations Get a node location to connection location list
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.
GetSupportedDiameterTypes Gets supported diameter types of connection.
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
Highlight Highlights the object.
IsInheritedMaterial Use this function to check if the connection inherits material from flanges
MoveLocation Move the location by number of positions
Print Prints a representation of this object to the system log file.
RedisplayObject Redisplays the object in all views.
RemoveFlangeEntities Remove entities from flange.
RemoveLocation Remove a location from connection location list
RemoveViewDependency Remove dependency on all views from an object.
SetAttribute Creates or modifies an integer attribute.
SetBooleanUserAttribute Creates or modifies a boolean attribute with the option to update or not.
SetInheritedMaterial Use this function to set inherited material to connection
SetName Sets the custom name of the object.
SetNameLocation Sets the location of the object’s name.
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.
Unblank Unblanks the object.
Unhighlight Unhighlights the object.

Property Detail

Coefficient

Bolt.Coefficient

Returns the coefficient for formula defined diameter

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

Getter Method

Signature Coefficient

Returns:
Return type:NXOpen.Expression

New in version NX12.0.0.

License requirements: None.

Diameter

Bolt.Diameter

Returns the connection diameter

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

Getter Method

Signature Diameter

Returns:
Return type:NXOpen.Expression

New in version NX12.0.0.

License requirements: None.

DiameterType

Bolt.DiameterType

Returns or sets the diameter type

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

Getter Method

Signature DiameterType

Returns:
Return type:NXOpen.CAE.Connections.DiameterType

New in version NX12.0.0.

License requirements: None.

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

Setter Method

Signature DiameterType

Parameters:diameterType (NXOpen.CAE.Connections.DiameterType) –

New in version NX12.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”)

HeadDiameter

Bolt.HeadDiameter

Returns the head diameter

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

Getter Method

Signature HeadDiameter

Returns:Head diameter
Return type:NXOpen.Expression

New in version NX12.0.0.

License requirements: None.

HeadDiameterCoefficient

Bolt.HeadDiameterCoefficient

Returns the head diameter coefficient

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

Getter Method

Signature HeadDiameterCoefficient

Returns:Head diameter
Return type:NXOpen.Expression

New in version NX12.0.0.

License requirements: None.

HeadDiameterType

Bolt.HeadDiameterType

Returns or sets the head diameter type

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

Getter Method

Signature HeadDiameterType

Returns:Head diameter type
Return type:NXOpen.CAE.Connections.HeadDiameterType

New in version NX12.0.0.

License requirements: None.

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

Setter Method

Signature HeadDiameterType

Parameters:param (NXOpen.CAE.Connections.HeadDiameterType) – Head diameter type

New in version NX12.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”)

IsOccurrence

Bolt.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

Bolt.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.

Material

Bolt.Material

Returns or sets the connection material

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

Getter Method

Signature Material

Returns:The connection material
Return type:NXOpen.PhysicalMaterial

New in version NX12.0.0.

License requirements: None.

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

Setter Method

Signature Material

Parameters:material (NXOpen.PhysicalMaterial) – The connection material

New in version NX12.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”)

MaxBoltLength

Bolt.MaxBoltLength

Returns the maximum bolt length

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

Getter Method

Signature MaxBoltLength

Returns:Maximmum bolt length
Return type:NXOpen.Expression

New in version NX12.0.0.

License requirements: None.

Name

Bolt.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.

NumberOfFlanges

Bolt.NumberOfFlanges

Returns or sets the number of flanges.

When changing the number of flanges this is not applied till an update is performed by calling Update.DoUpdate()

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

Getter Method

Signature NumberOfFlanges

Returns:
Return type:int

New in version NX12.0.0.

License requirements: None.

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

Setter Method

Signature NumberOfFlanges

Parameters:numberOfFlanges (int) –

New in version NX12.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”)

OwningComponent

Bolt.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

Bolt.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

Bolt.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.

TableFile

Bolt.TableFile

Returns or sets the table file used to compute the diameter

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

Getter Method

Signature TableFile

Returns:
Return type:str

New in version NX12.0.0.

License requirements: None.

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

Setter Method

Signature TableFile

Parameters:tableFile (str) – Full path to the diameter table file.

New in version NX12.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”)

Method Detail

AddFlangeEntities

Bolt.AddFlangeEntities

Add entities to flange.

Changes are not applied till an update is performed by calling Update.DoUpdate()

Signature AddFlangeEntities(flangeIndex, entities)

Parameters:

New in version NX12.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”)

AddLocationCoordinatesWithDirectionCoordinates

Bolt.AddLocationCoordinatesWithDirectionCoordinates

Adds a coordinates location with direction definited by coordinates to connection location list

Signature AddLocationCoordinatesWithDirectionCoordinates(indexOfDefinition, point, direction)

Parameters:
  • indexOfDefinition (int) – The index of definition
  • point (NXOpen.Point) – Location Coordinates
  • direction (NXOpen.Point) – Direction Point
Returns:

The created coordinates with direction type location
Return type:

NXOpen.CAE.Connections.LocationWithDir

New in version NX12.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”)

AddLocationCoordinatesWithDirectionVector

Bolt.AddLocationCoordinatesWithDirectionVector

Adds a coordinates location with direction definited by vector to connection location list

Signature AddLocationCoordinatesWithDirectionVector(indexOfDefinition, masterPoint, direction)

Parameters:
  • indexOfDefinition (int) – The index of definition
  • masterPoint (NXOpen.Point) – Location Coordinates
  • direction (NXOpen.Direction) – Direction direction
Returns:

The created point with direction type location
Return type:

NXOpen.CAE.Connections.LocationWithDir

New in version NX12.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”)

CanHaveNoMaterial

Bolt.CanHaveNoMaterial

Use this function to check if the connction supports having no material

Signature CanHaveNoMaterial()

Returns:
Return type:bool

New in version NX12.0.0.

License requirements: None.

CanInheritMaterial

Bolt.CanInheritMaterial

Use this function to check if the connction supports inherited material

Signature CanInheritMaterial()

Returns:
Return type:bool

New in version NX12.0.0.

License requirements: None.

ConvertLocationToCoordinatesType

Bolt.ConvertLocationToCoordinatesType

Convert a location to coordinates.

The location is given by its index

Signature ConvertLocationToCoordinatesType(indexOfDefinition, index)

Parameters:
  • indexOfDefinition (int) – The index of definition
  • index (int) – The location index
Returns:

The created coordinates type location
Return type:

NXOpen.CAE.Connections.Location

New in version NX12.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”)

FindObject

Bolt.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.

GetFlangeEntities

Bolt.GetFlangeEntities

Gets entities from flange.

These can be meshes, elements, groups.

Signature GetFlangeEntities(flangeIndex)

Parameters:flangeIndex (int) –
Returns:Flange entities
Return type:list of NXOpen.TaggedObject

New in version NX12.0.0.

License requirements: None.

GetLocation

Bolt.GetLocation

Get a node location to connection location list

Signature GetLocation(indexOfDefinition, indexOfLocation)

Parameters:
  • indexOfDefinition (int) – The index of definition
  • indexOfLocation (int) – The location index
Returns:

The location
Return type:

NXOpen.CAE.Connections.Location

New in version NX12.0.0.

License requirements: None.

GetMaxNumberOfFlanges

Bolt.GetMaxNumberOfFlanges

Retrieve the max number of flanges supported by this connection

Signature GetMaxNumberOfFlanges()

Returns:
Return type:int

New in version NX12.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”)

GetMinNumberOfFlanges

Bolt.GetMinNumberOfFlanges

Retrieve the minimmum number of flanges supported by this connection

Signature GetMinNumberOfFlanges()

Returns:
Return type:int

New in version NX12.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”)

GetNumberOfDefinitions

Bolt.GetNumberOfDefinitions

Gets the number of line offset definitions

Signature GetNumberOfDefinitions()

Returns:The number of definitions
Return type:int

New in version NX12.0.0.

License requirements: None.

GetNumberOfLocations

Bolt.GetNumberOfLocations

Get a node location to connection location list

Signature GetNumberOfLocations(indexOfDefinition)

Parameters:indexOfDefinition (int) – The index of definition
Returns:The number of locations
Return type:int

New in version NX12.0.0.

License requirements: None.

GetSupportedDiameterTypes

Bolt.GetSupportedDiameterTypes

Gets supported diameter types of connection.

Signature GetSupportedDiameterTypes()

Returns:Supported CSys Types
Return type:list of NXOpen.CAE.Connections.DiameterType

New in version NX12.0.0.

License requirements: None.

IsInheritedMaterial

Bolt.IsInheritedMaterial

Use this function to check if the connection inherits material from flanges

Signature IsInheritedMaterial()

Returns:
Return type:bool

New in version NX12.0.0.

License requirements: None.

MoveLocation

Bolt.MoveLocation

Move the location by number of positions

Signature MoveLocation(indexOfDefinition, indexOfLocation, numberOfPositions)

Parameters:
  • indexOfDefinition (int) – The index of definition
  • indexOfLocation (int) – The index of location
  • numberOfPositions (int) – The number of positions to move the location
Returns:

The operation result
Return type:

bool

New in version NX12.0.0.

License requirements: None.

Print

Bolt.Print

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

Signature Print()

New in version NX3.0.0.

License requirements: None.

RemoveFlangeEntities

Bolt.RemoveFlangeEntities

Remove entities from flange.

Changes are not applied till an update is performed by calling Update.DoUpdate()

Signature RemoveFlangeEntities(flangeIndex, entities)

Parameters:

New in version NX12.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”)

RemoveLocation

Bolt.RemoveLocation

Remove a location from connection location list

Signature RemoveLocation(indexOfDefinition, indexOfLocation)

Parameters:
  • indexOfDefinition (int) – The index of definition
  • indexOfLocation (int) – The location index

New in version NX12.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”)

SetInheritedMaterial

Bolt.SetInheritedMaterial

Use this function to set inherited material to connection

Signature SetInheritedMaterial()

New in version NX12.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”)

SetName

Bolt.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.