Tekla Open API

Detailed and full API reference helps you master Tekla Open API

This is the most recent version of Tekla Open API.
For older versions, please visit Tekla Warehouse.

BoltXYList Class

The BoltXYList class defines a bolt group with an XY list shape. The bolt group is the most generic one of the bolt groups.
Inheritance Hierarchy

Namespace:  Tekla.Structures.Model
Assembly:  Tekla.Structures.Model (in Tekla.Structures.Model.dll) Version: 2018.1.0.0 (2018.1.0.0)
Syntax
[SerializableAttribute]
public sealed class BoltXYList : BoltGroup

The BoltXYList type exposes the following members.

Constructors
  Name Description
Public method BoltXYList
Creates a new bolt XY list instance.
Top
Properties
  Name Description
Public property Bolt
Indicates whether the instance is a bolt or just a hole.
(Inherited from BoltGroup.)
Public property BoltPositions
Gets the single bolt positions. All the bolt positions are in the XY-plane defined by the bolt group coordinate system. The given positions are in relation to the transformation plane in which the bolt group was selected.
(Inherited from BoltGroup.)
Public property BoltSize
The size of the bolts in the group.
(Inherited from BoltGroup.)
Public property BoltStandard
The standard of the bolt group.
(Inherited from BoltGroup.)
Public property BoltType
The type of the bolt group.
(Inherited from BoltGroup.)
Public property ConnectAssemblies
Defines whether to connect a part or an assembly as a secondary part (false) or as a sub-assembly (true).
(Inherited from BoltGroup.)
Public property CutLength
The cut length.
(Inherited from BoltGroup.)
Public property EndPointOffset
The end point offset values of the bolt group.
(Inherited from BoltGroup.)
Public property ExtraLength
The extra length for the bolts.
(Inherited from BoltGroup.)
Public property FirstPosition
The first position point.
(Inherited from BoltGroup.)
Public property Hole1
Indicates whether the hole 1 is used.
(Inherited from BoltGroup.)
Public property Hole2
Indicates whether the hole 2 is used.
(Inherited from BoltGroup.)
Public property Hole3
Indicates whether the hole 3 is used.
(Inherited from BoltGroup.)
Public property Hole4
Indicates whether the hole 4 is used.
(Inherited from BoltGroup.)
Public property Hole5
Indicates whether the hole 5 is used.
(Inherited from BoltGroup.)
Public property HoleType
The hole type: oversized or slotted.
(Inherited from BoltGroup.)
Public property Identifier
The identifier of the object.
(Inherited from Object.)
Public property IsUpToDate
Gets if the object does not have a modification which is not shared.
(Inherited from ModelObject.)
Public property Length
The length. An extra variable that is only set when the bolt group is made of studs instead of bolts.
(Inherited from BoltGroup.)
Public property ModificationTime
Gets latest time of the object was modified or created.
(Inherited from ModelObject.)
Public property Nut1
Indicates whether the nut 1 is used in the assembly.
(Inherited from BoltGroup.)
Public property Nut2
Indicates whether the nut 2 is used in the assembly.
(Inherited from BoltGroup.)
Public property OtherPartsToBolt
The other parts to be bolted (read-only).
(Inherited from BoltGroup.)
Public property PartToBeBolted
The part to be bolted.
(Inherited from BoltGroup.)
Public property PartToBoltTo
The part to bolt to.
(Inherited from BoltGroup.)
Public property Position
The position attributes.
(Inherited from BoltGroup.)
Public property RotateSlots
The rotation of the slots: odd, even or parallel.
(Inherited from BoltGroup.)
Public property SecondPosition
The second position point.
(Inherited from BoltGroup.)
Public property SlottedHoleX
The X allowance of the slotted hole.
(Inherited from BoltGroup.)
Public property SlottedHoleY
The Y allowance of the slotted hole.
(Inherited from BoltGroup.)
Public property StartPointOffset
The start point offset values of the bolt group.
(Inherited from BoltGroup.)
Public property ThreadInMaterial
Whether the thread goes inside the materal or not.
(Inherited from BoltGroup.)
Public property Tolerance
The hole tolerance.
(Inherited from BoltGroup.)
Public property Washer1
Indicates whether the washer 1 is used in the assembly.
(Inherited from BoltGroup.)
Public property Washer2
Indicates whether the washer 2 is used in the assembly.
(Inherited from BoltGroup.)
Public property Washer3
Indicates whether the washer 3 is used in the assembly.
(Inherited from BoltGroup.)
Top
Methods
  Name Description
