Interface IOperationsCalculusLineDataSeriesViewModel

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

Represents a view model for the calculus line data series.

public interface IOperationsCalculusLineDataSeriesViewModel

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.

# IOperationsCalculusLineDataSeriesViewModel.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 Active Page
# This retrieves the currently active page in the application.
page = applicationHandler.GetActivePage()

# Creating a Chart
# Create a new Chart View on the page
# This will create a new chart view with the specified name.
chartView = page.CreateChart("Chart")

# Set array about combination of characteristic and component
curvePaths = List[str]()
curvePaths.Add(r'Displacement/Magnitude')

# Create a PlotParameters object to specify the parameters for the plot.
# Set the Entity to Plot.
# The Target is the name of the target for which you want to retrieve the curves.
# Set the paths for the curves you want to retrieve.
# This is where you specify the characteristics and components you want to plot.
parameters = PlotParameters()
parameters.Paths = curvePaths
parameters.Target = "Crank"

# Add Curves (FilePath, Curve Parameter)
# FilePath - The path of the result to access.
# parameters - The class used as a parameter of the AddCurve function.
# The instance of the curve.
curves = chartView.AddCurves(result_file_path, parameters)

# Documentation Example
# Calculus - Differentiation
calculusCurves = chartView.CreateDifferentiatedCurve(curves)

# Calculus - Integration
calculusCurves[0].CalculusType = CalculusType.Integration

# Close the Pages
page.Close()

# Close Document
applicationHandler.CloseDocument(result_file_path)

Properties

CalculusType

Gets or sets the type of calculus operation.

CalculusType CalculusType { get; set; }

Property Value

CalculusType

Examples

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

Remarks

Use this property to specify or retrieve the type of calculus operation. The supported types are: