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

Параметры аналогового канала Подробнее...

#include <RshChannel.h>

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

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

enum  Control {
  NotUsed = 0x0, NoSynchro = 0x0, Resist1MOhm = 0x0, DC = 0x0,
  ICPPowerOff = 0x0, Used = 0x1, Synchro = 0x2, AC = 0x4,
  Resist50Ohm = 0x8, ICPPowerOn = 0x10, FirstChannel = 0x10000
}
 Список опций для канала Подробнее...
 

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

 RshChannel (U32 Gain=1, U32 Control=0, double Adjustment=0.0)
 
 RshChannel (const RshChannel &obj)
 
RshChanneloperator= (const RshChannel &obj)
 
bool operator== (RshChannel &obj) const
 
bool operator!= (RshChannel &obj) const
 
bool operator< (const RshChannel &obj) const
 
bool operator> (const RshChannel &obj) const
 
void SetDefaultPatameters ()
 Установить параметры канала по умолчанию Подробнее...
 
void SetUsed (bool on=true)
 Установка использования канала при сборе данных Подробнее...
 
void SetFirstChannel (bool on=true)
 Установка или снятие флага RshChannel::FirstChannel. Подробнее...
 
void SetSynchro (bool on=true)
 Установка или снятие флага RshChannel::Synchro. Подробнее...
 
void SetICPPower (bool on=true)
 Установка или снятие флага RshChannel::ICPPowerOn. Подробнее...
 
void SetInputAC (bool on=true)
 Установка или снятие флага RshChannel::AC. Подробнее...
 
void SetInputDC (bool on=true)
 Установка или снятие флага RshChannel::AC. Подробнее...
 
void SetResist50Ohm (bool on=true)
 Установка или снятие флага RshChannel::AC. Подробнее...
 
void SetResist1MOhm (bool on=true)
 Установка или снятие флага RshChannel::AC. Подробнее...
 
bool IsUsed () const
 Проверка наличия флага RshChannel::Used. Подробнее...
 
bool IsFirstChannel () const
 Проверка наличия флага RshChannel::FirstChannel. Подробнее...
 
bool IsSynchroSource () const
 Проверка наличия флага RshChannel::Synchro. Подробнее...
 
bool IsICPPowerOn () const
 Проверка наличия флага RshChannel::ICPPowerOn. Подробнее...
 
bool IsInputACActive () const
 Проверка наличия флага RshChannel::AC. Подробнее...
 
bool IsInputDCActive () const
 Проверка наличия флага RshChannel::DC. Подробнее...
 
bool IsResist50OhmActive () const
 Проверка наличия флага RshChannel::Resist50Ohm. Подробнее...
 
bool IsResist1MOhmActive () const
 Проверка наличия флага RshChannel::Resist1MOhm. Подробнее...
 
- Открытые члены inherited from RshBaseType
 RshBaseType (const RshDataTypes type=rshTypeUndefined, const size_t typeSize=sizeof(RshBaseType))
 Конструктор Подробнее...
 
const char * GetTypeName () const
 

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

U32 gain
 Коэффициент усиления Подробнее...
 
U32 control
 Дополнительные флаги Подробнее...
 
double adjustment
 Подстройка уровня входного напряжения Подробнее...
 
- Открытые атрибуты inherited from RshBaseType
const size_t _typeSize
 Размер структуры данных или класса. Подробнее...
 
const RshDataTypes _type
 Идентификатор типа данных. Подробнее...
 

Друзья

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

Additional Inherited Members

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

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

Параметры аналогового канала

Используя данную структуру, можно задать параметры аналогового входного канала.
Обычно, данная структура используется как элемент списка каналов RshBufferType (RSH_BUFFER_CHANNEL), передаваемый с другими данными (в структуре инициализации) в метод IRshDevice::Init().

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

Список опций для канала

Дополнительные параметры канала, которые могут быть заданы в поле RshChannel::control.

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

Канал НЕ будет использоваться при сборе данных

Взаимоисключающий с RshChannel::Used

NoSynchro 

Канал НЕ будет использоваться в качестве источника синхронизации

Взаимоисключающий с RshChannel::Synchro

Resist1MOhm 

Установить входное сопротивление канала 1МОм

Взаимоисключающий с RshChannel::Resist50Ohm

DC 

Установить состояние входа "открытый".

Взаимоисключающий с RshChannel::AC

ICPPowerOff 

Отключение ICP питания канала

Взаимоисключающий с RshChannel::ICPPowerOn

Used 

Канал будет использоваться при сборе данных

Взаимоисключающий с RshChannel::NotUsed

Synchro 

Канал будет использоваться в качестве источника синхронизации

Взаимоисключающий с RshChannel::NoSynchro

AC 

Установить состояние входа "закрытый".

Взаимоисключающий с RshChannel::DC

Resist50Ohm 

Установить входное сопротивление канала 50Ом

