Main Page | Data Structures | Directories | File List | Data Fields | Globals | Related Pages | Examples

mem.c File Reference

Memory and channel interface. More...

#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include <stdio.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <hamlib/rig.h>

Functions

int HAMLIB_API rig_set_mem (RIG *rig, vfo_t vfo, int ch)
 set the current memory channel number
int HAMLIB_API rig_get_mem (RIG *rig, vfo_t vfo, int *ch)
 get the current memory channel number
int HAMLIB_API rig_set_bank (RIG *rig, vfo_t vfo, int bank)
 set the current memory bank
int HAMLIB_API rig_set_channel (RIG *rig, const channel_t *chan)
 set channel data
int HAMLIB_API rig_get_channel (RIG *rig, channel_t *chan)
 get channel data


Detailed Description

Memory and channel interface.

Author:
Stephane Fillod
Date:
2000-2005
Hamlib interface is a frontend implementing wrapper functions.

Function Documentation

int HAMLIB_API rig_get_channel RIG rig,
channel_t chan
 

get channel data

Parameters:
rig The rig handle
chan The location where to store the channel data
Retrieves the data associated with a channel. This channel can either be the state of a VFO specified by chan->vfo, or a memory channel specified with chan->vfo = RIG_VFO_MEM and chan->channel_num. See channel_t for more information.

Example:

  channel_t chan;
  int err;

  chan->vfo = RIG_VFO_MEM;
  chan->channel_num = 10;
  err = rig_get_channel(rig, &chan);
  if (err != RIG_OK)
        error("get_channel failed: %s", rigerror(err));

The rig_get_channel is supposed to have no impact on the current VFO and memory number selected. Depending on backend and rig capabilities, the chan struct may not be filled in completely.

Note: chan->ext_levels is a pointer to a newly mallocated memory. This is the responsability of the caller to manage and eventually free it.

Returns:
RIG_OK if the operation has been sucessful, otherwise a negative value if an error occured (in which case, cause is set appropriately).
See also:
rig_set_channel()

int HAMLIB_API rig_get_mem RIG rig,
vfo_t  vfo,
int *  ch
 

get the current memory channel number

Parameters:
rig The rig handle
vfo The target VFO
ch The location where to store the current memory channel number
Retrieves the current memory channel number. It is not mandatory for the radio to be in memory mode. Actually it depends on rigs. YMMV.

Returns:
RIG_OK if the operation has been sucessful, otherwise a negative value if an error occured (in which case, cause is set appropriately).
See also:
rig_set_mem()

int HAMLIB_API rig_set_bank RIG rig,
vfo_t  vfo,
int  bank
 

set the current memory bank

Parameters:
rig The rig handle
vfo The target VFO
bank The memory bank
Sets the current memory bank number. It is not mandatory for the radio to be in memory mode. Actually it depends on rigs. YMMV.

Returns:
RIG_OK if the operation has been sucessful, otherwise a negative value if an error occured (in which case, cause is set appropriately).
See also:
rig_set_mem()

int HAMLIB_API rig_set_channel RIG rig,
const channel_t chan
 

set channel data

Parameters:
rig The rig handle
chan The location of data to set for this channel
Sets the data associated with a channel. This channel can either be the state of a VFO specified by chan->vfo, or a memory channel specified with chan->vfo = RIG_VFO_MEM and chan->channel_num. See channel_t for more information.

The rig_set_channel is supposed to have no impact on the current VFO and memory number selected. Depending on backend and rig capabilities, the chan struct may not be set completely.

Returns:
RIG_OK if the operation has been sucessful, otherwise a negative value if an error occured (in which case, cause is set appropriately).
See also:
rig_get_channel()

int HAMLIB_API rig_set_mem RIG rig,
vfo_t  vfo,
int  ch
 

set the current memory channel number

Parameters:
rig The rig handle
vfo The target VFO
ch The memory channel number
Sets the current memory channel number. It is not mandatory for the radio to be in memory mode. Actually it depends on rigs. YMMV.

Returns:
RIG_OK if the operation has been sucessful, otherwise a negative value if an error occured (in which case, cause is set appropriately).
See also:
rig_get_mem()


Generated on Mon Apr 4 21:47:34 2005 for Hamlib - the C library reference by  doxygen 1.4.2