Click or drag to resize

ArbitraryDefinitionSegment Class

[This is preliminary documentation and is subject to change.]

Defines a segment of an arbitrary definition
Inheritance Hierarchy
SystemObject
  ModelExchanger.AnalysisDataModel.SubtypesArbitraryDefinitionSegment

Namespace:  ModelExchanger.AnalysisDataModel.Subtypes
Assembly:  ModelExchanger.AnalysisDataModel (in ModelExchanger.AnalysisDataModel.dll) Version: 1.13.0+Branch.master.Sha.d583fc64569355d188a9c0818d257b6d0d3e1339
Syntax
C#
Copy
public sealed class ArbitraryDefinitionSegment : IEquatable<ArbitraryDefinitionSegment>

The ArbitraryDefinitionSegment type exposes the following members.

Constructors
  NameDescription
Public methodArbitraryDefinitionSegment(StructuralCrossSection, Double, CurveAlignment)
Create a segment for an arbitrary definition that consists out of a single cross section and a given alignment and span.
Public methodArbitraryDefinitionSegment(StructuralCrossSection, StructuralCrossSection, Double, CurveAlignment)
Create a segment for an arbitrary definition that consists out of two cross sections and a given alignment and span.
Top
Properties
  NameDescription
Public propertyAlignment
The positioning of the system-line of this segment
Public propertyCrossSectionBegin
The cross section at the start of the segment
Public propertyCrossSectionEnd
The cross section at the end of the segment
Public propertySpan
The span of the segment. Must be greater than 0 and less than or equal to 1
Top
Methods
  NameDescription
Public methodEquals(ArbitraryDefinitionSegment)
Indicates whether the current object is equal to another object of the same type.
Public methodEquals(Object)
Determines whether the specified object is equal to the current object.
(Overrides ObjectEquals(Object).)
Public methodGetHashCode
Serves as the default hash function.
(Overrides ObjectGetHashCode.)
Top
Examples
Creating an instance
Copy
/// <summary>
/// Create an arbitrary definition segment which consists out of single profile with a given span and alignment
/// </summary>
/// <param name="crossSection">The cross section of the segment</param>
/// <param name="span">How much the segment spans across the beam, expressed in a relative number (0 ... 1)</param>
/// <param name="alignment">Defines how the system line is positioned</param>
/// <returns>A segment that is part of an arbitrary definition</returns>
private ArbitraryDefinitionSegment CreateArbitraryDefinitionSegment(StructuralCrossSection crossSection, double span,
    CurveAlignment alignment)
{
    return new ArbitraryDefinitionSegment(crossSection, span, alignment);
}

/// <summary>
/// Create an arbitrary definition segment which consists out of two different profiles with a given span and alignment
/// </summary>
/// <param name="crossSectionBegin">The cross section at the beginning of the segment</param>
/// <param name="crossSectionEnd">The cross section at the end of the segment</param>
/// <param name="span">How much the segment spans across the beam, expressed in a relative number (0 ... 1)</param>
/// <param name="alignment">Defines how the system line is positioned</param>
/// <returns></returns>
private ArbitraryDefinitionSegment CreateArbitraryDefinitionSegment(StructuralCrossSection crossSectionBegin,
    StructuralCrossSection crossSectionEnd, double span, CurveAlignment alignment)
{
    return new ArbitraryDefinitionSegment(crossSectionBegin, crossSectionEnd, span, alignment);
}
See Also