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

rotator.h File Reference

Hamlib rotator data structures. More...

#include <hamlib/rig.h>
#include <hamlib/rotlist.h>

Go to the source code of this file.

Data Structures

struct  rot_caps
 Rotator data structure. More...
struct  rot_state
 Live data and customized fields. More...
struct  rot
 This is the master data structure, acting as a handle for the controlled rotator. More...

Defines

#define ROT_RESET_ALL   1
 A macro that returns the flag for the reset operation.
#define ROT_FLAG_AZIMUTH   (1<<1)
 A macro that returns the azimuth flag.
#define ROT_FLAG_ELEVATION   (1<<2)
 A macro that returns the elevation flag.
#define ROT_MOVE_UP   (1<<1)
 A macro that returns the flag for the UP direction.
#define ROT_MOVE_DOWN   (1<<2)
 A macro that returns the flag for the DOWN direction.
#define ROT_MOVE_LEFT   (1<<3)
 A macro that returns the flag for the LEFT direction.
#define ROT_MOVE_CCW   ROT_MOVE_LEFT
 A macro that returns the flag for the counterclockwise direction.
#define ROT_MOVE_RIGHT   (1<<4)
 A macro that returns the flag for the RIGHT direction.
#define ROT_MOVE_CW   ROT_MOVE_RIGHT
 A macro that returns the flag for the clockwise direction.
#define rot_debug   rig_debug
 Convenience definition for debug level.

Typedefs

typedef rot ROT
 Rotator structure definition (see rot for details).
typedef float elevation_t
 Type definition for elevation.
typedef float azimuth_t
 Type definition for azimuth.
typedef int rot_reset_t
 Type definition for rotator reset.


Detailed Description

Hamlib rotator data structures.

This file contains the data structures and definitions for the Hamlib rotator API. see the rotator.c file for more details on the rotator API.


Define Documentation

#define rot_debug   rig_debug
 

Convenience definition for debug level.

This is just as convenience definition of the rotator debug level, and is the same as for the rig debug level.

See also:
rig_debug

#define ROT_MOVE_CCW   ROT_MOVE_LEFT
 

A macro that returns the flag for the counterclockwise direction.

This macro defines the value of the counterclockwise direction which can be used with the rot_move() function. This value is equivalent to ROT_MOVE_LEFT .

See also:
rot_move(), ROT_MOVE_UP, ROT_MOVE_DOWN, ROT_MOVE_LEFT, ROT_MOVE_RIGHT, ROT_MOVE_CW

#define ROT_MOVE_CW   ROT_MOVE_RIGHT
 

A macro that returns the flag for the clockwise direction.

This macro defines the value of the clockwise direction wich can be used with the rot_move() function. This value is equivalent to ROT_MOVE_RIGHT .

See also:
rot_move(), ROT_MOVE_UP, ROT_MOVE_DOWN, ROT_MOVE_LEFT, ROT_MOVE_CCW, ROT_MOVE_RIGHT

#define ROT_MOVE_DOWN   (1<<2)
 

A macro that returns the flag for the DOWN direction.

This macro defines the value of the DOWN direction which can be used with the rot_move() function.

See also:
rot_move(), ROT_MOVE_UP, ROT_MOVE_LEFT, ROT_MOVE_CCW, ROT_MOVE_RIGHT, ROT_MOVE_CW

#define ROT_MOVE_LEFT   (1<<3)
 

A macro that returns the flag for the LEFT direction.

This macro defines the value of the LEFT direction which can be used with the rot_move function.

See also:
rot_move(), ROT_MOVE_UP, ROT_MOVE_DOWN, ROT_MOVE_CCW, ROT_MOVE_RIGHT, ROT_MOVE_CW

#define ROT_MOVE_RIGHT   (1<<4)
 

A macro that returns the flag for the RIGHT direction.

This macro defines the value of the RIGHT direction which can be used with the rot_move() function.

See also:
rot_move(), ROT_MOVE_UP, ROT_MOVE_DOWN, ROT_MOVE_LEFT, ROT_MOVE_CCW, ROT_MOVE_CW

#define ROT_MOVE_UP   (1<<1)
 

A macro that returns the flag for the UP direction.

This macro defines the value of the UP direction which can be used with the rot_move() function.

See also:
rot_move(), ROT_MOVE_DOWN, ROT_MOVE_LEFT, ROT_MOVE_CCW, ROT_MOVE_RIGHT, ROT_MOVE_CW

#define ROT_RESET_ALL   1
 

A macro that returns the flag for the reset operation.

See also:
rot_reset(), rot_reset_t


Typedef Documentation

typedef float azimuth_t
 

Type definition for azimuth.

The azimuth_t type is used as parameter for the rot_set_position() and rot_get_position() functions.

Unless specified otherwise, the unit of azimuth_t is decimal degrees.

typedef float elevation_t
 

Type definition for elevation.

The elevation_t type is used as parameter for the rot_set_position() and rot_get_position() functions.

Unless specified otherwise, the unit of elevation_t is decimal degrees.

typedef int rot_reset_t
 

Type definition for rotator reset.

The rot_reset_t type is used as parameter for the rot_reset() API function.


Generated on Sat Sep 30 15:49:37 2006 for Hamlib - the C library reference by  doxygen 1.4.4