Version: 15.0

    Show / Hide Table of Contents

    Class CylindricalGear

    Inheritance
    System.Object
    APIBase
    DesignEntity
    Part
    Component
    MountableComponent
    Gear
    CylindricalGear
    CylindricalPlanetGear
    Implements
    System.IEquatable<APIBase>
    Inherited Members
    Gear.ConnectTo(Gear)
    Gear.ClonedFrom
    Gear.EvenNumberOfTeethRequired
    Gear.IsCloneGear
    Gear.Length
    Gear.MaximumNumberOfTeeth
    Gear.MaximumAndMinimumNumberOfTeethDeviation
    Gear.MinimumNumberOfTeeth
    Gear.FaceWidth
    Gear.GearSet
    Gear.NumberOfTeeth
    Gear.Shaft
    MountableComponent.MountOn(AbstractShaft, Double)
    MountableComponent.TryMountOn(AbstractShaft, Double)
    MountableComponent.RotationAboutAxis
    MountableComponent.InnerComponent
    MountableComponent.InnerConnection
    MountableComponent.InnerSocket
    MountableComponent.IsMounted
    Component.CanConnectTo(Component)
    Component.CanDeleteConnection(Connection)
    Component.ConnectTo(Component)
    Component.ConnectTo(Socket)
    Component.CreateCoordinateSystemEditor()
    Component.DiameterAtMiddleOfConnection(Connection)
    Component.DiameterOfSocketFor(Connection)
    Component.IsCoaxiallyConnectedTo(Component)
    Component.IsDirectlyConnectedTo(Component)
    Component.IsDirectlyOrIndirectlyConnectedTo(Component)
    Component.MoveAllConcentricPartsRadially(Double, Double)
    Component.MoveAlongAxis(Double)
    Component.MoveWithConcentricPartsToNewOrigin(Vector3D)
    Component.PossibleSocketsToConnectWith(Component)
    Component.PossibleSocketsToConnectWith(Socket)
    Component.SetPositionAndAxisOfComponentAndConnectedComponents(Vector3D, Vector3D)
    Component.SetPositionAndRotationOfComponentAndConnectedComponents(CoordinateSystem3D)
    Component.SetPositionOfComponentAndConnectedComponents(Vector3D)
    Component.SocketNamed(String)
    Component.TryConnectTo(Component, Double)
    Component.AdditionalModalDampingRatio
    Component.Draw3DTransparent
    Component.PolarInertia
    Component.PolarInertiaForSynchroniserSizingOnly
    Component.ReasonMassPropertiesAreUnknown
    Component.ReasonMassPropertiesAreZero
    Component.Translation
    Component.TransverseInertia
    Component.XAxis
    Component.YAxis
    Component.ZAxis
    Component.CoordinateSystemEulerAngles
    Component.LocalCoordinateSystem
    Component.Position
    Component.ComponentConnections
    Component.AvailableSocketOffsets
    Component.CentreOffset
    Component.TranslationVector
    Component.XAxisVector
    Component.YAxisVector
    Component.ZAxisVector
    Part.ConnectionsTo(Part)
    Part.CopyTo(Assembly)
    Part.CreateGeometryExportOptions()
    Part.DeleteConnections()
    Part.TwoDDrawing
    Part.TwoDDrawingFullModel
    Part.ThreeDIsometricView
    Part.ThreeDView
    Part.ThreeDViewOrientatedInXyPlaneWithZAxisPointingIntoTheScreen
    Part.ThreeDViewOrientatedInXyPlaneWithZAxisPointingOutOfTheScreen
    Part.ThreeDViewOrientatedInXzPlaneWithYAxisPointingIntoTheScreen
    Part.ThreeDViewOrientatedInXzPlaneWithYAxisPointingOutOfTheScreen
    Part.ThreeDViewOrientatedInYzPlaneWithXAxisPointingIntoTheScreen
    Part.ThreeDViewOrientatedInYzPlaneWithXAxisPointingOutOfTheScreen
    Part.DrawingNumber
    Part.EditableName
    Part.FullNameWithoutRootName
    Part.Mass
    Part.UniqueName
    Part.UseScriptToProvideResistiveTorque
    Part.MassPropertiesFromDesign
    Part.MassPropertiesFromDesignIncludingPlanetaryDuplicates
    Part.Connections
    Part.LocalConnections
    DesignEntity.Delete()
    DesignEntity.OutputDefaultReportTo(String)
    DesignEntity.GetDefaultReportWithEncodedImages()
    DesignEntity.OutputActiveReportTo(String)
    DesignEntity.OutputActiveReportAsTextTo(String)
    DesignEntity.GetActiveReportWithEncodedImages()
    DesignEntity.OutputNamedReportTo(String, String)
    DesignEntity.OutputNamedReportAsMastaReport(String, String)
    DesignEntity.OutputNamedReportAsTextTo(String, String)
    DesignEntity.GetNamedReportWithEncodedImages(String)
    DesignEntity.Comment
    DesignEntity.ID
    DesignEntity.Icon
    DesignEntity.SmallIcon
    DesignEntity.DesignProperties
    DesignEntity.AllDesignEntities
    DesignEntity.AllStatusErrors
    DesignEntity.Status
    DesignEntity.UserSpecifiedData
    DesignEntity.ReportNames
    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.PartModel.Gears
    Assembly: SMT.MastaAPI.15.0.dll
    Syntax
    public class CylindricalGear : Gear, IEquatable<APIBase>

    Properties

    ActiveGearDesign

    Declaration
    [Obsolete("Use CylindricalGearDesign")]
    public CylindricalGearDesign ActiveGearDesign { get; }
    Property Value
    Type Description
    CylindricalGearDesign

    CentreOfEstimatedMicroGeometryRange

    The middle of the extents of all meshes on this gear, and hence the middle of the evaluation limits of the estimated micro geometry. Only used if the 'Micro Geometry Model for Simple Mesh Stiffness' property is set to 'Estimated From Macro Geometry' in the Design or overridden in the load case.

    Measurement: ShortLength

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

    ClearanceToTipDiameterLimit

    Measurement: ShortLength

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

    ClockingAngleError

    Measurement: Angle

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

    CylindricalGearDesign

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

    CylindricalMeshes

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

    EstimatedCrowning

    Calculated based on having no edge load with force equal to one third of the static capacity, and is evaluated over the mesh extents range. Only used if the 'Micro Geometry Model for Simple Mesh Stiffness' property is set to 'Estimated From Macro Geometry' in the Design or overridden in the load case.

    Measurement: VeryShortLength

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

    ExtraBacklash

    Adds extra backlash to any of this gear's meshes on top of that specified in design

    Measurement: VeryShortLength

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

    HasConceptSynchroniser

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

    IsPositionFixedForCentreDistanceModification

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

    LeftLimitOfEstimatedMicroGeometryRange

    The left limit of the extents of all meshes on this gear, and hence the left evaluation limit of the estimated micro geometry. Only used if the 'Micro Geometry Model for Simple Mesh Stiffness' property is set to 'Estimated From Macro Geometry' in the Design or overridden in the load case.

    Measurement: ShortLength

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

    LinearRelief

    Only used if the 'Micro Geometry Model for Simple Mesh Stiffness' property is set to 'Estimated From Macro Geometry' in the Design or overridden in the load case.

    Measurement: VeryShortLength

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

    MinimumRimThicknessNormalModule

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

    ReferenceAxisAngleAboutLocalZAxisFromYAxis

    The reference axis may be displayed in the 3D view via Edit > Settings > Graphics > Show Reference Axis for Cylindrical Gears in 3D View? The reference axis defines an axis where at the less positive local z coordinate end of the face width the middle of the tip of a tooth lies on the reference axis.

    Measurement: Angle

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

    RightLimitOfEstimatedMicroGeometryRange

    The right limit of the extents of all meshes on this gear, and hence the right evaluation limit of the estimated micro geometry. Only used if the 'Micro Geometry Model for Simple Mesh Stiffness' property is set to 'Estimated From Macro Geometry' in the Design or overridden in the load case.

    Measurement: ShortLength

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

    RootDiameterLimit

    This is the minimum root diameter for external gears and the maximum root diameter for internal gears. The calculated value is based on the shaft diameter and the 'Minimum Rim Thickness / Normal Module'.

    Measurement: ShortLength

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

    TipDiameterLimit

    This is the maximum tip diameter for external gears and the minimum tip diameter for internal gears

    Measurement: ShortLength

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

    Methods

    MakeCarrierAssembly(Int32, Boolean, Boolean, Double, Double, Double, Double, Double, Double, Double, Boolean, Nullable<Double>, Nullable<Double>)

    Declaration
    public void MakeCarrierAssembly(int numberOfRadialBearings, bool addLeftThrustBearing, bool addRightThrustBearing, double gearBore, double carrierBore, double carrierWidth, double gearOffset = 0, double leftBearingIndent = 0, double rightBearingIndent = 0, double thrustPadClearance = 0, bool addingBearing = true, double? leftThurstPadContactDiameter = default(double? ), double? rightThurstPadContactDiameter = default(double? ))
    Parameters
    Type Name Description
    System.Int32 numberOfRadialBearings
    System.Boolean addLeftThrustBearing
    System.Boolean addRightThrustBearing
    System.Double gearBore
    System.Double carrierBore
    System.Double carrierWidth
    System.Double gearOffset
    System.Double leftBearingIndent
    System.Double rightBearingIndent
    System.Double thrustPadClearance
    System.Boolean addingBearing
    System.Nullable<System.Double> leftThurstPadContactDiameter
    System.Nullable<System.Double> rightThurstPadContactDiameter

    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