Взаимоисключающий с RshChannel::Resist1MOhm

ICPPowerOn 

Включение ICP питания канала

Взаимоисключающий с RshChannel::ICPPowerOff

FirstChannel 

Выбрать канал в качестве первого канала для оцифровки

Большинство устройств не поддерживает данную опцию.

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

RshChannel::RshChannel ( U32  Gain = 1,
U32  Control = 0,
double  Adjustment = 0.0 
)
RshChannel::RshChannel ( const RshChannel obj)

Методы

bool RshChannel::IsFirstChannel ( ) const

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

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

bool RshChannel::IsICPPowerOn ( ) const

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

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

bool RshChannel::IsInputACActive ( ) const

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

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

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

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

bool RshChannel::IsInputDCActive ( ) const

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

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

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

bool RshChannel::IsResist1MOhmActive ( ) const

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

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

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

bool RshChannel::IsResist50OhmActive ( ) const

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

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

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

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

bool RshChannel::IsSynchroSource ( ) const

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

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

bool RshChannel::IsUsed ( ) const

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

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

Используется в RshInitADC::ActiveChannelsNumber().

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

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

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

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

bool RshChannel::operator< ( const RshChannel obj) const

Перекрестные ссылки gain.

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

Перекрестные ссылки adjustment, control и gain.

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

Перекрестные ссылки adjustment, control, gain и RSH_CMPDOUBLE.

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

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

bool RshChannel::operator> ( const RshChannel obj) const

Перекрестные ссылки gain.

void RshChannel::SetDefaultPatameters ( )

Установить параметры канала по умолчанию

gain = 1; adjustment = 0.0; control = 0;

Перекрестные ссылки adjustment, control и gain.

void RshChannel::SetFirstChannel ( bool  on = true)

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

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

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

void RshChannel::SetICPPower ( bool  on = true)

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

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

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

void RshChannel::SetInputAC ( bool  on = true)

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

Аргументы
[in]onЕсли передано значение true, флаг будет установлен, если false, то флаг будет снят. Установка флага RshChannel::AC приводит к снятию флага RshChannel::DC; снятие флага RshChannel::AC приводит к установке флага RshChannel::DC.

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

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

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

void RshChannel::SetInputDC ( bool  on = true)

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

Аргументы
[in]onЕсли передано значение true, флаг будет установлен, если false, то флаг будет снят. Установка флага RshChannel::DC приводит к снятию флага RshChannel::AC; снятие флага RshChannel::DC приводит к установке флага RshChannel::AC.

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

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

void RshChannel::SetResist1MOhm ( bool  on = true)

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

Аргументы
[in]onЕсли передано значение true, флаг будет установлен, если false, то флаг будет снят. Установка флага RshChannel::Resist1MOhm приводит к снятию флага RshChannel::Resist50Ohm; снятие флага RshChannel::Resist1MOhm приводит к установке флага RshChannel::Resist50Ohm.

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

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

void RshChannel::SetResist50Ohm ( bool  on = true)

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

Аргументы
[in]onЕсли передано значение true, флаг будет установлен, если false, то флаг будет снят. Установка флага RshChannel::Resist50Ohm приводит к снятию флага RshChannel::Resist1MOhm; снятие флага RshChannel::Resist50Ohm приводит к установке флага RshChannel::Resist1MOhm.

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

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

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

void RshChannel::SetSynchro ( bool  on = true)

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

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

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

void RshChannel::SetUsed ( bool  on = true)

Установка использования канала при сборе данных

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

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

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

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

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

double RshChannel::adjustment

Подстройка уровня входного напряжения

Подстройка (смещение) уровня входного напряжения для данного канала. Данный параметр задается в вольтах.

См. также
RSH_CAPS_DEVICE_INPUT_LEVEL_ADJUSTMENT

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

U32 RshChannel::control

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

Комбинация по 'ИЛИ' элементов перечисления RshChannel::Control. Если установить флаг, который не поддерживается данным устройством, он будет проигнорирован (при этом, ошибки не возникнет).

Прим.
По умолчанию, данный параметр равен нулю, что соответствует следующей комбинации флагов:
RshChannel::NotUsed | RshChannel::NoSynchro | RshChannel::Resist1MOhm | RshChannel::DC | RshChannel::ICPPowerOff

Используется в IsFirstChannel(), IsICPPowerOn(), IsInputACActive(), IsResist50OhmActive(), IsSynchroSource(), IsUsed(), operator<<(), operator=(), operator==(), SetDefaultPatameters(), SetFirstChannel(), SetICPPower(), SetInputAC(), SetResist50Ohm(), SetSynchro() и SetUsed().

U32 RshChannel::gain

Коэффициент усиления

Коэффициент усиления, который будет использован для данного канала при сборе данных

Прим.
Получить список доступных коэффициентов усиления можно, вызвав метод IRshDevice::Get() с параметром RSH_GET_DEVICE_GAIN_LIST.

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


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