pytabs.group
1# pyTABS - ETABS .NET API python wrapper 2# Group - cGroup interface 3__all__ = ['Group'] 4 5# import ETABS namespace and pyTABS error handler 6from pytabs.etabs_config import * 7from pytabs.error_handle import * 8 9# import typing 10 11 12class Group: 13 """Group interface""" 14 def __init__(self, sap_model : etabs.cSapModel) -> None: 15 # link of SapModel interface 16 self.sap_model = sap_model 17 # create Group interface 18 self.group = etabs.cGroup(self.sap_model.GroupDef) 19 20 21 def set_group_1(self, 22 group_name : str, 23 group_color : int = -1, 24 specified_selection : bool = True, 25 specified_section_cut_def : bool = True, 26 specified_steel_design : bool = True, 27 specified_concrete_design : bool = True, 28 specified_aluminum_design : bool = True, 29 specified_static_nla_active: bool = True, 30 specified_auto_seismic_output : bool = False, 31 specified_auto_wind_output : bool = False, 32 specified_mass_weight : bool = True, 33 specified_steeljoist_design : bool = True, 34 specified_wall_design : bool = True, 35 specified_baseplate_design : bool = True, 36 specified_connection_design : bool = True) -> None: 37 """Sets the group data. 38 39 :param group_name: name of group 40 :type group_name: str 41 :param group_color: display color of group, defaults to -1 (auto) 42 :type group_color: int, optional 43 :param specified_selection: `True` if the group is specified to be used for selection; otherwise `False`, defaults to `True` 44 :type specified_selection: bool, optional 45 :param specified_section_cut_def: `True` if the group is specified to be used for defining section cuts; otherwise `False`, defaults to `True` 46 :type specified_section_cut_def: bool, optional 47 :param specified_steel_design: `True` if the group is specified to be used for defining steel frame design groups; otherwise `False`, defaults to `True` 48 :type specified_steel_design: bool, optional 49 :param specified_concrete_design: `True` if the group is specified to be used for defining concrete frame design groups; otherwise `False`, defaults to `True` 50 :type specified_concrete_design: bool, optional 51 :param specified_aluminum_design: `True` if the group is specified to be used for defining aluminum frame design groups; otherwise `False`, defaults to `True` 52 :type specified_aluminum_design: bool, optional 53 :param specified_static_nla_active: `True` if the group is specified to be used for defining stages for nonlinear static analysis; otherwise `False`, defaults to `True` 54 :type specified_static_nla_active: bool, optional 55 :param specified_auto_seismic_output: `True` if the group is specified to be used for reporting auto seismic loads; otherwise `False`, defaults to `False` 56 :type specified_auto_seismic_output: bool, optional 57 :param specified_auto_wind_output: `True` if the group is specified to be used for reporting auto wind loads; otherwise `False`, defaults to `False` 58 :type specified_auto_wind_output: bool, optional 59 :param specified_mass_weight: `True` if the group is specified to be used for reporting group masses and weight; otherwise `False`, defaults to `True` 60 :type specified_mass_weight: bool, optional 61 :param specified_steeljoist_design: `True` if the group is specified to be used for defining steel joist design groups; otherwise `False`, defaults to `True` 62 :type specified_steeljoist_design: bool, optional 63 :param specified_wall_design: `True` if the group is specified to be used for defining wall design groups; otherwise `False`, defaults to `True` 64 :type specified_wall_design: bool, optional 65 :param specified_baseplate_design: `True` if the group is specified to be used for defining base plate design groups; otherwise `False`, defaults to `True` 66 :type specified_baseplate_design: bool, optional 67 :param specified_connection_design: `True` if the group is specified to be used for defining connection design groups; otherwise `False`, defaults to `True` 68 :type specified_connection_design: bool, optional 69 """ 70 handle(self.group.SetGroup_1(group_name, 71 group_color, 72 specified_selection, 73 specified_section_cut_def, 74 specified_steel_design, 75 specified_concrete_design, 76 specified_aluminum_design, 77 specified_static_nla_active, 78 specified_auto_seismic_output, 79 specified_auto_wind_output, 80 specified_mass_weight, 81 specified_steeljoist_design, 82 specified_wall_design, 83 specified_baseplate_design, 84 specified_connection_design))
class
Group:
13class Group: 14 """Group interface""" 15 def __init__(self, sap_model : etabs.cSapModel) -> None: 16 # link of SapModel interface 17 self.sap_model = sap_model 18 # create Group interface 19 self.group = etabs.cGroup(self.sap_model.GroupDef) 20 21 22 def set_group_1(self, 23 group_name : str, 24 group_color : int = -1, 25 specified_selection : bool = True, 26 specified_section_cut_def : bool = True, 27 specified_steel_design : bool = True, 28 specified_concrete_design : bool = True, 29 specified_aluminum_design : bool = True, 30 specified_static_nla_active: bool = True, 31 specified_auto_seismic_output : bool = False, 32 specified_auto_wind_output : bool = False, 33 specified_mass_weight : bool = True, 34 specified_steeljoist_design : bool = True, 35 specified_wall_design : bool = True, 36 specified_baseplate_design : bool = True, 37 specified_connection_design : bool = True) -> None: 38 """Sets the group data. 39 40 :param group_name: name of group 41 :type group_name: str 42 :param group_color: display color of group, defaults to -1 (auto) 43 :type group_color: int, optional 44 :param specified_selection: `True` if the group is specified to be used for selection; otherwise `False`, defaults to `True` 45 :type specified_selection: bool, optional 46 :param specified_section_cut_def: `True` if the group is specified to be used for defining section cuts; otherwise `False`, defaults to `True` 47 :type specified_section_cut_def: bool, optional 48 :param specified_steel_design: `True` if the group is specified to be used for defining steel frame design groups; otherwise `False`, defaults to `True` 49 :type specified_steel_design: bool, optional 50 :param specified_concrete_design: `True` if the group is specified to be used for defining concrete frame design groups; otherwise `False`, defaults to `True` 51 :type specified_concrete_design: bool, optional 52 :param specified_aluminum_design: `True` if the group is specified to be used for defining aluminum frame design groups; otherwise `False`, defaults to `True` 53 :type specified_aluminum_design: bool, optional 54 :param specified_static_nla_active: `True` if the group is specified to be used for defining stages for nonlinear static analysis; otherwise `False`, defaults to `True` 55 :type specified_static_nla_active: bool, optional 56 :param specified_auto_seismic_output: `True` if the group is specified to be used for reporting auto seismic loads; otherwise `False`, defaults to `False` 57 :type specified_auto_seismic_output: bool, optional 58 :param specified_auto_wind_output: `True` if the group is specified to be used for reporting auto wind loads; otherwise `False`, defaults to `False` 59 :type specified_auto_wind_output: bool, optional 60 :param specified_mass_weight: `True` if the group is specified to be used for reporting group masses and weight; otherwise `False`, defaults to `True` 61 :type specified_mass_weight: bool, optional 62 :param specified_steeljoist_design: `True` if the group is specified to be used for defining steel joist design groups; otherwise `False`, defaults to `True` 63 :type specified_steeljoist_design: bool, optional 64 :param specified_wall_design: `True` if the group is specified to be used for defining wall design groups; otherwise `False`, defaults to `True` 65 :type specified_wall_design: bool, optional 66 :param specified_baseplate_design: `True` if the group is specified to be used for defining base plate design groups; otherwise `False`, defaults to `True` 67 :type specified_baseplate_design: bool, optional 68 :param specified_connection_design: `True` if the group is specified to be used for defining connection design groups; otherwise `False`, defaults to `True` 69 :type specified_connection_design: bool, optional 70 """ 71 handle(self.group.SetGroup_1(group_name, 72 group_color, 73 specified_selection, 74 specified_section_cut_def, 75 specified_steel_design, 76 specified_concrete_design, 77 specified_aluminum_design, 78 specified_static_nla_active, 79 specified_auto_seismic_output, 80 specified_auto_wind_output, 81 specified_mass_weight, 82 specified_steeljoist_design, 83 specified_wall_design, 84 specified_baseplate_design, 85 specified_connection_design))
Group interface
def
set_group_1( self, group_name: str, group_color: int = -1, specified_selection: bool = True, specified_section_cut_def: bool = True, specified_steel_design: bool = True, specified_concrete_design: bool = True, specified_aluminum_design: bool = True, specified_static_nla_active: bool = True, specified_auto_seismic_output: bool = False, specified_auto_wind_output: bool = False, specified_mass_weight: bool = True, specified_steeljoist_design: bool = True, specified_wall_design: bool = True, specified_baseplate_design: bool = True, specified_connection_design: bool = True) -> None:
22 def set_group_1(self, 23 group_name : str, 24 group_color : int = -1, 25 specified_selection : bool = True, 26 specified_section_cut_def : bool = True, 27 specified_steel_design : bool = True, 28 specified_concrete_design : bool = True, 29 specified_aluminum_design : bool = True, 30 specified_static_nla_active: bool = True, 31 specified_auto_seismic_output : bool = False, 32 specified_auto_wind_output : bool = False, 33 specified_mass_weight : bool = True, 34 specified_steeljoist_design : bool = True, 35 specified_wall_design : bool = True, 36 specified_baseplate_design : bool = True, 37 specified_connection_design : bool = True) -> None: 38 """Sets the group data. 39 40 :param group_name: name of group 41 :type group_name: str 42 :param group_color: display color of group, defaults to -1 (auto) 43 :type group_color: int, optional 44 :param specified_selection: `True` if the group is specified to be used for selection; otherwise `False`, defaults to `True` 45 :type specified_selection: bool, optional 46 :param specified_section_cut_def: `True` if the group is specified to be used for defining section cuts; otherwise `False`, defaults to `True` 47 :type specified_section_cut_def: bool, optional 48 :param specified_steel_design: `True` if the group is specified to be used for defining steel frame design groups; otherwise `False`, defaults to `True` 49 :type specified_steel_design: bool, optional 50 :param specified_concrete_design: `True` if the group is specified to be used for defining concrete frame design groups; otherwise `False`, defaults to `True` 51 :type specified_concrete_design: bool, optional 52 :param specified_aluminum_design: `True` if the group is specified to be used for defining aluminum frame design groups; otherwise `False`, defaults to `True` 53 :type specified_aluminum_design: bool, optional 54 :param specified_static_nla_active: `True` if the group is specified to be used for defining stages for nonlinear static analysis; otherwise `False`, defaults to `True` 55 :type specified_static_nla_active: bool, optional 56 :param specified_auto_seismic_output: `True` if the group is specified to be used for reporting auto seismic loads; otherwise `False`, defaults to `False` 57 :type specified_auto_seismic_output: bool, optional 58 :param specified_auto_wind_output: `True` if the group is specified to be used for reporting auto wind loads; otherwise `False`, defaults to `False` 59 :type specified_auto_wind_output: bool, optional 60 :param specified_mass_weight: `True` if the group is specified to be used for reporting group masses and weight; otherwise `False`, defaults to `True` 61 :type specified_mass_weight: bool, optional 62 :param specified_steeljoist_design: `True` if the group is specified to be used for defining steel joist design groups; otherwise `False`, defaults to `True` 63 :type specified_steeljoist_design: bool, optional 64 :param specified_wall_design: `True` if the group is specified to be used for defining wall design groups; otherwise `False`, defaults to `True` 65 :type specified_wall_design: bool, optional 66 :param specified_baseplate_design: `True` if the group is specified to be used for defining base plate design groups; otherwise `False`, defaults to `True` 67 :type specified_baseplate_design: bool, optional 68 :param specified_connection_design: `True` if the group is specified to be used for defining connection design groups; otherwise `False`, defaults to `True` 69 :type specified_connection_design: bool, optional 70 """ 71 handle(self.group.SetGroup_1(group_name, 72 group_color, 73 specified_selection, 74 specified_section_cut_def, 75 specified_steel_design, 76 specified_concrete_design, 77 specified_aluminum_design, 78 specified_static_nla_active, 79 specified_auto_seismic_output, 80 specified_auto_wind_output, 81 specified_mass_weight, 82 specified_steeljoist_design, 83 specified_wall_design, 84 specified_baseplate_design, 85 specified_connection_design))
Sets the group data.
Parameters
- group_name: name of group
- group_color: display color of group, defaults to -1 (auto)
- specified_selection:
True
if the group is specified to be used for selection; otherwiseFalse
, defaults toTrue
- specified_section_cut_def:
True
if the group is specified to be used for defining section cuts; otherwiseFalse
, defaults toTrue
- specified_steel_design:
True
if the group is specified to be used for defining steel frame design groups; otherwiseFalse
, defaults toTrue
- specified_concrete_design:
True
if the group is specified to be used for defining concrete frame design groups; otherwiseFalse
, defaults toTrue
- specified_aluminum_design:
True
if the group is specified to be used for defining aluminum frame design groups; otherwiseFalse
, defaults toTrue
- specified_static_nla_active:
True
if the group is specified to be used for defining stages for nonlinear static analysis; otherwiseFalse
, defaults toTrue
- specified_auto_seismic_output:
True
if the group is specified to be used for reporting auto seismic loads; otherwiseFalse
, defaults toFalse
- specified_auto_wind_output:
True
if the group is specified to be used for reporting auto wind loads; otherwiseFalse
, defaults toFalse
- specified_mass_weight:
True
if the group is specified to be used for reporting group masses and weight; otherwiseFalse
, defaults toTrue
- specified_steeljoist_design:
True
if the group is specified to be used for defining steel joist design groups; otherwiseFalse
, defaults toTrue
- specified_wall_design:
True
if the group is specified to be used for defining wall design groups; otherwiseFalse
, defaults toTrue
- specified_baseplate_design:
True
if the group is specified to be used for defining base plate design groups; otherwiseFalse
, defaults toTrue
- specified_connection_design:
True
if the group is specified to be used for defining connection design groups; otherwiseFalse
, defaults toTrue