Rsh API  SDK 2.1
Документация по программированию
 Указатель Классы Файлы Функции Переменные Определения типов Перечисления Элементы перечислений Друзья Макросы Страницы
Открытые типы | Открытые члены | Открытые атрибуты | Друзья | Полный список членов класса
Структура RshInitGSPF

Cтруктура инициализации для генераторов Подробнее...

#include <RshInitGSPF.h>

Граф наследования:RshInitGSPF:
Inheritance graph
[см. легенду]
Граф связей класса RshInitGSPF:
Collaboration graph
[см. легенду]

Открытые типы

enum  Attenuator {
  AttenuationOff = 0x0, Attenuation6dB = 0x1, Attenuation12dB = 0x2, Attenuation18dB = 0x3,
  Attenuation24dB = 0x4, Attenuation30dB = 0x5, Attenuation36dB = 0x6, Attenuation42dB = 0x7
}
 Список режимов работы аттенюатора Подробнее...
 
enum  StartType { Program = 0x1, External = 0x4, FrequencyExternal = 0x10 }
 Список режимов запуска Подробнее...
 
enum  Control {
  FilterOff = 0x0, PlayOnce = 0x0, SynchroFront = 0x0, SynthesizerOff = 0x0,
  SynthesizerOn = 0x1, FilterOn = 0x2, PlayLoop = 0x4, SynchroDecline = 0x8
}
 Список дополнительных параметров генерации Подробнее...
 

Открытые члены

 RshInitGSPF ()
 
 RshInitGSPF (RshInitGSPF const &obj)
 
RshInitGSPFoperator= (const RshInitGSPF &obj)
 
bool operator== (RshInitGSPF &obj) const
 
bool operator!= (RshInitGSPF &obj) const
 
void SetFilterOn (bool on=true)
 Установка или снятие флага RshInitGSPF::FilterOn. Подробнее...
 
void SetSynthesizerOn (bool on=true)
 Установка или снятие флага RshInitGSPF::SynthesizerOn. Подробнее...
 
void SetSynchroSlopeFront ()
 Установка флага RshInitGSPF::SynchroFront. Подробнее...
 
void SetSynchroSlopeDecline ()
 Установка флага RshInitGSPF::SynchroDecline. Подробнее...
 
void SetPlayModeOnce ()
 Установка флага RshInitGSPF::PlayOnce. Подробнее...
 
void SetPlayModeLoop ()
 Установка флага RshInitGSPF::PlayLoop. Подробнее...
 
bool IsSynchroSlopeFrontActive () const
 Проверка наличия флага RshInitGSPF::SynchroFront. Подробнее...
 
bool IsSynchroSlopeDeclineActive () const
 Проверка наличия флага RshInitGSPF::SynchroDecline. Подробнее...
 
bool IsFilterOn () const
 Проверка наличия флага RshInitGSPF::FilterOn. Подробнее...
 
bool IsSynthesizerOn () const
 Проверка наличия флага RshInitGSPF::SynthesizerOn. Подробнее...
 
bool IsPlayModeOnceOn () const
 Проверка наличия флага RshInitGSPF::PlayOnce. Подробнее...
 
bool IsPlayModeLoopOn () const
 Проверка наличия флага RshInitGSPF::PlayLoop. Подробнее...
 
- Открытые члены inherited from RshBaseType
 RshBaseType (const RshDataTypes type=rshTypeUndefined, const size_t typeSize=sizeof(RshBaseType))
 Конструктор Подробнее...
 
const char * GetTypeName () const
 

Открытые атрибуты

U32 startType
 Режим запуска генерации сигнала Подробнее...
 
double frequency
 Частота дискретизации Подробнее...
 
U32 attenuator
 Аттенюатор Подробнее...
 
U32 control
 Дополнительные флаги Подробнее...
 
- Открытые атрибуты inherited from RshBaseType
const size_t _typeSize
 Размер структуры данных или класса. Подробнее...
 
const RshDataTypes _type
 Идентификатор типа данных. Подробнее...
 

Друзья

std::ostream & operator<< (std::ostream &out, const RshInitGSPF &obj)
 

Additional Inherited Members

- Открытые статические члены inherited from RshBaseType
static const char * GetTypeName (const RshDataTypes typeCode)
 Получение названия типа данных. Подробнее...
 

Подробное описание

Cтруктура инициализации для генераторов

Данная структура используется для управления генераторами сигнала серии ГСПФ.
Соответствующие капс-коды: RSH_CAPS_SOFT_GENERATION_IS_AVAILABLE и RSH_CAPS_SOFT_INIT_GSPF.

См. также
RshInitDAC
Примеры:
GSPF-052PCI_Generate.cpp и GSPF-053USB_Generate.cpp.

Перечисления

Список режимов работы аттенюатора

Элементы этого перечисления могут быть использованы в качестве значений для поля RshInitGSPF::attenuator.

Элементы перечислений
AttenuationOff 

Ослабление не используется

Attenuation6dB 

Ослабление 6дБ

Attenuation12dB 

Ослабление 12дБ

Attenuation18dB 

Ослабление 18дБ

Attenuation24dB 

Ослабление 24дБ

Attenuation30dB 

Ослабление 30дБ

Attenuation36dB 

Ослабление 36дБ

Attenuation42dB 

Ослабление 42дБ

Список дополнительных параметров генерации

Флаги из этого списка можно использовать в поле RshInitGSPF::control, чтобы задействовать дополнительные режимы генерации сигнала.

Элементы перечислений
FilterOff 

Выключить фильтр НЧ

Выключение ФНЧ. Взаимоисключающий с RshInitGSPF::FilterOn

PlayOnce 

Одиночное проигрование

Записанный в буфер сигнал будет выведен на ЦАП, после чего проигрование остановится.
Взаимоисключающий с RshInitGSPF::PlayLoop.

SynchroFront 

Запуск по фронту

Актуально только при использовании запуска с флагом RshInitGSPF::External.
Генерация сигнала начнется по фронту запускающего импульса. Взаимоисключающий с RshInitGSPF::SynchroDecline.

SynthesizerOff 

Синтезатор частоты не исползуется

ЦАП будет тактироваться от кварцевого генератора (с делителем)
Взаимоисключающий с RshInitGSPF::SynthesizerOn.

SynthesizerOn 

Использовать синтезатор частоты

Синтезатор частоты будет использоваться в качестве источника тактовых импульсов для ЦАП.
Взаимоисключающий с RshInitGSPF::SynthesizerOff.

FilterOn 

Включить фильтр НЧ

Включение ФНЧ с частотой среза 10.7МГц. Взаимоисключающий с RshInitGSPF::FilterOff

PlayLoop 

Циклическое проигрование

Записанный в буфер сигнал будет проигрываться циклически.
Взаимоисключающий с RshInitGSPF::PlayOnce.

Прим.
При использовании данного флага, сигнал будет проигрываться даже после завершения работы программы. Чтобы остановать проигрование, нужно вызвать метод IRshDevice::Stop().
SynchroDecline 

Запуск по спаду

Актуально только при использовании запуска с флагом RshInitGSPF::External.
Генерация сигнала начнется по спаду запускающего импульса. Взаимоисключающий с RshInitGSPF::SynchroFront.

Список режимов запуска

Элементы этого перечисления используются для задания режима запуска процесса генерации.
Чтобы выбрать режим, нужно установить одно из этих значений в поле RshInitGSPF::startType.

Элементы перечислений
Program 

Программный запуск

Генерация будет запущена сразу же после получения устройством команды на запуск.
Это означает, что ЦАП будет запущен сразу же после вызова метода IRshDevice::Start().

Прим.
"Сразу же" на самом деле происходит не мгновенно, так как всегда есть задержки - вызов функций, передача данных по шине, отклик устройства.
External 

Внешний запуск

Использовать внешний источник для запуска процесса генерации сигнала.
Генерация будет запущена по приходу соответствующего строба запуска на вход внешнего запуска.
Дополнительную информацию о необходимых параметрах запускающего сигнала можно найти в руководстве пользователя.

FrequencyExternal 

Использование внешней частоты дискретизации

ЦАП будет тактироваться от внешнего источника частоты дискретизации.
Дополнительную информацию о необходимых параметрах тактирующего сигнала можно найти в руководстве пользователя.

Конструктор(ы)

RshInitGSPF::RshInitGSPF ( )
RshInitGSPF::RshInitGSPF ( RshInitGSPF const &  obj)

Перекрестные ссылки attenuator, control, frequency и startType.

Методы

bool RshInitGSPF::IsFilterOn ( ) const

Проверка наличия флага RshInitGSPF::FilterOn.

Перекрестные ссылки control и FilterOn.

bool RshInitGSPF::IsPlayModeLoopOn ( ) const

Проверка наличия флага RshInitGSPF::PlayLoop.

Перекрестные ссылки control и PlayLoop.

Используется в IsPlayModeOnceOn().

Граф вызова функции:

bool RshInitGSPF::IsPlayModeOnceOn ( ) const

Проверка наличия флага RshInitGSPF::PlayOnce.

Перекрестные ссылки IsPlayModeLoopOn().

Граф вызовов:

bool RshInitGSPF::IsSynchroSlopeDeclineActive ( ) const

Проверка наличия флага RshInitGSPF::SynchroDecline.

Перекрестные ссылки control и SynchroDecline.

Используется в IsSynchroSlopeFrontActive().

Граф вызова функции:

bool RshInitGSPF::IsSynchroSlopeFrontActive ( ) const

Проверка наличия флага RshInitGSPF::SynchroFront.

Перекрестные ссылки IsSynchroSlopeDeclineActive().

Граф вызовов:

bool RshInitGSPF::IsSynthesizerOn ( ) const

Проверка наличия флага RshInitGSPF::SynthesizerOn.

Перекрестные ссылки control и SynthesizerOn.

bool RshInitGSPF::operator!= ( RshInitGSPF obj) const

Перекрестные ссылки operator==().

Граф вызовов:

RshInitGSPF & RshInitGSPF::operator= ( const RshInitGSPF obj)

Перекрестные ссылки attenuator, control, frequency и startType.

bool RshInitGSPF::operator== ( RshInitGSPF obj) const

Перекрестные ссылки attenuator, control, frequency, RSH_CMPDOUBLE и startType.

Используется в operator!=().

Граф вызова функции:

void RshInitGSPF::SetFilterOn ( bool  on = true)

Установка или снятие флага RshInitGSPF::FilterOn.

Аргументы
[in]onЕсли передано значение true, флаг будет установлен, если false, то флаг будет снят.

Перекрестные ссылки control и FilterOn.

void RshInitGSPF::SetPlayModeLoop ( )

Установка флага RshInitGSPF::PlayLoop.

Циклическое проигрывание сигнала (буфера). Сигнал будет проигрываться до вызова метода Stop().

Примеры:
GSPF-052PCI_Generate.cpp и GSPF-053USB_Generate.cpp.

Перекрестные ссылки control и PlayLoop.

void RshInitGSPF::SetPlayModeOnce ( )

Установка флага RshInitGSPF::PlayOnce.

Сигнал (буфер) будет проигран только один раз

Перекрестные ссылки control и PlayLoop.

void RshInitGSPF::SetSynchroSlopeDecline ( )

Установка флага RshInitGSPF::SynchroDecline.

Синхронизация по спаду

Перекрестные ссылки control и SynchroDecline.

void RshInitGSPF::SetSynchroSlopeFront ( )

Установка флага RshInitGSPF::SynchroFront.

Синхронизация по фронту

Перекрестные ссылки control и SynchroDecline.

void RshInitGSPF::SetSynthesizerOn ( bool  on = true)

Установка или снятие флага RshInitGSPF::SynthesizerOn.

Аргументы
[in]onЕсли передано значение true, флаг будет установлен, если false, то флаг будет снят.

Перекрестные ссылки control и SynthesizerOn.

Документация по друзьям класса и функциям, отноносящимся к классу

std::ostream& operator<< ( std::ostream &  out,
const RshInitGSPF obj 
)
friend

Данные класса

U32 RshInitGSPF::attenuator

Аттенюатор

Один из элементов перечисления RshInitGSPF::Attenuator.
С помощью этого поля можно задать дополнительное ослабление сигнала.
По умолчанию, ослабление не используется.

Прим.
При использовании аттенюатора, ослабление сигнала происходит уже после его формирования ЦАПом, непосредственно перед выдачей сигнала на выход генератора. Таким образом, используя аттенюатор, можно более полно использовать динамический диапазон ЦАП при генерации слабых сигналов.
Примеры:
GSPF-052PCI_Generate.cpp и GSPF-053USB_Generate.cpp.

Используется в operator<<(), operator=(), operator==() и RshInitGSPF().

U32 RshInitGSPF::control

Дополнительные флаги

Комбинация по 'ИЛИ' элементов перечисления RshInitGSPF::Control. Данное поле используется для управления дополнительными параметрами генерации сигнала, такими как использование синтезатора частоты, фильтра и др.

Прим.
По умолчанию, данный параметр равен нулю, что соответствует следующей комбинации флагов:
RshInitGSPF::SynthesizerOff | RshInitGSPF::FilterOff | RshInitGSPF::PlayOnce | RshInitGSPF::SynchroFront

Используется в IsFilterOn(), IsPlayModeLoopOn(), IsSynchroSlopeDeclineActive(), IsSynthesizerOn(), operator<<(), operator=(), operator==(), RshInitGSPF(), SetFilterOn(), SetPlayModeLoop(), SetPlayModeOnce(), SetSynchroSlopeDecline(), SetSynchroSlopeFront() и SetSynthesizerOn().

double RshInitGSPF::frequency

Частота дискретизации

Частота дискретизации, которая будет использована при генерации сигнала, в Гц.
В зависимости от состояния поля RshInitGSPF::control будет использована частота из списка частот (см. RSH_GET_DEVICE_FREQUENCY_LIST), либо близкая к заданной частота, созданная синтезатором частоты.

Примеры:
GSPF-052PCI_Generate.cpp и GSPF-053USB_Generate.cpp.

Используется в operator<<(), operator=(), operator==() и RshInitGSPF().

U32 RshInitGSPF::startType

Режим запуска генерации сигнала

Одна из констант перечисления RshInitGSPF::StartType, которая определяет, как будет запускаться генерация сигнала.

Примеры:
GSPF-052PCI_Generate.cpp и GSPF-053USB_Generate.cpp.

Используется в operator<<(), operator=(), operator==() и RshInitGSPF().


Объявления и описания членов структур находятся в файлах: