Version: 13.0

    Show / Hide Table of Contents

    Class SystemDeflectionFEExportOptions

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

    Fields

    _parent

    Declaration
    protected readonly APIBase _parent
    Field Value
    Type Description
    APIBase

    Properties

    AlternativeFEMeshFile

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

    BaseCouplingsOnAlternativeFEMesh

    If selected, exported couplings will be set up according to current configuration, but connected to node IDs as defined in the alternative mesh file.

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

    DefaultTypeOfResultToExport

    The main type of boundary condition to export if not overridden on a node. Note that when exporting forces and the FE is not grounded one node will automatically use displacement boundary conditions to give a stable solution.

    Declaration
    public EnumWithSelectedValue<BoundaryConditionType> DefaultTypeOfResultToExport { get; set; }
    Property Value
    Type Description
    EnumWithSelectedValue<BoundaryConditionType>

    FEExportFormat

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

    FileType

    Declaration
    public SystemDeflectionFEExportOptions.ExportType FileType { get; set; }
    Property Value
    Type Description
    SystemDeflectionFEExportOptions.ExportType

    ForceUnit

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

    IncludeAnFEMesh

    Include a full mesh from an FE file in the exported file.

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

    IncludeRigidCouplingNodesAndConstraintsAddedByMASTA

    Include all rigid couplings, nodes, and 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>

    Links

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

    Nodes

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

    PathOfFEMeshFileToBeIncluded

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

    PlanetaryDuplicateToExport

    Which planetary duplicate of the selected FE Part to export

    Declaration
    public ListWithSelectedItem<NamedTuple1<int>> PlanetaryDuplicateToExport { get; set; }
    Property Value
    Type Description
    ListWithSelectedItem<NamedTuple1<System.Int32>>

    ReportNames

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

    UseRigidCouplingTypesFromFESubstructureForExportedCouplings

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

    Methods

    ExportToFile(String)

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

    ExportToOP2File(String)

    Declaration
    public void ExportToOP2File(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

    SetAlternativeFEMeshFile(String, FEExportFormat, Double, Double)

    Declaration
    public void SetAlternativeFEMeshFile(string filePath, FEExportFormat format, double lengthScale = 1, double forceScale = 1)
    Parameters
    Type Name Description
    System.String filePath
    FEExportFormat format
    System.Double lengthScale
    System.Double forceScale

    SetFEMeshFileToInclude(String, FEExportFormat, Double, Double)

    Declaration
    public void SetFEMeshFileToInclude(string filePath, FEExportFormat format, double lengthScale = 1, double forceScale = 1)
    Parameters
    Type Name Description
    System.String filePath
    FEExportFormat format
    System.Double lengthScale
    System.Double forceScale

    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