Интерфейс IScripted

Analog.SStudioScripting.IScripted содержится в .NET-сборке BaseLib.dll, установленной в папке SigmaStudio.

Окно сценариев можно использовать для запуска сценариев с помощью интерфейса Iscripted.

Интерфейс определяет целочисленный возвращаемый тип «HResult» следующим образом:

HResult.S_OK = 0
HResult.E_FAILED = 1
HResult.E_INVALID_ARGS = 2
HResult.E_EXCEPTION = 3

Следующие функции можно использовать для взаимодействия с файлом проекта.

Создать новый файл проекта

HResult ProjectNew();

Функция не принимает параметров

Открыть файл проекта с диска

HResult ProjectOpen( string filename );

filename → Полный путь к файлу

Сохранить активный файл проекта

HResult ProjectSave();

Функция не принимает параметров

Сохранить конкретный файл проекта

HResult ProjectSave( string projectName );

projectName → Имя открытого файла проекта или полный путь к нему

Сохранить как активный файл проекта

HResult ProjectSaveAs( string saveAsFilename );

saveAsFilename → Новое имя файла или полный путь

Сохранить как конкретный файл проекта

HResult ProjectSaveAs( string projectName, string saveAsFilename );

projectName → Имя открытого файла проекта или полный путь к нему
saveAsFilename → Новое имя файла или полный путь

Закрыть активный файл проекта

HResult ProjectClose();

Закрыть конкретный файл проекта

HResult ProjectClose( string projectName );

projectName → Имя открытого файла проекта или полный путь к нему

Установить проект как активный

HResult ProjectSetActive( string projectName );

projectName → Имя открытого файла проекта или полный путь к нему

Связать активную схему

HResult ProjectLink();

Функция не принимает параметров

Связать и скомпилировать активную схему

HResult ProjectLinkCompile();

Функция не принимает параметров

Связать и скомпилировать активную схему

HResult ProjectLinkCompile( string projectName );

projectName → Имя открытого файла проекта или полный путь к нему

Связать, скомпилировать и загрузить активную схему

HResult ProjectLinkCompileDownload();

Функция не принимает параметров

Связать, скомпилировать и загрузить конкретный файл проекта

HResult ProjectLinkCompileDownload( string projectName );

projectName → Имя открытого файла проекта или полный путь к нему

Установить «Частоту дискретизации нового элемента» (частоту дискретизации схемы) для активного проекта

HResult DesignSetSamplingRate( int samplingRate );

Распространить частоту дискретизации схемы

HResult DesignPropagateSamplingRate();

Функция не принимает параметров

Переключить заморозку схемы Вкл/Выкл

HResult DesignToggleSchematicFreeze( string password );

password → Пароль заморозки схемы

Установить активную плату иерархии в текущей схеме

HResult DesignSetActiveBoard( string boardName );

boardName → Имя платы в активной схеме

Экспортировать системные файлы активной схемы

HResult ProjectExportSystemFiles ( string fullyQualifiedFileName );

fullyQualifiedFileName → Полный путь к системному файлу без расширения

Создать DLL подключаемого модуля с помощью Algorithm Designer

HResult BuildExternalModule ( string ICName, string fullyQualifiedProjectName, string fullyQualifiedLibraryName );

ICName → Понятное имя DSP(ИС), например «IC 1» или «IC 2»
fullyQualifiedProjectName → Полный путь к файлу проекта конструктора
fullyQualifiedLibraryName → Полный путь к выходной DLL
Примечание: ИС DSP должна присутствовать в новом окне схемы перед вызовом этого API.
Например,
HResult eResult = HResult.S_OK;
sigmastudio.ProjectNew();
sigmastudio.ObjectInsert( «ADSP-214xx» );
eResult = sigmastudio.BuildExternalModule(«IC 1», «C:\\Analog Devices\\SoftwareModules\\SigmaStudioForSHARC-SH-Rel2.2.0\\Target\\ExtModules\\Biquad\\adi_Biquad.ssg», «C:\\Analog Devices\\SoftwareModules\\SigmaStudioForSHARC-SH-Rel2.2.0\\Target\\ExtModules\\Biquad\\adi_biquad.dll»);

Установить «Размер блока схемы» для ИС и алгоритмов, принадлежащих ИС, для активного проекта

HResult DesignSetBlockSize(string ICName, int nSize);

ICName → Понятное имя DSP(ИС)
nSize → «Размер блока схемы», заданный как «nSize», будет установлен для всех модулей/алгоритмов, принадлежащих ИС, соответствующих «ICName». «Размер блока схемы» (nSize) должен быть больше 8 и кратным 8.

Функции для работы с регистрами и параметрами перечислены ниже.

Записать данные в регистр по конкретному адресу устройства

HResult ICRegisterWrite( int numOfBytesToWrite, byte[] dataToWrite, int protocol, int chipAddress, int writeAddress, int addressWidth, int registerByteLength, int communicationChannel, int ICType);

numOfBytesToWrite → Количество байтов в 'dataToWrite' для записи в DSP
dataToWrite → Данные для записи, массив байтов длиной numOfBytesToWrite
protocol → Протокол передачи данных, SPI = 1 и I2C = 0
chipAddress → Адрес I2C или SPI
writeAddress → Адрес регистра для записи
addressWidth → Ширина адреса регистра для записи
registerByteLength → Длина регистра в байтах для записи
communicationChannel → Интерфейс связи, USBI = 0 и AARDVARK = 1
ICType → Тип ИС, ADAU145x/ADAU146x = 0, ADSP-214xx = 1, ADSP-SC5xx/ADSP-215xx = 2

Примечание: Обратитесь к этой ссылке для примера сценария https://wiki.analog.com/resources/tools-software/sigmastudio/usingsigmastudio/scripting/iscripted_samples#icregisterwrite_and_icregisterread


Записать данные в регистр

HResult ICRegisterWrite( string ICName, int writeAddress,int writeNumberBytes, long dataToWrite );

