Interface IResults

Gives access to Cae results.

Namespace: TopSolid.Cae.Kernel.Automating

Assembly: TopSolid.Cae.Kernel.Automating.dll

Syntax

[ServiceContract]
public interface IResults

Remarks

This interface is available since v7.17.

Methods

GetCurrentScaleFactor(DocumentId)

Gets the current scale factor from an analysis result document.

Declaration

[OperationContract]
double GetCurrentScaleFactor(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
System.Double	The value of the scale factor.

Remarks

This method is available since v7.19.

Examples

     DocumentId docId = TopSolidHost.Documents.EditedDocument;
     double valueOfScaleFactor = TopSolidCaeHost.Results.GetCurrentScaleFactor(docId);

GetDisplacementMinAndMaxResults(DocumentId, out Double, out Double)

Gets the displacement minimum and maximum results in a result document.

Declaration

[OperationContract]
void GetDisplacementMinAndMaxResults(DocumentId inDocumentId, out double outMinValue, out double outMaxValue)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.
System.Double	outMinValue	Minimum value.
System.Double	outMaxValue	Maximum value.

Remarks

This method is available since v7.19.

Examples

     DocumentId docId = TopSolidHost.Documents.EditedDocument;
     TopSolidCaeHost.Results.GetDisplacementMinAndMaxResults(docId, out double minValue, out double maxValue);

GetMaterialElasticLimit(DocumentId)

Gets the material elastic limit from a result document.

Declaration

[OperationContract]
Real GetMaterialElasticLimit(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
Real	The value of the elastic limit.

Remarks

This method is available since v7.19.

Examples

     DocumentId docId = TopSolidHost.Documents.EditedDocument;
     Real elasticLimit = TopSolidCaeHost.Results.GetMaterialElasticLimit(docId);

GetMaterialName(DocumentId)

Gets the material name from a result document.

Declaration

[OperationContract]
string GetMaterialName(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
System.String	The name of the material.

Remarks

This method is available since v7.19.

Examples

     DocumentId docId = TopSolidHost.Documents.EditedDocument;
     string materialName = TopSolidCaeHost.Results.GetMaterialName(docId);

GetScaleFactorCalculatedValue(DocumentId)

Gets the scale factor calculated value from an analysis result document.

Declaration

[OperationContract]
double GetScaleFactorCalculatedValue(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
System.Double	The value of the scale factor.

Remarks

This method is available since v7.19.

Examples

     DocumentId docId = TopSolidHost.Documents.EditedDocument;
     double valueOfScaleFactor = TopSolidCaeHost.Results.GetScaleFactorCalculatedValue(docId);

GetTrescaMinAndMaxResults(DocumentId, out Double, out Double)

Gets theTresca minimum and maximum results in a result document.

Declaration

[OperationContract]
void GetTrescaMinAndMaxResults(DocumentId inDocumentId, out double outMinValue, out double outMaxValue)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.
System.Double	outMinValue	Minimum value.
System.Double	outMaxValue	Maximum value.

Remarks

This method is available since v7.19.

Examples

     DocumentId docId = TopSolidHost.Documents.EditedDocument;
     TopSolidCaeHost.Results.GetTrescaMinAndMaxResults(docId, out double minValue, out double maxValue);

GetVonMisesMinAndMaxResults(DocumentId, out Double, out Double)

Gets the Von Mises minimum and maximum results in a result document.

Declaration

[OperationContract]
void GetVonMisesMinAndMaxResults(DocumentId inDocumentId, out double outMinValue, out double outMaxValue)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.
System.Double	outMinValue	Minimum value.
System.Double	outMaxValue	Maximum value.

Remarks

This method is available since v7.19.

Examples

     DocumentId docId = TopSolidHost.Documents.EditedDocument;
     TopSolidCaeHost.Results.GetVonMisesMinAndMaxResults(docId, out double minValue, out double maxValue);

SetCurrentScaleFactor(DocumentId, Double)

Sets the current scale factor for an analysis result document.

Declaration

[OperationContract]
void SetCurrentScaleFactor(DocumentId inDocumentId, double inValue)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.
System.Double	inValue	The value to use as scale factor.

Remarks

This method is available since v7.19.

Examples

    DocumentId docId = TopSolidHost.Documents.EditedDocument;
    if (TopSolidHost.Application.StartModification("set current scale factor", false))
    {
        try
        {
            TopSolidCaeHost.Results.SetCurrentScaleFactor(docId, 9);
            TopSolidHost.Application.EndModification(true, true);
        }
        catch
        {
            TopSolidHost.Application.EndModification(false, false);
        }
    }