v2.23
IRebarUsage Interface Reference

Represents a usage of rebar in the reinforcement unit or reinforced object. More...

Inheritance diagram for IRebarUsage:

Public Member Functions

HRESULT GetQuantities ([out, retval] IQuantityContainer **ppQuantityContainer)
 Returns the quantity container interface for the usage. More...
 
HRESULT GetRebarGeometry ([out, retval] ICurve3D **ppGeometry)
 Returns the rebar geometry represented by a 3D curve. The coordinate system the curve is defined in is unspecified. To get the rebar geometry set transform this geometry into placements returned by GetPlacements. More...
 
HRESULT GetPlacements ([out, retval] IPlacement3DCollection **ppPlacements)
 Returns a collection of 3D placements that define the locations of the rebars. For rebar usages recieved from a level based object the placements are defined in the coordinate system of the level. For rebar usages recieved from a reinforcement unit the placements are defined in the coordinate system of the unit. More...
 

Properties

int StyleId [get]
 The rebar style ID.
 

Detailed Description

Represents a usage of rebar in the reinforcement unit or reinforced object.

The rebar usage aggregates all rebars with equal geometry and style within a single owner (a model object, e.g. a wall, or a reinforcement unit, e.g a reinforcement cage). Rebar usage quantities, such as total reinforcement mass or total reinforcement length, can be obtained via this interface. This interface can be obtained from an IObjectReinforcementModel or an IReinforcementUnitStyle.

See also
IRebarUsageCollection, IRebarStyle, IReinforcementUnitStyle, IObjectReinforcementModel, Quantity identifiers

Member Function Documentation

◆ GetPlacements()

HRESULT IRebarUsage::GetPlacements ( [out, retval] IPlacement3DCollection **  ppPlacements)

Returns a collection of 3D placements that define the locations of the rebars. For rebar usages recieved from a level based object the placements are defined in the coordinate system of the level. For rebar usages recieved from a reinforcement unit the placements are defined in the coordinate system of the unit.

See also
GetRebarGeometry

◆ GetQuantities()

HRESULT IRebarUsage::GetQuantities ( [out, retval] IQuantityContainer **  ppQuantityContainer)

Returns the quantity container interface for the usage.

Returns
A quantity container.

◆ GetRebarGeometry()

HRESULT IRebarUsage::GetRebarGeometry ( [out, retval] ICurve3D **  ppGeometry)

Returns the rebar geometry represented by a 3D curve. The coordinate system the curve is defined in is unspecified. To get the rebar geometry set transform this geometry into placements returned by GetPlacements.

See also
GetPlacements