GetGroup Method

cGroup GetGroup Method

CSi API ETABS 2015

Retrieves the group data.

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

Syntax

int GetGroup(
	string Name,
	ref int Color,
	ref bool SpecifiedForSelection,
	ref bool SpecifiedForSectionCutDefinition,
	ref bool SpecifiedForSteelDesign,
	ref bool SpecifiedForConcreteDesign,
	ref bool SpecifiedForAluminumDesign,
	ref bool SpecifiedForColdFormedDesign,
	ref bool SpecifiedForStaticNLActiveStage,
	ref bool SpecifiedForBridgeResponseOutput,
	ref bool SpecifiedForAutoSeismicOutput,
	ref bool SpecifiedForAutoWindOutput,
	ref bool SpecifiedForMassAndWeight
)

int GetGroup(
	string Name,
	ref int Color,
	ref bool SpecifiedForSelection,
	ref bool SpecifiedForSectionCutDefinition,
	ref bool SpecifiedForSteelDesign,
	ref bool SpecifiedForConcreteDesign,
	ref bool SpecifiedForAluminumDesign,
	ref bool SpecifiedForColdFormedDesign,
	ref bool SpecifiedForStaticNLActiveStage,
	ref bool SpecifiedForBridgeResponseOutput,
	ref bool SpecifiedForAutoSeismicOutput,
	ref bool SpecifiedForAutoWindOutput,
	ref bool SpecifiedForMassAndWeight
)

Function GetGroup ( _
	Name As String, _
	ByRef Color As Integer, _
	ByRef SpecifiedForSelection As Boolean, _
	ByRef SpecifiedForSectionCutDefinition As Boolean, _
	ByRef SpecifiedForSteelDesign As Boolean, _
	ByRef SpecifiedForConcreteDesign As Boolean, _
	ByRef SpecifiedForAluminumDesign As Boolean, _
	ByRef SpecifiedForColdFormedDesign As Boolean, _
	ByRef SpecifiedForStaticNLActiveStage As Boolean, _
	ByRef SpecifiedForBridgeResponseOutput As Boolean, _
	ByRef SpecifiedForAutoSeismicOutput As Boolean, _
	ByRef SpecifiedForAutoWindOutput As Boolean, _
	ByRef SpecifiedForMassAndWeight As Boolean _
) As Integer

Function GetGroup ( _
	Name As String, _
	ByRef Color As Integer, _
	ByRef SpecifiedForSelection As Boolean, _
	ByRef SpecifiedForSectionCutDefinition As Boolean, _
	ByRef SpecifiedForSteelDesign As Boolean, _
	ByRef SpecifiedForConcreteDesign As Boolean, _
	ByRef SpecifiedForAluminumDesign As Boolean, _
	ByRef SpecifiedForColdFormedDesign As Boolean, _
	ByRef SpecifiedForStaticNLActiveStage As Boolean, _
	ByRef SpecifiedForBridgeResponseOutput As Boolean, _
	ByRef SpecifiedForAutoSeismicOutput As Boolean, _
	ByRef SpecifiedForAutoWindOutput As Boolean, _
	ByRef SpecifiedForMassAndWeight As Boolean _
) As Integer

int GetGroup(
	String^ Name, 
	int% Color, 
	bool% SpecifiedForSelection, 
	bool% SpecifiedForSectionCutDefinition, 
	bool% SpecifiedForSteelDesign, 
	bool% SpecifiedForConcreteDesign, 
	bool% SpecifiedForAluminumDesign, 
	bool% SpecifiedForColdFormedDesign, 
	bool% SpecifiedForStaticNLActiveStage, 
	bool% SpecifiedForBridgeResponseOutput, 
	bool% SpecifiedForAutoSeismicOutput, 
	bool% SpecifiedForAutoWindOutput, 
	bool% SpecifiedForMassAndWeight
)

int GetGroup(
	String^ Name, 
	int% Color, 
	bool% SpecifiedForSelection, 
	bool% SpecifiedForSectionCutDefinition, 
	bool% SpecifiedForSteelDesign, 
	bool% SpecifiedForConcreteDesign, 
	bool% SpecifiedForAluminumDesign, 
	bool% SpecifiedForColdFormedDesign, 
	bool% SpecifiedForStaticNLActiveStage, 
	bool% SpecifiedForBridgeResponseOutput, 
	bool% SpecifiedForAutoSeismicOutput, 
	bool% SpecifiedForAutoWindOutput, 
	bool% SpecifiedForMassAndWeight
)

Parameters

Name: Type: System String
This is the name of an existing group.

Color: Type: System Int32

SpecifiedForSelection: Type: System Boolean
This item is True if the group is specified to be used for selection; otherwise it is False.