ICName → Понятное имя DSP(ИС) для записи
writeAddress → Адрес регистра для записи
writeNumberBytes → Количество байтов в 'dataToWrite' для записи в DSP
dataToWrite → Данные для записи (long == максимум 64 бита данных)

Записать данные в регистр по конкретному адресу устройства

HResult ICRegisterWrite( string ICName, int deviceAddress, int writeAddress, int writeNumberBytes, long dataToWrite );

ICName → Понятное имя DSP(ИС)
deviceAddress → Адрес I2C или SPI
writeAddress → Адрес регистра для записи
writeNumberBytes → Количество байтов в 'dataToWrite' для записи в DSP
dataToWrite → Данные для записи (long == максимум 64 бита данных)

Записать данные в регистр, данные заданы как массив байтов

HResult ICRegisterWrite( string ICName, int writeAddress,int writeNumberBytes, byte[] dataToWrite );

ICName → Понятное имя DSP(ИС) для записи
writeAddress → Адрес регистра для записи
writeNumberBytes → Количество байтов в 'dataToWrite' для записи в DSP
dataToWrite → Данные для записи, массив байтов длиной writeNumberBytes

Записать данные в регистр по конкретному адресу устройства

HResult ICRegisterWrite( string ICName, int deviceAddress, int writeAddress,int writeNumberBytes, byte[] dataToWrite );

ICName → Понятное имя DSP(ИС)
deviceAddress → Адрес I2C или SPI
writeAddress → Адрес регистра для записи
writeNumberBytes → Количество байтов в 'dataToWrite' для записи в DSP
dataToWrite → Данные для записи, массив байтов длиной writeNumberBytes

Записать регистр безопасной загрузки (safeload)

HResult ICRegisterSafeload( string ICName, int safeloadRegister,long dataToWrite );

ICName → Понятное имя DSP(ИС) для записи
«safeloadRegister» = Адрес регистра для безопасной загрузки
dataToWrite → Данные для записи в регистр безопасной загрузки (5 байт)

Записать несколько смежных регистров безопасной загрузки

HResult ICRegisterSafeload( string ICName, int safeloadRegister,int writeNumberBytes, Byte[] dataToWrite );

ICName → Понятное имя DSP(ИС) для записи
safeloadRegister → Адрес регистра для безопасной загрузки
writeNumberBytes → Количество байтов данных в dataToWrite
dataToWrite → Данные для записи в регистр безопасной загрузки (5 байт)

Записать несколько регистров безопасной загрузки

HResult ICRegisterSafeload( string ICName, int[] writeAddresses,int[] writeNumberBytes, byte[] dataToWrite );

ICName → Понятное имя DSP(ИС) для записи
writeAddresses → Массив адресов для безопасной загрузки
writeNumberBytes → Количество байтов записи на адрес (для каждой записи writeAddresses)
dataToWrite → Массив данных для записи в регистры безопасной загрузки

Читать данные из регистра с конкретного адреса устройства

HResult ICRegisterRead( int numOfBytesToRead, byte[] dataRead, int protocol, int chipAddress, int readAddress, int addressWidth, int registerByteLength, int communicationChannel, int ICType);

numOfBytesToRead → Количество байтов для чтения из DSP
dataRead → Прочитать данные из регистра
protocol → Протокол передачи данных, SPI = 1 и I2C = 0
chipAddress → Адрес I2C или SPI
readAddress → Адрес регистра для чтения данных
addressWidth → Ширина адреса регистра для записи
registerByteLength → Длина регистра в байтах для записи
communicationChannel → Интерфейс связи, USBI = 0 и AARDVARK = 1
ICType → Тип ИС, ADAU145x/ADAU146x = 0, ADSP-214xx = 1, ADSP-SC5xx/ADSP-215xx = 2

Примечание: Обратитесь к этой ссылке для примера сценария https://wiki.analog.com/resources/tools-software/sigmastudio/usingsigmastudio/scripting/iscripted_samples#icregisterwrite_and_icregisterread

Читать данные из регистра, прочитанное значение возвращается в параметре метода

HResult ICRegisterRead( string ICName, int readAddress, int readNumberBytes,out long bytesRead );

ICName → Понятное имя DSP(ИС) для чтения
readAddress → Адрес регистра для чтения
readNumberBytes → Количество байтов для чтения
bytesRead → Возвращаемые данные при успешном чтении

Читать данные из регистра с конкретного адреса устройства

HResult ICRegisterRead( string ICName, int deviceAddress, int readAddress, int readNumberBytes, out long bytesRead );

ICName → Понятное имя DSP(ИС)
deviceAddress → Адрес I2C или SPI
readAddress → Адрес регистра для чтения
readNumberBytes → Количество байтов для чтения
bytesRead → Возвращаемые данные при успешном чтении

Читать данные из регистра, данные в виде массива байтов

HResult ICRegisterRead( string ICName, int readAddress, int readNumberBytes, ref byte[] bytesRead );

ICName → Понятное имя DSP(ИС) для чтения
readAddress → Адрес регистра для чтения
readNumberBytes → Количество байтов для чтения
bytesRead → Возвращаемые данные при успешном чтении

Читать данные из регистра с конкретного адреса устройства

HResult ICRegisterRead( string ICName, int deviceAddress, int readAddress, int readNumberBytes, ref byte[] bytesRead );

ICName → Понятное имя DSP(ИС)
deviceAddress → Адрес I2C или SPI
readAddress → Адрес регистра для чтения
readNumberBytes → Количество байтов для чтения
bytesRead → Возвращаемые данные при успешном чтении

Читать данные из регистра, прочитанное значение является возвращаемым типом

long ICRegisterRead( string ICName, int readAddress, int readNumberBytes );

ICName → Понятное имя DSP(ИС) для чтения
readAddress → Адрес регистра для чтения
readNumberBytes → Количество байтов для чтения

Читать буфер данных из регистра, возвращается массив прочитанных значений

byte[] ICRegisterRead( string ICName, int readAddress, int readNumberBytes, ref bool bRet );

