Version: 13.0

    Show / Hide Table of Contents

    Class GearSetDesignGroup

    Inheritance
    System.Object
    System.MarshalByRefObject
    SMT.MastaAPIUtility.MarshalByRefObjectPermanent
    APIBase
    GearSetDesignGroup
    Implements
    System.IEquatable<APIBase>
    Inherited Members
    APIBase.DisconnectFromMASTA()
    APIBase.GetProperty<T>(String)
    APIBase.SetProperty(String, Object)
    APIBase.cacheRpds
    APIBase.clearCachedRpds()
    APIBase.getNamedObjectList<TElementType>(String)
    APIBase.getExpandableProperty<TReturnType>(String)
    APIBase.callPartialMethod(String, (T1, T2)<Type, Object>[])
    APIBase.callPartialMethod<T>(String, T)
    APIBase.callPartialMethod<T>(String, (T1, T2)<Type, Object>, T)
    APIBase.callPartialMethod<T>(String, (T1, T2)<Type, Object>, (T1, T2)<Type, Object>, T)
    APIBase.callPartialMethod<T>(String, (T1, T2)<Type, Object>, (T1, T2)<Type, Object>, (T1, T2)<Type, Object>, T)
    APIBase.callPartialMethod<T1, T2>(String, (T1, T2)<Type, Object>, T1, T2)
    APIBase.getPartialProperty(String)
    APIBase.setPartialProperty(String, Object)
    APIBase.IsValid(String)
    APIBase.IsReadOnly(String)
    APIBase.isInvalid
    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.CreateObjRef(Type)
    APIBase.RunPython(String, String, Object)
    APIBase.createWrappedRange(Double, Double)
    APIBase.createWrappedVector2D(Double, Double)
    APIBase.createWrappedPosition3D(Double, Double, Double)
    APIBase.Equals(APIBase)
    APIBase.GetHashCode()
    APIBase.Equals(Object)
    SMT.MastaAPIUtility.MarshalByRefObjectPermanent.InitializeLifetimeService()
    Namespace: SMT.MastaAPI.Gears
    Assembly: SMT.MastaAPI.13.0.dll
    Syntax
    public class GearSetDesignGroup : APIBase, IEquatable<APIBase>

    Fields

    _parent

    Declaration
    protected readonly APIBase _parent
    Field Value
    Type Description
    APIBase

    Properties

    CylindricalGearDesignConstraintSettings

    Declaration
    public CylindricalGearDesignConstraints CylindricalGearDesignConstraintSettings { get; }
    Property Value
    Type Description
    CylindricalGearDesignConstraints

    DefaultCylindricalGearMaterialAGMA

    Declaration
    public DatabaseWithSelectedItem DefaultCylindricalGearMaterialAGMA { get; set; }
    Property Value
    Type Description
    DatabaseWithSelectedItem

    DefaultCylindricalGearMaterialISO

    Declaration
    public DatabaseWithSelectedItem DefaultCylindricalGearMaterialISO { get; set; }
    Property Value
    Type Description
    DatabaseWithSelectedItem

    DefaultRoughTolerancedMetalMeasurement

    This setting controls the rough thickness selection used for analyses for gears defined by manufacturing configurations. The behaviour can be overridden on individual gears.

    Declaration
    public TolerancedMetalMeasurements DefaultRoughTolerancedMetalMeasurement { get; set; }
    Property Value
    Type Description
    TolerancedMetalMeasurements

    ExtraBacklashForAllGears

    Adds extra backlash to all gear meshes on top of that specified in design

    Measurement: VeryShortLength

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

    GeneralTransmissionProperties

    Declaration
    public GeneralTransmissionProperties GeneralTransmissionProperties { get; }
    Property Value
    Type Description
    GeneralTransmissionProperties

    HuntingRatioRequired

    When selected, cylindrical gear meshes will give a warning if the number of teeth have a greatest common denominator greater than 1

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

    LimitDynamicFactorIfNotInMainResonanceRange

    If the ISO 6336 Dynamic Factor would give a value greater than 2, and the mesh is not operating in its main resonance range, then this option will clip the dynamic factor to 2.

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

    LimitMicroGeometryFactorForTheDynamicLoad

    If ISO 6336 Dynamic factor is calculated using Method B for gears ISO tolerance class in the range 1 to 5 as specified in ISO 1328-1:2013(E), then this option will clip the calculated BK to 1.

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

    MaximumNumberOfPlanets

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

    MicroGeometryModelInSystemDeflection

    Defines how micro geometry is considered in System Deflection.

    Declaration
    public EnumWithSelectedValue<MicroGeometryModel> MicroGeometryModelInSystemDeflection { get; set; }
    Property Value
    Type Description
    EnumWithSelectedValue<MicroGeometryModel>

    MinimumFactorOfSafetyForToothFatigueFracture

    Measurement: SafetyFactor

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

    MinimumPowerForGearMeshToBeLoaded

    The maximum of the base radii of the gears in the mesh, and the maximum speed is used to convert this into a minimum force. If the mesh force is below this and the equivalent force from the minimum torque, then the mesh is deemed to be not transmitting torque, and is not checked for convergence.

    Measurement: Power

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

    MinimumTorqueForGearMeshToBeLoaded

    The maximum of the base radii of the gears in the mesh is used to convert this into a minimum force. If the mesh force is below this and the equivalent force from the minimum power, then the mesh is deemed to be not transmitting torque, and is not checked for convergence.

    Measurement: Torque

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

    MisalignmentContactPatternEnhancement

    Declaration
    public MisalignmentContactPatternEnhancements MisalignmentContactPatternEnhancement { get; set; }
    Property Value
    Type Description
    MisalignmentContactPatternEnhancements

    PlanetCarrierSpaceRequired

    When System Optimiser selects the number of planets it will leave at least this amount of space at the pitch circle diameter for the planet carrier

    Measurement: Percentage

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

    RelativeToleranceForConvergence

    Used when running analyses to determine if components have converged

    Measurement: Percentage

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

    ReportNames

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

    RequiredSafetyFactorForBending

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

    RequiredSafetyFactorForContact

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

    RequiredSafetyFactorForCrackInitiation

    Measurement: SafetyFactor

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

    RequiredSafetyFactorForMicropitting

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

    RequiredSafetyFactorForScuffing

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

    RequiredSafetyFactorForStaticBending

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

    RequiredSafetyFactorForStaticContact

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

    Settings

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

    Methods

    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

    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