Version: 13.0

    Show / Hide Table of Contents

    Class ExcelFileDetails

    Inheritance
    System.Object
    System.MarshalByRefObject
    SMT.MastaAPIUtility.MarshalByRefObjectPermanent
    APIBase
    ExcelFileDetails
    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.DutyCycles.ExcelBatchDutyCycles
    Assembly: SMT.MastaAPI.13.0.dll
    Syntax
    public class ExcelFileDetails : APIBase, IEquatable<APIBase>

    Fields

    _parent

    Declaration
    protected readonly APIBase _parent
    Field Value
    Type Description
    APIBase

    Properties

    CombinePositiveAndNegativeSpeeds

    Declaration
    public bool CombinePositiveAndNegativeSpeeds { get; set; }
    Property Value
    Type Description
    System.Boolean

    CompressLoadCases

    If this option is selected, all the speeds for each torque value are combined into a weighted-averaged speed. This will greatly reduce the analysis time but may result in loss of accuracy. Bearing results involving life modification factor will be particularly affected.

    Declaration
    public bool CompressLoadCases { get; set; }
    Property Value
    Type Description
    System.Boolean

    CyclesUnit

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

    DurationUnit

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

    FirstDataColumn

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

    FirstDataRow

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

    HeaderColumn

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

    HeaderRow

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

    IgnoreSheetNamesContaining

    Enter comma-separated names or parts of names of sheets to ignore. For instance, if each Excel file contains a sheet called 'Vehicle Data' and a sheet called 'Overview', "Data, Overview" could be entered here.

    Declaration
    public string IgnoreSheetNamesContaining { get; set; }
    Property Value
    Type Description
    System.String

    NegateSpeedsAndTorques

    If this is selected, the speeds and torques in the Excel sheets are negated. This can be used in the event that the convention for speed and torque signs in the Excel sheets do not agree with those used by MASTA.

    Declaration
    public bool NegateSpeedsAndTorques { get; set; }
    Property Value
    Type Description
    System.Boolean

    NumberOfDataColumns

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

    NumberOfDataRows

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

    ReportNames

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

    ShowZeroDurationSpeedsAndTorques

    Use this option to show/hide speed or torque values which do not have any duration or cycles set. This option is not available if the load cases are compressed.

    Declaration
    public bool ShowZeroDurationSpeedsAndTorques { get; set; }
    Property Value
    Type Description
    System.Boolean

    SpecifyDuration

    Either the duration or the number of cycles are specified.

    Declaration
    public bool SpecifyDuration { get; set; }
    Property Value
    Type Description
    System.Boolean

    SpecifyNumberOfDataRowsAndColumns

    Declaration
    public bool SpecifyNumberOfDataRowsAndColumns { get; set; }
    Property Value
    Type Description
    System.Boolean

    SpeedUnit

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

    TorqueUnit

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

    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

    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