ICName → Понятное имя DSP(ИС) для чтения
readAddress → Адрес регистра для чтения
readNumberBytes → Количество байтов для чтения
ret → Успешно ли выполнено чтение

Записать данные параметра с указанием целевого формата с фиксированной точкой

HResult ICParameterWrite( string ICName, int writeAddress, int intbits, int fracbits, float valToWrite );

ICName → Понятное имя DSP(ИС) для записи
writeAddress → Адрес параметра для начала записи данных
intbits = количество целых (знаковых) битов fracbits → количество дробных битов
valToWrite → Значение данных параметра для записи

Записать данные параметра с указанием целевого формата с фиксированной точкой и имени параметра вместо адреса параметра.

HResult ICParameterWrite( string icName, string paramName, int intbits, int fracbits, float valToWrite );

ICName → Понятное имя DSP(ИС) для записи
paramName → Имя параметра для начала записи данных
intbits = количество целых (знаковых) битов fracbits → количество дробных битов
valToWrite → Значение данных параметра для записи

Записать массив данных параметра с указанием целевого формата с фиксированной точкой

HResult ICParameterWrite( string ICName, int writeAddress, int intbits, int fracbits, int writeNumParams, float[] valsToWrite );

ICName → Понятное имя DSP(ИС) для записи
writeAddress → Адрес параметра для начала записи данных
intbits = количество целых (знаковых) битов fracbits → количество дробных битов
writeNumParams → Количество значений в valsToWrite
valsToWrite → Значения данных параметра для записи

Записать массив данных параметра с указанием целевого формата с фиксированной точкой и имени параметра вместо адреса параметра.

 HResult ICParameterWrite(string icName, string paramName, int intbits, int fracbits, int writeNumParams, float[] valsToWrite)

ICName → Понятное имя DSP(ИС) для записи
paramName → Имя параметра для начала записи данных
intbits = количество целых (знаковых) битов fracbits → количество дробных битов
writeNumParams → Количество значений в valsToWrite
valsToWrite → Значения данных параметра для записи

Записать данные параметра, значение с плавающей запятой

HResult ICParameterWrite( string ICName, int writeAddress, float valToWrite )

ICName → Понятное имя DSP(ИС) для записи
writeAddress → Адрес параметра для начала записи данных
valToWrite → Значение данных параметра для записи

Записать данные параметра как значение с плавающей запятой, используя имя параметра вместо адреса параметра.

HResult ICParameterWrite( string ICName, string paramName, float valToWrite )

ICName → Понятное имя DSP(ИС) для записи
paramName → Имя параметра для начала записи данных
valToWrite → Значение данных параметра для записи

Записать несколько смежных параметров, значение с плавающей запятой.

HResult ICParameterWrite( string ICName, int writeAddress, int writeNumParams, float[] valsToWrite );

ICName → Понятное имя DSP(ИС) для записи
writeAddress → Адрес параметра для начала записи данных
writeNumParams → Количество значений в valsToWrite
valsToWrite → Значения данных параметра для записи

Записать несколько смежных параметров как значение с плавающей запятой, используя имя параметра вместо адреса параметра.

HResult ICParameterWrite( string ICName, string paramName, int writeNumParams, float[] valsToWrite );

ICName → Понятное имя DSP(ИС) для записи
paramName → Имя параметра для начала записи данных
writeNumParams → Количество значений в valsToWrite
valsToWrite → Значения данных параметра для записи

Записать данные параметра безопасной загрузки с указанием целевого формата с фиксированной точкой

HResult ICParameterSafeload( string ICName, int writeAddress, int intbits, int fracbits, float valToWrite );

ICName → Понятное имя DSP(ИС) для записи
writeAddress → Адрес параметра для начала записи данных
intbits = количество целых (знаковых) битов fracbits → количество дробных битов
valToWrite → Значение данных параметра для записи

Записать массив данных параметра безопасной загрузки с указанием целевого формата с фиксированной точкой

HResult ICParameterSafeload( string ICName, int writeAddress, int intbits, int fracbits, int writeNumParams, float[] dataToWrite );

ICName → Понятное имя DSP(ИС) для записи
writeAddress → Адрес параметра, с которого начинается запись данных
intbits = количество целых (знаковых) битов fracbits → количество дробных битов
writeNumParams → Количество значений в valsToWrite
dataToWrite → Значения данных параметра для записи

Запись данных параметра через safeload, значение с плавающей запятой

HResult ICParameterSafeload( string ICName, int writeAddress, float valToWrite );

ICName → Понятное имя DSP(ИС) для записи
writeAddress → Адрес параметра, с которого начинается запись данных
writeNumParams → Количество значений в valsToWrite
valToWrite → Значение данных параметра для записи

Запись нескольких параметров через safeload, значения с плавающей запятой

HResult ICParameterSafeload( string ICName, int writeAddress, int writeNumParams, float[] valsToWrite );

ICName → Понятное имя DSP(ИС) для записи
writeAddress → Адрес параметра, с которого начинается запись данных
writeNumParams → Количество значений в valsToWrite
valsToWrite → Значения данных параметра для записи

Загрузка байтовых данных, разделённых запятыми, из текстового файла по определённому адресу параметра

HResult ICLoadDataFile( string ICName, string filename, int writeAddress );

ICName → Понятное имя DSP(ИС) для записи
filename → полностью указанное имя файла данных для загрузки
writeAddress → Адрес параметра, с которого начинается запись данных

Чтение данных параметра в формате с фиксированной запятой, возвращаемое значение преобразуется в число с плавающей запятой

float ICParameterRead( string ICName, int readAddress, int intbits, int fracbits );

ICName → Понятное имя DSP(ИС) для чтения
readAddress → Адрес параметра для чтения
intbits = количество целых (знаковых) битов fracbits → количество дробных битов

Чтение данных параметра в формате с фиксированной запятой по имени параметра, возвращаемое значение преобразуется в число с плавающей запятой

