Version: 13.0

    Show / Hide Table of Contents

    Class Shaft

    Inheritance
    System.Object
    System.MarshalByRefObject
    SMT.MastaAPIUtility.MarshalByRefObjectPermanent
    APIBase
    DesignEntity
    Part
    Component
    AbstractShaftOrHousing
    AbstractShaft
    Shaft
    Implements
    System.IEquatable<APIBase>
    Inherited Members
    Component.AdditionalModalDampingRatio
    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
    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)
    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.Mass
    Part.UniqueName
    Part.MassPropertiesFromDesign
    Part.MassPropertiesFromDesignIncludingPlanetaryDuplicates
    Part.Connections
    Part.LocalConnections
    Part.ConnectionsTo(Part)
    Part.CopyTo(Assembly)
    Part.CreateGeometryExportOptions()
    Part.DeleteConnections()
    DesignEntity._parent
    DesignEntity.Comment
    DesignEntity.Delete()
    DesignEntity.ID
    DesignEntity.Icon
    DesignEntity.SmallIcon
    DesignEntity.DesignProperties
    DesignEntity.AllDesignEntities
    DesignEntity.AllStatusErrors
    DesignEntity.Status
    DesignEntity.UserSpecifiedData
    DesignEntity.ReportNames
    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)
    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.SystemModel.PartModel.ShaftModel
    Assembly: SMT.MastaAPI.13.0.dll
    Syntax
    public class Shaft : AbstractShaft, IEquatable<APIBase>

    Properties

    ActiveDefinition

    Declaration
    public SimpleShaftDefinition ActiveDefinition { get; }
    Property Value
    Type Description
    SimpleShaftDefinition

    ActiveDesign

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

    CADModel

    To use this feature you must add an 'External 2D CAD Model' to the design

    Declaration
    public ListWithSelectedItem<GuideDxfModel> CADModel { get; set; }
    Property Value
    Type Description
    ListWithSelectedItem<GuideDxfModel>

    FESubstructureReplacingThis

    Declaration
    public virtual FESubstructure FESubstructureReplacingThis { get; }
    Property Value
    Type Description
    FESubstructure

    GuideImage

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

    HasGuideImage

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

    IsReplacedByFE

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

    LeftSideOffset

    The offset of the first point in the profile. Entering a value will leave the shaft in the same position, but with the profile points shifted.

    Measurement: ShortLength

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

    Length

    Measurement: ShortLength

    Declaration
    public override double Length { get; set; }
    Property Value
    Type Description
    System.Double
    Overrides
    Component.Length

    MassOfShaftBody

    Includes the mass of the specified shaft profile and any gears that are mounted on the shaft.

    Measurement: Mass

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

    PolarInertiaOfShaftBody

    Includes the polar inertia of the specified shaft profile and any gears that are mounted on the shaft. Measured about the axis of rotation.

    Measurement: Inertia

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

    PositionFixed

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

    RotationAboutAxisForAllMountedComponents

    Describes the rotation of the local X and Y axes around the local Z axis. It is 'unknown' if the shaft and the components mounted on the shaft don't all share the same value. Specifying a value will set the value on the shaft as well as all of the mounted components resulting in the shaft and the mounted components all having the same value.

    Measurement: Angle

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

    StressToYieldStrengthFactor

    A factor used in AGMA 6001/6101-E08 shaft fatigue calculations to provide conservatism over the stress resulting from expected peak load conditions and variations in the tensile yield strength. AGMA 6001/6101-E08 suggests using values in the range 0.66 to 0.8 and recommends a value of 0.75.

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

    UsesCADGuide

    Select this to allow this shaft to show a 2D CAD model to aid checking model consistency. To use this feature you must add an 'External 2D CAD Model' to the design.

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

    Methods

    AddSection(Double, Double, Double, Double, Double, Double)

    Declaration
    public void AddSection(double startOffset, double endOffset, double startOuter, double startInner, double endOuter, double endInner)
    Parameters
    Type Name Description
    System.Double startOffset
    System.Double endOffset
    System.Double startOuter
    System.Double startInner
    System.Double endOuter
    System.Double endInner

    ImportShaft()

    Declaration
    public void ImportShaft()

    MountComponent(MountableComponent, Double)

    Declaration
    public void MountComponent(MountableComponent component, double offset)
    Parameters
    Type Name Description
    MountableComponent component
    System.Double offset

    RemoveAllSections()

    Declaration
    public void RemoveAllSections()

    RemoveDuplications()

    Declaration
    public void RemoveDuplications()

    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