Version: 15.0

    Show / Hide Table of Contents

    Class ML1MicroGeometryOptimiser

    Inheritance
    System.Object
    APIBase
    ML1MicroGeometryOptimiser
    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.MachineLearning
    Assembly: SMT.MastaAPI.15.0.dll
    Syntax
    public sealed class ML1MicroGeometryOptimiser : APIBase, IEquatable<APIBase>

    Properties

    Analysis

    Declaration
    public string Analysis { get; }
    Property Value
    Type Description
    System.String

    Constraints

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

    DutyCycleResults

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

    EditableName

    Declaration
    public string EditableName { get; set; }
    Property Value
    Type Description
    System.String

    FlankParameterSelections

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

    MicroGeometryUsedForOptimisation

    Declaration
    public string MicroGeometryUsedForOptimisation { get; }
    Property Value
    Type Description
    System.String

    NumberOfIterationsCompleted

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

    ReportNames

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

    ScatterChart

    Declaration
    public ScatterChartDefinition ScatterChart { get; }
    Property Value
    Type Description
    ScatterChartDefinition

    SelectedResults

    Declaration
    public CylindricalGearSetMicroGeometryDutyCycle SelectedResults { get; }
    Property Value
    Type Description
    CylindricalGearSetMicroGeometryDutyCycle

    Settings

    Declaration
    public ML1OptimizerSettings Settings { get; }
    Property Value
    Type Description
    ML1OptimizerSettings

    Snapshots

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

    Stage

    Declaration
    public OptimizationStage Stage { get; }
    Property Value
    Type Description
    OptimizationStage

    StartingMicroGeometry

    The micro geometry to use as a starting point for the optimization.

    Declaration
    public ListWithSelectedItem<string> StartingMicroGeometry { get; set; }
    Property Value
    Type Description
    ListWithSelectedItem<System.String>

    Targets

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

    Methods

    AddConstraint()

    Declaration
    public void AddConstraint()

    AddSelectedMicroGeometry()

    Declaration
    public void AddSelectedMicroGeometry()

    AddTarget()

    Declaration
    public void AddTarget()

    ClearResults()

    Declaration
    public void ClearResults()

    DeleteOptimiser()

    Declaration
    public void DeleteOptimiser()

    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

    SelectBestMicroGeometry()

    Declaration
    public void SelectBestMicroGeometry()

    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