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

Структура инициализации для устройств типа "Memory". Подробнее...

#include <RshInitMemory.h>

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

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

enum  Control {
  FreqSingle = 0x0, AutoStartOff = 0x0, FreqDouble = 0x1, FreqQuadro = 0x2,
  AutoStartOn = 0x4
}
 Список дополнительных опций сбора данных Подробнее...
 
- Открытые типы inherited from RshInitADC
enum  StartType {
  Program = 0x1, Timer = 0x2, External = 0x4, Internal = 0x8,
  FrequencyExternal = 0x10, Master = 0x20
}
 Список режимов запуска Подробнее...
 
enum  ControlSynchro {
  FrequencySwitchOff = 0x0, SlopeFront = 0x0, SlopeDecline = 0x2, FrequencySwitchToMinimum = 0x4,
  FrequencySwitchToMaximum = 0x8
}
 Список дополнительных опций сбора данных Подробнее...
 

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

 RshInitMemory ()
 
 RshInitMemory (RshInitADC const &obj)
 
 RshInitMemory (RshInitMemory const &obj)
 
RshInitMemoryoperator= (const RshInitMemory &obj)
 
RshInitMemoryoperator= (const RshInitDMA &obj)
 
bool operator== (RshInitMemory &obj) const
 
bool operator!= (RshInitMemory &obj) const
 
void SetAutoStartOn (bool on=true)
 Установка или снятие RshInitMemory::AutoStartOn. Подробнее...
 
bool IsAutoStartOn () const
 Проверка наличия флага RshInitMemory::AutoStartOn. Подробнее...
 
void SetFreqModeSingle ()
 Установка флага RshInitMemory::FreqSingle. Подробнее...
 
void SetFreqModeDouble ()
 Установка флага RshInitMemory::FreqDouble. Подробнее...
 
void SetFreqModeQuadro ()
 Установка флага RshInitMemory::FreqQuadro. Подробнее...
 
bool IsSingleFreqModeActive () const
 Проверка наличия флага RshInitMemory::FreqSingle. Подробнее...
 
bool IsDoubleFreqModeActive () const
 Проверка наличия флага RshInitMemory::FreqDouble. Подробнее...
 
bool IsQuadroFreqModeActive () const
 Проверка наличия флага RshInitMemory::FreqQuadro. Подробнее...
 
- Открытые члены inherited from RshInitADC
 RshInitADC (const RshDataTypes type=rshInitADC, const size_t sizeType=sizeof(RshInitADC))
 
 RshInitADC (RshInitADC const &obj)
 
RshInitADCoperator= (const RshInitADC &obj)
 
bool operator== (RshInitADC &obj) const
 
bool operator!= (RshInitADC &obj) const
 
U32 ActiveChannelsNumber () const
 Число активных каналов в массиве каналов. Подробнее...
 
void SetSynchroSlopeFront ()
 Установка флага RshInitADC::SlopeFront. Подробнее...
 
void SetSynchroSlopeDecline ()
 Установка флага RshInitADC::SlopeDecline. Подробнее...
 
bool IsSynchroSlopeFrontActive () const
 Проверка наличия флага RshInitADC::SlopeFront. Подробнее...
 
bool IsSynchroSlopeDeclineActive () const
 Проверка наличия флага RshInitADC::SlopeDecline. Подробнее...
 
void SetSynchroFreqSwitchOff ()
 Установка флага RshInitADC::FrequencySwitchOff. Подробнее...
 
void SetSynchroFreqSwitchToMin ()
 Установка флага RshInitADC::FrequencySwitchToMinimum. Подробнее...
 
void SetSynchroFreqSwitchToMax ()
 Установка флага RshInitADC::FrequencySwitchToMaximum. Подробнее...
 
bool IsSynchroFreqSwitchToMinActive () const
 Проверка наличия флага RshInitADC::FrequencySwitchToMinimum. Подробнее...
 
bool IsSynchroFreqSwitchToMaxActive () const
 Проверка наличия флага RshInitADC::FrequencySwitchToMaximum. Подробнее...
 
- Открытые члены inherited from RshBaseType
 RshBaseType (const RshDataTypes type=rshTypeUndefined, const size_t typeSize=sizeof(RshBaseType))
 Конструктор Подробнее...
 
const char * GetTypeName () const
 

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

RshSynchroChannel channelSynchro
 Параметры входа внешней синхронизации Подробнее...
 
U32 control
 Дополнительные опции Подробнее...
 
