Class HarmonicAnalysisExportOptions<TPartAnalysis, TPart>

Inheritance
System.Object
System.MarshalByRefObject
SMT.MastaAPIUtility.MarshalByRefObjectPermanent
APIBase
HarmonicAnalysisExportOptions<TPartAnalysis, TPart>
HarmonicAnalysisFEExportOptions
HarmonicAnalysisRootAssemblyExportOptions
HarmonicAnalysisShaftExportOptions
Implements
System.IEquatable<APIBase>
Inherited Members
SMT.MastaAPIUtility.MarshalByRefObjectPermanent.InitializeLifetimeService()
Namespace: SMT.MastaAPI.SystemModel.AnalysesAndResults.HarmonicAnalyses
Assembly: SMT.MastaAPI.13.0.dll
Syntax
public abstract class HarmonicAnalysisExportOptions<TPartAnalysis, TPart> : APIBase, IEquatable<APIBase> where TPart : Part
Type Parameters
Name Description
TPartAnalysis
TPart

Fields

_parent

Declaration
protected readonly APIBase _parent
Field Value
Type Description
APIBase

Properties

AnalysisOptions

Declaration
public HarmonicAnalysisOptions AnalysisOptions { get; }
Property Value
Type Description
HarmonicAnalysisOptions

DistanceUnitsForExport

Distance Units for Export

Declaration
public ListWithSelectedItem<Unit> DistanceUnitsForExport { get; set; }
Property Value
Type Description
ListWithSelectedItem<Unit>

ExportType

Select how to export the results of the Harmonic Analysis

Declaration
public EnumWithSelectedValue<ExportOutputType> ExportType { get; set; }
Property Value
Type Description
EnumWithSelectedValue<ExportOutputType>

PlanetaryDuplicateToExport

Which planetary duplicate of the selected Component to export.

Declaration
public ListWithSelectedItem<TPartAnalysis> PlanetaryDuplicateToExport { get; set; }
Property Value
Type Description
ListWithSelectedItem<TPartAnalysis>

ReportNames

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

StatusMessageForExport

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

TypeOfResultToExport

Declaration
public EnumWithSelectedValue<DynamicsResponseType> TypeOfResultToExport { get; set; }
Property Value
Type Description
EnumWithSelectedValue<DynamicsResponseType>

Methods

ExportResults()

Declaration
public void ExportResults()

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