public void SetFunction(string name,
double PGA,
double S02,
double S05,
double S1,
double S2,
eSiteClass_NBCC_2010 siteClass,
double Fa,
double Fv,
double dampingRatio)
{
}
public void GetFunction(string name,
ref double PGA,
ref double S02,
ref double S05,
ref double S1,
ref double S2,
ref eSiteClass_NBCC_2010 siteClass,
ref double Fa,
ref double Fv,
ref double dampingRatio)
{
}
/// <summary>
/// This function defines an NBCC2010 response spectrum function.
/// </summary>
/// <param name="name">The name of an NBCC2010 response spectrum function. <para />
/// If this is an existing function, that function is modified; otherwise, a new function is added.</param>
/// <param name="PGA">The peak ground acceleration.</param>
/// <param name="S02">The spectral acceleration at a 0.2 second period.</param>
/// <param name="S05">The spectral acceleration at a 0.5 second period.</param>
/// <param name="S1">The spectral acceleration at a 1 second period.</param>
/// <param name="S2">The spectral acceleration at a 2 second period.</param>
/// <param name="siteClass">The site class.</param>
/// <param name="Fa">The site coefficient at a 0.2 second period.<para />
/// These items are used only when <paramref name="siteClass" /> = <see cref="eSiteClass_NBCC_2010.F" />.</param>
/// <param name="Fv">The site coefficient at a 0.5 second period.<para />
/// These items are used only when <paramref name="siteClass" /> = <see cref="eSiteClass_NBCC_2010.F" />.</param>
/// <param name="dampingRatio">The damping ratio for the function, 0 <= <paramref name="dampingRatio" /> < 1.</param>
/// <exception cref="CSiException">API_DEFAULT_ERROR_CODE</exception>
public void SetFunction(string name,
double PGA,
double S02,
double S05,
double S1,
double S2,
eSiteClass_NBCC_2010 siteClass,
double Fa,
double Fv,
double dampingRatio)
{
dampingRatio = limitDampingRatio(dampingRatio);
_callCode = _sapModel.Func.FuncRS.SetNBCC2010(name, PGA, S02, S05, S1, S2, (int)siteClass, Fa, Fv, dampingRatio);
if (throwCurrentApiException(_callCode))
{
throw new CSiException(API_DEFAULT_ERROR_CODE);
}
}
/// <summary>
/// This function defines an NBCC2010 response spectrum function.
/// </summary>
/// <param name="name">The name of an NBCC2010 response spectrum function.</param>
/// <param name="PGA">The peak ground acceleration.</param>
/// <param name="S02">The spectral acceleration at a 0.2 second period.</param>
/// <param name="S05">The spectral acceleration at a 0.5 second period.</param>
/// <param name="S1">The spectral acceleration at a 1 second period.</param>
/// <param name="S2">The spectral acceleration at a 2 second period.</param>
/// <param name="siteClass">The site class.</param>
/// <param name="Fa">The site coefficient at a 0.2 second period.<para />
/// These items are used only when <paramref name="siteClass" /> = <see cref="eSiteClass_NBCC_2010.F" />.</param>
/// <param name="Fv">The site coefficient at a 0.5 second period.<para />
/// These items are used only when <paramref name="siteClass" /> = <see cref="eSiteClass_NBCC_2010.F" />.</param>
/// <param name="dampingRatio">The damping ratio for the function, 0 <= <paramref name="dampingRatio" /> < 1.</param>
/// <exception cref="CSiException">API_DEFAULT_ERROR_CODE</exception>
public void GetFunction(string name,
ref double PGA,
ref double S02,
ref double S05,
ref double S1,
ref double S2,
ref eSiteClass_NBCC_2010 siteClass,
ref double Fa,
ref double Fv,
ref double dampingRatio)
{
int csiSiteClass = 0;
_callCode = _sapModel.Func.FuncRS.GetNBCC2010(name, ref PGA, ref S02, ref S05, ref S1, ref S2, ref csiSiteClass, ref Fa, ref Fv, ref dampingRatio);
if (throwCurrentApiException(_callCode))
{
throw new CSiException(API_DEFAULT_ERROR_CODE);
}
siteClass = (eSiteClass_NBCC_2010)csiSiteClass;
}