U32 preHistory
 Размер предыстории Подробнее...
 
U32 startDelay
 Задержка старта Подробнее...
 
U32 hysteresis
 Гистерезис Подробнее...
 
U32 packetNumber
 Количество пакетов Подробнее...
 
- Открытые атрибуты inherited from RshInitADC
U32 startType
 Режим запуска сбора данных Подробнее...
 
U32 bufferSize
 Размер буфера в отсчетах Подробнее...
 
double frequency
 Частота дискретизации в Гц Подробнее...
 
RSH_BUFFER_CHANNEL channels
 Настройки аналоговых каналов Подробнее...
 
double threshold
 Уровень синхронизации Подробнее...
 
U32 controlSynchro
 Дополнительные параметры синхронизации Подробнее...
 
- Открытые атрибуты inherited from RshBaseType
const size_t _typeSize
 Размер структуры данных или класса. Подробнее...
 
const RshDataTypes _type
 Идентификатор типа данных. Подробнее...
 

Друзья

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

Additional Inherited Members

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

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

Структура инициализации для устройств типа "Memory".

Обычно, данная структура используется для высокочастотных устройств. Узнать, поддерживается ли эта структура библиотекой абстракции устройства можно, используя капс RSH_CAPS_SOFT_INIT_MEMORY.
Характерные особенности устройств типа "Memory":
высокая частота дискретизации, наличие собственной памяти, расширенные возможности синхронизации.

Прим.
Название "Memory" у структуры осталось по историческим причинам - данная структура выступает наследником таких структур из SDK1, как ADCInitParametersMemory и ADCInitParametersMemory1
Примеры:
IRshDevice_DoubleFreqMode_RU.cpp, LA-n10-12PCI_StartStop.cpp, LA-n10-12USB_StartStop.cpp, LA-n10M8-100PCI_StartStop.cpp, LA-n10M8-500PCI_StartStop.cpp, LA-n1USB_StartStop.cpp, LA-n20-12PCI_StartStop.cpp, LA-n2USB_StartStop.cpp, Python_Continuous.cpp, Python_StartStop.cpp, RshChannelSetup_RU.cpp, RshInitMemroySynchroChannel_RU.cpp и Sirius_StartStop.cpp.

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

Список дополнительных опций сбора данных

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

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

Обычный режим

Удвоение и учетверение частоты не используется. Данный режим используется по умолчанию и подходит для всех устройств.
Взаимоисключающий с флагами RshInitMemory::FreqDouble и RshInitMemory::FreqQuadro

См. также
RSH_CAPS_DEVICE_DOUBLE_FREQUENCY_MODE | RSH_CAPS_DEVICE_QUADRO_FREQUENCY_MODE
AutoStartOff 

Автозапуск выключен

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

См. также
RSH_CAPS_DEVICE_AUTO_START_MODE | RSH_GET_DEVICE_AUTO_START_INTERVAL_SET
FreqDouble 

Удвоение частоты

Если данный флаг активен, устройство будет работать в режиме удвоения частоты дискретизации. Этот флаг можно включить только для устройств, которые поддерживают данный режим работы (RSH_CAPS_DEVICE_DOUBLE_FREQUENCY_MODE). Взаимоисключающий с флагами RshInitMemory::FreqSingle и RshInitMemory::FreqQuadro

См. также
RSH_CAPS_DEVICE_DOUBLE_FREQUENCY_MODE
FreqQuadro 

Учетверение частоты

Если данный флаг активен, устройство будет работать в режиме учетверения частоты дискретизации. Этот флаг можно включить только для устройств, которые поддерживают данный режим работы (RSH_CAPS_DEVICE_QUADRO_FREQUENCY_MODE). Взаимоисключающий с флагами RshInitMemory::FreqSingle и RshInitMemory::FreqDouble

См. также
RSH_CAPS_DEVICE_QUADRO_FREQUENCY_MODE
AutoStartOn 

Автозапуск включен

Автоматический запуск сбора данных выключен. Данный флаг актуален только для устройств с поддержкой режима RSH_CAPS_DEVICE_AUTO_START_MODE.
Когда данный режим включен, устройство будет циклически запускать процесс сбора и передачи данных с заданным интервалом, используя текущие настройки сбора. Нужно вызвать метод IRshDevice::Start() только один раз для запуска процесса, и затем просто получать данные до тех пор, пока это необходимо (вызов метода IRshDevice::Stop() останавливает процесс).

См. также
RSH_CAPS_DEVICE_AUTO_START_MODE | RSH_GET_DEVICE_AUTO_START_INTERVAL_SET

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

RshInitMemory::RshInitMemory ( )
RshInitMemory::RshInitMemory ( RshInitADC const &  obj)
RshInitMemory::RshInitMemory ( RshInitMemory const &  obj)

Методы

bool RshInitMemory::IsAutoStartOn ( ) const

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

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

bool RshInitMemory::IsDoubleFreqModeActive ( ) const

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

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

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

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

bool RshInitMemory::IsQuadroFreqModeActive ( ) const

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

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

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

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

bool RshInitMemory::IsSingleFreqModeActive ( ) const

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

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

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

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

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

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

RshInitMemory & RshInitMemory::operator= ( const RshInitMemory obj)
RshInitMemory & RshInitMemory::operator= ( const RshInitDMA obj)
bool RshInitMemory::operator== ( RshInitMemory obj) const
void RshInitMemory::SetAutoStartOn ( bool  on = true)

Установка или снятие RshInitMemory::AutoStartOn.

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

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

void RshInitMemory::SetFreqModeDouble ( )

Установка флага RshInitMemory::FreqDouble.

Задает режим работы с удвоением частоты дискретизации

Примеры:
IRshDevice_DoubleFreqMode_RU.cpp.

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

void RshInitMemory::SetFreqModeQuadro ( )

Установка флага RshInitMemory::FreqQuadro.

Задает режим работы с учетверением частоты дискретизации

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

void RshInitMemory::SetFreqModeSingle ( )

Установка флага RshInitMemory::FreqSingle.

Задает режим работы "обычный", без удвоения/учетверения частоты

Перекрестные ссылки control, FreqDouble и FreqQuadro.

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

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

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

RshSynchroChannel RshInitMemory::channelSynchro

Параметры входа внешней синхронизации

Используя данное поле, можно задать необходимые параметры (коэффициент усиления, сопротвление входа и др.) для входа внешней синхронизации.

Прим.
Используйте капс RSH_CAPS_DEVICE_SYNCHRO_EXTERNAL чтобы проверить, есть ли возможность использовать программно настраиваемый вход внешней синхронизации.
См. также
RshSynchroChannel
Примеры:
RshInitMemroySynchroChannel_RU.cpp.

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

U32 RshInitMemory::control

Дополнительные опции

Комбинация флагов перечисления RshInitMemory::Control.

Примеры:
Python_Continuous.cpp.

Используется в IsAutoStartOn(), IsDoubleFreqModeActive(), IsQuadroFreqModeActive(), operator<<(), RshInitDMA::operator=(), operator=(), RshInitMemory(), SetAutoStartOn(), SetFreqModeDouble(), SetFreqModeQuadro() и SetFreqModeSingle().

U32 RshInitMemory::hysteresis

Гистерезис

В данном поле можно задать уровень гистерезиса. Диапазон допустимых значений - от 0 до 20. Подробности можно найти на странице с описанием синхронизации .

Прим.
Соответствующий капс-код: RSH_CAPS_DEVICE_HYSTERESIS

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

U32 RshInitMemory::packetNumber

Количество пакетов

Данная опция актуальна только для устройств, которые поддерживают пакетный режим сбора данных (см. RSH_CAPS_DEVICE_PACKET_MODE).
Используя данное поле, можно задать, сколько пакетов данных размера RshInitMemory::bufferSize нужно собрать за один цикл сбора данных.

Прим.
Если устройство не может работать в пакетном режиме, данный параметр игнорируется.

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

U32 RshInitMemory::preHistory

Размер предыстории

Данный параметр определяет, какая часть буфера данных будет использована для записи предыстории измерений. Диапазон допустимых значений - от 0 (предыстория не записывается) до 15 (15/16 буфера будет отдано под данные предыстории).
Дополнительные подробности можно найти в статье о синхронизации .

Прим.
Соответствующий капс-код: RSH_CAPS_DEVICE_PREHISTORY
Примеры:
Python_Continuous.cpp.

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

U32 RshInitMemory::startDelay

Задержка старта

В этом поле можно задать значение задержки старта для синхронизации. Подробности можно найти на странице с описанием синхронизации .

Прим.
Соответствующий капс-код: RSH_CAPS_DEVICE_START_DELAY
Необходимо сделать:
Провести ревизию устройств, у которых есть данная возможность, выбрать, в каком виде будет задаваться параметр.

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


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