Interface IOperationsEigenValueAnalysisResultViewModel

Namespace: VM.Operations.Post.Interfaces
Assembly: VM.Operations.Post.dll

Interface representing information for an eigenvalue analysis result view model.

public interface IOperationsEigenValueAnalysisResultViewModel : IOperationAnalysisResult

Implements

IOperationAnalysisResult

Examples

For an example that includes information about interfaces, see this example. To view the examples, refer to the location of the 'Install_Path\Motion\Document\Postprocessor API for Python.zip' file.

# IOperationsEigenValueAnalysisResultViewModel.py
import sys

# Get the current file's path and set the path for external modules.
current_dir = __file__.rsplit('\\', 1)[0]
external_modules_path = current_dir + '\\..\\..\\Modules'
sys.path.append(external_modules_path)

# Import necessary modules
from OperationAPI import *

# Start the headless application interface
applicationHandler = ApplicationHandler()

# Import result file
result_file_path = get_result_file_path()

# Set array about result file
filepaths = List[str]()
filepaths.Add(result_file_path)

# Open about result files
# This will open the result file in the application.
# When the result is first opened, a Page is created and an Animation View is created on that Page.
applicationHandler.AddDocument(filepaths)

# Get all created pages.
# This retrieves all pages created in the application.
pages = applicationHandler.GetPages()

findViews = list()
for page in pages :
    views = page.GetViews()
    animationViews = [view for view in views if view.ViewType == ViewType.Animation]
    for animationView in animationViews :
        if animationView.DocumentFilePath == result_file_path and animationView.AnalysisResultType == AnalysisResultType.Dynamics :
            findViews.append(animationView)

# result_file_path - Get the document from the result file path.
document = applicationHandler.GetDocument(result_file_path)

# This retrieves the analysis result from the document.
# Types of Analysis Results
# - Dynamics
# - Eigenvalue
# - Statics
dynamic_analysis = document.GetAnalysisResultViewModel(AnalysisResultType.Dynamics)
dynamic_analysis.SetAnimationFrame(10)

viewCount = len(findViews)
if viewCount > 0 :
    page1 = applicationHandler.GetPage(findViews[0].GroupID)

    # This retrieves the analysis result from the document.
    # Types of Analysis Results
    # - Dynamics
    # - Eigenvalue
    # - Statics
    eigenval_analysis = document.GetAnalysisResultViewModel(AnalysisResultType.Eigenvalue)

    # Create an Animation View on the active page
    # This will create an animation view based on the eigenvalue analysis.
    eigenvalue_animation = page1.CreateAnimation(eigenval_analysis, "EigenvalueAnimation")
    eigenval_analysis.Frame = 100
    
    times = eigenval_analysis.GetSamplingTimes()
    convertedtimes = list(times)
    eigenval_analysis.TargetSamplingTime = convertedtimes[0]
    frequencies = eigenval_analysis.GetFrequencies()
    frequency = eigenval_analysis.GetFrequency(1)
    # frequency.Enable = True

# Get all created pages.
# This retrieves all pages created in the application.
pages = applicationHandler.GetPages()
for page in pages :
    page.Close()

# Close the Document
applicationHandler.CloseDocument(result_file_path)

Properties

Frame

Gets or sets the frame number to be read when loading animation for EigenValue analysis type.

uint Frame { get; set; }

Property Value

uint

Examples

For an example that includes this property, see the Interface IOperationsEigenValueAnalysisResultViewModel.

Remarks

Use this property to specify or retrieve the frame number to load for animations in EigenValue analysis.

TargetSamplingTime

Gets or sets the target sampling time.

double TargetSamplingTime { get; set; }

Property Value

double

Examples

For an example that includes this property, see the Interface IOperationsEigenValueAnalysisResultViewModel.

Remarks

This property allows you to select and set one specific sampling time from multiple available sampling times.

Methods

GetFrequencies()

Retrieves all instances of frequencies.

IEnumerable<IOperationsFrequencyViewModel> GetFrequencies()

Returns

IEnumerable<IOperationsFrequencyViewModel>

An enumerable collection of representing the frequency instances.

Examples

For an example that includes this property, see the Interface IOperationsEigenValueAnalysisResultViewModel.

Remarks

This method finds and returns all instances of frequencies.

GetFrequency(int)

Retrieves the frequency instance for the specified sampling time index.

IOperationsFrequencyViewModel GetFrequency(int index)

Parameters

index int

The index of the target sampling time.

Returns

IOperationsFrequencyViewModel

An instance of representing the frequency for the specified index.

Examples

For an example that includes this property, see the Interface IOperationsEigenValueAnalysisResultViewModel.

Remarks

This method finds and returns the frequency instance corresponding to the provided sampling time index.

GetSamplingTimes()

Retrieves an array of sampling times.

double[] GetSamplingTimes()

Returns

double[]

An array of doubles representing the available sampling times.

Examples

For an example that includes this property, see the Interface IOperationsEigenValueAnalysisResultViewModel.

Remarks

This method extracts and returns the array of available sampling times.