Class SubsystemAPI

Namespace: VM.API.Pre
Assembly: VM.API.Pre.dll

This class implements APIs for subsystem.

public static class SubsystemAPI

Inheritance

object ← SubsystemAPI

Extension Methods

LinkPropertyItemCache.GetLinkProperties(object, LinkPropertyType), LinkPropertyItemCache.GetLinkPropertiesAndValues(object, LinkPropertyType), LinkPropertyItemCache.GetLinkedObjects<T>(object, LinkPropertyType)

Methods

CreateSubSystem(Document, string, TMatrix, string)

Create .

[NotNull(new string[] { "document", "transform" })]
[ExistFile(new string[] { "subsystemFilePath" })]
public static Obj CreateSubSystem(this Document document, string subsystemFilePath, TMatrix transform, string subsystemName = "")

Parameters

document Document

The document to create the subsystem.

subsystemFilePath string

The file path of imported subsystem document

transform TMatrix

The transformation matrix for a subsystem.

subsystemName string

The name of the subsystem. If empty, default name starts with 'SubSystem_' will be generated and used.

Returns

Obj

The new object that is created by this API.

Exceptions

ArgumentNullException

Will be thrown if 'document' or 'subsystemFilePath' arguments are empty.

FileNotFoundException

Will be thrown if 'subsystemFilePath' does not exist.

CreateSubSystem(Document, string)

Create .

public static Obj CreateSubSystem(this Document document, string subsystemFilePath)

Parameters

document Document

The document to create the subsystem.

subsystemFilePath string

The file path of imported subsystem document

Returns

Obj

The new object that is created by this API.