Class Component
Inheritance
System.Object
Component
Assembly: SMT.MastaAPI.14.1.1.dll
Syntax
public abstract class Component : Part, IEquatable<APIBase>
Properties
AdditionalModalDampingRatio
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
CoordinateSystemEulerAngles
Declaration
public Vector3D CoordinateSystemEulerAngles { get; set; }
Property Value
Length
Declaration
public virtual double Length { get; set; }
Property Value
| Type |
Description |
| System.Double |
|
LocalCoordinateSystem
Declaration
public virtual CoordinateSystem3D LocalCoordinateSystem { get; }
Property Value
PolarInertia
Declaration
public Overridable<double> PolarInertia { get; set; }
Property Value
PolarInertiaForSynchroniserSizingOnly
Declaration
public Overridable<double> PolarInertiaForSynchroniserSizingOnly { get; set; }
Property Value
Position
Declaration
public Vector3D Position { get; set; }
Property Value
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
TransverseInertia
Declaration
public Overridable<double> TransverseInertia { get; set; }
Property Value
XAxis
Declaration
public string XAxis { get; }
Property Value
| Type |
Description |
| System.String |
|
XAxisVector
Declaration
public Vector3D XAxisVector { get; }
Property Value
YAxis
Declaration
public string YAxis { get; }
Property Value
| Type |
Description |
| System.String |
|
YAxisVector
Declaration
public Vector3D YAxisVector { get; }
Property Value
ZAxis
Declaration
public string ZAxis { get; }
Property Value
| Type |
Description |
| System.String |
|
ZAxisVector
Declaration
public Vector3D ZAxisVector { get; }
Property Value
Methods
CanConnectTo(Component)
Declaration
public bool CanConnectTo(Component component)
Parameters
Returns
| Type |
Description |
| System.Boolean |
|
CanDeleteConnection(Connection)
Declaration
public bool CanDeleteConnection(Connection connection)
Parameters
Returns
| Type |
Description |
| System.Boolean |
|
ConnectTo(Socket)
Declaration
public ComponentsConnectedResult ConnectTo(Socket socket)
Parameters
| Type |
Name |
Description |
| Socket |
socket |
|
Returns
ConnectTo(Component)
Declaration
public ComponentsConnectedResult ConnectTo(Component component)
Parameters
Returns
CreateCoordinateSystemEditor()
Declaration
public CoordinateSystemEditor CreateCoordinateSystemEditor()
Returns
DiameterAtMiddleOfConnection(Connection)
Declaration
public double DiameterAtMiddleOfConnection(Connection connection)
Parameters
Returns
| Type |
Description |
| System.Double |
|
DiameterOfSocketFor(Connection)
Declaration
public double DiameterOfSocketFor(Connection connection)
Parameters
Returns
| Type |
Description |
| System.Double |
|
IsCoaxiallyConnectedTo(Component)
Declaration
public bool IsCoaxiallyConnectedTo(Component component)
Parameters
Returns
| Type |
Description |
| System.Boolean |
|
IsDirectlyConnectedTo(Component)
Declaration
public bool IsDirectlyConnectedTo(Component component)
Parameters
Returns
| Type |
Description |
| System.Boolean |
|
IsDirectlyOrIndirectlyConnectedTo(Component)
Declaration
public bool IsDirectlyOrIndirectlyConnectedTo(Component component)
Parameters
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
Returns
| Type |
Description |
| System.Collections.ObjectModel.ReadOnlyCollection<Socket> |
|
SetPositionAndAxisOfComponentAndConnectedComponents(Vector3D, Vector3D)
Declaration
public RealignmentResult SetPositionAndAxisOfComponentAndConnectedComponents(Vector3D origin, Vector3D zAxis)
Parameters
Returns
SetPositionAndRotationOfComponentAndConnectedComponents(CoordinateSystem3D)
Declaration
public RealignmentResult SetPositionAndRotationOfComponentAndConnectedComponents(CoordinateSystem3D newCoordinateSystem)
Parameters
Returns
SetPositionOfComponentAndConnectedComponents(Vector3D)
Declaration
public RealignmentResult SetPositionOfComponentAndConnectedComponents(Vector3D position)
Parameters
Returns
SocketNamed(String)
Declaration
public Socket SocketNamed(string socketName)
Parameters
| Type |
Name |
Description |
| System.String |
socketName |
|
Returns
TryConnectTo(Component, Double)
Declaration
public ComponentsConnectedResult TryConnectTo(Component component, double hintOffset = NaN)
Parameters
| Type |
Name |
Description |
| Component |
component |
|
| System.Double |
hintOffset |
|
Returns
Implements
System.IEquatable<T>
Extension Methods