SetGroup Method

cGroup SetGroup Method

CSi API ETABS 2015

Sets the group data.

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

Syntax

int SetGroup(
	string Name,
	int Color = -1,
	bool SpecifiedForSelection = true,
	bool SpecifiedForSectionCutDefinition = true,
	bool SpecifiedForSteelDesign = true,
	bool SpecifiedForConcreteDesign = true,
	bool SpecifiedForAluminumDesign = true,
	bool SpecifiedForColdFormedDesign = true,
	bool SpecifiedForStaticNLActiveStage = true,
	bool SpecifiedForBridgeResponseOutput = true,
	bool SpecifiedForAutoSeismicOutput = false,
	bool SpecifiedForAutoWindOutput = false,
	bool SpecifiedForMassAndWeight = true
)

int SetGroup(
	string Name,
	int Color = -1,
	bool SpecifiedForSelection = true,
	bool SpecifiedForSectionCutDefinition = true,
	bool SpecifiedForSteelDesign = true,
	bool SpecifiedForConcreteDesign = true,
	bool SpecifiedForAluminumDesign = true,
	bool SpecifiedForColdFormedDesign = true,
	bool SpecifiedForStaticNLActiveStage = true,
	bool SpecifiedForBridgeResponseOutput = true,
	bool SpecifiedForAutoSeismicOutput = false,
	bool SpecifiedForAutoWindOutput = false,
	bool SpecifiedForMassAndWeight = true
)

Function SetGroup ( _
	Name As String, _
	Optional Color As Integer = -1, _
	Optional SpecifiedForSelection As Boolean = True, _
	Optional SpecifiedForSectionCutDefinition As Boolean = True, _
	Optional SpecifiedForSteelDesign As Boolean = True, _
	Optional SpecifiedForConcreteDesign As Boolean = True, _
	Optional SpecifiedForAluminumDesign As Boolean = True, _
	Optional SpecifiedForColdFormedDesign As Boolean = True, _
	Optional SpecifiedForStaticNLActiveStage As Boolean = True, _
	Optional SpecifiedForBridgeResponseOutput As Boolean = True, _
	Optional SpecifiedForAutoSeismicOutput As Boolean = False, _
	Optional SpecifiedForAutoWindOutput As Boolean = False, _
	Optional SpecifiedForMassAndWeight As Boolean = True _
) As Integer

Function SetGroup ( _
	Name As String, _
	Optional Color As Integer = -1, _
	Optional SpecifiedForSelection As Boolean = True, _
	Optional SpecifiedForSectionCutDefinition As Boolean = True, _
	Optional SpecifiedForSteelDesign As Boolean = True, _
	Optional SpecifiedForConcreteDesign As Boolean = True, _
	Optional SpecifiedForAluminumDesign As Boolean = True, _
	Optional SpecifiedForColdFormedDesign As Boolean = True, _
	Optional SpecifiedForStaticNLActiveStage As Boolean = True, _
	Optional SpecifiedForBridgeResponseOutput As Boolean = True, _
	Optional SpecifiedForAutoSeismicOutput As Boolean = False, _
	Optional SpecifiedForAutoWindOutput As Boolean = False, _
	Optional SpecifiedForMassAndWeight As Boolean = True _
) As Integer

int SetGroup(
	String^ Name, 
	int Color = -1, 
	bool SpecifiedForSelection = true, 
	bool SpecifiedForSectionCutDefinition = true, 
	bool SpecifiedForSteelDesign = true, 
	bool SpecifiedForConcreteDesign = true, 
	bool SpecifiedForAluminumDesign = true, 
	bool SpecifiedForColdFormedDesign = true, 
	bool SpecifiedForStaticNLActiveStage = true, 
	bool SpecifiedForBridgeResponseOutput = true, 
	bool SpecifiedForAutoSeismicOutput = false, 
	bool SpecifiedForAutoWindOutput = false, 
	bool SpecifiedForMassAndWeight = true
)

int SetGroup(
	String^ Name, 
	int Color = -1, 
	bool SpecifiedForSelection = true, 
	bool SpecifiedForSectionCutDefinition = true, 
	bool SpecifiedForSteelDesign = true, 
	bool SpecifiedForConcreteDesign = true, 
	bool SpecifiedForAluminumDesign = true, 
	bool SpecifiedForColdFormedDesign = true, 
	bool SpecifiedForStaticNLActiveStage = true, 
	bool SpecifiedForBridgeResponseOutput = true, 
	bool SpecifiedForAutoSeismicOutput = false, 
	bool SpecifiedForAutoWindOutput = false, 
	bool SpecifiedForMassAndWeight = true
)

Parameters

Name: Type: System String
This is the name of a group. If this is the name of an existing group, that group is modified, otherwise a new group is added.

Color (Optional): Type: System Int32

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

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

SpecifiedForSteelDesign (Optional): 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 (Optional): 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 (Optional): 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 (Optional): 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 (Optional): 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 (Optional): 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 (Optional): 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 (Optional): 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 (Optional): 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 

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

   '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 

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

   'close ETABS
       EtabsObject.ApplicationExit(False)

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