Show / Hide Table of Contents

    Class ParametricProfileFactory<TProfileType, TProfile>

    A profile factory which creates parametric profiles.

    Inheritance
    System.Object
    ParametricProfileFactory<TProfileType, TProfile>
    CProfileFactory
    HSSProfileFactory
    LProfileFactory
    MCProfileFactory
    STProfileFactory
    WProfileFactory
    WTProfileFactory
    Inherited Members
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.ToString()
    Namespace: Elements.Geometry.Profiles
    Assembly: Hypar.Elements.dll
    Syntax
    public class ParametricProfileFactory<TProfileType, TProfile>
        where TProfileType : Enum where TProfile : ParametricProfile
    Type Parameters
    Name Description
    TProfileType
    TProfile

    Constructors

    ParametricProfileFactory(String, Double)

    Create a parametric profile factory by reading from a csv.

    Declaration
    public ParametricProfileFactory(string csvPath, double conversion)
    Parameters
    Type Name Description
    System.String csvPath

    The path of the csv. This can be an absolute path, a path relative to the current working directory, or a path relative to the location of the type's assembly.

    System.Double conversion

    The conversion factor applied to values in the catalogue.

    Methods

    AllProfilesAsync()

    Get all profiles.

    Declaration
    public async Task<IEnumerable<TProfile>> AllProfilesAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<TProfile>>

    GetProfileByNameAsync(String)

    Get a profile by name.

    Declaration
    public async Task<TProfile> GetProfileByNameAsync(string name)
    Parameters
    Type Name Description
    System.String name

    The name of the profile.

    Returns
    Type Description
    System.Threading.Tasks.Task<TProfile>

    GetProfileByTypeAsync(TProfileType)

    Get a profile by type.

    Declaration
    public async Task<TProfile> GetProfileByTypeAsync(TProfileType type)
    Parameters
    Type Name Description
    TProfileType type
    Returns
    Type Description
    System.Threading.Tasks.Task<TProfile>