/// <summary>
/// Returns the modal combination option assigned to the specified load case.
/// </summary>
/// <param name="name">The name of an existing load case.</param>
/// <param name="modalCombination">The modal combination option.</param>
/// <param name="gmcF1">The GMC f1 factor [cyc/s].
/// This item does not apply when <paramref name="modalCombination" /> = <see cref="eModalCombination.ABS" />.</param>
/// <param name="gmcF2">The GMC f2 factor [cyc/s].
/// This item does not apply when <paramref name="modalCombination" /> = <see cref="eModalCombination.ABS" />.</param>
/// <param name="periodicPlusRigidModalCombination">The periodic plus rigid modal combination option.</param>
/// <param name="td">The factor td [s].
/// This item applies only when <paramref name="modalCombination" /> = <see cref="eModalCombination.DoubleSum" />.</param>
/// <exception cref="CSiException"><see cref="CSiApiBase.API_DEFAULT_ERROR_CODE" /></exception>
public void GetModalCombination(string name,
out eModalCombination modalCombination,
out double gmcF1,
out double gmcF2,
out ePeriodicPlusRigidModalCombination periodicPlusRigidModalCombination,
out double td)
{
gmcF1 = -1;
gmcF2 = -1;
td = -1;
int csiModalCombination = 0;
int csiPeriodicPlusRigidModalCombination = 0;
_callCode = _sapModel.LoadCases.ResponseSpectrum.GetModalComb_1(name,
ref csiModalCombination,
ref gmcF1,
ref gmcF2,
ref csiPeriodicPlusRigidModalCombination,
ref td);
if (throwCurrentApiException(_callCode))
{
throw new CSiException(API_DEFAULT_ERROR_CODE);
}
modalCombination = (eModalCombination)csiModalCombination;
periodicPlusRigidModalCombination = (ePeriodicPlusRigidModalCombination)csiPeriodicPlusRigidModalCombination;
}
/// <summary>
/// Returns the modal combination option assigned to the specified load case.
/// </summary>
/// <param name="name">The name of an existing load case.</param>
/// <param name="modalCombination">The modal combination option.</param>
/// <param name="gmcF1">The GMC f1 factor [cyc/s].
/// This item does not apply when <paramref name="modalCombination" /> = <see cref="eModalCombination.ABS" />.</param>
/// <param name="gmcF2">The GMC f2 factor [cyc/s].
/// This item does not apply when <paramref name="modalCombination" /> = <see cref="eModalCombination.ABS" />.</param>
/// <param name="periodicPlusRigidModalCombination">The periodic plus rigid modal combination option.</param>
/// <param name="td">The factor td [s].
/// This item applies only when <paramref name="modalCombination" /> = <see cref="eModalCombination.DoubleSum" />.</param>
/// <exception cref="CSiException"><see cref="CSiApiBase.API_DEFAULT_ERROR_CODE" /></exception>
public void SetModalCombination(string name,
eModalCombination modalCombination,
double gmcF1,
double gmcF2,
ePeriodicPlusRigidModalCombination periodicPlusRigidModalCombination,
double td)
{
}
public void GetModalCombination(string name,
ref eModalCombination modalCombination,
ref double gmcF1,
ref double gmcF2,
ref ePeriodicPlusRigidModalCombination periodicPlusRigidModalCombination,
ref double td)
{
}
/// <summary>
/// Returns the modal combination option assigned to the specified load case.
/// </summary>
/// <param name="name">The name of an existing load case.</param>
/// <param name="modalCombination">The modal combination option.</param>
/// <param name="gmcF1">The GMC f1 factor [cyc/s].
/// This item does not apply when <paramref name="modalCombination" /> = <see cref="eModalCombination.ABS" />.</param>
/// <param name="gmcF2">The GMC f2 factor [cyc/s].
/// This item does not apply when <paramref name="modalCombination" /> = <see cref="eModalCombination.ABS" />.</param>
/// <param name="periodicPlusRigidModalCombination">The periodic plus rigid modal combination option.</param>
/// <param name="td">The factor td [s].
/// This item applies only when <paramref name="modalCombination" /> = <see cref="eModalCombination.DoubleSum" />.</param>
/// <exception cref="CSiException"><see cref="CSiApiBase.API_DEFAULT_ERROR_CODE" /></exception>
public void SetModalCombination(string name,
eModalCombination modalCombination,
double gmcF1,
double gmcF2,
ePeriodicPlusRigidModalCombination periodicPlusRigidModalCombination,
double td)
{
throw new NotImplementedException();
}
/// <summary>
/// Returns the modal combination option assigned to the specified load case.
/// </summary>
/// <param name="name">The name of an existing load case.</param>
/// <param name="modalCombination">The modal combination option.</param>
/// <param name="gmcF1">The GMC f1 factor [cyc/s].
/// This item does not apply when <paramref name="modalCombination" /> = <see cref="eModalCombination.ABS" />.</param>
/// <param name="gmcF2">The GMC f2 factor [cyc/s].
/// This item does not apply when <paramref name="modalCombination" /> = <see cref="eModalCombination.ABS" />.</param>
/// <param name="periodicPlusRigidModalCombination">The periodic plus rigid modal combination option.</param>
/// <param name="td">The factor td [s].
/// This item applies only when <paramref name="modalCombination" /> = <see cref="eModalCombination.DoubleSum" />.</param>
/// <exception cref="CSiException"><see cref="CSiApiBase.API_DEFAULT_ERROR_CODE" /></exception>
public void SetModalCombination(string name,
eModalCombination modalCombination,
double gmcF1,
double gmcF2,
ePeriodicPlusRigidModalCombination periodicPlusRigidModalCombination,
double td)
{
_callCode = _sapModel.LoadCases.ResponseSpectrum.SetModalComb_1(name, (int)modalCombination, gmcF1, gmcF2, (int)periodicPlusRigidModalCombination, td);
if (throwCurrentApiException(_callCode))
{
throw new CSiException(API_DEFAULT_ERROR_CODE);
}
}
/// <summary>
/// This function retrieves the modal combination option assigned to the specified load case.
/// </summary>
/// <param name="name">The name of an existing load case.</param>
/// <param name="modalCombination">The modal combination option.</param>
/// <param name="gmcF1">The GMC f1 factor [cyc/s].
/// This item does not apply when <paramref name="modalCombination" /> = <see cref="eModalCombination.ABS" />.</param>
/// <param name="gmcF2">The GMC f2 factor [cyc/s].
/// This item does not apply when <paramref name="modalCombination" /> = <see cref="eModalCombination.ABS" />.</param>
/// <param name="periodicPlusRigidModalCombination">The periodic plus rigid modal combination option.</param>
/// <param name="td">The factor td [s].
/// This item applies only when <paramref name="modalCombination" /> = <see cref="eModalCombination.DoubleSum" />.</param>
/// <exception cref="CSiException"></exception>
public void GetModalCombination(string name,
ref eModalCombination modalCombination,
ref double gmcF1,
ref double gmcF2,
ref ePeriodicPlusRigidModalCombination periodicPlusRigidModalCombination,
ref double td)
{
int csiModalCombination = 0;
int csiPeriodicPlusRigidModalCombination = 0;
_callCode = _sapModel.LoadCases.ResponseSpectrum.GetModalComb_1(name, ref csiModalCombination, ref gmcF1, ref gmcF2, ref csiPeriodicPlusRigidModalCombination, ref td);
if (throwCurrentApiException(_callCode))
{
throw new CSiException();
}
modalCombination = (eModalCombination)csiModalCombination;
periodicPlusRigidModalCombination = (ePeriodicPlusRigidModalCombination)csiPeriodicPlusRigidModalCombination;
}