API for Project Components

Part of the Object based program API.

class ComponentApi

API to access projects

Returned by

CreateAnalysisPackageCall(name, packagePath, libraryNamespace=None)

Returns the created analysis package call.

Parameters:
name : str

Name of the analysis package call

packagePath : str

Path to the package to be called (absolute or relative to package directory)

libraryNamespace : str

Namespace of a library workspace (requires feature flag; packagePath must be relative)

Returns:

Package call

Return type:

AnalysisPackageCall

CreateConfigChange(name, tcfFile, tbcFile)

Returns the created config change.

If keeping the TCF or TBC is not intended, set it explicitly via SetKeepTcf(False) or SetKeepTbc(False).

Parameters:
name : str

Name of the config change

tcfFile : str

Path of the tcf file

tbcFile : str

Path to the tbc file

Returns:

Config change

Return type:

ConfigChange

CreateFolder(name)

Returns the created folder.

Parameters:
name : str

Name of the folder

Returns:

Project Folder

Return type:

ProjectFolder

CreatePackageCall(name, packagePath, libraryNamespace=None)

Returns the created package call.

Parameters:
name : str

Name of the package call

packagePath : str

Path to the package to be called (absolute or relative to package directory)

libraryNamespace : str

Namespace of a library workspace (requires feature flag; packagePath must be relative)

Returns:

Package call

Return type:

PackageCall

CreatePackageGenerator(name, generatorId)

Returns the created package generator.

Parameters:
name : str

Name of the generator

generatorId : str

Unique identifier of the generator to be created

Returns:

Package generator

Return type:

PackageGenerator

CreateProjectCall(name, projectPath, libraryNamespace=None)

Returns the created project call.

Parameters:
name : str

Name of the project call

projectPath : str

Path to the project to be called. In contrast to the method CreatePackageCall(), this path must be relative to the parent project. Absolute paths are also allowed. If an absolute path is used that is inside a currently defined library workspace, the project call will be a reference into this workspace.

libraryNamespace : str

Namespace of a library workspace (requires feature flag; projectPath must be relative)

Returns:

Project call

Return type:

ProjectCall

CreateProjectGenerator(name, generatorId)

Returns the created project generator.

Parameters:
name : str

Name of the generator

generatorId : str

Unique identifier of the generator to be created

Returns:

Project generator

Return type:

ProjectGenerator

CreateStimulationPackageCall(name, packagePath, libraryNamespace=None)

Returns the created stimulation package call.

Parameters:
name : str

Name of the stimulation package call

packagePath : str

Path to the package to be called (absolute or relative to package directory)

libraryNamespace : str

Namespace of a library workspace (requires feature flag; packagePath must be relative)

Returns:

Package call

Return type:

StimulationPackageCall