float ICParameterRead( string ICName, string paramName, int intbits, int fracbits );

ICName → Понятное имя DSP(ИС) для чтения
paramName → Имя параметра для чтения
intbits = количество целых (знаковых) битов fracbits → количество дробных битов

Чтение данных из параметра, данные возвращаются в виде числа с плавающей запятой

HResult ICParameterRead( string ICName, int readAddress, int intbits,int fracbits, out float valRead );

ICName → Понятное имя DSP(ИС) для чтения
readAddress → Адрес параметра для чтения
intbits = количество целых (знаковых) битов fracbits → количество дробных битов
valRead → возвращаемое прочитанное значение

Чтение массива данных параметра в формате с фиксированной запятой, возвращаемые значения преобразуются в float[]

float[] ICParameterRead( string ICName, int readAddress, int intbits, int fracbits, int readNumParams, ref bool bRet );

ICName → Понятное имя DSP(ИС) для чтения
readAddress → Адрес параметра для чтения
intbits = количество целых (знаковых) битов fracbits → количество дробных битов
readNumParams → Количество значений для чтения
bRet → результат, true, если чтение прошло успешно asdf

Чтение массива данных параметра в формате с фиксированной запятой по имени параметра, возвращаемые значения преобразуются в float[]

float[] ICParameterRead( string ICName, string paramName, int intbits, int fracbits, int readNumParams, ref bool bRet );

ICName → Понятное имя DSP(ИС) для чтения
paramName → Имя параметра для чтения
intbits = количество целых (знаковых) битов fracbits → количество дробных битов
readNumParams → Количество значений для чтения
bRet → результат, true, если чтение прошло успешно asdf

Чтение массива данных параметра в формате с фиксированной запятой, возвращаемые значения помещаются в float[]

HResult ICParameterRead( string ICName, int readAddress, int intbits, int fracbits, int readNumParams, ref float[] valsRead );

ICName → Понятное имя DSP(ИС) для чтения
readAddress → Адрес параметра для чтения
intbits = количество целых (знаковых) битов fracbits → количество дробных битов
readNumParams → Количество значений для чтения
valsRead → возвращаемые прочитанные значения

API возвращает имена и адреса всех параметров для ИС в текущей схеме.

HResult ICGetParamNamesAndAddresses(string icName, out string[] names, out int[] addresses);

icName → Понятное имя DSP(ИС) для чтения
names → Возвращает массив параметров для ИС в текущей схеме.
addresses Возвращает массив адресов параметров, соответствующих names[].

API возвращает имена и адреса всех параметров для ячейки/модуля в текущей схеме.

HResult ICGetParamNamesAndAddresses(string icName, string cellName, out string[] names, out int[] addresses);

icName → Понятное имя DSP(ИС) для чтения
cellName → Имя ячейки/модуля в схеме.
names → Возвращает массив параметров для ИС в текущей схеме.
addresses Возвращает массив адресов параметров, соответствующих names[].

API возвращает имена и адреса всех параметров для ячейки/модуля в текущей схеме.

HResult ICGetParamNamesAndAddresses(string icName, object cellObject, out string[] names, out int[] addresses);

icName → Понятное имя DSP(ИС) для чтения
cellObject → Объект ячейки/модуля.
names → Возвращает массив параметров для ИС в текущей схеме.
addresses Возвращает массив адресов параметров, соответствующих names[].

API возвращает адрес параметра для заданного имени параметра

HResult ICGetParamAddress(string icName, string paramName, out int address);

icName → Понятное имя DSP(ИС) для чтения
paramName → Имя параметра.
address → Возвращает адрес параметра.

API возвращает имя параметра для заданного адреса параметра

HResult ICGetParamName(string icName, int address, out string paramName);

icName → Понятное имя DSP(ИС) для чтения
address → Адрес параметра.
paramName → Возвращает имя параметра.

Перечисленные ниже функции используются для вставки объектов схемы в плату.

Вставка объекта в активный проект, возвращает ссылку на объект

object ObjectInsert( string typeName );

typeName → описание объекта (имя в панели инструментов)

Вставка объекта в конкретный открытый проект, возвращает ссылку на объект

object ObjectInsert( string projectName, string typeName );

projectName → Имя открытого файла проекта или полностью указанный путь
typeName → описание объекта (имя в панели инструментов)

Вставка объекта в активный проект в определённую позицию

object ObjectInsert( string typeName, Point pointInsert );

typeName → описание объекта (имя в панели инструментов)
pointInsert → System.Drawing.Point Позиция на экране схемы

Вставка объекта в конкретный открытый проект в определённую позицию

object ObjectInsert( string projectName, string typeName, Point point );

projectName → Имя открытого файла проекта или полностью указанный путь
typeName → описание объекта (имя в панели инструментов)
point → System.Drawing.Point Координаты на экране схемы

Вставка объекта в активный проект в определённую позицию

object ObjectInsert( string typeName, int X, int Y );

typeName → описание объекта (имя в панели инструментов)
X” & “Y → Координаты x и y на схеме для размещения объекта

Вставка объекта в конкретный открытый проект в определённую позицию

object ObjectInsert( string projectName, string typeName, int X, int Y );

projectName → Имя открытого файла проекта или полностью указанный путь
typeName → описание объекта (имя в панели инструментов)
X” & “Y → Координаты x и y на схеме для размещения объекта

Вставка объекта в активный проект, возвращает HResult

HResult ObjectInsert( string typeName, out string objectName );

typeName → описание объекта (имя в панели инструментов)
objectName → возвращает имя вставленного объекта, null в случае неудачи

Вставка объекта в конкретный открытый проект, возвращает HResult

HResult ObjectInsert( string projectName, string typeName,out string objectName );

projectName → Имя открытого файла проекта или полностью указанный путь
typeName → описание объекта (имя в панели инструментов)
objectName → возвращает имя вставленного объекта, null в случае неудачи

Вставка объекта в активный проект в определённую позицию

