Class ThermalLoadCaseGroup

Inheritance

System.Object

APIBase

ThermalLoadCaseGroup

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.ElectricMachines.Thermal.LoadCasesAndAnalyses

Assembly: SMT.MastaAPI.15.0.dll

Syntax

public sealed class ThermalLoadCaseGroup : APIBase, IEquatable<APIBase>

Properties

LoadCases

Declaration

public ReadOnlyCollection<ThermalLoadCase> LoadCases { get; }

Property Value

Type	Description
System.Collections.ObjectModel.ReadOnlyCollection<ThermalLoadCase>

Name

Declaration

public string Name { get; set; }

Property Value

Type	Description
System.String

ReportNames

Declaration

public IReadOnlyList<string> ReportNames { get; }

Property Value

Type	Description
System.Collections.Generic.IReadOnlyList<System.String>

ThermalElectricMachine

Declaration

public ThermalElectricMachine ThermalElectricMachine { get; }

Property Value

Type	Description
ThermalElectricMachine

Methods

AddLoadCase(String)

Declaration

public ThermalLoadCase AddLoadCase(string name = "Load Case")

Parameters

Type	Name	Description
System.String	name

Returns

Type	Description
ThermalLoadCase

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

LoadCaseNamed(String)

Declaration

public ThermalLoadCase LoadCaseNamed(string name)

Parameters

Type	Name	Description
System.String	name

Returns

Type	Description
ThermalLoadCase

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

PerformCompoundAnalysis(ThermalElectricMachineSetup)

Declaration

public MethodOutcome PerformCompoundAnalysis(ThermalElectricMachineSetup setup)

Parameters

Type	Name	Description
ThermalElectricMachineSetup	setup

Returns

Type	Description
MethodOutcome

PerformCompoundAnalysisWithProgress(ThermalElectricMachineSetup, TaskProgress)

Declaration

public MethodOutcome PerformCompoundAnalysisWithProgress(ThermalElectricMachineSetup setup, TaskProgress token)

Parameters

Type	Name	Description
ThermalElectricMachineSetup	setup
SMT.MastaAPIUtility.TaskProgress	token

Returns

Type	Description
MethodOutcome

TryRemoveLoadCase(ThermalLoadCase)

Declaration

public bool TryRemoveLoadCase(ThermalLoadCase loadCase)

Parameters

Type	Name	Description
ThermalLoadCase	loadCase

Returns

Type	Description
System.Boolean

TryRemoveLoadCaseNamed(String)

Declaration

public bool TryRemoveLoadCaseNamed(string name)

Parameters

Type	Name	Description
System.String	name

Returns

Type	Description
System.Boolean

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>>)