tifGetPosition
Section: Devices and Network Interfaces (4)
Updated: 2012-04-23 10:10
Index
Return to man pages list
NAME
tifGetPosition, tifGetStates, tifGetStatus, tifGetByName
- TCS data query library
SYNOPSIS
#include <tif.h>
ccsCOMPL_STAT tifGetPosition(tifPOSITION *position, ccsERROR *error = NULL)
ccsCOMPL_STAT tifGetStates(tifSTATES *states, ccsERROR *error = NULL)
ccsCOMPL_STAT tifGetStatus(tifSTATUS *status, ccsERROR *error = NULL)
ccsCOMPL_STAT tifGetByName(char *nameIndex, char *buffer,
dbTYPE *type = NULL,
ccsERROR *error = NULL)
DESCRIPTION
These functions form the TCS data query library. They return data items
which are stored in the TCS database branch, thus hiding the database
structure before the user.
tifGetPosition - get actual telescope position
tifGetStates - get TCS global state and sub-state
tifGetStatus - get telescope status information
tifGetByName - get single data item by name
position <OUT> current actual telescope position in (RA,dec) and (alt,az)
struct tifPOSITION
{
vltDOUBLE HA; // hour angle (HHMMSS.F)
vltDOUBLE RA; // right asc. mean place of J2000 (HHMMSS.F)
vltDOUBLE dec; // declin. mean place of J2000 (DDMMSS.F)
vltDOUBLE alt; // altitude (deg)
vltDOUBLE az; // azimuth (deg, S=0 E=90)
};
states <OUT> current TCS state and sub-state
What follows is the current definition for the
tifSTATES structure:
struct tifSTATES
{
vltINT32 tcsState; // TCS global state
vltINT32 tcsSubstate; // TCS sub-state
};
status <OUT> current telescope status (TBD)
What follows is the current definition for the
tifSTATUS structure:
struct tifSTATUS
{
// TBD
};
nameIndex <IN> a literal, specifying a named data item
type <OUT> the data type of this data item. If a NULL pointer is given,
it is ignored.
buffer <OUT> a user buffer, receiving the binary data item value
The user must take care os passing a buffer big enough
to store all the requested data.
error <OUT> error stack. If NULL is passed the default eccs error
stack is used.
The tifGetByName() returns the type of the specified data item in <type>
and its binary value in the passed user <buffer>. The data item <name> is
specified by a string. Convenience defines are provided in the
tif.h header file.
ENVIRONMENT
TCS_ENVNAME specifies the environment in which TCS runs
TCS_DBPOINT specifies the root point of the TCS database branch
RETURN VALUES
SUCCESS if everything ok
FAILURE if any error occured
Index
- NAME
-
- SYNOPSIS
-
- DESCRIPTION
-
- // TBD
-
- ENVIRONMENT
-
- RETURN VALUES
-
This document was created by
man2html,
using the manual pages.
Time: 10:10:00 GMT, April 23, 2012