HResult ObjectInsert( string typeName, Point point, out string objectName );

typeName → описание объекта (имя в панели инструментов)
point → System.Drawing.Point Координаты на экране схемы
objectName → возвращает имя вставленного объекта, null в случае неудачи

Вставка объекта в конкретный открытый проект в определённую позицию

HResult ObjectInsert( string projectName, string typeName,Point point, out string objectName );

projectName → Имя открытого файла проекта или полностью указанный путь
typeName → описание объекта (имя в панели инструментов)
point → System.Drawing.Point Координаты на экране схемы
objectName → возвращает имя вставленного объекта или null в случае неудачи

Вставка объекта в активный проект в определённую позицию

HResult ObjectInsert( string typeName, int X, int Y, out string objectName );

typeName → описание объекта (имя в панели инструментов)
X” & “Y → Координаты x и y на схеме для размещения объекта
objectName → возвращает имя вставленного объекта, null в случае неудачи

Вставка объекта в конкретный открытый проект в определённую позицию

HResult ObjectInsert( string projectName, string typeName, int X, int Y,out string objectName );

projectName → имя открытого файла проекта или полностью указанный путь
typeName → описание объекта (имя в панели инструментов)
X” & “Y → Координаты x и y на схеме для размещения объекта
objectName → возвращает имя вставленного объекта, null в случае неудачи

ПРИМЕЧАНИЕ: Объекты схемы по умолчанию вставляются в выбранную в данный момент иерархическую плату вкладки «Схема» (Schematic). Используйте функцию 'BlockObjectInsert' вместо функции 'ObjectInsert' для вставки объектов схемы во вкладку «Блок-схема» (Block Schematic).

Приведённые ниже функции используются для удаления объектов из проектов.

Удаление объекта в активном проекте

HResult ObjectRemove( string objectName );

objectName → Имя объекта для удаления

Удаление объекта из конкретного открытого проекта

HResult ObjectRemove( string projectName, string objectName );

projectName → Имя открытого файла проекта или полностью указанный путь
objectName → Имя объекта для удаления

Удаление объекта в активном проекте

HResult ObjectRemove( object object );

object → Ссылка на объект для удаления

Удаление объекта из конкретного открытого проекта

HResult ObjectRemove( string projectName, object object );

projectName → Имя открытого файла проекта или полностью указанный путь
object → Ссылка на объект для удаления

Используйте приведённые ниже функции для соединения входов и выходов объектов в проекте.

Соединение выхода одного объекта со входом другого в активном проекте

HResult ObjectConnect( string fromName, int fromOutPinIndex,string toName, int toInPinIndex );

fromName → Имя объекта, ОТ которого выполняется соединение
fromOutPinIndex → Индекс выходного вывода, ОТ которого выполняется соединение (начиная с нуля)
toName → Имя объекта, К которому выполняется соединение
toInPinIndex → Индекс входного вывода, К которому выполняется соединение (начиная с нуля)

Соединение выходов объектов со входами в конкретном открытом проекте

HResult ObjectConnect( string projectName, string fromName,int fromOutPinIndex, string toName, int toInPinIndex);

projectName → Имя открытого файла проекта или полностью указанный путь
fromName → Имя объекта, ОТ которого выполняется соединение
fromOutPinIndex → Индекс выходного вывода, ОТ которого выполняется соединение (начиная с нуля)
toName → Имя объекта, К которому выполняется соединение
toInPinIndex → Индекс входного вывода, К которому выполняется соединение (начиная с нуля)

Соединение выхода одного объекта со входом другого в активном проекте

HResult ObjectConnect( object fromObject, int fromOutPinIndex,object toObject, int toInPinIndex );

fromObject → Ссылка на объект, ОТ которого выполняется соединение
fromOutPinIndex → Индекс выходного вывода, ОТ которого выполняется соединение (начиная с нуля)
toObject → Ссылка на объект, К которому выполняется соединение
toInPinIndex → Индекс входного вывода, К которому выполняется соединение (начиная с нуля)

Соединение выхода одного объекта со входом другого в конкретном открытом проекте

HResult ObjectConnect( string projectName, object fromObject,int fromOutPinIndex, object toObject, int toInPinIndex );

projectName → Имя открытого файла проекта или полностью указанный путь
fromObject → Ссылка на объект, ОТ которого выполняется соединение
fromOutPinIndex → Индекс выходного вывода, ОТ которого выполняется соединение (начиная с нуля)
toObject → Ссылка на объект, К которому выполняется соединение
toInPinIndex → Индекс входного вывода, К которому выполняется соединение (начиная с нуля)

Приведённые ниже функции используются для разъединения входов и выходов объектов в проекте.

Разъединение выхода и входа пары объектов в активном проекте

HResult ObjectDisconnect( string fromName, int fromOutPinIndex,string toName, int toInPinIndex );

fromName → Имя объекта, ОТ которого выполняется разъединение
fromOutPinIndex → Индекс выходного вывода, ОТ которого выполняется разъединение (начиная с нуля)
toName → Имя объекта, ОТ которого выполняется разъединение
toInPinIndex → Индекс входного вывода, ОТ которого выполняется разъединение (начиная с нуля)

Разъединение выхода и входа пары объектов в конкретном открытом проекте

HResult ObjectDisconnect( string projectName, string fromName,int fromOutPinIndex, string toName, int toInPinIndex );

projectName → Имя открытого файла проекта или полностью указанный путь
fromName → Имя объекта, ОТ которого выполняется разъединение
fromOutPinIndex → Индекс выходного вывода, ОТ которого выполняется разъединение (начиная с нуля)
toName → Имя объекта, ОТ которого выполняется разъединение
toInPinIndex → Индекс входного вывода, ОТ которого выполняется разъединение (начиная с нуля)

Разъединение выхода и входа пары объектов в активном проекте

HResult ObjectDisconnect( object fromObject, int fromOutPinIndex,object toObject, int toInPinIndex );

