pytabs.load_cases
1# pyTABS - ETABS .NET API python wrapper 2# LoadCases - cLoadCases interface 3__all__ = ['LoadCases'] 4 5# import etabs namespace and error handler 6from pytabs.etabs import * 7from pytabs.error_handle import * 8 9# import typing 10from typing import Union 11 12 13class LoadCases: 14 """LoadCases interface""" 15 def __init__(self, sap_model : cSapModel) -> None: 16 # link of SapModel interface 17 self.sap_model = sap_model 18 # create LoadCases interface 19 self.load_cases = cLoadCases(sap_model.LoadCases) 20 21 22 def count(self, case_type : Union[None, eLoadCaseType] = None) -> int: 23 """Count of load cases of type if specified. 24 25 :param case_type: load case type enumeration, defaults to None 26 :type case_type: Union[None, eLoadCaseType], optional 27 :return: count of load case of type, if specified, else all 28 :rtype: int 29 """ 30 if case_type: 31 return self.load_cases.Count(case_type) 32 else: 33 return self.load_cases.Count() 34 35 36 def get_name_list(self, case_type : Union[None, eLoadCaseType] = None) -> list[str]: 37 """Retrieves the names of all defined load cases of the specified type. 38 39 :param case_type: load case type enumeration, defaults to None 40 :type case_type: Union[None, eLoadCaseType], optional 41 :return: load case names of type, if specified, else all 42 :rtype: list[str] 43 """ 44 number_names = int() 45 case_names = [str()] 46 if case_type: 47 [ret, number_names, case_names] = self.load_cases.GetNameList(number_names, case_names, case_type) 48 else: 49 [ret, number_names, case_names] = self.load_cases.GetNameList(number_names, case_names) 50 handle(ret) 51 return list(case_names)
class
LoadCases:
14class LoadCases: 15 """LoadCases interface""" 16 def __init__(self, sap_model : cSapModel) -> None: 17 # link of SapModel interface 18 self.sap_model = sap_model 19 # create LoadCases interface 20 self.load_cases = cLoadCases(sap_model.LoadCases) 21 22 23 def count(self, case_type : Union[None, eLoadCaseType] = None) -> int: 24 """Count of load cases of type if specified. 25 26 :param case_type: load case type enumeration, defaults to None 27 :type case_type: Union[None, eLoadCaseType], optional 28 :return: count of load case of type, if specified, else all 29 :rtype: int 30 """ 31 if case_type: 32 return self.load_cases.Count(case_type) 33 else: 34 return self.load_cases.Count() 35 36 37 def get_name_list(self, case_type : Union[None, eLoadCaseType] = None) -> list[str]: 38 """Retrieves the names of all defined load cases of the specified type. 39 40 :param case_type: load case type enumeration, defaults to None 41 :type case_type: Union[None, eLoadCaseType], optional 42 :return: load case names of type, if specified, else all 43 :rtype: list[str] 44 """ 45 number_names = int() 46 case_names = [str()] 47 if case_type: 48 [ret, number_names, case_names] = self.load_cases.GetNameList(number_names, case_names, case_type) 49 else: 50 [ret, number_names, case_names] = self.load_cases.GetNameList(number_names, case_names) 51 handle(ret) 52 return list(case_names)
LoadCases interface
def
count(self, case_type: Optional[ETABSv1.eLoadCaseType] = None) -> int:
23 def count(self, case_type : Union[None, eLoadCaseType] = None) -> int: 24 """Count of load cases of type if specified. 25 26 :param case_type: load case type enumeration, defaults to None 27 :type case_type: Union[None, eLoadCaseType], optional 28 :return: count of load case of type, if specified, else all 29 :rtype: int 30 """ 31 if case_type: 32 return self.load_cases.Count(case_type) 33 else: 34 return self.load_cases.Count()
Count of load cases of type if specified.
Parameters
- case_type: load case type enumeration, defaults to None
Returns
count of load case of type, if specified, else all
def
get_name_list(self, case_type: Optional[ETABSv1.eLoadCaseType] = None) -> list[str]:
37 def get_name_list(self, case_type : Union[None, eLoadCaseType] = None) -> list[str]: 38 """Retrieves the names of all defined load cases of the specified type. 39 40 :param case_type: load case type enumeration, defaults to None 41 :type case_type: Union[None, eLoadCaseType], optional 42 :return: load case names of type, if specified, else all 43 :rtype: list[str] 44 """ 45 number_names = int() 46 case_names = [str()] 47 if case_type: 48 [ret, number_names, case_names] = self.load_cases.GetNameList(number_names, case_names, case_type) 49 else: 50 [ret, number_names, case_names] = self.load_cases.GetNameList(number_names, case_names) 51 handle(ret) 52 return list(case_names)
Retrieves the names of all defined load cases of the specified type.
Parameters
- case_type: load case type enumeration, defaults to None
Returns
load case names of type, if specified, else all