SpecifiedForSectionCutDefinition: Type: System Boolean
This item is True if the group is specified to be used for defining section cuts; otherwise it is False.

SpecifiedForSteelDesign: Type: System Boolean
This item is True if the group is specified to be used for defining steel frame design groups; otherwise it is False.

SpecifiedForConcreteDesign: Type: System Boolean
This item is True if the group is specified to be used for defining concrete frame design groups; otherwise it is False.

SpecifiedForAluminumDesign: Type: System Boolean
This item is True if the group is specified to be used for defining aluminum frame design groups; otherwise it is False.

SpecifiedForColdFormedDesign: Type: System Boolean
This item is True if the group is specified to be used for defining cold formed frame design groups; otherwise it is False.

SpecifiedForStaticNLActiveStage: Type: System Boolean
This item is True if the group is specified to be used for defining stages for nonlinear static analysis; otherwise it is False.

SpecifiedForBridgeResponseOutput: Type: System Boolean
This item is True if the group is specified to be used for reporting bridge response output; otherwise it is False.

SpecifiedForAutoSeismicOutput: Type: System Boolean
This item is True if the group is specified to be used for reporting auto seismic loads; otherwise it is False.

SpecifiedForAutoWindOutput: Type: System Boolean
This item is True if the group is specified to be used for reporting auto wind loads; otherwise it is False.

SpecifiedForMassAndWeight: Type: System Boolean
This item is True if the group is specified to be used for reporting group masses and weight; otherwise it is False.

Return Value

Returns zero if the group data is successfully set; otherwise it returns a nonzero value.

Remarks

Items SpecifiedForAluminumDesign, SpecifiedForColdFormedDesignSpecifiedForBridgeResponseOutput are not supported in ETABS.

Examples

C++

Copy to Clipboard Print

Public Sub Example()
       Dim SapModel As cSapModel
       Dim EtabsObject As cOAPI
       Dim ret As Integer = -1 
       Dim Color as Integer 
       Dim SpecifiedForSelection as Boolean 
       Dim SpecifiedForSectionCutDefinition as Boolean 
       Dim SpecifiedForSteelDesign as Boolean 
       Dim SpecifiedForConcreteDesign as Boolean 
       Dim SpecifiedForAluminumDesign as Boolean 
       Dim SpecifiedForColdFormedDesign as Boolean 
       Dim SpecifiedForStaticNLActiveStage as Boolean 
       Dim SpecifiedForBridgeResponseOutput as Boolean 
       Dim SpecifiedForAutoSeismicOutput as Boolean 
       Dim SpecifiedForAutoWindOutput as Boolean 
       Dim SpecifiedForMassAndWeight as Boolean 

   '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)

   'define new group
       ret = SapModel.GroupDef.SetGroup("Group1", -1, True)

   'get group data
       ret = SapModel.GroupDef.GetGroup("Group1", Color, SpecifiedForSelection, SpecifiedForSectionCutDefinition, SpecifiedForSteelDesign, SpecifiedForConcreteDesign, SpecifiedForAluminumDesign, SpecifiedForColdFormedDesign, SpecifiedForStaticNLActiveStage, SpecifiedForBridgeResponseOutput, SpecifiedForAutoSeismicOutput, SpecifiedForAutoWindOutput, SpecifiedForMassAndWeight)

   '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 Color as Integer 
       Dim SpecifiedForSelection as Boolean 
       Dim SpecifiedForSectionCutDefinition as Boolean 
       Dim SpecifiedForSteelDesign as Boolean 
       Dim SpecifiedForConcreteDesign as Boolean 
       Dim SpecifiedForAluminumDesign as Boolean 
       Dim SpecifiedForColdFormedDesign as Boolean 
       Dim SpecifiedForStaticNLActiveStage as Boolean 
       Dim SpecifiedForBridgeResponseOutput as Boolean 
       Dim SpecifiedForAutoSeismicOutput as Boolean 
       Dim SpecifiedForAutoWindOutput as Boolean 
       Dim SpecifiedForMassAndWeight as Boolean 

   '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)

   'define new group
       ret = SapModel.GroupDef.SetGroup("Group1", -1, True)

   'get group data
       ret = SapModel.GroupDef.GetGroup("Group1", Color, SpecifiedForSelection, SpecifiedForSectionCutDefinition, SpecifiedForSteelDesign, SpecifiedForConcreteDesign, SpecifiedForAluminumDesign, SpecifiedForColdFormedDesign, SpecifiedForStaticNLActiveStage, SpecifiedForBridgeResponseOutput, SpecifiedForAutoSeismicOutput, SpecifiedForAutoWindOutput, SpecifiedForMassAndWeight)

   'close ETABS
       EtabsObject.ApplicationExit(False)

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