fromObject → Ссылка на объект, ОТ которого выполняется разъединение
fromOutPinIndex → Индекс выходного вывода, ОТ которого выполняется разъединение (начиная с нуля)
toObject → Ссылка на объект, ОТ которого выполняется разъединение
toInPinIndex → Индекс входного вывода, ОТ которого выполняется разъединение (начиная с нуля)

Разъединение выхода и входа пары объектов в конкретном открытом проекте

HResult ObjectDisconnect( string projectName, object fromObject,int fromOutPinIndex, object toObject, int toInPinIndex );

projectName → Имя открытого файла проекта или полностью указанный путь
fromObject → Ссылка на объект, ОТ которого выполняется разъединение
fromOutPinIndex → Индекс выходного вывода, ОТ которого выполняется разъединение (начиная с нуля)
toObject → Ссылка на объект, К которому выполняется соединение
toInPinIndex → Индекс входного вывода, ОТ которого выполняется разъединение (начиная с нуля)

Следующие функции выводят любое сообщение в окно вывода в редакторе сценариев.

HResult Print( string message);
HResult PrintLine( string message);

Следующий пример кода показывает, как читать параметры из файла с помощью файлового ввода-вывода C#.

// #LANGUAGE# C#
// Get Cell object
 
ss.ProjectLinkCompileDownload();
object obj = ss.GetCellObject("Gain1");
System.Reflection.FieldInfo[] memberInfos = ss.ObjectGetFields(obj);
System.Collections.ArrayList arr1 = null;
foreach (System.Reflection.FieldInfo memberInfo in memberInfos) 
{
	if (memberInfo.Name == "controlarr")
	{
	    arr1  = (System.Collections.ArrayList)memberInfo.GetValue(obj);
		break;
	}
}
System.Reflection.PropertyInfo prop = ss.ObjectGetProperty(arr1[0], "LGain");
 
string pathSource = @"D:\testdata.txt";
FileStream fsSource = new FileStream(pathSource, FileMode.Open, FileAccess.Read);
System.IO.StreamReader sr = new System.IO.StreamReader(fsSource, System.Text.Encoding.ASCII);
 
while (!sr.EndOfStream)
{
	string myString = sr.ReadLine();
        float fval = 0;
	float.TryParse(myString, out fval);
	prop.SetValue(arr1[0], (double) fval, null);
	System.Threading.Thread.Sleep(2000);
}
fsSource.Dispose();
 
// #LANGUAGE# C#

Приведённые ниже функции могут использоваться для управления свойствами объектов.

Управление свойствами или параметрами объекта в активном проекте

HResult ObjectSetProperties( string opcode, string objectName, params object[] propertyParams );

opcode → Код операции для выполнения (см. ниже)
objectName → Имя объекта для обновления
propertyParams → Параметры, связанные с указанным кодом операции

Управление свойствами или параметрами объекта в активном проекте

HResult ObjectSetProperties( string opcode, object object, params object[] propertyParams );

opcode → Код операции для выполнения (см. ниже)
object → Ссылка на объект для обновления
propertyParams → Параметры, связанные с указанным кодом операции

Управление свойствами или параметрами объекта в конкретном открытом проекте

HResult ObjectSetProperties( string projectName, string opcode, string objectName, params object[] propertyParams );

projectName → Имя открытого файла проекта или полностью указанный путь
opcode → Код операции для выполнения (см. ниже)
objectName → Имя объекта для обновления
propertyParams → Параметры, связанные с указанным кодом операции

Управление свойствами или параметрами объекта в конкретном открытом проекте

HResult ObjectSetProperties( string projectName, string opcode, object object, params object[] propertyParams );

projectName → Имя открытого файла проекта или полностью указанный путь
opcode → Код операции для выполнения (см. ниже)
object → Ссылка на объект для обновления
propertyParams → Параметры, связанные с указанным кодом операции

Получение свойств или параметров объекта в активном проекте

HResult ObjectGetProperties( string opcode, string objectName, out object[] getPropVal,params object[] propertyParams );

opcode → Код операции для выполнения (см. ниже)
objectName → Имя объекта для обновления
getPropVal → Полученное свойство или параметры
propertyParams → Параметры, связанные с указанным кодом операции

Получение свойств или параметров объекта в активном проекте

HResult ObjectGetProperties( string opcode, object object, out object[] getPropVal, params object[] propertyParams );

opcode → Код операции для выполнения (см. ниже)
object → Ссылка на объект для обновления
getPropVal → Полученное свойство или параметры
propertyParams → Параметры, связанные с указанным кодом операции

Получение свойств или параметров объекта в активном проекте

HResult ObjectGetProperties( string projectName, string opcode, string objectName,out object[] getPropVal, params object[] propertyParams );

projectName → Имя открытого файла проекта или полностью указанный путь
opcode → Код операции для выполнения (см. ниже)
objectName → Имя объекта для обновления
getPropVal → Полученное свойство или параметры
propertyParams → Параметры, связанные с указанным кодом операции

Получение свойств или параметров объекта в активном проекте

HResult ObjectGetProperties( string projectName, string opcode, object object, out object[] getPropVal,params object[] propertyParams );

projectName → Имя открытого файла проекта или полностью указанный путь
opcode → Код операции для выполнения (см. ниже)
object → Ссылка на объект для обновления
getPropVal → Полученное свойство или параметры
propertyParams → Параметры, связанные с указанным кодом операции

Интерфейсы свойств требуют код операции (Operation Code), который определяет тип выполняемой операции. Соответствующие коды операций зависят от типа объекта. Некоторые коды операций применимы ко всем объектам (например, setPosition и setName); другие специфичны для определённых категорий объектов. Основные коды операций перечислены в таблице ниже:

Таблица 2: Параметры кода операции и свойств

ПРИМЕЧАНИЕ. Имена значений управления можно просмотреть во всплывающей подсказке. Обратитесь к разделу Просмотр имен параметров управления .

Приведенные ниже функции могут использоваться для доступа к методам, свойствам и полям объекта SigmaStudio с помощью отражений C#.

В модулях схемы SigmaStudio используются два типа объектов: объект ячейки (Cell Object) и объект алгоритма (Algorithm Object). Объект ячейки содержит информацию, связанную с GUI. Объект алгоритма содержит информацию, связанную с алгоритмом. В одном объекте ячейки может быть несколько объектов алгоритма.

object GetCellObject(string objectName);
object[] GetAlgorithmObjects(string objectName);

objectName → Имя объекта ячейки.

API использует метод GetProperty() отражения и возвращает PropertyInfo для модуля с именем 'objectName' на схеме. ObjectGetProperties() возвращает все открытые свойства объекта.

PropertyInfo ObjectGetProperty(string objectName, string propertyName);
PropertyInfo[] ObjectGetProperties(string objectName);

objectName → Имя объекта, для которого требуется получить информацию о свойствах
propertyName → Имя свойства, которое требуется получить из объекта.

API использует метод GetField() отражения и возвращает FieldInfo для модуля с именем 'objectName' на схеме. ObjectGetFields() возвращает все открытые поля объекта.

FieldInfo ObjectGetField(string objectName, string fieldName);
FieldInfo [] ObjectGetFields(string objectName);

objectName → Имя объекта, для которого требуется получить информацию о полях
fieldName → Имя поля, которое требуется получить из объекта.

API использует метод GetMethod() отражения и возвращает MethodInfo для модуля с именем 'objectName' на схеме. ObjecMethodss() возвращает все открытые методы объекта.

MethodInfo ObjectGetMethod(string objectName, string methodName);
MethodInfo [] ObjectGetMethods(string objectName);

objectName → Имя объекта, для которого требуется получить информацию о методах
methodName → Имя метода, который требуется получить из объекта.

Ниже показан пример доступа к флажку в модуле отключения звука (mute) с помощью отражения.

object obj = ss.GetCellObject("Mute1");
System.Reflection.FieldInfo[] memberInfos = ss.ObjectGetFields(obj);
System.Collections.ArrayList arr = null;
ss.PrintLine("Mute fields are received ");
foreach (System.Reflection.FieldInfo memberInfo in memberInfos) 
{	
        // control array contains all the Controls in the module.
	if (memberInfo.Name == "controlarr")
	{
	        arr  = (System.Collections.ArrayList)memberInfo.GetValue(obj);
		break;
	}
}
 
System.Reflection.PropertyInfo[] props = ss.ObjectGetProperties(arr[0]);
foreach (System.Reflection.PropertyInfo prop in props) 
{
   ss.PrintLine(prop.Name);
   if (prop.Name == "IsChecked")
   {
        // Set the Checkbox status to true
	prop.SetValue(arr[0], true, null);
   }
}
 
// Wait for 5s
System.Threading.Thread.Sleep(5000);
 
// Set the checkbox to false
System.Reflection.PropertyInfo propInfo = ss.ObjectGetProperty(arr[0],"IsChecked");
propInfo.SetValue(arr[0], false, null);

В следующем примере вызывается метод 'PackDataAllControls' из объекта ячейки. Этот метод загружает все параметры из модуля.

object obj = ss.GetCellObject("Mute1");
 
// Print all the methods
System.Reflection.MethodInfo[] memberInfos = ss.ObjectGetMethods(obj);
foreach (System.Reflection.MethodInfo memberInfo in memberInfos) 
{	
   ss.PrintLine(memberInfo.Name);
}
 
// Get Pack All Controls method and call it.
System.Reflection.MethodInfo methodInfo = ss.ObjectGetMethod(obj, "PackDataAllControls");
ss.PrintLine(methodInfo.Name);
methodInfo.Invoke(obj, new object[]{});

Приведенная ниже функция может использоваться для управления настройками SigmaStudio.

Управление настройками SigmaStudio в активном проекте

HResult DesignSettings(string cmd, params object[] arg);

cmd → Код операции команды настройки для изменения
arg → Измененное значение настройки. Должно быть строкового типа данных

Таблица 3: Команды и аргументы для API настроек
1 x.y.z обозначает версию SigmaStudio for SHARC. Информацию о версии SigmaStudio for SHARC см. в примечаниях к выпуску

Управление свойствами в окне управления ИС (IC Control window)

HResult SetICControlProperties(string ICName, string cmd, object arg);

ICName → Понятное имя DSP (ИС), которое требуется изменить
cmd → Код операции команды свойства для изменения
arg → Измененное значение настройки

Таблица 4: Команда и аргумент для API изменения свойств окна управления ИС

Приведенная ниже функция может использоваться для управления подключаемыми модулями.

Включение или отключение подключаемого модуля, добавленного в окно «Дополнения» (Add-Ins) SigmaStudio

HResult ModifyPlugInState ( string plugin, bool state);

plugin → имя подключаемого модуля в виде строки
state → «True» или «False», указывающее, следует ли «включить» или «отключить» подключаемый модуль

Первый аргумент, который является именем подключаемого модуля, может быть либо полным путем к DLL-файлу подключаемого модуля, указанным в списке «Дополнения», либо только именем файла DLL подключаемого модуля. SigmaStudio сначала попытается сопоставить строку аргумента с полным путем подключаемых модулей в списке «Дополнения». Если совпадение не найдено, строка сопоставляется с именем файла подключаемых модулей. Если в списке «Дополнения» присутствует несколько подключаемых модулей с именем, переданным в качестве аргумента, эта функция изменяет только первое вхождение в списке. Имя подключаемого модуля не чувствительно к регистру.

Функция имеет два перегруженных метода, как показано в прототипе-1 и прототипе-2 ниже.
Это API для обработки пакетов с плавающей запятой и, следовательно, применимо только для SHARC.

HResult ICParameterSafeload ( string ICname, int32 WriteAddress, single DataToWrite)

Описание
Метод отправляет данные параметра по адресу, указанному адресом записи, для указанной ИС. Параметры будут загружены в целевое устройство с использованием механизма «Safeload».

