Class WhineWaterfallSettings

Inheritance

System.Object

System.MarshalByRefObject

SMT.MastaAPIUtility.MarshalByRefObjectPermanent

APIBase

WhineWaterfallSettings

Implements

System.IEquatable<APIBase>

Inherited Members

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.AnalysesAndResults.ModalAnalyses

Assembly: SMT.MastaAPI.13.0.dll

Syntax

public class WhineWaterfallSettings : APIBase, IEquatable<APIBase>

Fields

_parent

Declaration

protected readonly APIBase _parent

Field Value

Type	Description
APIBase

Properties

ActiveResultLocations

Declaration

public ReadOnlyCollection<ResultNodeSelection> ActiveResultLocations { get; }

Property Value

Type	Description
System.Collections.ObjectModel.ReadOnlyCollection<ResultNodeSelection>

BoundaryHandling

Declaration

public WhineWaterfallSettings.SpeedBoundaryHandling BoundaryHandling { get; set; }

Property Value

Type	Description
WhineWaterfallSettings.SpeedBoundaryHandling

ChartType

Declaration

public EnumWithSelectedValue<DynamicsResponse3DChartType> ChartType { get; set; }

Property Value

Type	Description
EnumWithSelectedValue<DynamicsResponse3DChartType>

ComplexComponent

Declaration

public EnumWithSelectedValue<ComplexPartDisplayOption> ComplexComponent { get; set; }

Property Value

Type	Description
EnumWithSelectedValue<ComplexPartDisplayOption>

ConnectedComponentType

Declaration

public ConnectedComponentType ConnectedComponentType { get; set; }

Property Value

Type	Description
ConnectedComponentType

CoordinateSystem

Declaration

public CoordinateSystemForWhine CoordinateSystem { get; set; }

Property Value

Type	Description
CoordinateSystemForWhine

DataScaling

Declaration

public DataScalingOptions DataScaling { get; }

Property Value

Type	Description
DataScalingOptions

DegreesOfFreedom

Declaration

public ReadOnlyCollection<EnumWithBoolean<ResultOptionsFor3DVector>> DegreesOfFreedom { get; }

Property Value

Type	Description
System.Collections.ObjectModel.ReadOnlyCollection<EnumWithBoolean<ResultOptionsFor3DVector>>

ExtendTorqueMapAtEdges

If selected, the Torque Map will include duplicated data past the maximum and minimum torque values.

Declaration

public bool ExtendTorqueMapAtEdges { get; set; }

Property Value

Type	Description
System.Boolean

FrequencyOptions

Declaration

public FrequencyOptionsForHarmonicAnalysisResults FrequencyOptions { get; }

Property Value

Type	Description
FrequencyOptionsForHarmonicAnalysisResults

HarmonicAnalysisOptions

Declaration

public HarmonicAnalysisOptions HarmonicAnalysisOptions { get; }

Property Value

Type	Description
HarmonicAnalysisOptions

LimitToMaxUnderTorqueSpeedCurve

If selected, the maximum limit of the response axis and the colour contour will be set to the maximum response in the area below the Torque Speed Curve

Declaration

public bool LimitToMaxUnderTorqueSpeedCurve { get; set; }

Property Value

Type	Description
System.Boolean

MaxHarmonic

Declaration

public Overridable<int> MaxHarmonic { get; set; }

Property Value

Type	Description
Overridable<System.Int32>

MaximumOrder

Declaration

public double MaximumOrder { get; set; }

Property Value

Type	Description
System.Double

MinimumOrder

Declaration

public double MinimumOrder { get; set; }

Property Value

Type	Description
System.Double

ModalContributionViewOptions

Declaration

public ModalContributionViewOptions ModalContributionViewOptions { get; }

Property Value

Type	Description
ModalContributionViewOptions

ModeViewOptions

Declaration

public AdvancedTimeSteppingAnalysisForModulationModeViewOptions ModeViewOptions { get; }

Property Value

Type	Description
AdvancedTimeSteppingAnalysisForModulationModeViewOptions

NumberOfAdditionalPointsEitherSideOfOrderLine

Declaration

public int NumberOfAdditionalPointsEitherSideOfOrderLine { get; set; }

Property Value

Type	Description
System.Int32

NumberOfPointsPerStep

The Torque Map is constructed from one data series per stiffness step, with each containing values at multiple speeds. This option controls how many data points are computed per step.

Declaration

public Overridable<int> NumberOfPointsPerStep { get; set; }

Property Value

Type	Description
Overridable<System.Int32>

OrderCutsChartSettings

Declaration

public OrderCutsChartSettings OrderCutsChartSettings { get; }

Property Value

Type	Description
OrderCutsChartSettings

OverlayTorqueSpeedCurve

Declaration

public bool OverlayTorqueSpeedCurve { get; set; }

Property Value

Type	Description
System.Boolean

ReduceNumberOfResultPoints

If selected, a Ramer-Douglas-Peucker reduction will be used to reduce the number of points plotted for each line, while preserving peaks and shape.

Declaration

public bool ReduceNumberOfResultPoints { get; set; }

Property Value

Type	Description
System.Boolean

ReferenceSpeedOptions

Declaration

public SpeedOptionsForHarmonicAnalysisResults ReferenceSpeedOptions { get; }

Property Value

Type	Description
SpeedOptionsForHarmonicAnalysisResults

