Version:

    Show / Hide Table of Contents

    Class SystemOptimiserDetails

    Inheritance
    System.Object
    APIBase
    SystemOptimiserDetails
    Implements
    System.IEquatable<APIBase>
    Inherited Members
    APIBase.DisconnectFromMASTA()
    APIBase.GetProperty<T>(String)
    APIBase.SetProperty(String, Object)
    APIBase.clearCachedRpds()
    APIBase.getNamedObjectList<TElementType>(String)
    APIBase.getExpandableProperty<TReturnType>(String)
    APIBase.callPartialMethod(String, [])
    APIBase.callPartialMethod<T>(String, T)
    APIBase.callPartialMethod<T>(String, , T)
    APIBase.callPartialMethod<T>(String, , , T)
    APIBase.callPartialMethod<T>(String, , , , T)
    APIBase.callPartialMethod<T1, T2>(String, , T1, T2)
    APIBase.getPartialProperty(String)
    APIBase.setPartialProperty(String, Object)
    APIBase.IsValid(String)
    APIBase.IsReadOnly(String)
    APIBase.DocumentationUrl()
    APIBase.ToString()
    APIBase.RunPython<T>(String, String, Object)
    APIBase.RunPythonCode<T>(String, String, Object)
    APIBase.RunPythonCode<T>(String)
    APIBase.RunPython<T>(String, String)
    APIBase.RunPython(String, String, Object)
    APIBase.createWrappedRange(Double, Double)
    APIBase.createWrappedVector2D(Double, Double)
    APIBase.createWrappedPosition3D(Double, Double, Double)
    APIBase.ToListWithSelectedItem<T>(IEnumerable<T>)
    APIBase.ToListWithSelectedItem<T>(T, IEnumerable<T>)
    APIBase.Equals(APIBase)
    APIBase.GetHashCode()
    APIBase.Equals(Object)
    APIBase.InvalidProperties
    APIBase.ReadOnlyProperties
    APIBase.AllPropertiesAreReadOnly
    APIBase.AllPropertiesAreInvalid
    APIBase.cacheRpds
    APIBase.isInvalid
    Namespace: SMT.MastaAPI.SystemModel.Optimization.SystemOptimiser
    Assembly: SMT.MastaAPI.14.1.dll
    Syntax
    public class SystemOptimiserDetails : APIBase, IEquatable<APIBase>

    Fields

    _parent

    Declaration
    protected readonly APIBase _parent
    Field Value
    Type Description
    APIBase

    Properties

    AvoidSpecificOrders

    Declaration
    public bool AvoidSpecificOrders { get; set; }
    Property Value
    Type Description
    System.Boolean

    CheckFrequencySeparation

    Declaration
    public bool CheckFrequencySeparation { get; set; }
    Property Value
    Type Description
    System.Boolean

    CheckPassingOrderSeparation

    Declaration
    public bool CheckPassingOrderSeparation { get; set; }
    Property Value
    Type Description
    System.Boolean

    CriteriaForSelectingConfigurationsToKeep

    Declaration
    public SystemOptimiserTargets CriteriaForSelectingConfigurationsToKeep { get; set; }
    Property Value
    Type Description
    SystemOptimiserTargets

    FilterDesignsOnEstimatedMaximumAchievableTransverseContactRatio

    Declaration
    public bool FilterDesignsOnEstimatedMaximumAchievableTransverseContactRatio { get; set; }
    Property Value
    Type Description
    System.Boolean

    GearSetOptimisation

    Declaration
    public SystemOptimiserGearSetOptimisation GearSetOptimisation { get; set; }
    Property Value
    Type Description
    SystemOptimiserGearSetOptimisation

    InputShaftSpeedForGearMeshFrequencySeparationTest

    Declaration
    public Overridable<double> InputShaftSpeedForGearMeshFrequencySeparationTest { get; set; }
    Property Value
    Type Description
    Overridable<System.Double>

    MaximumNumberOfConfigurationsToCreate

    Declaration
    public int MaximumNumberOfConfigurationsToCreate { get; set; }
    Property Value
    Type Description
    System.Int32

    MaximumNumberOfSolutions

    Declaration
    public Overridable<int> MaximumNumberOfSolutions { get; set; }
    Property Value
    Type Description
    Overridable<System.Int32>

    MinimumNumberOfSolutions

    Declaration
    public int MinimumNumberOfSolutions { get; set; }
    Property Value
    Type Description
    System.Int32

    ModifyFaceWidths

    Declaration
    public bool ModifyFaceWidths { get; set; }
    Property Value
    Type Description
    System.Boolean

    NumberOfHarmonicsForFrequencySeparationTest

    Declaration
    public int NumberOfHarmonicsForFrequencySeparationTest { get; set; }
    Property Value
    Type Description
    System.Int32

    NumberOfHarmonicsForPassingOrderSeparationTest

    Declaration
    public int NumberOfHarmonicsForPassingOrderSeparationTest { get; set; }
    Property Value
    Type Description
    System.Int32

    NumberOfOrdersToAvoid

    Declaration
    public int NumberOfOrdersToAvoid { get; set; }
    Property Value
    Type Description
    System.Int32

    NumberOfSolutions

    Declaration
    public int NumberOfSolutions { get; }
    Property Value
    Type Description
    System.Int32

    PlanetGearOptions

    Declaration
    public ReadOnlyCollection<PlanetGearOptions> PlanetGearOptions { get; }
    Property Value
    Type Description
    System.Collections.ObjectModel.ReadOnlyCollection<PlanetGearOptions>

    ReportNames

    Declaration
    public IReadOnlyList<string> ReportNames { get; }
    Property Value
    Type Description
    System.Collections.Generic.IReadOnlyList<System.String>

    RequiredGearMeshFrequencySeparation

    Declaration
    public double RequiredGearMeshFrequencySeparation { get; set; }
    Property Value
    Type Description
    System.Double

    RequiredGearMeshFrequencySeparationPercentage

    Declaration
    public double RequiredGearMeshFrequencySeparationPercentage { get; set; }
    Property Value
    Type Description
    System.Double

    RequiredNormalisedSafetyFactor

    Declaration
    public double RequiredNormalisedSafetyFactor { get; set; }
    Property Value
    Type Description
    System.Double

    RequiredPassingOrderSeparation

    Declaration
    public double RequiredPassingOrderSeparation { get; set; }
    Property Value
    Type Description
    System.Double

    ShowRatioAsSpeedIncreasing

    Declaration
    public Overridable<bool> ShowRatioAsSpeedIncreasing { get; set; }
    Property Value
    Type Description
    Overridable<System.Boolean>

    TargetMaximumAbsoluteCylindricalGearProfileShiftCoefficient

    Declaration
    public double TargetMaximumAbsoluteCylindricalGearProfileShiftCoefficient { get; set; }
    Property Value
    Type Description
    System.Double

    TargetRatios

    Declaration
    public ReadOnlyCollection<DesignStateTargetRatio> TargetRatios { get; }
    Property Value
    Type Description
    System.Collections.ObjectModel.ReadOnlyCollection<DesignStateTargetRatio>

    ToleranceForCombiningDutyCycles

    Declaration
    public double ToleranceForCombiningDutyCycles { get; set; }
    Property Value
    Type Description
    System.Double

    Methods

    CreateDesigns()

    Declaration
    public void CreateDesigns()

    DetermineRatioTolerances()

    Declaration
    public void DetermineRatioTolerances()

    FindSolutionsFromCurrentRatioTolerances()

    Declaration
    public void FindSolutionsFromCurrentRatioTolerances()

    GetActiveReportWithEncodedImages()

    Declaration
    public string GetActiveReportWithEncodedImages()
    Returns
    Type Description
    System.String

    GetDefaultReportWithEncodedImages()

    Declaration
    public string GetDefaultReportWithEncodedImages()
    Returns
    Type Description
    System.String

    GetNamedReportWithEncodedImages(String)

    Declaration
    public string GetNamedReportWithEncodedImages(string reportName)
    Parameters
    Type Name Description
    System.String reportName
    Returns
    Type Description
    System.String

    OutputActiveReportAsTextTo(String)

    Declaration
    public void OutputActiveReportAsTextTo(string filePath)
    Parameters
    Type Name Description
    System.String filePath

    OutputActiveReportTo(String)

    Declaration
    public void OutputActiveReportTo(string filePath)
    Parameters
    Type Name Description
    System.String filePath

    OutputDefaultReportTo(String)

    Declaration
    public void OutputDefaultReportTo(string filePath)
    Parameters
    Type Name Description
    System.String filePath

    OutputNamedReportAsMastaReport(String, String)

    Declaration
    public void OutputNamedReportAsMastaReport(string reportName, string filePath)
    Parameters
    Type Name Description
    System.String reportName
    System.String filePath

    OutputNamedReportAsTextTo(String, String)

    Declaration
    public void OutputNamedReportAsTextTo(string reportName, string filePath)
    Parameters
    Type Name Description
    System.String reportName
    System.String filePath

    OutputNamedReportTo(String, String)

    Declaration
    public void OutputNamedReportTo(string reportName, string filePath)
    Parameters
    Type Name Description
    System.String reportName
    System.String filePath

    PerformSystemOptimisation()

    Declaration
    public void PerformSystemOptimisation()

    Implements

    System.IEquatable<T>

    Extension Methods

    UtilityMethods.IsReadOnly<T>(T, Expression<Func<T, Object>>)
    UtilityMethods.IsValid<T>(T, Expression<Func<T, Object>>)
    UtilityMethods.IsMethodValid<T>(T, Expression<Func<T, Action>>)
    UtilityMethods.IsMethodReadOnly<T>(T, Expression<Func<T, Action>>)
    Back to top