Skip to main content

Motion Standalone Preprocessor C# library 2025 R2

Class CreateSubEntity

Last update: 16.07.2025

Namespace: VM.Managed.DAFUL.Operation.Util
Assembly: VMOpCore.dll

The utility class for the sub-entity creation.

public class CreateSubEntity

Inheritance

objectCreateSubEntity

Extension Methods

LinkPropertyItemCache.GetLinkProperties(object, LinkPropertyType), LinkPropertyItemCache.GetLinkPropertiesAndValues(object, LinkPropertyType), LinkPropertyItemCache.GetLinkedObjects(object, LinkPropertyType)

Constructors

CreateSubEntity()

public CreateSubEntity()

Methods

CreateArray(Document3D, int, bool)

Create the array.

public static Array CreateArray(Document3D document, int size, bool isInterface)

Parameters

document Document3D

The document.

size int

The number of array size.

isInterface bool

The flag of interface.

Returns

Array

The new array.

CreateArray(Document3D, int, bool, string)

Create the array.

public static Array CreateArray(Document3D activeDocument, int nSize, bool bInterface, string strName)

Parameters

activeDocument Document3D

The active document.

nSize int

The number of array size.

bInterface bool

The flag of interface.

strName string

The array name.

Returns

Array

The new array.

CreateDifferential1Equation(Document3D, Function, double, double, FunctionEquType, string)

Create the variable equation.

public static Differential1 CreateDifferential1Equation(Document3D activeDocument, Function function, double initialDisplacement, double initialVelocity, EquationFunctionDiff.FunctionEquType differentialFunctionType, string name)

Parameters

activeDocument Document3D

The active document.

function Function

The function.

initialDisplacement double

The initial value.

initialVelocity double

The initial velocity.

differentialFunctionType EquationFunctionDiff.FunctionEquType

The differential function type.

name string

The variable equation name.

Returns

Differential1

The new variable equation.

CreateDifferential1Equation(Document3D, UserSubroutine, double, double, FunctionEquType, string)

Create the variable equation.

public static Differential1 CreateDifferential1Equation(Document3D activeDocument, UserSubroutine userSubroutine, double initialDisplacement, double initialVelocity, EquationFunctionDiff.FunctionEquType differentialFunctionType, string name)

Parameters

activeDocument Document3D

The active document.

userSubroutine UserSubroutine

The function.

initialDisplacement double

The initial value.

initialVelocity double

The initial velocity.

differentialFunctionType EquationFunctionDiff.FunctionEquType

The differential function type.

name string

The variable equation name.

Returns

Differential1

The new variable equation.

CreateDifferential2Equation(Document3D, Function, double, double, FunctionEquType, string)

Create the variable equation.

public static Differential2 CreateDifferential2Equation(Document3D activeDocument, Function function, double initialDisplacement, double initialVelocity, EquationFunctionDiff.FunctionEquType differentialFunctionType, string name)

Parameters

activeDocument Document3D

The active document.

function Function

The function.

initialDisplacement double

The initial value.

initialVelocity double

The initial velocity.

differentialFunctionType EquationFunctionDiff.FunctionEquType

The differential function type.

name string

The variable equation name.

Returns

Differential2

The new variable equation.

CreateDifferential2Equation(Document3D, UserSubroutine, double, double, FunctionEquType, string)

Create the variable equation.

public static Differential2 CreateDifferential2Equation(Document3D activeDocument, UserSubroutine userSubroutine, double initialDisplacement, double initialVelocity, EquationFunctionDiff.FunctionEquType differentialFunctionType, string name)

Parameters

activeDocument Document3D

The active document.

userSubroutine UserSubroutine

The function.

initialDisplacement double

The initial value.

initialVelocity double

The initial velocity.

differentialFunctionType EquationFunctionDiff.FunctionEquType

The differential function type.

name string

The variable equation name.

Returns

Differential2

The new variable equation.

CreateFunction(Document3D, string, IArgument[], string, bool)

Create the function.

public static Function CreateFunction(Document3D document, string expression, IArgument[] arguments, string name, bool getNewEntityName = false)

Parameters

document Document3D

expression string

arguments IArgument[]

name string

getNewEntityName bool

Flag for creating a new entity if there is already an entity with the same name

Returns

Function

CreateFunction(Document3D, string, string)

Create the function.

public static Function CreateFunction(Document3D document, string expression, string name)

Parameters

document Document3D

expression string

name string

Returns

Function

CreateFunctionSimple(Document, string, bool, string, bool)

Create the function.

public static Function CreateFunctionSimple(Document document, string strExpression, bool bInterface, string strName, bool getNewEntityName = false)

Parameters

document Document

The active document.

strExpression string

The expression of function.

bInterface bool

The flag of interface.

strName string

The function name.

getNewEntityName bool

Flag for creating a new entity if there is already an entity with the same name

Returns

Function

The new function.

CreateFunctionSimple(Document3D, string, bool, string, string)

Create the function.

public static Function CreateFunctionSimple(Document3D activeDocument, string strExpression, bool bInterface, string strName, string strMatchName)

Parameters

activeDocument Document3D

The active document.

strExpression string

The expression of function.

bInterface bool

The flag of interface.

strName string

The function name.

strMatchName string

Name of the STR match.

Returns

Function

The new function.

CreateFunctionWithArguments(Document, string, IEnumerable, bool, string, bool)

Create the function.

public static Function CreateFunctionWithArguments(Document document, string strExpression, IEnumerable<iargument> lstArgument, bool bInterface, string strName, bool getNewEntityName = false)

Parameters

document Document

The active document.

strExpression string

The expression of function.

lstArgument IEnumerable

The list of argument.

bInterface bool

The flag of interface.

strName string

The function name.

getNewEntityName bool

