GetCoverPlatedI Method

cPropFrame GetCoverPlatedI Method

CSi API ETABS 2015

retrieves frame section property data for a cover plated I-type frame section.

Namespace: ETABS2015
Assembly: ETABS2015 (in ETABS2015.dll) Version: 15.0.0.0 (15.0.0.0)

Syntax

int GetCoverPlatedI(
	string Name,
	ref string SectName,
	ref double FyTopFlange,
	ref double FyWeb,
	ref double FyBotFlange,
	ref double Tc,
	ref double Bc,
	ref string MatPropTop,
	ref double Tcb,
	ref double Bcb,
	ref string MatPropBot,
	ref int Color,
	ref string Notes,
	ref string GUID
)

int GetCoverPlatedI(
	string Name,
	ref string SectName,
	ref double FyTopFlange,
	ref double FyWeb,
	ref double FyBotFlange,
	ref double Tc,
	ref double Bc,
	ref string MatPropTop,
	ref double Tcb,
	ref double Bcb,
	ref string MatPropBot,
	ref int Color,
	ref string Notes,
	ref string GUID
)

Function GetCoverPlatedI ( _
	Name As String, _
	ByRef SectName As String, _
	ByRef FyTopFlange As Double, _
	ByRef FyWeb As Double, _
	ByRef FyBotFlange As Double, _
	ByRef Tc As Double, _
	ByRef Bc As Double, _
	ByRef MatPropTop As String, _
	ByRef Tcb As Double, _
	ByRef Bcb As Double, _
	ByRef MatPropBot As String, _
	ByRef Color As Integer, _
	ByRef Notes As String, _
	ByRef GUID As String _
) As Integer

Function GetCoverPlatedI ( _
	Name As String, _
	ByRef SectName As String, _
	ByRef FyTopFlange As Double, _
	ByRef FyWeb As Double, _
	ByRef FyBotFlange As Double, _
	ByRef Tc As Double, _
	ByRef Bc As Double, _
	ByRef MatPropTop As String, _
	ByRef Tcb As Double, _
	ByRef Bcb As Double, _
	ByRef MatPropBot As String, _
	ByRef Color As Integer, _
	ByRef Notes As String, _
	ByRef GUID As String _
) As Integer

int GetCoverPlatedI(
	String^ Name, 
	String^% SectName, 
	double% FyTopFlange, 
	double% FyWeb, 
	double% FyBotFlange, 
	double% Tc, 
	double% Bc, 
	String^% MatPropTop, 
	double% Tcb, 
	double% Bcb, 
	String^% MatPropBot, 
	int% Color, 
	String^% Notes, 
	String^% GUID
)

int GetCoverPlatedI(
	String^ Name, 
	String^% SectName, 
	double% FyTopFlange, 
	double% FyWeb, 
	double% FyBotFlange, 
	double% Tc, 
	double% Bc, 
	String^% MatPropTop, 
	double% Tcb, 
	double% Bcb, 
	String^% MatPropBot, 
	int% Color, 
	String^% Notes, 
	String^% GUID
)

Parameters

Name: Type: System String
The name of an existing frame section property.

SectName: Type: System String

FyTopFlange: Type: System Double
The yield strength of the top flange of the I-section. [F/L2]
If this item is 0, the yield strength of the I-section specified by the SectName item is used.

FyWeb: Type: System Double
The yield strength of the web of the I-section. [F/L2]
If this item is 0, the yield strength of the I-section specified by the SectName item is used.

FyBotFlange: Type: System Double
The yield strength of the bottom flange of the I-section. [F/L2]
If this item is 0, the yield strength of the I-section specified by the SectName item is used.

Tc: Type: System Double

Bc: Type: System Double

MatPropTop: Type: System String
The name of the material property for the bottom cover plate.
This item applies only if both the tcb and the bcb items are greater than 0.

Tcb: Type: System Double

Bcb: Type: System Double

MatPropBot: Type: System String
The name of the material property for the bottom cover plate.
This item applies only if both the tcb and the bcb items are greater than 0.

Color: Type: System Int32

Notes: Type: System String

GUID: Type: System String
The GUID (global unique identifier), if any, assigned to the section.

Return Value

Returns zero if the section property is successfully initialized; otherwise it returns a nonzero value.

Remarks

Examples

C++

Copy to Clipboard Print

Public Sub Example()
       Dim SapModel As cSapModel
       Dim EtabsObject As cOAPI
       Dim ret As Integer = -1 
       Dim SectName As String 
       Dim FyTopFlange As Double 
       Dim FyWeb As Double 
       Dim FyBotFlange As Double 
       Dim tc As Double 
       Dim bc As Double 
       Dim MatPropTop As String 
       Dim tcb As Double 
       Dim bcb As Double 
       Dim MatPropBot As String 
       Dim Color As Integer 
       Dim Notes As String 
       Dim GUID As String 


   'create ETABS object
       EtabsObject = CreateObject("CSI.ETABS.API.ETABSObject")

   'start ETABS application
       ret = EtabsObject.ApplicationStart()

   'create SapModel object
       SapModel = EtabsObject.SapModel

   'initialize model
       ret = SapModel.InitializeNewModel()

   'create steel deck template model
       ret = SapModel.File.NewSteelDeck(4,12,12,4,4,24,24)

   'set new I-type frame section property
       ret = SapModel.PropFrame.SetISection("ISEC", "A992Fy50", 24, 8, 0.5, 0.3, 8, 0.5)

   'set new cover plated I-type frame section property
       ret = SapModel.PropFrame.SetCoverPlatedI("CPI1", "ISEC", 0, 36, 0, 0.75, 14, "A992Fy50", 0.5, 6, "A992Fy50")

   'get frame section property data for cover plated I
       ret = SapModel.PropFrame.GetCoverPlatedI("CPI1", SectName, FyTopFlange, FyWeb, FyBotFlange, tc, bc, MatPropTop, tcb, bcb, MatPropBot, Color, Notes, GUID)

   'close ETABS
       EtabsObject.ApplicationExit(False)

   'clean up variables
       SapModel = Nothing
       EtabsObject = Nothing 
   End Sub

Public Sub Example()
       Dim SapModel As cSapModel
       Dim EtabsObject As cOAPI
       Dim ret As Integer = -1 
       Dim SectName As String 
       Dim FyTopFlange As Double 
       Dim FyWeb As Double 
       Dim FyBotFlange As Double 
       Dim tc As Double 
       Dim bc As Double 
       Dim MatPropTop As String 
       Dim tcb As Double 
       Dim bcb As Double 
       Dim MatPropBot As String 
       Dim Color As Integer 
       Dim Notes As String 
       Dim GUID As String 


   'create ETABS object
       EtabsObject = CreateObject("CSI.ETABS.API.ETABSObject")

   'start ETABS application
       ret = EtabsObject.ApplicationStart()

   'create SapModel object
       SapModel = EtabsObject.SapModel

   'initialize model
       ret = SapModel.InitializeNewModel()

   'create steel deck template model
       ret = SapModel.File.NewSteelDeck(4,12,12,4,4,24,24)

   'set new I-type frame section property
       ret = SapModel.PropFrame.SetISection("ISEC", "A992Fy50", 24, 8, 0.5, 0.3, 8, 0.5)

   'set new cover plated I-type frame section property
       ret = SapModel.PropFrame.SetCoverPlatedI("CPI1", "ISEC", 0, 36, 0, 0.75, 14, "A992Fy50", 0.5, 6, "A992Fy50")

   'get frame section property data for cover plated I
       ret = SapModel.PropFrame.GetCoverPlatedI("CPI1", SectName, FyTopFlange, FyWeb, FyBotFlange, tc, bc, MatPropTop, tcb, bcb, MatPropBot, Color, Notes, GUID)

   'close ETABS
       EtabsObject.ApplicationExit(False)

   'clean up variables
       SapModel = Nothing
       EtabsObject = Nothing 
   End Sub