Version: 15.0

    Show / Hide Table of Contents

    Class AcousticAnalysisSetupCacheReporting

    Inheritance
    System.Object
    APIBase
    AcousticAnalysisSetupCacheReporting
    Implements
    System.IEquatable<APIBase>
    Inherited Members
    APIBase.DisconnectFromMASTA()
    APIBase.GetProperty<T>(String)
    APIBase.SetProperty(String, Object)
    APIBase.clearCachedRpds()
    APIBase.getNamedObjectList<TElementType>(String)
    APIBase.getExpandableProperty<TReturnType>(String)
    APIBase.callPartialMethod(String, [])
    APIBase.callPartialMethod<T>(String, T)
    APIBase.callPartialMethod<T>(String, , T)
    APIBase.callPartialMethod<T>(String, , , T)
    APIBase.callPartialMethod<T>(String, , , , T)
    APIBase.callPartialMethod<T1, T2>(String, , T1, T2)
    APIBase.getPartialProperty(String)
    APIBase.setPartialProperty(String, Object)
    APIBase.IsValid(String)
    APIBase.IsReadOnly(String)
    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.RunPython(String, String, Object)
    APIBase.createWrappedRange(Double, Double)
    APIBase.createWrappedVector2D(Double, Double)
    APIBase.createWrappedPosition3D(Double, Double, Double)
    APIBase.ToListWithSelectedItem<T>(IEnumerable<T>)
    APIBase.ToListWithSelectedItem<T>(T, IEnumerable<T>)
    APIBase.Equals(APIBase)
    APIBase.GetHashCode()
    APIBase.Equals(Object)
    APIBase.InvalidProperties
    APIBase.ReadOnlyProperties
    APIBase.AllPropertiesAreReadOnly
    APIBase.AllPropertiesAreInvalid
    APIBase.cacheRpds
    APIBase.isInvalid
    Namespace: SMT.MastaAPI.SystemModel.PartModel.Acoustics
    Assembly: SMT.MastaAPI.15.0.dll
    Syntax
    public sealed class AcousticAnalysisSetupCacheReporting : APIBase, IEquatable<APIBase>

    Properties

    Caches

    Declaration
    public ReadOnlyCollection<CacheMemoryEstimates> Caches { get; }
    Property Value
    Type Description
    System.Collections.ObjectModel.ReadOnlyCollection<CacheMemoryEstimates>

    MaximumFrequency

    This frequency is used to calculate the estimated memory usage of the Near Field Integral and M2L caches, and will not be used as input for the actual analysis. Must be less than 20kHz. This upper bound is in place to retain good performance for the estimate calculation and is not a restriction on the acoustic analysis.

    Measurement: Frequency

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

    MaximumNumberOfThreads

    As reported in Program Settings as Maximum Number of Threads for Large Operations. This number is used to multiply the largest of the minimum or maximum frequency memory estimates to provide a largest upper bound for memory usage during an acoustic analysis.

    Declaration
    public int MaximumNumberOfThreads { get; }
    Property Value
    Type Description
    System.Int32

    MinimumFrequency

    This frequency is used to calculate the estimated memory usage of the Near Field Integral and M2L caches, and will not be used as input for the actual analysis. Must be less than 20kHz. This upper bound is in place to retain good performance for the estimate calculation and is not a restriction on the acoustic analysis.

    Measurement: Frequency

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

    ReportNames

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

    Methods

    EstimateMemoryUsage()

    Declaration
    public void EstimateMemoryUsage()

    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>>)
    Back to top