Class Component

Inheritance
System.Object
System.MarshalByRefObject
SMT.MastaAPIUtility.MarshalByRefObjectPermanent
APIBase
DesignEntity
Part
Component
AbstractShaftOrHousing
Bolt
Datum
ExternalCADModel
GuideDxfModel
MountableComponent
Implements
System.IEquatable<APIBase>
Inherited Members
SMT.MastaAPIUtility.MarshalByRefObjectPermanent.InitializeLifetimeService()
Namespace: SMT.MastaAPI.SystemModel.PartModel
Assembly: SMT.MastaAPI.13.0.dll
Syntax
public abstract class Component : Part, IEquatable<APIBase>

Properties

AdditionalModalDampingRatio

Specifies an additional damping for the component in NVH analysis compared to the rest of the system. A value larger than 0 will give additional damping for this component. Values less than 0 will result in less damping for this component.

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

AvailableSocketOffsets

Declaration
public virtual ReadOnlyCollection<string> AvailableSocketOffsets { get; }
Property Value
Type Description
System.Collections.ObjectModel.ReadOnlyCollection<System.String>

CentreOffset

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

ComponentConnections

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

CoordinateSystemEulerAngles

This is the Tait-Bryan XYZ Extrinsic definition of Euler Angles. Read-only if the component has any connections

Declaration
public Vector3D CoordinateSystemEulerAngles { get; set; }
Property Value
Type Description
Vector3D

Length

Measurement: ShortLength

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

LocalCoordinateSystem

Declaration
public virtual CoordinateSystem3D LocalCoordinateSystem { get; }
Property Value
Type Description
CoordinateSystem3D

PolarInertia

Mass moment of inertia about the rotation axis of the component. For Power Loads, this is the inertia of the system the Power Load represents.

Measurement: Inertia

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

PolarInertiaForSynchroniserSizingOnly

Polar Inertia used in Synchroniser Sizing calculation only. Usually used to represent the inertia of a disengaged clutch half. For shafts this includes the shaft profile and bearing races mounted on the shaft but not gears.

Measurement: Inertia

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

Position

Read-only if the component has any connections

Declaration
public Vector3D Position { get; set; }
Property Value
Type Description
Vector3D

ReasonMassPropertiesAreUnknown

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

ReasonMassPropertiesAreZero

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

Translation

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

TranslationVector

Declaration
public Vector3D TranslationVector { get; }
Property Value
Type Description
Vector3D

TransverseInertia

Rotational inertia about the component local X axis.

Measurement: Inertia

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

XAxis

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

XAxisVector

Declaration
public Vector3D XAxisVector { get; }
Property Value
Type Description
Vector3D

YAxis

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

YAxisVector

Declaration
public Vector3D YAxisVector { get; }
Property Value
Type Description
Vector3D

ZAxis

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

ZAxisVector

Declaration
public Vector3D ZAxisVector { get; }
Property Value
Type Description
Vector3D

Methods

CanConnectTo(Component)

Declaration
public bool CanConnectTo(Component component)
Parameters
Type Name Description
Component component
Returns
Type Description
System.Boolean

CanDeleteConnection(Connection)

Declaration
public bool CanDeleteConnection(Connection connection)
Parameters
Type Name Description
Connection connection
Returns
Type Description
System.Boolean

ConnectTo(Socket)

Declaration
public ComponentsConnectedResult ConnectTo(Socket socket)
Parameters
Type Name Description
Socket socket
Returns
Type Description
ComponentsConnectedResult

ConnectTo(Component)

Declaration
public ComponentsConnectedResult ConnectTo(Component component)
Parameters
Type Name Description
Component component
Returns
Type Description
ComponentsConnectedResult

CreateCoordinateSystemEditor()

Declaration
public CoordinateSystemEditor CreateCoordinateSystemEditor()
Returns
Type Description
CoordinateSystemEditor

DiameterAtMiddleOfConnection(Connection)

Declaration
public double DiameterAtMiddleOfConnection(Connection connection)
Parameters
Type Name Description
Connection connection
Returns
Type Description
System.Double

DiameterOfSocketFor(Connection)

Declaration
public double DiameterOfSocketFor(Connection connection)
Parameters
Type Name Description
Connection connection
Returns
Type Description
System.Double

IsCoaxiallyConnectedTo(Component)

Declaration
public bool IsCoaxiallyConnectedTo(Component component)
Parameters
Type Name Description
Component component
Returns
Type Description
System.Boolean

IsDirectlyConnectedTo(Component)

Declaration
public bool IsDirectlyConnectedTo(Component component)
Parameters
Type Name Description
Component component
Returns
Type Description
System.Boolean

IsDirectlyOrIndirectlyConnectedTo(Component)

Declaration
public bool IsDirectlyOrIndirectlyConnectedTo(Component component)
Parameters
Type Name Description
Component component
Returns
Type Description
System.Boolean

MoveAllConcentricPartsRadially(Double, Double)

Declaration
public bool MoveAllConcentricPartsRadially(double deltaX, double deltaY)
Parameters
Type Name Description
System.Double deltaX
System.Double deltaY
Returns
Type Description
System.Boolean

MoveAlongAxis(Double)

Declaration
public void MoveAlongAxis(double delta)
Parameters
Type Name Description
System.Double delta

MoveWithConcentricPartsToNewOrigin(Vector3D)

Declaration
public bool MoveWithConcentricPartsToNewOrigin(Vector3D targetOrigin)
Parameters
Type Name Description
Vector3D targetOrigin
Returns
Type Description
System.Boolean

PossibleSocketsToConnectWith(Socket)

Declaration
public ReadOnlyCollection<Socket> PossibleSocketsToConnectWith(Socket socket)
Parameters
Type Name Description
Socket socket
Returns
Type Description
System.Collections.ObjectModel.ReadOnlyCollection<Socket>

PossibleSocketsToConnectWith(Component)

Declaration
public ReadOnlyCollection<Socket> PossibleSocketsToConnectWith(Component component)
Parameters
Type Name Description
Component component
Returns
Type Description
System.Collections.ObjectModel.ReadOnlyCollection<Socket>

SetPositionAndAxisOfComponentAndConnectedComponents(Vector3D, Vector3D)

Declaration
public RealignmentResult SetPositionAndAxisOfComponentAndConnectedComponents(Vector3D origin, Vector3D zAxis)
Parameters
Type Name Description
Vector3D origin
Vector3D zAxis
Returns
Type Description
RealignmentResult

SetPositionAndRotationOfComponentAndConnectedComponents(CoordinateSystem3D)

Declaration
public RealignmentResult SetPositionAndRotationOfComponentAndConnectedComponents(CoordinateSystem3D newCoordinateSystem)
Parameters
Type Name Description
CoordinateSystem3D newCoordinateSystem
Returns
Type Description
RealignmentResult

SetPositionOfComponentAndConnectedComponents(Vector3D)

Declaration
public RealignmentResult SetPositionOfComponentAndConnectedComponents(Vector3D position)
Parameters
Type Name Description
Vector3D position
Returns
Type Description
RealignmentResult

SocketNamed(String)

Declaration
public Socket SocketNamed(string socketName)
Parameters
Type Name Description
System.String socketName
Returns
Type Description
Socket

TryConnectTo(Component, Double)

Declaration
public ComponentsConnectedResult TryConnectTo(Component component, double hintOffset = NaN)
Parameters
Type Name Description
Component component
System.Double hintOffset
Returns
Type Description
ComponentsConnectedResult

Implements

System.IEquatable<T>

Extension Methods