Flag for creating a new entity if there is already an entity with the same name

Returns

Function

The new function.

CreateFunctionWithArguments(Document, string, IEnumerable(string, IArgument)&gt;, bool, string, bool)

Create the function with argument for python.

public static Function CreateFunctionWithArguments(Document document, string strExpression, IEnumerable(string, IArgument)&gt; lstArgument, bool bInterface, string strName, bool getNewEntityName = false)

Parameters

document Document

The active document.

strExpression string

The expression of function.

lstArgument IEnumerable(string, IArgument)&gt;

The list of argument.

bInterface bool

The flag of interface.

strName string

The function name.

getNewEntityName bool

Flag for creating a new entity if there is already an entity with the same name

Returns

Function

The new function.

CreateGroup(Document3D, string)

Create the Group.

public static Group CreateGroup(Document3D docSub, string strName)

Parameters

docSub Document3D

The active document

strName string

The group name

Returns

Group

CreateScenario(Document, Sensor, Sign, Action, double, ObjectBase, double, string, ObjectBase, Motion, string)

Create scenario

public static Scenario CreateScenario(Document document, Scenario.Sensor sensor, Scenario.Sign sign, Scenario.Action action, double dActionValue, ObjectBase function, double dValue, string strICFPath, ObjectBase objEnableTarget, Scenario.Motion targetOfMotion, string strPrefixName)

Parameters

document Document

The document

sensor Scenario.Sensor

The sensor

sign Scenario.Sign

The sign

action Scenario.Action

The action

dActionValue double

The action value

function ObjectBase

The function

dValue double

The value

strICFPath string

The icf path

objEnableTarget ObjectBase

The enable target

targetOfMotion Scenario.Motion

The motion

strPrefixName string

The prefix name

Returns

Scenario

CreateSpline(Document3D, IEnumerable, string)

public static Spline CreateSpline(Document3D document, IEnumerable<datapoint> dataPoints, string name)

Parameters

document Document3D

The active document.

dataPoints IEnumerable

The spline data

name string

The spline name.

Returns

Spline

The new spline.

CreateSpline(Document3D, SplineValue, string)

public static Spline CreateSpline(Document3D document, SplineValue splineValue, string name)

Parameters

document Document3D

The active document.

splineValue SplineValue

The spline value

name string

The spline name.

Returns

Spline

The new spline.

CreateSplineFromFile(Document3D, string, string)

public static Spline CreateSplineFromFile(Document3D activeDocument, string strDataFilePath, string strName)

Parameters

activeDocument Document3D

The active document.

strDataFilePath string

The path of spline data file.

strName string

The spline name.

Returns

Spline

The new spline.

CreateSplineFromValue(Document3D, List, string, bool)

public static Spline CreateSplineFromValue(Document3D activeDocument, List<string> points, string strName, bool getNewEntityName = false)

Parameters

activeDocument Document3D

The active document.

points Liststring[]&gt;

The data of spline value.

strName string

The spline name.

getNewEntityName bool

Flag for creating a new entity if there is already an entity with the same name

Returns

Spline

The new spline.

CreateStringValue(Document3D, string, bool)

Create the stringValue.

public static StringValue CreateStringValue(Document3D document, string stringValue, bool isInterface)

Parameters

document Document3D

The document.

stringValue string

The string value.

isInterface bool

The flag of interface.

Returns

StringValue

The new string value.

CreateStringValue(Document3D, string, bool, string)

Create the stringValue.

public static StringValue CreateStringValue(Document3D activeDocument, string stringValue, bool bInterface, string strName)

Parameters

activeDocument Document3D

The active document.

stringValue string

The number of array size.

bInterface bool

The flag of interface.

strName string

The array name.

Returns

StringValue

The new array.

CreateUserSubroutine(Document3D, string, string, int, string, bool, string)

Create the user-subroutine.

public static UserSubroutine CreateUserSubroutine(Document3D document, string dllName, string functionName, int resultValue, string expression, bool @interface, string name)

Parameters

document Document3D

The active document.

dllName string

The DLL file name.

functionName string

The function name.

resultValue int

The number of result value.

expression string

The expression of user-subroutine.

interface bool

The flag of interface.

name string

The user-subroutine name.

Returns

UserSubroutine

The new user-subroutine.

CreateUserSubroutineWithArguments(Document, string, string, int, string, IEnumerable, bool, string, bool)

Create the user-subroutine.

public static UserSubroutine CreateUserSubroutineWithArguments(Document document, string dllName, string functionName, int resultValue, string expression, IEnumerable<iargument> arguments, bool @interface, string name, bool addToDocument = true)

Parameters

document Document

The active document.

dllName string

The DLL file name.

functionName string

The function name.

resultValue int

The number of result value.

expression string

The expression of user-subroutine.

arguments IEnumerable

The list of argument.

interface bool

The flag of interface.

name string

The user-subroutine name.

addToDocument bool

Flag for add created element to document.

Returns

UserSubroutine

The new user-subroutine.

CreateVariableEquation(Document3D, Function, double, string)

Create the variable equation.

public static VariableEq CreateVariableEquation(Document3D activeDocument, Function function, double dInitialValue, string strName)

Parameters

activeDocument Document3D

The active document.

function Function

The function.

dInitialValue double

The intial value.

strName string

The variable equation name.

Returns

VariableEq

The new variable equation.

CreateVariableEquation(Document3D, UserSubroutine, double, string)

Create the variable equation.

public static VariableEq CreateVariableEquation(Document3D document, UserSubroutine userSubroutine, double initialValue, string name)

Parameters

document Document3D

The active document.

userSubroutine UserSubroutine

The UserSubroutine.

initialValue double

The intial value.

name string

The variable equation name.

Returns

VariableEq

The new variable equation.

Connect with Ansys