rig_state Struct Reference
[Rig (transceiver) API]

Rig state containing live data and customized fields. More...

#include <rig.h>

Data Fields
hamlib_port_t	rigport
hamlib_port_t	pttport
hamlib_port_t	dcdport
double	vfo_comp
int	itu_region
freq_range_t	rx_range_list [FRQRANGESIZ]
freq_range_t	tx_range_list [FRQRANGESIZ]
struct tuning_step_list	tuning_steps [TSLSTSIZ]
struct filter_list	filters [FLTLSTSIZ]
cal_table_t	str_cal
chan_t	chan_list [CHANLSTSIZ]
shortfreq_t	max_rit
shortfreq_t	max_xit
shortfreq_t	max_ifshift
ann_t	announces
int	preamp [MAXDBLSTSIZ]
int	attenuator [MAXDBLSTSIZ]
setting_t	has_get_func
setting_t	has_set_func
setting_t	has_get_level
setting_t	has_set_level
setting_t	has_get_parm
setting_t	has_set_parm
gran_t	level_gran [RIG_SETTING_MAX]
gran_t	parm_gran [RIG_SETTING_MAX]
int	hold_decode
vfo_t	current_vfo
int	vfo_list
int	comm_state
rig_ptr_t	priv
rig_ptr_t	obj
int	transceive
int	poll_interval
freq_t	current_freq
rmode_t	current_mode
pbwidth_t	current_width
vfo_t	tx_vfo
int	mode_list

---

Detailed Description

Rig state containing live data and customized fields.

This struct contains live data, as well as a copy of capability fields that may be updated (ie. customized)

It is fine to move fields around, as this kind of struct should not be initialized like caps are.

---

Field Documentation

ann_t rig_state::announces

Announces bit field list

int rig_state::attenuator[MAXDBLSTSIZ]

Preamp list in dB, 0 terminated

chan_t rig_state::chan_list[CHANLSTSIZ]

Channel list, zero ended

int rig_state::comm_state

Comm port state, opened/closed.

freq_t rig_state::current_freq

Frequency currently set

rmode_t rig_state::current_mode

Mode currently set

vfo_t rig_state::current_vfo

VFO currently set

pbwidth_t rig_state::current_width

Passband width currently set

hamlib_port_t rig_state::dcdport

DCD port (internal use).

struct filter_list rig_state::filters[FLTLSTSIZ]

Mode/filter table, at -6dB

setting_t rig_state::has_get_func

List of get functions

setting_t rig_state::has_get_level

List of get level

setting_t rig_state::has_get_parm

List of get parm

setting_t rig_state::has_set_func

List of set functions

setting_t rig_state::has_set_level

List of set level

setting_t rig_state::has_set_parm

List of set parm

int rig_state::hold_decode

set to 1 to hold the event decoder (async) otherwise 0

int rig_state::itu_region

ITU region to select among freq_range_t

gran_t rig_state::level_gran[RIG_SETTING_MAX]

level granularity

shortfreq_t rig_state::max_ifshift

max absolute IF-SHIFT

shortfreq_t rig_state::max_rit

max absolute RIT

shortfreq_t rig_state::max_xit

max absolute XIT

int rig_state::mode_list

Complete list of modes for this rig

rig_ptr_t rig_state::obj

Internal use by hamlib++ for event handling.

gran_t rig_state::parm_gran[RIG_SETTING_MAX]

parm granularity

int rig_state::poll_interval

Event notification polling period in milliseconds

int rig_state::preamp[MAXDBLSTSIZ]

Preamp list in dB, 0 terminated

rig_ptr_t rig_state::priv

Pointer to private rig state data.

hamlib_port_t rig_state::pttport

PTT port (internal use).

hamlib_port_t rig_state::rigport

Rig port (internal use).

Examples:

/tests/testrig.c.

freq_range_t rig_state::rx_range_list[FRQRANGESIZ]

Receive frequency range list

cal_table_t rig_state::str_cal

S-meter calibration table

int rig_state::transceive

Whether the transceive mode is on

struct tuning_step_list rig_state::tuning_steps[TSLSTSIZ]

Tuning step list

freq_range_t rig_state::tx_range_list[FRQRANGESIZ]

Transmit frequency range list

vfo_t rig_state::tx_vfo

Tx VFO currently set

double rig_state::vfo_comp

VFO compensation in PPM, 0.0 to disable

int rig_state::vfo_list

Complete list of VFO for this rig

---

The documentation for this struct was generated from the following file:

• rig.h