/// <summary> /// This function assigns auto seismic loading parameters for the AS 1170 2007 code. /// </summary> /// <param name="name">The name of an existing Quake-type load pattern with a corresponding auto seismic load assignment.</param> /// <param name="loadDirection">The seismic load direction.</param> /// <param name="eccentricity">The eccentricity ratio that applies to all diaphragms.</param> /// <param name="periodOption">The time period option.</param> /// <param name="Ct">The code-specified Ct factor. [L]. /// This only applies when <paramnamef name="periodOption" /> = <see cref="eTimePeriodOption.Approximate" />.</param> /// <param name="userSpecifiedPeriod">The user specified time period. [s] /// This only applies when <paramnamef name="periodOption" /> = <see cref="eTimePeriodOption.UserDefined" /></param> /// <param name="userSpecifiedHeights">True: Top and bottom elevations of the seismic load are user specified. /// Else, the program determines the elevations.</param> /// <param name="coordinateTopZ">Global Z-coordinate at the highest level where auto seismic loads are applied. [L]. /// This only applies when <paramnamef name="userSpecifiedHeights" /> = True.</param> /// <param name="coordinateBottomZ">Global Z-coordinate at the lowest level where auto seismic loads are applied. [L]. /// This only applies when <paramnamef name="userSpecifiedHeights" /> = True.</param> /// <param name="siteClass">The site class.</param> /// <param name="kp">The probability factor, kp.</param> /// <param name="Z">The hazard factor, Z.</param> /// <param name="Sp">The structural performance factor, Sp.</param> /// <param name="Mu">The structural ductility factor, u.</param> /// <exception cref="CSiException">API_DEFAULT_ERROR_CODE</exception> public void SetLoad(string name, eSeismicLoadDirection loadDirection, double eccentricity, eTimePeriodOption periodOption, double Ct, double userSpecifiedPeriod, bool userSpecifiedHeights, double coordinateTopZ, double coordinateBottomZ, eSiteClass_AS_1170_2007 siteClass, double kp, double Z, double Sp, double Mu) { _callCode = _sapModel.LoadPatterns.AutoSeismic.SetAS11702007(name, (int)loadDirection, eccentricity, (int)periodOption, Ct, userSpecifiedPeriod, userSpecifiedHeights, coordinateTopZ, coordinateBottomZ, (int)siteClass, kp, Z, Sp, Mu); if (throwCurrentApiException(_callCode)) { throw new CSiException(API_DEFAULT_ERROR_CODE); } }
public void SetFunction(string name, eSiteClass_AS_1170_2007 siteClass, double kp, double Z, double Sp, double u, double dampingRatio) { }
public void GetFunction(string name, ref eSiteClass_AS_1170_2007 siteClass, ref double kp, ref double Z, ref double Sp, ref double u, ref double dampingRatio) { }
/// <summary> /// This function defines an AS 1170 2007 response spectrum function. /// </summary> /// <param name="name">The name of an AS 1170 2007 response spectrum function. <para /> /// If this is an existing function, that function is modified; otherwise, a new function is added.</param> /// <param name="siteClass">The site class.</param> /// <param name="kp">The probability factor, kp.</param> /// <param name="Z">The hazard factor, Z.</param> /// <param name="Sp">The structural performance factor, Sp.</param> /// <param name="u">The structural ductility factor, u.</param> /// <param name="dampingRatio">The damping ratio for the function, 0 <= <paramref name="dampingRatio" /> < 1.</param> /// <exception cref="CSiException"><see cref="CSiApiBase.API_DEFAULT_ERROR_CODE" /></exception> public void SetFunction(string name, eSiteClass_AS_1170_2007 siteClass, double kp, double Z, double Sp, double u, double dampingRatio) { dampingRatio = limitDampingRatio(dampingRatio); _callCode = _sapModel.Func.FuncRS.SetAS11702007(name, (int)siteClass, kp, Z, Sp, u, dampingRatio); if (throwCurrentApiException(_callCode)) { throw new CSiException(API_DEFAULT_ERROR_CODE); } }
public void SetLoad(string name, eSeismicLoadDirection loadDirection, double eccentricity, eTimePeriodOption periodOption, double Ct, double userSpecifiedPeriod, bool userSpecifiedHeights, double coordinateTopZ, double coordinateBottomZ, eSiteClass_AS_1170_2007 siteClass, double kp, double Z, double Sp, double Mu) { }
/// <summary> /// Returns the definition of an AS 1170 2007 response spectrum function. /// </summary> /// <param name="name">The name of an AS 1170 2007 response spectrum function.</param> /// <param name="siteClass">The site class.</param> /// <param name="kp">The probability factor, kp.</param> /// <param name="Z">The hazard factor, Z.</param> /// <param name="Sp">The structural performance factor, Sp.</param> /// <param name="u">The structural ductility factor, u.</param> /// <param name="dampingRatio">The damping ratio for the function, 0 <= <paramref name="dampingRatio" /> < 1.</param> /// <exception cref="CSiException"><see cref="CSiApiBase.API_DEFAULT_ERROR_CODE" /></exception> public void GetFunction(string name, ref eSiteClass_AS_1170_2007 siteClass, ref double kp, ref double Z, ref double Sp, ref double u, ref double dampingRatio) { int csiSiteClass = 0; _callCode = _sapModel.Func.FuncRS.GetAS11702007(name, ref csiSiteClass, ref kp, ref Z, ref Sp, ref u, ref dampingRatio); if (throwCurrentApiException(_callCode)) { throw new CSiException(API_DEFAULT_ERROR_CODE); } siteClass = (eSiteClass_AS_1170_2007)csiSiteClass; }
/// <summary> /// This function retrieves auto seismic loading parameters for the AS 1170 2007 code. /// </summary> /// <param name="name">The name of an existing Quake-type load pattern with a corresponding auto seismic load assignment.</param> /// <param name="loadDirection">The seismic load direction.</param> /// <param name="eccentricity">The eccentricity ratio that applies to all diaphragms.</param> /// <param name="periodOption">The time period option.</param> /// <param name="Ct">The code-specified Ct factor. [L]. /// This only applies when <paramref name="periodOption" /> = <see cref="eTimePeriodOption.Approximate" />.</param> /// <param name="userSpecifiedPeriod">The user specified time period. [s] /// This only applies when <paramref name="periodOption" /> = <see cref="eTimePeriodOption.UserDefined" /></param> /// <param name="userSpecifiedHeights">True: Top and bottom elevations of the seismic load are user specified. /// Else, the program determines the elevations.</param> /// <param name="coordinateTopZ">Global Z-coordinate at the highest level where auto seismic loads are applied. [L]. /// This only applies when <paramref name="userSpecifiedHeights" /> = True.</param> /// <param name="coordinateBottomZ">Global Z-coordinate at the lowest level where auto seismic loads are applied. [L]. /// This only applies when <paramref name="userSpecifiedHeights" /> = True.</param> /// <param name="siteClass">The site class.</param> /// <param name="kp">The probability factor, kp.</param> /// <param name="Z">The hazard factor, Z.</param> /// <param name="Sp">The structural performance factor, Sp.</param> /// <param name="Mu">The structural ductility factor, u.</param> /// <exception cref="CSiException">API_DEFAULT_ERROR_CODE</exception> public void GetLoad(string name, ref eSeismicLoadDirection loadDirection, ref double eccentricity, ref eTimePeriodOption periodOption, ref double Ct, ref double userSpecifiedPeriod, ref bool userSpecifiedHeights, ref double coordinateTopZ, ref double coordinateBottomZ, ref eSiteClass_AS_1170_2007 siteClass, ref double kp, ref double Z, ref double Sp, ref double Mu) { int csiLoadDirection = 0; int csiPeriodOption = 0; int csiSiteClass = 0; _callCode = _sapModel.LoadPatterns.AutoSeismic.GetAS11702007(name, ref csiLoadDirection, ref eccentricity, ref csiPeriodOption, ref Ct, ref userSpecifiedPeriod, ref userSpecifiedHeights, ref coordinateTopZ, ref coordinateBottomZ, ref csiSiteClass, ref kp, ref Z, ref Sp, ref Mu); if (throwCurrentApiException(_callCode)) { throw new CSiException(API_DEFAULT_ERROR_CODE); } loadDirection = (eSeismicLoadDirection)csiLoadDirection; periodOption = (eTimePeriodOption)csiPeriodOption; siteClass = (eSiteClass_AS_1170_2007)csiSiteClass; }