ReplaceSpeedAxisWithFrequency

If selected, the Torque Map will replace the speed axis with a frequency axis, converted using the order of the selected excitations.

Declaration

public bool ReplaceSpeedAxisWithFrequency { get; set; }

Property Value

Type	Description
System.Boolean

ReportNames

Declaration

public IReadOnlyList<string> ReportNames { get; }

Property Value

Type	Description
System.Collections.Generic.IReadOnlyList<System.String>

ResponseType

Declaration

public EnumWithSelectedValue<DynamicsResponseType> ResponseType { get; set; }

Property Value

Type	Description
EnumWithSelectedValue<DynamicsResponseType>

ResultLocationSelectionGroups

Declaration

public ResultLocationSelectionGroups ResultLocationSelectionGroups { get; }

Property Value

Type	Description
ResultLocationSelectionGroups

SelectedExcitations

Declaration

public ExcitationSourceSelectionGroup SelectedExcitations { get; }

Property Value

Type	Description
ExcitationSourceSelectionGroup

ShowAmplitudesOfGearExcitations

If selected, a chart of Transmission Error and/or Misalignment will be shown alongside the Torque Map.

Declaration

public bool ShowAmplitudesOfGearExcitations { get; set; }

Property Value

Type	Description
System.Boolean

ShowBoundariesOfStiffnessSteps

A dynamic response in a Harmonic Analysis with Varying Stiffness is made up of sections, each taken from the stiffness step closest to the Torque Speed Curve for those speeds. If this option is selected, the speed boundaries between stiffness steps will be shown.

Declaration

public bool ShowBoundariesOfStiffnessSteps { get; set; }

Property Value

Type	Description
System.Boolean

ShowCoupledModes

Declaration

public bool ShowCoupledModes { get; set; }

Property Value

Type	Description
System.Boolean

ShowTorquesAtStiffnessSteps

If selected, the Torque Map will show a line for each stiffness step at the reference power load torque for that step.

Declaration

public bool ShowTorquesAtStiffnessSteps { get; set; }

Property Value

Type	Description
System.Boolean

ShowTotalResponseForMultipleExcitations

Calculate the total response by combining the response from multiple harmonic excitations. The total response is calculated by combining the individual responses at the same value of speed.

Declaration

public bool ShowTotalResponseForMultipleExcitations { get; set; }

Property Value

Type	Description
System.Boolean

ShowTotalResponseForMultipleSurfaces

Calculate the total response by combining the response from a single harmonic excitation for the selected locations. The total response is calculated by combining the individual responses at the same value of frequency/speed.

Declaration

public bool ShowTotalResponseForMultipleSurfaces { get; set; }

Property Value

Type	Description
System.Boolean

SpeedRangeForCombiningExcitations

Determines the extent of the speed range that the excitations are combined for.

Declaration

public MultipleExcitationsSpeedRangeOption SpeedRangeForCombiningExcitations { get; set; }

Property Value

Type	Description
MultipleExcitationsSpeedRangeOption

TranslationOrRotation

Declaration

public TranslationRotation TranslationOrRotation { get; set; }

Property Value

Type	Description
TranslationRotation

VectorMagnitudeMethod

Declaration

public ComplexMagnitudeMethod VectorMagnitudeMethod { get; set; }

Property Value

Type	Description
ComplexMagnitudeMethod

WaterfallChartSettings

Declaration

public WaterfallChartSettings WaterfallChartSettings { get; }

Property Value

Type	Description
WaterfallChartSettings

WhineWaterfallExportOption

Declaration

public WhineWaterfallExportOption WhineWaterfallExportOption { get; set; }

Property Value

Type	Description
WhineWaterfallExportOption

Methods

CalculateResults()

Declaration

public void CalculateResults()

ClearCachedResults()

Declaration

public void ClearCachedResults()

GetActiveReportWithEncodedImages()

Declaration

public string GetActiveReportWithEncodedImages()

Returns

Type	Description
System.String

GetDefaultReportWithEncodedImages()

Declaration

public string GetDefaultReportWithEncodedImages()

Returns

Type	Description
System.String

GetNamedReportWithEncodedImages(String)

Declaration

public string GetNamedReportWithEncodedImages(string reportName)

Parameters

Type	Name	Description
System.String	reportName

Returns

Type	Description
System.String

OutputActiveReportAsTextTo(String)

Declaration

public void OutputActiveReportAsTextTo(string filePath)

Parameters

Type	Name	Description
System.String	filePath

OutputActiveReportTo(String)

Declaration

public void OutputActiveReportTo(string filePath)

Parameters

Type	Name	Description
System.String	filePath

OutputDefaultReportTo(String)

Declaration

public void OutputDefaultReportTo(string filePath)

Parameters

Type	Name	Description
System.String	filePath

OutputNamedReportAsMastaReport(String, String)

Declaration

public void OutputNamedReportAsMastaReport(string reportName, string filePath)

Parameters

Type	Name	Description
System.String	reportName
System.String	filePath

OutputNamedReportAsTextTo(String, String)

Declaration

public void OutputNamedReportAsTextTo(string reportName, string filePath)

Parameters

Type	Name	Description
System.String	reportName
System.String	filePath

OutputNamedReportTo(String, String)

Declaration

public void OutputNamedReportTo(string reportName, string filePath)

Parameters

Type	Name	Description
System.String	reportName
System.String	filePath

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>>)