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.

Beam Class

The Beam class represents a single beam in the model. A beam has a single start and end point.
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 Beam : Part

The Beam type exposes the following members.

Constructors
  Name Description
Public method Beam
Initializes a new instance of the Beam class. The start and end points are in the origin.
Public method Beam(BeamBeamTypeEnum)
Initializes a new instance of the Beam class by using the defined type.
Public method Beam(Point, Point)
Initializes a new instance of the Beam class with the given start and end points.
Top
Properties
  Name Description
Public property AssemblyNumber
Gets or sets the assembly number. Defines the numbering in the assembly sense.
(Inherited from Part.)
Public property CastUnitType
Gets or sets the cast unit type of the part.
(Inherited from Part.)
Public property Class
Gets or sets the class of the part.
(Inherited from Part.)
Public property DeformingData
Gets or sets the deforming data of the part.
(Inherited from Part.)
Public property EndPoint
Gets or sets the end point of the beam.
Public property EndPointOffset
Gets or sets the beam's end point offset.
Public property Finish
Gets or sets the finish of the part.
(Inherited from Part.)
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 Material
Gets or sets the material the part is made of.
(Inherited from Part.)
Public property ModificationTime
Gets latest time of the object was modified or created.
(Inherited from ModelObject.)
Public property Name
Gets or sets the name of the part.
(Inherited from Part.)
Public property PartNumber
Gets or sets the part number. Defines the numbering in the part sense.
(Inherited from Part.)
Public property Position
Gets or sets the part position. Defines the way the part is positioned in the model.
(Inherited from Part.)
Public property PourPhase
Gets or sets the pour phase of the part.
(Inherited from Part.)
Public property Profile
Gets or sets the profile of the part.
(Inherited from Part.)
Public property StartPoint
Gets or sets the start point of the beam.
Public property StartPointOffset
Gets or sets the beam's start point offset.
Public property Type
Gets the read-only type of the beam. The default type for a new beam instance is beam.
Top
Methods
  Name Description
Public method CompareTo(Object)
Compares Identifiers of model objects.
(Inherited from ModelObject.)
Public method CompareTo(Part)
Compares the instantiated part with another one.
(Inherited from Part.)
Public method Delete
Deletes the beam instance with the given identifier 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 GetAssembly
Returns the assembly that the part belongs to.
(Inherited from Part.)
Public method GetBolts
Returns an enumerator of all the connected bolts.
(Inherited from Part.)
Public method GetBooleans
Returns an enumerator of all the connected boolean objects.
(Inherited from Part.)
Public method GetCenterLine
Returns the center line for the given part.
(Inherited from Part.)
Public method GetChildren
Returns an enumerator of all the children model objects.
(Inherited from ModelObject.)
Public method GetComponents
Returns an enumerator of all the connected components, connections, seams and details inherited from the base component.
(Inherited from Part.)
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 GetDSTVCoordinateSystem
Get DSTV coordinate system.
(Inherited from Part.)
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 GetPartMark
Returns the part mark.
(Inherited from Part.)
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 GetPours
Returns an enumerator of all the pours that the part belongs to.
(Inherited from Part.)
Public method GetReferenceLine
Returns the reference line for the given part.
(Inherited from Part.)
Public method GetReinforcements
Returns an enumerator of all the connected reinforcements.
(Inherited from Part.)
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
Returns the solid of the part.
(Inherited from Part.)
Public method GetSolid(FormingStates)
Returns the solid of the part.
(Inherited from Part.)
Public method GetSolid(SolidSolidCreationTypeEnum)
Returns the solid of the part.
(Inherited from Part.)
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 GetSurfaceObjects
Returns an enumerator of all the connected surface objects.
(Inherited from Part.)
Public method GetSurfaceTreatments
Returns an enumerator of all the connected surface treatments.
(Inherited from Part.)
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 GetWelds
Returns an enumerator of all the connected welds.
(Inherited from Part.)
Public method Insert
Inserts the beam into the model database. All the attributes must be set.
(Overrides ModelObjectInsert.)
Public method Modify
Modifies the existing beam in the model database to match the current one.
(Overrides ModelObjectModify.)
Public method Select
Selects a beam from the model database. The beam identifier 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;

public class Example
{
       public void Example1()
       {
           Point point = new Point(0, 0, 0);
           Point point2 = new Point(1000, 0, 0);
           Beam beam = new Beam();
           beam.StartPoint = point;
           beam.EndPoint = point2;
           beam.Profile.ProfileString = "HEA400";
           beam.Finish = "PAINT";
           beam.StartPointOffset = new Offset();
           beam.EndPointOffset = new Offset();
           bool result = false;
           result = beam.Insert();
       }
}
See Also