Class Design
Inheritance
System.Object
System.MarshalByRefObject
SMT.MastaAPIUtility.MarshalByRefObjectPermanent
Design
Implements
System.IDisposable
Inherited Members
APIBase.callPartialMethod<T>(String, (T1, T2)<Type, Object>, (T1, T2)<Type, Object>, (T1, T2)<Type, Object>, T)
SMT.MastaAPIUtility.MarshalByRefObjectPermanent.InitializeLifetimeService()
Assembly: SMT.MastaAPI.13.0.dll
Syntax
public class Design : APIBase, IEquatable<APIBase>, IDisposable
Constructors
Design()
Declaration
Design(Object)
Declaration
public Design(object wrappedDesign)
Parameters
Type |
Name |
Description |
System.Object |
wrappedDesign |
|
Design(String)
Declaration
public Design(string fileName)
Parameters
Type |
Name |
Description |
System.String |
fileName |
|
Design(String, ExternalFullFEFileOption)
Declaration
public Design(string fileName, ExternalFullFEFileOption externalFullFEFileOption)
Parameters
Fields
_parent
Declaration
protected readonly APIBase _parent
Field Value
Properties
AvailableExamples
Declaration
public static IReadOnlyList<string> AvailableExamples { get; }
Property Value
Type |
Description |
System.Collections.Generic.IReadOnlyList<System.String> |
|
Declaration
public ContactRatioRequirements AxialContactRatioRequirement { get; set; }
Property Value
BearingConfiguration
Declaration
public ListWithSelectedItem<string> BearingConfiguration { get; set; }
Property Value
BearingDetailConfigurations
Declaration
public ReadOnlyCollection<BearingDetailConfiguration> BearingDetailConfigurations { get; }
Property Value
cacheRpds
Declaration
protected override bool cacheRpds { get; }
Property Value
Type |
Description |
System.Boolean |
|
Overrides
CoefficientOfFriction
This is used when calculating frictional losses between components connected to the two sides of axial and radial clearance bearings.
Declaration
public double CoefficientOfFriction { get; set; }
Property Value
Type |
Description |
System.Double |
|
Declaration
public string Comment { get; set; }
Property Value
Type |
Description |
System.String |
|
Databases
Declaration
public Databases Databases { get; }
Property Value
DefaultSaveLocationPath
The location folder for the mesh and vector external FE files to be saved into.
Declaration
public string DefaultSaveLocationPath { get; }
Property Value
Type |
Description |
System.String |
|
DefaultSystemTemperatures
Declaration
public TransmissionTemperatureSet DefaultSystemTemperatures { get; }
Property Value
DesignName
Declaration
public string DesignName { get; set; }
Property Value
Type |
Description |
System.String |
|
DesignStates
Declaration
public ReadOnlyCollection<DesignState> DesignStates { get; }
Property Value
Type |
Description |
System.Collections.ObjectModel.ReadOnlyCollection<DesignState> |
|
DetailedSplineSettings
Declaration
public DetailedSplineJointSettings DetailedSplineSettings { get; }
Property Value
DutyCycles
Declaration
public ReadOnlyCollection<DutyCycle> DutyCycles { get; }
Property Value
Type |
Description |
System.Collections.ObjectModel.ReadOnlyCollection<DutyCycle> |
|
EfficiencyRatingMethodForBearings
Declaration
public BearingEfficiencyRatingMethod EfficiencyRatingMethodForBearings { get; set; }
Property Value
EfficiencyRatingMethodIfSKFLossModelDoesNotProvideLosses
If the geometric constants are unknown then the SKF loss model will not provide any losses. For such bearings the method defined here will be used to obtain losses.
Declaration
public EnumWithSelectedValue<BearingEfficiencyRatingMethod> EfficiencyRatingMethodIfSKFLossModelDoesNotProvideLosses { get; set; }
Property Value
ElectricMachineGroup
Declaration
public ElectricMachineGroup ElectricMachineGroup { get; }
Property Value
FEBatchOperations
Declaration
public BatchOperations FEBatchOperations { get; }
Property Value
FESubstructureConfiguration
Declaration
public ListWithSelectedItem<string> FESubstructureConfiguration { get; set; }
Property Value
FESubstructureConfigurations
Declaration
public ReadOnlyCollection<ActiveFESubstructureSelectionGroup> FESubstructureConfigurations { get; }
Property Value
FileName
Declaration
public string FileName { get; }
Property Value
Type |
Description |
System.String |
|
FileSaveDetailsAll
Declaration
public FileHistory FileSaveDetailsAll { get; }
Property Value
FileSaveDetailsMostRecent
Declaration
public FileHistoryItem FileSaveDetailsMostRecent { get; }
Property Value
GearSetConfig
Declaration
public GearSetConfiguration GearSetConfig { get; set; }
Property Value
GearSetConfiguration
Declaration
public ListWithSelectedItem<ActiveGearSetDesignSelectionGroup> GearSetConfiguration { get; set; }
Property Value
GearSetConfigurations
Declaration
public ReadOnlyCollection<ActiveGearSetDesignSelectionGroup> GearSetConfigurations { get; }
Property Value
GearSetDesignGroup
Declaration
public GearSetDesignGroup GearSetDesignGroup { get; }
Property Value
GravityMagnitude
The magnitude of the gravity field
Measurement: Acceleration
Declaration
public double GravityMagnitude { get; set; }
Property Value
Type |
Description |
System.Double |
|
GravityOrientation
Specifies the unit vector pointing in the direction of the acceleration field. Arrow in 3D view shows direction things fall.
Declaration
public Vector3D GravityOrientation { get; set; }
Property Value
GravityVectorComponents
Specifies the gravity vector pointing in the direction of the acceleration field. Arrow in 3D view shows direction things fall.
Declaration
public Vector3D GravityVectorComponents { get; set; }
Property Value
HousingMaterialForGroundedConnections
Used for default materials of grounded components (e.g. Detailed Splines, Bearing Supports) as well as the displacement of grounded components caused by thermal expansion. Note for components connected to an FE Substructure the thermal expansion will be determined by the FE material or specified expansion vector.
Declaration
public DatabaseWithSelectedItem HousingMaterialForGroundedConnections { get; set; }
Property Value
Declaration
public ListWithSelectedItem<PowerLoad> InputPowerLoad { get; set; }
Property Value
ISO14179CoefficientOfFrictionConstantsAndExponentsForExternalExternalMeshes
Declaration
public ISOTR1417912001CoefficientOfFrictionConstants ISO14179CoefficientOfFrictionConstantsAndExponentsForExternalExternalMeshes { get; }
Property Value
ISO14179CoefficientOfFrictionConstantsAndExponentsForInternalExternalMeshes
Declaration
public ISOTR1417912001CoefficientOfFrictionConstants ISO14179CoefficientOfFrictionConstantsAndExponentsForInternalExternalMeshes { get; }
Property Value
ISO14179Part1CoefficientOfFrictionConstantsAndExponentsForExternalExternalMeshesDatabase
Declaration
public DatabaseWithSelectedItem ISO14179Part1CoefficientOfFrictionConstantsAndExponentsForExternalExternalMeshesDatabase { get; set; }
Property Value
ISO14179Part1CoefficientOfFrictionConstantsAndExponentsForInternalExternalMeshesDatabase
Declaration
public DatabaseWithSelectedItem ISO14179Part1CoefficientOfFrictionConstantsAndExponentsForInternalExternalMeshesDatabase { get; set; }
Property Value
ISO14179SettingsPerBearingType
Declaration
public ReadOnlyCollection<ISO14179SettingsPerBearingType> ISO14179SettingsPerBearingType { get; }
Property Value
Manufacturer
Declaration
public string Manufacturer { get; set; }
Property Value
Type |
Description |
System.String |
|
MastaGUI
Declaration
public MASTAGUI MastaGUI { get; }
Property Value
MastaSettings
Declaration
public MASTASettings MastaSettings { get; }
Property Value
Declaration
public double MaximumAcceptableAxialContactRatio { get; set; }
Property Value
Type |
Description |
System.Double |
|
Declaration
public double MaximumAcceptableTransverseContactRatio { get; set; }
Property Value
Type |
Description |
System.Double |
|
MaximumNumberOfTeeth
Declaration
public int? MaximumNumberOfTeeth { get; set; }
Property Value
Type |
Description |
System.Nullable<System.Int32> |
|
MaximumNumberOfTeethExternalGears
Declaration
public int? MaximumNumberOfTeethExternalGears { get; set; }
Property Value
Type |
Description |
System.Nullable<System.Int32> |
|
MaximumNumberOfTeethInternalGears
Declaration
public int? MaximumNumberOfTeethInternalGears { get; set; }
Property Value
Type |
Description |
System.Nullable<System.Int32> |
|
Declaration
public double MinimumAcceptableAxialContactRatio { get; set; }
Property Value
Type |
Description |
System.Double |
|
Declaration
public double MinimumAcceptableTransverseContactRatio { get; set; }
Property Value
Type |
Description |
System.Double |
|
MinimumNumberOfTeeth
Declaration
public int? MinimumNumberOfTeeth { get; set; }
Property Value
Type |
Description |
System.Nullable<System.Int32> |
|
MinimumNumberOfTeethExternalGears
Declaration
public int? MinimumNumberOfTeethExternalGears { get; set; }
Property Value
Type |
Description |
System.Nullable<System.Int32> |
|
MinimumNumberOfTeethInternalGears
Declaration
public int? MinimumNumberOfTeethInternalGears { get; set; }
Property Value
Type |
Description |
System.Nullable<System.Int32> |
|
NodeSize
Nodes are drawn in 3D view with this diameter
Measurement: ShortLength
Declaration
public Overridable<double> NodeSize { get; set; }
Property Value
NumberOfGearSetConfigurations
Declaration
public int NumberOfGearSetConfigurations { get; }
Property Value
Type |
Description |
System.Int32 |
|
OutputPowerLoad
Declaration
public ListWithSelectedItem<PowerLoad> OutputPowerLoad { get; set; }
Property Value
RootAssembly
Declaration
public RootAssembly RootAssembly { get; }
Property Value
SaveExternalFEFilesInTheDefaultSubfolder
Save the external FE files to a subfolder named after the MASTA design file. Only works for new saves of the FE files and will not move FE files that are already saved elsewhere.
Declaration
public bool SaveExternalFEFilesInTheDefaultSubfolder { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
SelectedGearSetSelectionGroup
Use the 'Configurations' Editor to create and select active gear set selection groups
Declaration
public ActiveGearSetDesignSelectionGroup SelectedGearSetSelectionGroup { get; }
Property Value
Settings
Declaration
public DesignSettings Settings { get; }
Property Value
ShaftDetailConfiguration
Declaration
public ListWithSelectedItem<string> ShaftDetailConfiguration { get; set; }
Property Value
ShaftDetailConfigurations
Declaration
public ReadOnlyCollection<ActiveShaftDesignSelectionGroup> ShaftDetailConfigurations { get; }
Property Value
ShaftDiameterModificationDueToRollingBearingRings
Shaft diameter is modified in analyses to account for the mass and stiffness added by mounted rolling bearing rings. This setting controls how to calculate the modified diameter.
Declaration
public EnumWithSelectedValue<ShaftDiameterModificationDueToRollingBearingRing> ShaftDiameterModificationDueToRollingBearingRings { get; set; }
Property Value
Shafts
Declaration
public ShaftSafetyFactorSettings Shafts { get; }
Property Value
StaticLoads
Declaration
public ReadOnlyCollection<StaticLoadCase> StaticLoads { get; }
Property Value
Type |
Description |
System.Collections.ObjectModel.ReadOnlyCollection<StaticLoadCase> |
|
Status
Declaration
public Status Status { get; }
Property Value
System
Declaration
public SystemReporting System { get; }
Property Value
SystemOptimiser
Declaration
public SystemOptimiser SystemOptimiser { get; }
Property Value
SystemOptimiserDetails
Declaration
public SystemOptimiserDetails SystemOptimiserDetails { get; }
Property Value
ThermalExpansionForGroundedNodes
Determines how grounded nodes (such as bearing outers not connected to an FE housing) behave when thermal expansion is included for a load case.
Declaration
public ThermalExpansionOptionForGroundedNodes ThermalExpansionForGroundedNodes { get; set; }
Property Value
TimeSeriesLoadCaseGroups
Declaration
public ReadOnlyCollection<TimeSeriesLoadCaseGroup> TimeSeriesLoadCaseGroups { get; }
Property Value
Declaration
public ContactRatioRequirements TransverseContactRatioRequirement { get; set; }
Property Value
UnbalancedMassInclusion
Controls which analyses unbalanced mass forces are included in.
Declaration
public UnbalancedMassInclusionOption UnbalancedMassInclusion { get; set; }
Property Value
If not checked, calculations for element angular velocity and orbit speed on ball bearings will use the nominal contact angle instead. This will change the centrifugal and gyroscopic forces on the elements. The nominal contact angle is always used for four-point contact bearing elements where both outer races are loaded, and three-point contact bearing elements where the outer contact angle is close to zero.
Declaration
public bool UseElementContactAnglesForAngularVelocitiesInBallBearings { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
UseExpanded2DProjectionMode
If the design is complex and is drawn with overlapping components in the 2D view, selecting this can help
Declaration
public bool UseExpanded2DProjectionMode { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
VolumetricOilAirMixtureRatio
Declaration
public double VolumetricOilAirMixtureRatio { get; set; }
Property Value
Type |
Description |
System.Double |
|
Methods
AddBearingDetailConfigurationAllBearings()
Add a Bearing Detail Configuration for all bearings, allowing easy switching between different combinations of shaft details
Declaration
public void AddBearingDetailConfigurationAllBearings()
AddBearingDetailConfigurationRollingBearings()
Add a Bearing Detail Configuration for rolling bearings, allowing easy switching between different combinations of shaft details
Declaration
public void AddBearingDetailConfigurationRollingBearings()
AddDesignState(String)
Declaration
public DesignState AddDesignState(string name = "New Design State")
Parameters
Type |
Name |
Description |
System.String |
name |
|
Returns
AddDutyCycle(String)
Declaration
public DutyCycle AddDutyCycle(string name = "New Duty Cycle")
Parameters
Type |
Name |
Description |
System.String |
name |
|
Returns
AddFESubstructureConfiguration()
Add an FE Substructure Configuration, allowing easy switching between different combinations of FE Substructures
Declaration
public void AddFESubstructureConfiguration()
AddGearSetConfiguration()
Add a Gear Set Configuration, allowing easy switching between different combinations of gear set designs
Declaration
public void AddGearSetConfiguration()
AddShaftDetailConfiguration()
Add a Shaft Detail Configuration, allowing easy switching between different combinations of shaft details
Declaration
public void AddShaftDetailConfiguration()
AddSynchroniserShift()
Declaration
public SynchroniserShift AddSynchroniserShift()
Returns
AddSynchroniserShift(String)
Declaration
public SynchroniserShift AddSynchroniserShift(string name)
Parameters
Type |
Name |
Description |
System.String |
name |
|
Returns
AllParts<T>()
Declaration
public List<T> AllParts<T>()
where T : Part
Returns
Type |
Description |
System.Collections.Generic.List<T> |
|
Type Parameters
ChangeGearsToClonesWhereSuitable()
Declaration
public void ChangeGearsToClonesWhereSuitable()
ClearDesign()
Declaration
public void ClearDesign()
ClearUndoRedoStacks()
Declaration
public void ClearUndoRedoStacks()
CompareForTestOnly(Design, StringBuilder)
Declaration
[ComVisible(false)]
public bool CompareForTestOnly(Design design, StringBuilder sb)
Parameters
Type |
Name |
Description |
Design |
design |
|
System.Text.StringBuilder |
sb |
|
Returns
Type |
Description |
System.Boolean |
|
Copy()
Declaration
Returns
CopyWithResults()
Declaration
public Design CopyWithResults()
Returns
DeleteAllGearSetConfigurationsThatHaveErrorsOrWarnings()
Declaration
public void DeleteAllGearSetConfigurationsThatHaveErrorsOrWarnings()
DeleteAllGearSetsDesignsThatAreNotUsedInConfigurations()
Declaration
public void DeleteAllGearSetsDesignsThatAreNotUsedInConfigurations()
DeleteAllInactiveGearSetDesigns()
Declaration
public void DeleteAllInactiveGearSetDesigns()
DeleteMultipleBearingDetailConfigurations()
Declaration
public void DeleteMultipleBearingDetailConfigurations()
DeleteMultipleFESubstructureConfigurations()
Declaration
public void DeleteMultipleFESubstructureConfigurations()
DeleteMultipleGearSetConfigurations()
Declaration
public void DeleteMultipleGearSetConfigurations()
DeleteMultipleShaftDetailConfigurations()
Declaration
public void DeleteMultipleShaftDetailConfigurations()
DesignStateLoadCaseGroupNamed(String)
Declaration
public DesignState DesignStateLoadCaseGroupNamed(string name)
Parameters
Type |
Name |
Description |
System.String |
name |
|
Returns
DesignStateNamed(String)
Declaration
public DesignState DesignStateNamed(string name)
Parameters
Type |
Name |
Description |
System.String |
name |
|
Returns
Dispose()
Declaration
DutyCycleNamed(String)
Declaration
public DutyCycle DutyCycleNamed(string name)
Parameters
Type |
Name |
Description |
System.String |
name |
|
Returns
Load(String, ExternalFullFEFileOption)
Declaration
public static Design Load(string filePath, ExternalFullFEFileOption loadFullFEOption = ExternalFullFEFileOption.MeshAndExpansionVectors)
Parameters
Returns
LoadExample(String)
Declaration
public static Design LoadExample(string exampleString)
Parameters
Type |
Name |
Description |
System.String |
exampleString |
|
Returns
loadForAPI(String)
Declaration
protected void loadForAPI(string fileName)
Parameters
Type |
Name |
Description |
System.String |
fileName |
|
LoadResults(String)
Declaration
public void LoadResults(string fileName)
Parameters
Type |
Name |
Description |
System.String |
fileName |
|
NewBeltCreationOptions(Double, Double, Double, String)
Declaration
public BeltCreationOptions NewBeltCreationOptions(double centreDistance = 0.1, double pulleyADiameter = 0.08, double pulleyBDiameter = 0.08, string name = "Belt Drive")
Parameters
Type |
Name |
Description |
System.Double |
centreDistance |
|
System.Double |
pulleyADiameter |
|
System.Double |
pulleyBDiameter |
|
System.String |
name |
|
Returns
NewCycloidalAssemblyCreationOptions(Int32, Int32, String)
Declaration
public CycloidalAssemblyCreationOptions NewCycloidalAssemblyCreationOptions(int numberOfDiscs = 1, int numberOfPins = 10, string name = "Cycloidal Assembly")
Parameters
Type |
Name |
Description |
System.Int32 |
numberOfDiscs |
|
System.Int32 |
numberOfPins |
|
System.String |
name |
|
Returns
NewCylindricalGearLinearTrainCreationOptions(Int32, String)
Declaration
public CylindricalGearLinearTrainCreationOptions NewCylindricalGearLinearTrainCreationOptions(int numberOfGears = 3, string name = "Gear Train")
Parameters
Type |
Name |
Description |
System.Int32 |
numberOfGears |
|
System.String |
name |
|
Returns
NewCylindricalGearPairCreationOptions()
Declaration
public CylindricalGearPairCreationOptions NewCylindricalGearPairCreationOptions()
Returns
NewHypoidGearSetCreationOptions()
Declaration
public HypoidGearSetCreationOptions NewHypoidGearSetCreationOptions()
Returns
NewNodalMatrix(Double[,])
Declaration
public NodalMatrix NewNodalMatrix(double[, ] denseMatrix)
Parameters
Type |
Name |
Description |
System.Double[,] |
denseMatrix |
|
Returns
NewPlanetCarrierCreationOptions(Int32, Double)
Declaration
public PlanetCarrierCreationOptions NewPlanetCarrierCreationOptions(int numberOfPlanets = 3, double diameter = 0.05)
Parameters
Type |
Name |
Description |
System.Int32 |
numberOfPlanets |
|
System.Double |
diameter |
|
Returns
NewShaftCreationOptions(Double, Double, Double, String)
Declaration
public ShaftCreationOptions NewShaftCreationOptions(double length = 0.1, double outerDiameter = 0.025, double bore = 0, string name = "Shaft")
Parameters
Type |
Name |
Description |
System.Double |
length |
|
System.Double |
outerDiameter |
|
System.Double |
bore |
|
System.String |
name |
|
Returns
NewSpiralBevelGearSetCreationOptions()
Declaration
public SpiralBevelGearSetCreationOptions NewSpiralBevelGearSetCreationOptions()
Returns
RemoveBearingFromDatabase(RollingBearing)
Declaration
public void RemoveBearingFromDatabase(RollingBearing rollingBearing)
Parameters
RemoveSynchroniserShift(SynchroniserShift)
Declaration
public void RemoveSynchroniserShift(SynchroniserShift shift)
Parameters
Save(String, Boolean)
Declaration
public Status Save(string fileName, bool saveResults)
Parameters
Type |
Name |
Description |
System.String |
fileName |
|
System.Boolean |
saveResults |
|
Returns
Save(String, Boolean, TaskProgress)
Declaration
public Status Save(string fileName, bool saveResults, TaskProgress progress)
Parameters
Type |
Name |
Description |
System.String |
fileName |
|
System.Boolean |
saveResults |
|
SMT.MastaAPIUtility.TaskProgress |
progress |
|
Returns
SaveLoadCaseResults(String, IReadOnlyList<LoadCase>)
Declaration
public void SaveLoadCaseResults(string fileName, IReadOnlyList<LoadCase> loadCases)
Parameters
Type |
Name |
Description |
System.String |
fileName |
|
System.Collections.Generic.IReadOnlyList<LoadCase> |
loadCases |
|
SaveResults(String)
Declaration
public void SaveResults(string fileName)
Parameters
Type |
Name |
Description |
System.String |
fileName |
|
TimeSeriesLoadCaseGroupNamed(String)
Declaration
public TimeSeriesLoadCaseGroup TimeSeriesLoadCaseGroupNamed(string name)
Parameters
Type |
Name |
Description |
System.String |
name |
|
Returns
Implements
System.IEquatable<T>
System.IDisposable
Extension Methods