Files
kompas3d-mcp/docs/Kompas3D_SDK/interfaces/ksvariable.md
T
mikhail e1337e4016 feat(sdk-docs): MD-база знаний SDK — в репозиторий; генератор и зеркало убраны
docs/Kompas3D_SDK/ становится каноническим источником справки КОМПАС SDK
и включается в репозиторий (2491 файл, ~14 МБ). HTML-зеркало
docs/KOMPAS_SDK_ru-RU/ (~1.4 ГБ, © АСКОН) и генератор
tools/build_kompas3d_sdk.py больше не нужны — регенерация не предполагается.

- .gitignore: MD-база разблокирована; зеркало остаётся проигнорированным
  (safety-net на случай повторной локальной выгрузки).
- CLAUDE.md / SKILL.md: убраны упоминания регенерации и зеркала.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-26 20:00:05 +03:00

6.9 KiB

title, type, api, domain, tags, sources
title type api domain tags sources
Внешняя переменная (Интерфейсы ksVariable, IVariable) interface
api7
feature
interface
api7
feature
ksvariable
ksvariable.html

*API интерфейсов. Версия 5 > Документ-модель (Интерфейсы - ksDocument3D, IDocument3D )  > Компонент сборки (деталь или подсборка). Интерфейсы ksPart и IPart  > Объект Дерева построения (Интерфейсы ksFeature, IFeature)  > Массив переменных (Интерфейсы ksVariableCollection, IVariableCollection) *

Внешняя переменная (Интерфейсы ksVariable, IVariable)

Интерфейс внешней параметрической переменной модели.

ksVariable - интерфейс Automation
Ivariable - интерфейс COM
Примечание:
Данный интерфейс может быть получен с использованием методов интерфейса ksVariableCollection.

displayName - Отображаемое имя переменной

Интерфейс… Тип данных: BSTR Синтаксис Automation:

displayName = iVariable.displayName    Получить свойство (* )
displayName = iVariable.GetdisplayName()    Получить свойство (**)
Примечание.
Свойство только для чтения.

Expression - Выражение

Интерфейс… Тип данных: строка Синтаксис Automation:

expression = iVariable.expression    Получить свойство (* )
iVariable.expression = expression    Установить свойство (* )
iVariable.GetExpression()    Получить свойство (**)
iVariable.SetExpression(expression)    Установить свойство (**)

Примечание: Свойство позволяет получить или задать строковое выражение для расчета значения переменной.

External - Внешняя переменная

Интерфейс… Тип данных: BOOL Синтаксис Automation:

external = iVariable.external    Получить свойство (* )
iVariable.external = external    Установить свойство (* )
external = iVariable.GetExternal()    Получить свойство (**)
iVariable.SetExternal(external)    Установить свойство (**)

Information - Информационная переменная

Интерфейс… Тип данных: Long Синтаксис Automation:

Information = Object.Information    Получить свойство (* )
Object.Information = Information    Установить свойство (* )
Information = Object.GetInformation()    Получить свойство (**)
Object.SetInformation( Information )    Установить свойство (**)
Примечание.
Свойство позволяет задать и получить признак "информационная" для переменных модели.

linkDocName - Имя документа, в котором хранится ссылочная переменная

Интерфейс… Тип данных: строка Синтаксис Automation:

linkDocName = iVariable.linkDocName    Получить свойство (* )
linkDocName = iVariable.GetLinkDocName()    Получить свойство (**)

Примечание: Свойство только для чтения.

linkVarName - Имя переменной, на которую задана ссылка

Интерфейс… Тип данных: строка Синтаксис Automation:

linkVarName = iVariable.linkVarName    Получить свойство (* )
linkVarName = iVariable.GetLinkVarName()    Получить свойство (**)

Примечание: Свойство только для чтения.

name - Имя переменной

Интерфейс… Тип данных: строка Синтаксис Automation:

name = iVariable.name    Получить свойство (* )
name = iVariable.GetName()    Получить свойство (**)

Примечание: Свойство только для чтения.

note - Комментарий к переменной

Интерфейс… Тип данных: строка Синтаксис Automation:

note = iVariable.note    Получить свойство (* )
iVariable.note = note    Установить свойство (* )
note = iVariable.GetNote()    Получить свойство (**)
iVariable.SetNote(name)    Установить свойство (**)

parameterNote - Имя параметра переменной

Интерфейс… Тип данных: строка Синтаксис Automation:

parameterNote = iVariable.parameterNote    Получить свойство (* )
parameterNote = iVariable.GetParameterNote()    Получить свойство (**)

Примечание: Свойство только для чтения.

Pseudonym - Псевдоним переменной

Интерфейс… Тип данных: строка Синтаксис Automation:

pseudonym = iVariable.pseudonym    Получить свойство (* )
iVariable.pseudonym = pseudonym    Установить свойство (* )
pseudonym = iVariable.GetPseudonym()    Получить свойство (**)
iVariable.SetPseudonym(pseudonym)    Установить свойство (**)

Интерфейс… Синтаксис Automation:

BOOL SetLink (BSTR doc,BSTR name);

Синтаксис COM:

BOOL SetLink (LPOLESTR doc,LPOLESTR name);
Входные параметры:
Name    - имя переменной, на которую будет сделана ссылка,
Doc    - полный путь к документу, в котором лежит переменная с именем name.
Возвращаемое значение:
TRUE    - в случае успешного завершения,
FALSE    - в случае неудачи.

Примечание: Чтобы удалить установленную ссылку, необходимо задать следующие значения параметров: name = NULL, doc = NULL.

value - Значение переменной

Интерфейс… Тип данных: double Синтаксис Automation:

value = iVariable.value    Получить свойство (* )
iVariable.value = value    Установить свойство (* )
value = iVariable.GetValue()    Получить свойство (**)
iVariable.SetValue(value)    Установить свойство (**)