Public method AddBoltDistX
Adds an X distance to the bolt XY list.
Public method AddBoltDistY
Adds a Y distance to the bolt XY list.
Public method AddOtherPartToBolt
Adds the given part to the list of the other parts that should be bolted.
(Inherited from BoltGroup.)
Public method CompareTo
Compares Identifiers of model objects.
(Inherited from ModelObject.)
Public method Delete
Deletes the bolt XY list instance with the given ID from the model database.
(Overrides ModelObjectDelete.)
Public method Equals
Check if Identifiers of model objects are same.
(Inherited from ModelObject.)
Public methodCode example GetAllReportProperties
Retrieves all properties for the model object in one hashtable. Type for the returned value must be checked using type casting.
(Inherited from ModelObject.)
Public method GetAllUserProperties
Retrieves all properties for the model object in one hashtable. Type for the returned value must be checked using type casting.
(Inherited from ModelObject.)
Public method GetBoltDistX
Returns the X distance defined by the argument.
Public method GetBoltDistXCount
Returns the amount of X distances in the bolt XY list.
Public method GetBoltDistY
Returns the Y distance defined by the argument.
Public method GetBoltDistYCount
Returns the amount of Y distances in the bolt XY list.
Public method GetChildren
Returns an enumerator of all the children model objects.
(Inherited from ModelObject.)
Public method GetCoordinateSystem
Returns the coordinate system for the given model object.
(Inherited from ModelObject.)
Public method GetDoubleReportProperties
Retrieves multiple double report properties for the model object. It is faster to fetch multiple properties at once.
(Inherited from ModelObject.)
Public method GetDoubleUserProperties
Retrieves all double properties for the model object.
(Inherited from ModelObject.)
Public method GetDynamicStringProperty
Gets a dynamic string property from the model object.
(Inherited from ModelObject.)
Public method GetFatherComponent
Returns the father component of the model object.
(Inherited from ModelObject.)
Public method GetFatherPour
Returns the pour that the bolt group is associated to.
(Inherited from BoltGroup.)
Public method GetFatherPourUnit
Returns the pour unit that the bolt group is associated to.
(Inherited from BoltGroup.)
Public method GetHierarchicObjects
Returns an enumerator of all the connected hierarchic objects.
(Inherited from ModelObject.)
Public method GetIntegerReportProperties
Retrieves multiple integer report properties for the model object. It is faster to fetch multiple properties at once.
(Inherited from ModelObject.)
Public method GetIntegerUserProperties
Retrieves all integer properties for the model object.
(Inherited from ModelObject.)
Public method GetOtherPartsToBolt
Returns an array list containing all the other parts that are bolted.
(Inherited from BoltGroup.)
Public method GetPhase
Retrieves the phase of the model object (the phase number, the phase name, the phase comment and whether the phase is the current one or not).
(Inherited from ModelObject.)
Public method GetReportProperty(String, Double)
Retrieves a double property of the report for the model object.
(Inherited from ModelObject.)
Public method GetReportProperty(String, Int32)
Retrieves an integer property of the report for the model object.
(Inherited from ModelObject.)
Public method GetReportProperty(String, String)
Retrieves a string property of the report for the model object.
(Inherited from ModelObject.)
Public method GetSolid
Method for getting the solid information of the bolt group.
(Inherited from BoltGroup.)
Public method GetSolid(Boolean)
Method for getting the solid information of the bolt group.
(Inherited from BoltGroup.)
Public method GetStringReportProperties
Retrieves multiple string report properties for the model object. It is faster to fetch multiple properties at once.
(Inherited from ModelObject.)
Public method GetStringUserProperties
Retrieves all string properties for the model object.
(Inherited from ModelObject.)
Public method GetUserProperty(String, Double)
Retrieves a double property for the model object.
(Inherited from ModelObject.)
Public method GetUserProperty(String, Int32)
Retrieves an integer property for the model object.
(Inherited from ModelObject.)
Public method GetUserProperty(String, String)
Retrieves a string property for the model object.
(Inherited from ModelObject.)
Public method Insert
Inserts the bolt XY list into the model database. All the attributes must be set.
(Overrides ModelObjectInsert.)
Public method Modify
Modifies the existing bolt XY list in the model database to match the current one.

