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.

BaseRebarGroup Class

The BaseRebarGroup class is an abstract base class that represents reinforcing bar group classes. The reinforcing bar groups derived from the base group are the rebar group, the circled rebar group and the curved rebar group.
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 abstract class BaseRebarGroup : Reinforcement

The BaseRebarGroup type exposes the following members.

Properties
  Name Description
Public property Class
Gets or sets the class of the reinforcement. The class is used to group reinforcements.
(Inherited from Reinforcement.)
Public property EndFromPlaneOffset
The end offset value from the part surface.
Public property EndHook
The hook at the end of the reinforcing bar.
Public property EndPoint
The end point of the direction in which the bars are distributed.
Public property EndPointOffsetType
Gets or sets the type of the end point offset. The options are:
  • OFFSET_TYPE_LEG_LENGTH
  • OFFSET_TYPE_COVER_THICKNESS
(Inherited from Reinforcement.)
Public property EndPointOffsetValue
Gets or sets the concrete cover thickness or leg length at the second end of the bar.
(Inherited from Reinforcement.)
Public property ExcludeType
Defines which bars to omit from the group. The options are:
  • EXCLUDE_TYPE_NONE
  • EXCLUDE_TYPE_FIRST
  • EXCLUDE_TYPE_LAST
  • EXCLUDE_TYPE_BOTH
Public property Father
Gets or sets the father object of the reinforcement; the model object instance to operate on.
(Inherited from Reinforcement.)
Public property FromPlaneOffset
The offset value from the part surface applied in both sides.
(Overrides ReinforcementFromPlaneOffset.)
Public property Grade
Gets or sets the steel grade of the reinforcing bar. The grade indicates the strength of the steel used in reinforcing bars. It can also indicate other factors, such as the weldability or surface deformations of the bar.
(Inherited from Reinforcement.)
Public property Identifier
The identifier of the object.
(Inherited from Object.)
Public property InputPointDeformingState
Gets or sets the reinforcement input point deforming state.
(Inherited from Reinforcement.)
Public property IsUpToDate
Gets if the object does not have a modification which is not shared.
(Inherited from ModelObject.)
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 reinforcement.
(Inherited from Reinforcement.)
Public property NumberingSeries
Gets or sets the numbering series of the reinforcement.
(Inherited from Reinforcement.)
Public property OnPlaneOffsets
Gets or sets the double offset value for each leg on the same plane as the bar.
(Inherited from Reinforcement.)
Public property RadiusValues
Gets or sets the radius value(s) of the bends in the bar.
(Inherited from Reinforcement.)
Public property Size
The size of the reinforcement.
Public property Spacings
The spacing value(s). If the type of the spacing is SPACING_TYPE_EXACT_NUMBER Spacings has only one value that defines the number of the reinforcing bars.
Public property SpacingType
The type of spacing. The options are (BaseRebarGroup.RebarGroupSpacingTypeEnum.):
  • SPACING_TYPE_UNDEFINED
  • SPACING_TYPE_EXACT_SPACINGS
  • SPACING_TYPE_EXACT_NUMBER
  • SPACING_TYPE_TARGET_SPACE
  • SPACING_TYPE_EXACT_SPACE_FLEX_AT_START
  • SPACING_TYPE_EXACT_SPACE_FLEX_AT_END
  • SPACING_TYPE_EXACT_SPACE_FLEX_AT_BOTH
  • SPACING_TYPE_EXACT_SPACE_FLEX_AT_MIDDLE
Public property StartFromPlaneOffset
The start offset value from the part surface.
Public property StartHook
The hook at the beginning of the reinforcing bar.
Public property StartPoint
The start point of the direction in which the bars are distributed.
Public property StartPointOffsetType
Gets or sets the type of the start point offset is either OFFSET_TYPE_LEG_LENGTH or OFFSET_TYPE_COVER_THICKNESS.
(Inherited from Reinforcement.)
Public property StartPointOffsetValue
Gets or sets the concrete cover thickness or leg length at the first end of the bar.
(Inherited from Reinforcement.)
Top
Methods
  Name Description
Public method CompareTo
Compares Identifiers of model objects.
(Inherited from ModelObject.)
Public method Delete
Deletes the instance from the model database.
(Inherited from ModelObject.)
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 GetFatherPour
Returns the pour that the rebar is associated to.
(Inherited from Reinforcement.)
Public method GetFatherPourUnit
Returns the pour unit that the rebar is associated to.
(Inherited from Reinforcement.)
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 GetNumberOfRebars
Returns the number of rebars in the reinforcing group.
(Inherited from Reinforcement.)
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 GetRebarGeometries
Retrieves a list of physical reinforcing bars (of type RebarGeometry). These objects contain physical points in the 3D space of each reinforcing bar.
(Inherited from Reinforcement.)
Public method GetRebarGeometriesWithoutClashes
Retrieves a list of physical reinforcing bars (of type RebarGeometry). These objects contain physical points in the 3D space of each reinforcing bar as shown in model view. In case rebar polygon clashes with itself, physical points are moved to avoid clashing.
(Inherited from Reinforcement.)
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 GetSingleRebar
Returns a single rebar inside the rebar group located by the given index. The indexing starts from the start point. The rebar represents a physical reinforcing bar and contains physical points in the 3D space of the bar. The method returns null on error, for example if given an erroneous index. The number of rebars in the group can be requested with GetNumberOfRebars().
(Inherited from Reinforcement.)
Public method GetSingleRebarWithoutClash
Returns a single rebar inside the rebar group located by the given index. The indexing starts from the start point. The rebar represents a physical reinforcing bar and contains physical, non-clashing points in the 3D space of the bar. The method returns null on error, for example if given an erroneous index. The number of rebars in the group can be requested with GetNumberOfRebars().
(Inherited from Reinforcement.)
Public method GetSolid
Method for getting the solid information of the reinforcement.
(Inherited from Reinforcement.)
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 model object instance into the model database.
(Inherited from ModelObject.)
Public method IsGeometryValid
Tells whether the geometry of a reinforcement object is valid or not.
(Inherited from Reinforcement.)
Public method Modify
Modifies the model instance in the model database.
(Inherited from ModelObject.)
Public method Select
Selects the model object instance from the model database.
(Inherited from ModelObject.)
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
See Also