Class ParametricStudyToolOptions

Inheritance

System.Object

System.MarshalByRefObject

SMT.MastaAPIUtility.MarshalByRefObjectPermanent

APIBase

ParametricStudyToolOptions

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.ParametricStudyTools

Assembly: SMT.MastaAPI.13.0.dll

Syntax

public class ParametricStudyToolOptions : APIBase, IEquatable<APIBase>

Fields

_parent

Declaration

protected readonly APIBase _parent

Field Value

Type	Description
APIBase

Properties

AnalysisType

Declaration

public EnumWithSelectedValue<AnalysisType> AnalysisType { get; set; }

Property Value

Type	Description
EnumWithSelectedValue<AnalysisType>

ChangingDesign

Declaration

public bool ChangingDesign { get; set; }

Property Value

Type	Description
System.Boolean

ExternalFullFELoader

Declaration

public ExternalFullFELoader ExternalFullFELoader { get; }

Property Value

Type	Description
ExternalFullFELoader

FolderPathForSavedFiles

Declaration

public string FolderPathForSavedFiles { get; }

Property Value

Type	Description
System.String

IsLoggingData

Declaration

public bool IsLoggingData { get; set; }

Property Value

Type	Description
System.Boolean

LogReport

If enabled the specified reports, in the Data Logging Setup, will be logged at each step

Declaration

public bool LogReport { get; set; }

Property Value

Type	Description
System.Boolean

MaximumNumberOfDesignCopiesToUse

This is the maximum number of copies of the original design which will be made for parallelising the workload.

Declaration

public Overridable<int> MaximumNumberOfDesignCopiesToUse { get; set; }

Property Value

Type	Description
Overridable<System.Int32>

NumberOfAnalysisDimensions

Specifies whether parameters are varied linearly or on a two dimensional grid

Declaration

public int NumberOfAnalysisDimensions { get; set; }

Property Value

Type	Description
System.Int32

NumberOfSteps

Declaration

public int NumberOfSteps { get; }

Property Value

Type	Description
System.Int32

ParametricStudyLoggingVariables

Declaration

public ReadOnlyCollection<AnalysisCaseVariable> ParametricStudyLoggingVariables { get; }

Property Value

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

ParametricStudyType

Declaration

public ParametricStudyType ParametricStudyType { get; set; }

Property Value

Type	Description
ParametricStudyType

PerformSystemOptimisationPSTPostAnalysis

Available when a PST analysis includes the 'Perform System Optimisation' step and the 'Save Design at Each Step?' is enabled. Once the initial PST analysis is complete create a new design that contains all of the Gear Set Configurations in all of the PST steps. The same duty cycle that was initial run is then modified to perform a Design of Experiments on the 'Selected Gear Set Configuration' with the same results to be logged.

Declaration

public bool PerformSystemOptimisationPSTPostAnalysis { get; set; }

Property Value

Type	Description
System.Boolean

PutNewlyAddedNumericalVariablesInto

Setting the group for newly added variables is useful when adding a large number of inputs in-order to maintain a smaller number of combinations.

Declaration

public ListWithSelectedItem<string> PutNewlyAddedNumericalVariablesInto { get; set; }

Property Value

Type	Description
ListWithSelectedItem<System.String>

ReportNames

Declaration

public IReadOnlyList<string> ReportNames { get; }

Property Value

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

SaveDesignAtEachStep

Declaration

public bool SaveDesignAtEachStep { get; set; }

Property Value

Type	Description
System.Boolean

StepResults

Declaration

public ReadOnlyCollection<ParametricStudyToolStepResult> StepResults { get; }

Property Value

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

StepsForStatisticalStudy

Declaration

public int StepsForStatisticalStudy { get; set; }

Property Value

Type	Description
System.Int32

StepsInDimension1

Declaration

public int StepsInDimension1 { get; set; }

Property Value

Type	Description
System.Int32

StepsInDimension2

Declaration

public int StepsInDimension2 { get; set; }

Property Value

Type	Description
System.Int32

StudyVariables

Declaration

public ReadOnlyCollection<ParametricStudyVariable> StudyVariables { get; }

Property Value

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

UseMultipleDesigns

When set to true this will create 'x' duplicates of the design and split the run workload between each of these designs. Here, 'x' is the number of physical core on your machine. When set to false, only one design duplicate will be created on which the analyses will be performed. By default, this is true for single load case runs and false for compound load case runs.

Declaration

public Overridable<bool> UseMultipleDesigns { get; set; }

Property Value

Type	Description
Overridable<System.Boolean>

Methods

AddLoggingVariable(DesignEntity, List<String>)

Declaration

public AnalysisCaseVariable AddLoggingVariable(DesignEntity designEntity, List<string> path)

Parameters

Type	Name	Description
DesignEntity	designEntity
System.Collections.Generic.List<System.String>	path

Returns

Type	Description
AnalysisCaseVariable

AddStudyVariable(DesignEntity, List<String>)

Declaration

public ParametricStudyVariable AddStudyVariable(DesignEntity designEntity, List<string> path)

Parameters

Type	Name	Description
DesignEntity	designEntity
System.Collections.Generic.List<System.String>	path

Returns

Type	Description
ParametricStudyVariable

DataLoggerFor(DesignEntity)

Declaration

public DataLogger DataLoggerFor(DesignEntity designEntity)

Parameters

Type	Name	Description
DesignEntity	designEntity

Returns

Type	Description
DataLogger

EditFolderPath()

Declaration

public void EditFolderPath()

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

MoveStudyVariableDown(ParametricStudyVariable)

Declaration

public void MoveStudyVariableDown(ParametricStudyVariable studyVariable)

Parameters

Type	Name	Description
ParametricStudyVariable	studyVariable

MoveStudyVariableUp(ParametricStudyVariable)

Declaration

public void MoveStudyVariableUp(ParametricStudyVariable studyVariable)

Parameters

Type	Name	Description
ParametricStudyVariable	studyVariable

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

RemoveLoggingVariable(AnalysisCaseVariable)

Declaration

public void RemoveLoggingVariable(AnalysisCaseVariable analysisVariable)

Parameters

Type	Name	Description
AnalysisCaseVariable	analysisVariable

RemoveStudyVariable(ParametricStudyVariable)

Declaration

public void RemoveStudyVariable(ParametricStudyVariable studyVariable)

Parameters

Type	Name	Description
ParametricStudyVariable	studyVariable

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