Note, the IDs of Part To Bolt To, Part To Be Bolted and OtherParts cannot be modified.

(Overrides ModelObjectModify.)
Public method RemoveOtherPartToBolt
Removes the given part from the list of the other bolted parts.
(Inherited from BoltGroup.)
Public method Select
Selects a bolt XY list from the model database. The ID must be set.
(Overrides ModelObjectSelect.)
Public method SetDynamicStringProperty
Sets a dynamic string property for the model object.
(Inherited from ModelObject.)
Public method SetLabel
Sets a label for an object when a new instance is created. The label is used in plug-ins for identifying the changed object in modification.
(Inherited from ModelObject.)
Public method SetPhase
Sets the phase of the model object.
(Inherited from ModelObject.)
Public method SetUserProperty(String, Double)
Sets a double property for the model object.
(Inherited from ModelObject.)
Public method SetUserProperty(String, Int32)
Sets an integer property for the model object.
(Inherited from ModelObject.)
Public method SetUserProperty(String, String)
Sets a string property for the model object.
(Inherited from ModelObject.)
Top
Examples
using Tekla.Structures.Model;
using Tekla.Structures.Geometry3d;
using System;

public class Example
{
       public void Example1()
       {
           ContourPlate cp = new ContourPlate();
           cp.AddContourPoint(new ContourPoint(new Point( 6000,  6000, 0),null));
           cp.AddContourPoint(new ContourPoint(new Point( 9000,  6000, 0),null));
           cp.AddContourPoint(new ContourPoint(new Point( 9000, 12000, 0),null));
           cp.AddContourPoint(new ContourPoint(new Point( 6000, 12000, 0),null));

           if (!cp.Insert())
               Console.WriteLine("ContourPlate Insert failed!");

           BoltXYList B = new BoltXYList();

           B.PartToBeBolted = cp;
           B.PartToBoltTo   = cp;

           B.FirstPosition =  new Point(6000,  6000, 0);
           B.SecondPosition = new Point(9000, 12000, 0);

           B.BoltSize     = 16;
           B.Tolerance    = 3.00;
           B.BoltStandard = "7968";
           B.BoltType     = BoltGroup.BoltTypeEnum.BOLT_TYPE_WORKSHOP;
           B.CutLength    = 105;

           B.Length       = 50;
           B.ExtraLength  = 15;
           B.ThreadInMaterial = BoltGroup.BoltThreadInMaterialEnum.THREAD_IN_MATERIAL_NO;

           B.Position.Depth          = Position.DepthEnum.MIDDLE;
           B.Position.Plane          = Position.PlaneEnum.MIDDLE;
           B.Position.Rotation       = Position.RotationEnum.FRONT;

           B.Bolt    = true;
           B.Washer1 = true;
           B.Washer2 = true;
           B.Washer3 = true;
           B.Nut1    = true;
           B.Nut2    = true;

           B.Hole1   = true;
           B.Hole2   = true;
           B.Hole3   = true;
           B.Hole4   = true;
           B.Hole5   = true;

           B.AddBoltDistX(100);
           B.AddBoltDistX(200);
           B.AddBoltDistX(300);

           B.AddBoltDistY(100);
           B.AddBoltDistY(200);
           B.AddBoltDistY(300);

           if (!B.Insert())
               Console.WriteLine("BoltXYList Insert failed!");
       }
}
See Also