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.

LoadLine Class

The LoadLine class defines a linearly-distributed force or torsion.
Inheritance Hierarchy

Namespace:  Tekla.Structures.Model
Assembly:  Tekla.Structures.Model (in Tekla.Structures.Model.dll) Version: 2019.0.0.0 (2019.0.0.0)
Syntax
[SerializableAttribute]
public sealed class LoadLine : Load

The LoadLine type exposes the following members.

Constructors
  Name Description
Public method LoadLine
Creates a new load line instance.
Top
Properties
  Name Description
Public property AutomaticPrimaryAxisWeight
The automatic primary axis weight.
(Inherited from Load.)
Public property BoundingBoxDx
The dimension of the bounding box in the X direction.
(Inherited from Load.)
Public property BoundingBoxDy
The dimension of the bounding box in the Y direction.
(Inherited from Load.)
Public property BoundingBoxDz
The dimension of the bounding box in the Z direction.
(Inherited from Load.)
Public property CreateFixedSupportConditionsAutomatically
Indicates whether fixed support conditions are created automatically.
(Inherited from Load.)
Public property DistanceA
The distance a (for shortening or dividing the length of a line load).
Public property DistanceB
The distance b (for shortening or dividing the length of a line load).
Public property FatherId
The identifier of the father object that the load is attached to.
(Inherited from Load.)
Public property Group
The load group object for the load.
(Inherited from Load.)
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 LoadAttachment
The load attachment.
(Inherited from Load.)
Public property LoadDispersionAngle
The load dispersion angle.
(Inherited from Load.)
Public property LoadForm
The load form.
Public property ModificationTime
Gets latest time of the object was modified or created.
(Inherited from ModelObject.)
Public property P1
The load magnitude vector at the start position. The values are given in the local coordinate system of the load (not in the current coordinate system).
Public property P2
The load magnitude vector at the end position. The values are given in the local coordinate system of the load (not in the current coordinate system).
Public property PartFilter
The part filter.
(Inherited from Load.)
Public property PartNames
The part names.
(Inherited from Load.)
Public property Position1
The first input position point.
Public property Position2
The second input position point.
Public property PrimaryAxisDirection
The vector for the primary axis direction.
(Inherited from Load.)
Public property Spanning
The load spanning.
(Inherited from Load.)
Public property Torsion1
The first torsion.
Public property Torsion2
The second torsion.
Public property Weight
The weight.
(Inherited from Load.)
Top
Methods
  Name Description
Public method CompareTo
Compares Identifiers of model objects.
(Inherited from ModelObject.)
Public method Delete
Deletes the load line 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 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 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 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 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 load line into the model database.
(Overrides ModelObjectInsert.)
Public method Modify
Modifies the existing load line in the model database to match the current one. At the moment it is not possible to change the load attachment or the father.
(Overrides ModelObjectModify.)
Public method Select
Selects a load line 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()
       {
           LoadLine L = new LoadLine();
           L.P1 = new Vector(0000,0000,-1000);
           L.P2 = new Vector(0000,0000,-1000);
           L.DistanceA = 5;
           L.DistanceB = 6;
           L.Torsion1 = 1000;
           L.Torsion2 = 2000;
           L.Position1 = new Point(3000,12000,0);
           L.Position2 = new Point(4000,12000,0);
           L.LoadForm = LoadLine.LineLoadFormEnum.LOAD_FORM_LINE_1;

           L.AutomaticPrimaryAxisWeight = true;
           L.BoundingBoxDx = 500;
           L.BoundingBoxDy = 500;
           L.BoundingBoxDz = 500;
           L.LoadDispersionAngle = 5;
           L.PartFilter = "testing";
           L.PartNames = Load.LoadPartNamesEnum.LOAD_PART_NAMES_INCLUDE;
           L.PrimaryAxisDirection = new Vector(1000, 500, 0);
           L.Spanning = Load.LoadSpanningEnum.LOAD_SPANNING_SINGLE;
           L.Weight = 2;
           L.CreateFixedSupportConditionsAutomatically = true;

           if (!L.Insert())
               Console.WriteLine("LoadLine Insert failed!");
       }
}
See Also