/// <inheritdoc />
/// <summary>
/// Returns the case type, design type, and auto flag for the specified load case.
/// </summary>
/// <param name="nameLoadCase">The name of an existing load case.</param>
/// <param name="loadCaseType">Load case type corresponding to the name provided.</param>
/// <param name="loadCaseSubType">Load case sub-type corresponding to the name provided.</param>
/// <param name="designType">Load case design type corresponding to the name provided.</param>
/// <param name="designTypeOption">Load case type corresponding to the name provided.</param>
/// <param name="autoCreatedCase">This is a value indicating if the load case has been automatically created.</param>
/// <exception cref="CSiException"><see cref="CSiApiBase.API_DEFAULT_ERROR_CODE" /></exception>
public void GetCaseTypes(string nameLoadCase,
out eLoadCaseType loadCaseType,
out int loadCaseSubType,
out eLoadPatternType designType,
out eSpecificationSource designTypeOption,
out eAutoCreatedCase autoCreatedCase)
{
loadCaseType = 0;
loadCaseSubType = 0;
designType = 0;
CSiProgram.eLoadCaseType csiCaseType = CSiProgram.eLoadCaseType.Modal;
CSiProgram.eLoadPatternType csiPatternType = CSiProgram.eLoadPatternType.Dead;
int csiDesignTypeOption = 0;
int csiAutoCreatedCase = 0;
_callCode = _sapModel.LoadCases.GetTypeOAPI_1(nameLoadCase, ref csiCaseType, ref loadCaseSubType, ref csiPatternType, ref csiDesignTypeOption, ref csiAutoCreatedCase);
if (throwCurrentApiException(_callCode))
{
throw new CSiException(API_DEFAULT_ERROR_CODE);
}
loadCaseType = EnumLibrary.Convert(csiCaseType, loadCaseType);
designType = EnumLibrary.Convert(csiPatternType, designType);
designTypeOption = (eSpecificationSource)csiDesignTypeOption;
autoCreatedCase = (eAutoCreatedCase)csiAutoCreatedCase;
}
public void GetCaseTypes(string nameLoadCase,
ref eLoadCaseType loadCaseType,
ref int loadCaseSubType,
ref eLoadPatternType designType,
ref eSpecificationSource designTypeOption,
ref eAutoCreatedCase autoCreatedCase)
{
}
/// <summary>
/// Sets the design type for the specified load case.
/// </summary>
/// <param name="designTypeOption">This is one of the options for <paramref name="designType" />.</param>
/// <param name="designType">This item only applies when the <paramref name="designTypeOption" /> = <see cref="eSpecificationSource.UserSpecified"/>.</param>
/// <exception cref="CSiException"><see cref="CSiApiBase.API_DEFAULT_ERROR_CODE" /></exception>
public void SetDesignType(
eSpecificationSource designTypeOption,
eLoadPatternType designType = eLoadPatternType.Dead)
{
if (_apiLoadCases == null)
{
return;
}
_apiLoadCases.SetDesignType(Name, designTypeOption, designType);
_designType = designType;
_designTypeOption = designTypeOption;
}
/// <summary>
/// This function sets the design type for the specified load case.
/// </summary>
/// <param name="nameLoadCase">The name of an existing load case.</param>
/// <param name="designTypeOption">This is one of the following options for the DesignType item.</param>
/// <param name="designType">This item only applies when the DesignTypeOption is 1 (user specified). It is one of the following items in the eLoadPatternType enumeration.</param>
/// <exception cref="CSiException"></exception>
public void SetDesignType(string nameLoadCase,
eSpecificationSource designTypeOption,
eLoadPatternType designType = eLoadPatternType.Dead)
{
int csiDesignTypeOption = (int)designTypeOption;
_callCode = _sapModel.LoadCases.SetDesignType(nameLoadCase, csiDesignTypeOption,
EnumLibrary.Convert <eLoadPatternType, CSiProgram.eLoadPatternType>(designType));
if (throwCurrentApiException(_callCode))
{
throw new CSiException();
}
}
/// <summary>
/// Gets the case types.
/// </summary>
public void FillCaseTypes()
{
if (_apiLoadCases == null)
{
return;
}
_apiLoadCases.GetCaseTypes(Name,
out var loadCaseType,
out var loadCaseSubType,
out var designType,
out var designTypeOption,
out var autoCreatedCase);
_type = loadCaseType;
_subType = getCaseSubTypes(loadCaseType, loadCaseSubType);
_designType = designType;
_designTypeOption = designTypeOption;
_autoCreatedCase = autoCreatedCase;
}
public void SetDesignType(string nameLoadCase,
eSpecificationSource designTypeOption,
eLoadPatternType designType = eLoadPatternType.Dead)
{
}