Параметры
Имя: ICname
Тип: String
Описание: Имя ИС, на которую должны быть отправлены данные

Имя:WriteAddress
Тип:int32
Описание: Смещение адреса, по которому должен быть записан параметр

Имя:DataToWrite
Тип:Single
Описание: Значение параметра с плавающей запятой одинарной точности, которое должно быть записано в память целевого устройства.

HResult ICParameterSafeload ( string ICname, int32 WriteAddress, int32 WriteNumParams, single[] DataToWrite)

Описание
Метод отправляет массив данных параметров размером «WriteNumParams» по адресу, указанному адресом записи, для указанной ИС. Параметры будут загружены в целевое устройство с использованием механизма «Safeload».

Параметры
Имя: ICname
Тип: String
Описание: Имя ИС, на которую должны быть отправлены данные

Имя:WriteAddress
Тип:int32
Описание: Смещение адреса, по которому должен быть записан параметр

Имя:WriteNumParams
Тип:int32
Описание: Количество параметров, которые должны быть записаны в память параметров целевого устройства

Имя:DataToWrite
Тип:Single
Описание: Массив значений параметров с плавающей запятой одинарной точности, которые должны быть записаны в память параметров целевого устройства.

Функция имеет два перегруженных метода, как показано в прототипе-1 и прототипе-2 ниже.
Это API для обработки пакетов с плавающей запятой и, следовательно, применимо только для SHARC.

HResult ICParameterWrite ( string ICname, int32 WriteAddress, single DataToWrite)

Описание
Метод отправляет данные параметра по адресу, указанному адресом записи, для указанной ИС. Параметры будут загружены в целевое устройство без использования механизма «Safeload».

Параметры
Имя: ICname
Тип: String
Описание: Имя ИС, на которую должны быть отправлены данные

Имя:WriteAddress
Тип:int32
Описание: Смещение адреса, по которому должен быть записан параметр

Имя:DataToWrite
Тип:Single
Описание: Значение параметра с плавающей запятой одинарной точности, которое должно быть записано в память целевого устройства.

HResult ICParameterWrite ( string ICname, int32 WriteAddress, int32 WriteNumParams, single[] DataToWrite)

Описание
Метод отправляет массив данных параметров размером «WriteNumParams» по адресу, указанному адресом записи, для указанной ИС. Параметры будут загружены в целевое устройство блоком без использования механизма «Safeload».

Параметры
Имя: ICname
Тип: String
Описание: Имя ИС, на которую должны быть отправлены данные

Имя:WriteAddress
Тип:int32
Описание: Смещение адреса, по которому должен быть записан параметр

Имя:WriteNumParams
Тип:int32
Описание: Количество параметров, которые должны быть записаны в память параметров целевого устройства

Имя:DataToWrite
Тип:Single
Описание: Массив значений параметров с плавающей запятой одинарной точности, которые должны быть записаны в память параметров целевого устройства.

Это API для обработки пакетов с плавающей запятой и, следовательно, применимо только для SHARC.

float ICParameterRead ( string ICname, int32 readAddress)

Описание
Метод считывает данные параметра из адреса, указанного адресом чтения, для указанной ИС.

Параметры
Имя: ICname
Тип: String
Описание: Имя ИС, из которой должны быть считаны данные

Имя:readAddress
Тип:int32
Описание: Смещение адреса в памяти параметров, из которого должен быть считан параметр

Это применимо только для целевого устройства SHARC, где возможна загрузка с использованием файла загрузчика (Loader File).

HResult SHARCTargetBoot (string ICName, string fileName, ArrayList bootArgs)

Описание
Метод используется для загрузки целевого устройства SHARC с помощью файла загрузчика.

Параметры
Имя: ICname
Тип: String
Описание: Имя ИС, которую необходимо загрузить

Имя:Filename
Тип:String
Описание: Полный путь к LDR-файлу

Имя:bootArgs
Тип:ArrayList
Описание: Аргументы для конфигурации загрузки ArrayList с опцией загрузки (2, 3, 4, 5 или 10) в качестве первой записи 2: Аналоговый вход (Analog-In) 3: Цифровой вход (Digital-In) 4: Только цифровой выход (Digital-Out alone) 5: Совместное использование аналогового/цифрового (Analog\Digital Co-existence) 10: Совместное использование аналогового/цифрового (цифровые часы) (Analog\Digital Co-existence (Digital Clock))

Это API применимо только для целевого устройства SHARC для получения информации о MIPS от целевого устройства.

float SHARCReadMIPS (string ICName)

Описание
Метод используется для чтения MIPS, потребляемых аппаратным обеспечением целевого устройства SHARC.

Параметры
Имя: ICname
Тип: String
Описание: Имя ИС, из которой необходимо считать MIPS

Это API применимо только для целевого устройства SHARC для получения версии целевой библиотеки от целевого устройства.

uint SHARCReadLibVersion (string ICName)

Описание
Метод используется для чтения номера версии целевой библиотеки, работающей на целевом процессоре SHARC.

Параметры
Имя: ICname
Тип: String
Описание: Имя ИС, из которой должна быть получена версия

Список общих функций и их прототипов приведен ниже.

Отмена действия в активном файле проекта

HResult ScriptUndo();

Отмена действия в конкретном файле проекта

HResult ScriptUndo( string projectName );

projectName → Имя открытого файла проекта или полный путь к нему

Повтор действия в активном файле проекта

HResult ScriptRedo();

Повтор действия в конкретном файле проекта

HResult ScriptRedo( string projectName );

projectName → Имя открытого файла проекта или полный путь к нему

Приостановить выполнение скрипта на delay Milliseconds

HResult ScriptDelay( int delayMilliseconds );

delayMilliseconds → Величина задержки в миллисекундах

Запустить скрипт

HResult ScriptRun( string script );

script → код скрипта в виде System.String
Запустить файл скрипта

HResult ScriptRunFile( string scriptFilename );

scriptFilename → Полное имя файла скрипта