Class FrequencyOptionsForHarmonicAnalysisResults

Inheritance
System.Object
System.MarshalByRefObject
SMT.MastaAPIUtility.MarshalByRefObjectPermanent
APIBase
AbstractAnalysisOptions<StaticLoadCase>
FrequencyOptionsForHarmonicAnalysisResults
Implements
System.IEquatable<APIBase>
Inherited Members
SMT.MastaAPIUtility.MarshalByRefObjectPermanent.InitializeLifetimeService()
Namespace: SMT.MastaAPI.SystemModel.AnalysesAndResults.HarmonicAnalyses
Assembly: SMT.MastaAPI.13.0.dll
Syntax
public class FrequencyOptionsForHarmonicAnalysisResults : AbstractAnalysisOptions<StaticLoadCase>, IEquatable<APIBase>

Properties

AllowMaximumAboveHighestMode

Results above the frequency of the highest mode solved are likely to be incorrect.

Declaration
public Overridable<bool> AllowMaximumAboveHighestMode { get; set; }
Property Value
Type Description
Overridable<System.Boolean>

BasePointsOnModeFrequencies

If selected, points will be based on the the mode frequencies within the frequency range. If there are more than 'Number of Points Across Range', the mode frequencies which are closest together will be prioritised for removal; if there are fewer than 'Number of Points Across Range', additional points will be generated in the largest intervals between mode frequencies.

Declaration
public Overridable<bool> BasePointsOnModeFrequencies { get; set; }
Property Value
Type Description
Overridable<System.Boolean>

ClusteringBiasOfAdditionalPoints

If greater than 1, additional points will be clustered around mode frequencies. Set to 1 for approximately evenly-distributed points.

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

DesignDefaults

Declaration
public FrequencyOptionsForHarmonicAnalysisResults DesignDefaults { get; }
Property Value
Type Description
FrequencyOptionsForHarmonicAnalysisResults

LogarithmicFrequencyAxis

Declaration
public Overridable<bool> LogarithmicFrequencyAxis { get; set; }
Property Value
Type Description
Overridable<System.Boolean>

Maximum

Maximum frequency of interest

Measurement: Frequency

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

Minimum

Minimum frequency of interest

Measurement: Frequency

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

NumberOfPointsAcrossRange

Number of points to calculate across the frequency range. Fewer points will be calculated for harmonics which are not within the speed range for the full frequency range.

Declaration
public Overridable<int> NumberOfPointsAcrossRange { get; set; }
Property Value
Type Description
Overridable<System.Int32>

NumberOfPointsPerStepForTorqueMap

Declaration
public Overridable<int> NumberOfPointsPerStepForTorqueMap { get; set; }
Property Value
Type Description
Overridable<System.Int32>

ReportNames

Declaration
public IReadOnlyList<string> ReportNames { get; }
Property Value
Type Description
System.Collections.Generic.IReadOnlyList<System.String>

UseLogarithmicSpacing

Declaration
public Overridable<bool> UseLogarithmicSpacing { get; set; }
Property Value
Type Description
Overridable<System.Boolean>

Methods

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