/// <summary>
/// Adds a new section cut defined by a group to the model or reinitializes an existing section cut to be defined by a group.
/// </summary>
/// <param name="uniqueName">Name of the unique section cut.</param>
/// <param name="group">The group associated with the section cut.</param>
/// <param name="sectionCutType">The result type of the section cut.</param>
/// <returns>SectionCut.</returns>
/// <exception cref="NotImplementedException"></exception>
public static SectionCut AddByGroup(
string uniqueName,
Group group,
eSectionResultType sectionCutType)
{
throw new NotImplementedException();
}
/// <summary>
/// Adds a new section cut defined by a quadrilateral to the model or reinitializes an existing section cut to be defined by a quadrilateral.
/// </summary>
/// <param name="groupName">The name of the group associated with the section cut.</param>
/// <param name="sectionCutType">The result type of the section cut.</param>
/// <param name="xCoordinates">This is an array of four X coordinates, one for each of the four points defining the quadrilateral.</param>
/// <param name="yCoordinates">This is an array of four Y coordinates, one for each of the four points defining the quadrilateral.</param>
/// <param name="zCoordinates">This is an array of four Z coordinates, one for each of the four points defining the quadrilateral.</param>
/// <exception cref="CSiException">
/// xCoordinates + " has " + xCoordinates.Length + " items, but must have 4.
/// or
/// API_DEFAULT_ERROR_CODE</exception>
public void AddByQuadrilateral(
string groupName,
eSectionResultType sectionCutType,
ref double[] xCoordinates,
ref double[] yCoordinates,
ref double[] zCoordinates)
{
}
// === Set
/// <summary>
/// This function adds a new section cut defined by a group to the model or reinitializes an existing section cut to be defined by a group.
/// </summary>
/// <param name="nameSectionCut">Name of an existing section cut.</param>
/// <param name="groupName">The name of the group associated with the section cut.</param>
/// <param name="sectionCutType">The result type of the section cut.</param>
/// <exception cref="CSiException"></exception>
public void SetByGroup(string nameSectionCut,
string groupName,
eSectionResultType sectionCutType)
{
_callCode = _sapModel.SectCut.SetByGroup(nameSectionCut, groupName, (int)sectionCutType);
if (throwCurrentApiException(_callCode))
{
throw new CSiException();
}
}
/// <summary>
/// Adds a new section cut defined by a quadrilateral to the model or reinitializes an existing section cut to be defined by a quadrilateral.
/// </summary>
/// <param name="uniqueName">Name of the unique section cut.</param>
/// <param name="group">The group associated with the section cut.</param>
/// <param name="sectionCutType">The result type of the section cut.</param>
/// <param name="coordinate1">This is one of four coordinates, one for each of the four points defining the quadrilateral.</param>
/// <param name="coordinate2">This is one of four coordinates, one for each of the four points defining the quadrilateral.</param>
/// <param name="coordinate3">This is one of four coordinates, one for each of the four points defining the quadrilateral.</param>
/// <param name="coordinate4">This is one of four coordinates, one for each of the four points defining the quadrilateral.</param>
/// <returns>SectionCut.</returns>
/// <exception cref="NotImplementedException"></exception>
public static SectionCut AddByQuadrilateral(
string uniqueName,
Group group,
eSectionResultType sectionCutType,
Coordinate3DCartesian coordinate1,
Coordinate3DCartesian coordinate2,
Coordinate3DCartesian coordinate3,
Coordinate3DCartesian coordinate4)
{
throw new NotImplementedException();
}
/// <summary>
/// Adds a new section cut defined by a group to the model or reinitializes an existing section cut to be defined by a group.
/// </summary>
/// <param name="uniqueName">Name of the unique section cut.</param>
/// <param name="group">The group associated with the section cut.</param>
/// <param name="sectionCutType">The result type of the section cut.</param>
/// <returns><c>true</c> if XXXX, <c>false</c> otherwise.</returns>
public bool AddByGroup(
string uniqueName,
Group group,
eSectionResultType sectionCutType)
{
if (Contains(uniqueName))
{
return(false);
}
_items.Add(SectionCut.AddByGroup(uniqueName, group, sectionCutType));
return(true);
}
// === Get
/// <summary>
/// This function gets basic information about an existing section cut.
/// </summary>
/// <param name="nameSectionCut">Name of an existing section cut.</param>
/// <param name="groupName">The name of the group associated with the section cut.</param>
/// <param name="sectionCutType">The result type of the section cut.</param>
/// <param name="numberQuadrilaterals">The number of quadrilateral cutting planes defined for the section cut.
/// If this number is zero then the section cut is defined by the associated group.</param>
/// <exception cref="CSiException"></exception>
public void GetCutInfo(string nameSectionCut,
ref string groupName,
ref eSectionResultType sectionCutType,
ref int numberQuadrilaterals)
{
int csiSectionCutType = 0;
_callCode = _sapModel.SectCut.GetCutInfo(nameSectionCut, ref groupName, ref csiSectionCutType, ref numberQuadrilaterals);
if (throwCurrentApiException(_callCode))
{
throw new CSiException();
}
sectionCutType = (eSectionResultType)csiSectionCutType;
}
/// <summary>
/// Converts the type of to section result.
/// </summary>
/// <param name="resultType">Type of the result.</param>
/// <param name="designType">Type of the design.</param>
/// <returns>eSectionResultType.</returns>
private static string convertFromSectionDesignType(eSectionResultType designType)
{
switch (designType)
{
case eSectionResultType.DesignWall:
return("Wall");
case eSectionResultType.DesignSpandrel:
return("Spandrel");
case eSectionResultType.DesignSlab:
return("Slab");
default:
return(string.Empty);
}
}
/// <summary>
/// This function adds a new section cut defined by a quadrilateral to the model or reinitializes an existing section cut to be defined by a quadrilateral
/// </summary>
/// <param name="nameSectionCut">Name of an existing section cut.</param>
/// <param name="groupName">The name of the group associated with the section cut.</param>
/// <param name="sectionCutType">The result type of the section cut.</param>
/// <param name="xCoordinates">This is an array of four X coordinates, one for each of the four points defining the quadrilateral.</param>
/// <param name="yCoordinates">This is an array of four Y coordinates, one for each of the four points defining the quadrilateral.</param>
/// <param name="zCoordinates">This is an array of four Z coordinates, one for each of the four points defining the quadrilateral.</param>
/// <exception cref="CSiException">
/// xCoordinates
/// or
/// </exception>
public void SetByQuadrilateral(string nameSectionCut,
string groupName,
eSectionResultType sectionCutType,
ref double[] xCoordinates,
ref double[] yCoordinates,
ref double[] zCoordinates)
{
if (xCoordinates.Length != 4)
{
throw new CSiException(nameof(xCoordinates) + " has " + xCoordinates.Length + " items, but must have 4.");
}
arraysLengthMatch(nameof(xCoordinates), xCoordinates.Length, nameof(yCoordinates), yCoordinates.Length);
arraysLengthMatch(nameof(xCoordinates), xCoordinates.Length, nameof(zCoordinates), zCoordinates.Length);
_callCode = _sapModel.SectCut.SetByQuad(nameSectionCut, groupName, (int)sectionCutType, ref xCoordinates, ref yCoordinates, ref zCoordinates);
if (throwCurrentApiException(_callCode))
{
throw new CSiException();
}
}
/// <summary>
/// Adds a new section cut defined by a quadrilateral to the model or reinitializes an existing section cut to be defined by a quadrilateral.
/// </summary>
/// <param name="uniqueName">Name of the unique section cut.</param>
/// <param name="group">The group associated with the section cut.</param>
/// <param name="sectionCutType">The result type of the section cut.</param>
/// <param name="coordinate1">This is one of four coordinates, one for each of the four points defining the quadrilateral.</param>
/// <param name="coordinate2">This is one of four coordinates, one for each of the four points defining the quadrilateral.</param>
/// <param name="coordinate3">This is one of four coordinates, one for each of the four points defining the quadrilateral.</param>
/// <param name="coordinate4">This is one of four coordinates, one for each of the four points defining the quadrilateral.</param>
/// <returns><c>true</c> if XXXX, <c>false</c> otherwise.</returns>
public bool AddByQuadrilateral(
string uniqueName,
Group group,
eSectionResultType sectionCutType,
Coordinate3DCartesian coordinate1,
Coordinate3DCartesian coordinate2,
Coordinate3DCartesian coordinate3,
Coordinate3DCartesian coordinate4)
{
if (Contains(uniqueName))
{
return(false);
}
_items.Add(SectionCut.AddByQuadrilateral(
uniqueName,
group,
sectionCutType,
coordinate1,
coordinate2,
coordinate3,
coordinate4));
return(true);
}
// === Set
/// <summary>
/// Adds a new section cut defined by a group to the model or reinitializes an existing section cut to be defined by a group.
/// </summary>
/// <param name="groupName">The name of the group associated with the section cut.</param>
/// <param name="sectionCutType">The result type of the section cut.</param>
/// <exception cref="CSiException"><see cref="CSiApiBase.API_DEFAULT_ERROR_CODE" /></exception>
public void AddByGroup(
string groupName,
eSectionResultType sectionCutType)
{
}
// === Get
/// <summary>
/// This function gets basic information about an existing section cut.
/// </summary>
/// <param name="groupName">The name of the group associated with the section cut.</param>
/// <param name="sectionCutType">The result type of the section cut.</param>
/// <param name="numberQuadrilaterals">The number of quadrilateral cutting planes defined for the section cut.
/// If this number is zero then the section cut is defined by the associated group.</param>
/// <exception cref="CSiException"><see cref="CSiApiBase.API_DEFAULT_ERROR_CODE" /></exception>
public void GetCutInfo(
ref string groupName,
ref eSectionResultType sectionCutType,
ref int numberQuadrilaterals)
{
}
public void SetByGroup(string nameSectionCut,
string groupName,
eSectionResultType sectionCutType)
{
}
/// <summary>
/// Converts the type of to section result.
/// </summary>
/// <param name="resultType">Type of the result.</param>
/// <param name="designType">Type of the design.</param>
/// <returns>eSectionResultType.</returns>
private static string convertFromSectionResultType(eSectionResultType resultType)
{
return((resultType == eSectionResultType.Analysis) ? "Analysis" : "Design");
}