Version: 15.0

    Show / Hide Table of Contents

    Class FESubstructureExportOptions

    Inheritance
    System.Object
    APIBase
    FESubstructureExportOptions
    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.FE
    Assembly: SMT.MastaAPI.15.0.dll
    Syntax
    public sealed class FESubstructureExportOptions : APIBase, IEquatable<APIBase>

    Properties

    FEExportFileType

    Declaration
    public EnumWithSelectedValue<FESubstructuringFileFormat> FEExportFileType { get; set; }
    Property Value
    Type Description
    EnumWithSelectedValue<FESubstructuringFileFormat>

    ForceUnit

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

    IncludeCondensationNodeDisplacementExpansion

    Include the information required to quickly calculate the deformation of the model from the displacements of the condensation nodes. This property may be unavailable for export when not supported by the "FE Export File Type" selected.

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

    IncludeFEMeshDefinition

    Include the FE mesh details in the file. This may come from the original FE file or from the MASTA created mesh. If the file cannot be found at the expected location then this option will be unavailable.

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

    IncludeReducedGravityLoad

    By calculating the reduced gravity load the effect of gravity on the FE substructure can be taken into account. This is useful, for example, when the model represents a rotating shaft. This property may be unavailable for export when not supported by the "FE Export File Type" selected.

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

    IncludeReducedThermalExpansionForce

    By calculating the reduced thermal expansion force the effect of thermal expansion of the FE substructure can be taken into account. This property may be unavailable for export when not supported by the "FE Export File Type" selected.

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

    IncludeReductionCommands

    Include the commands to perform the reduction, as set up on this tab, in the exported file. This will include extraction of modes, if selected.

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

    IncludeRigidCouplingNodesAndConstraintsAddedByMASTA

    Include any rigid couplings, nodes, or fixed constraints created by MASTA in the exported file.

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

    LengthUnit

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

    ReportNames

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

    WarningAboutGearTeethForExport

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

    Methods

    ExportToFile(String)

    Declaration
    public void ExportToFile(string filePath)
    Parameters
    Type Name Description
    System.String filePath

    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