azcamutils.c File Reference

AzCam utility functions. More...

#include "azcam.h"

Functions
void	InitAzCam (azcam_t *cam)
	Initialize an azcam data structure.
void	AzCamInfo (azcam_t *cam)
	Print the contents of the struct on stdout.
int	ARCCommand (azcam_t *cam, char *cmdstr, char *reply)
	Send a raw command to the ARC Controller.

---

Detailed Description

AzCam utility functions.

The following are a suite of additional utility functions that provide additional functionality to an application using this client API.

Author:

R. Pogge, OSU Astronomy Dept. (pogge@astronomy.ohio-state.edu)

Date:

2005 May 17

---

Function Documentation

void InitAzCam (  azcam_t *  cam  )

Initialize an azcam data structure. Parameters: cam  pointer to an azcam struct with the server parameters Initialize the azcam data structure to default values. Many detector values take 0, which means "I don't know" to other routines in this API. This function should be called to clear out the azcam struct before filling it with valid data (e.g., from a setup file loaded by the application).

void AzCamInfo (  azcam_t *  cam  )

Print the contents of the struct on stdout. Parameters: cam  pointer to an azcam struct with the server parameters Prints the contents of the azcam struct on stdout in human-readable form.

int ARCCommand (  azcam_t *  cam, char *  cmdstr, char *  reply )

Send a raw command to the ARC Controller. Parameters: cam  pointer to an azcam struct with the server parameters cmdstr  command string to send reply  string to contain any reply text Returns: 0 if successful, -1 on errors, with error text in reply Sends a raw ARC Controller command to the AzCam server. Command strings are sent as-is with no validation, so if there is a syntax error on the server side, this function will report an error back to the calling application. A complete list of valid ARC Controller commands can be found in section 11 of the AzCam Programmers Reference Manual.

---