sampMTypes.c File Reference

SAMP interface procedures for application mtypes. More...

#include <stdlib.h>
#include <stdio.h>
#include <unistd.h>
#include <string.h>
#include <time.h>
#include <ctype.h>
#include "samp.h"

Functions

int samp_tableLoadVOTable (handle_t handle, String recip, String url, String tableId, String name)
 Tell an app to load a VOTable.
int samp_tableLoadFITS (handle_t handle, String recip, String url, String tableId, String name)
 Tell an app to load a FITS table.
int samp_tableHighlightRow (handle_t handle, String recip, String tableId, String url, int row)
 Tell an app to highlight a table row.
int samp_tableSelectRowList (handle_t handle, String recip, String tableId, String url, int rows[])
 Tell an app to select a list of table rows.
int samp_imageLoadFITS (handle_t handle, String recip, String url, String imageId, String name)
 Tell an app to load a FITS image.
int samp_coordPointAtSky (handle_t handle, String recip, float ra, float dec)
 Tell an app to point at an RA/Dec coordinate.
int samp_specLoadSSAGeneric (handle_t handle, String recip, String url, Map meta, String spectrumId, String name)
 Load a generic spectrum from an SSA service.
int samp_cmdExec (handle_t handle, String recip, String cmd)
 Execute a command in a remote application.
char * samp_envGet (handle_t handle, String recip, String name)
 Get an environment variable in a remote application.
int samp_envSet (handle_t handle, String recip, String name, String value)
 Set an environment variable in a remote application.
char * samp_paramGet (handle_t handle, String recip, String name)
 Get an parameter variable in a remote application.
int samp_paramSet (handle_t handle, String recip, String name, String value)
 Set an parameter variable in a remote application.
int samp_bibLoad (handle_t handle, String recip, String bibcode)
 Exchange a bibcode.
int samp_resourceLoad (handle_t handle, String recip, String type, String name, Map resMap)
 Exchange a resource list.
int samp_sendMsg (handle_t handle, String recip, Map msg)
 Send the specified message.


Detailed Description

SAMP interface procedures for application mtypes.

SAMPMTYPES.C -- SAMP interface procedures for application mtypes.

samp_tableLoadVOTable (handle, recip, url, tableId, name) samp_tableLoadFITS (handle, recip, url, tableId, name) samp_tableHighlightRow (handle, recip, tableId, url, row) samp_tableSelectRowList (handle, recip, tableId, url, rows[])

samp_imageLoadFITS (handle, recip, url, imageId, name) samp_coordPointAtSky (handle, recip, ra, dec)

samp_specLoadSSAGeneric (handle, recip, url, meta_map, specId, name) samp_cmdExec (handle, recip, cmd) samp_envGet (handle, recip, name) samp_envSet (handle, recip, name, value) samp_paramGet (handle, recip, name) samp_paramSet (handle, recip, name, value) samp_bibLoad (handle, recip, bibcode) samp_resourceLoad (handle, recip, type, resList[])

samp_sendMsg (handle, recip, Map msg_map)

Author:
Mike Fitzpatrick
Date:
7/18/11

Function Documentation

int samp_bibLoad ( handle_t  handle,
String  recip,
String  bibcode 
)

Exchange a bibcode.

SAMP_BIBLOAD -- Exchange a bibcode.

Parameters:
handle samp struct handle
recip name of recipient (or 'all')
bibcode Bibcode string
Returns:
SAMP_OK or SAMP_ERR

References Samp::hub, hub, samp_freeMsg(), samp_msgParam(), samp_newMsg(), samp_newParam(), and samp_sendMsg().

int samp_cmdExec ( handle_t  handle,
String  recip,
String  cmd 
)

Execute a command in a remote application.

SAMP_CMDEXEC -- Execute a command in a remote application.

Parameters:
handle samp struct handle
recip name of recipient (or 'all')
cmd Command string
Returns:
SAMP_OK or SAMP_ERR

References Samp::hub, hub, samp_freeMsg(), samp_msgParam(), samp_newMsg(), samp_newParam(), and samp_sendMsg().

int samp_coordPointAtSky ( handle_t  handle,
String  recip,
float  ra,
float  dec 
)

Tell an app to point at an RA/Dec coordinate.

SAMP_COORDPOINTATSKY -- Tell an app to point at an RA/Dec coordinate.

Parameters:
handle samp struct handle
recip name of recipient (or 'all')
ra RA of coord in degrees
dec Dec of coord in degrees
Returns:
SAMP_OK or SAMP_ERR

References Samp::hub, hub, samp_addFloatParam(), samp_freeMsg(), samp_msgParam(), samp_newMsg(), samp_newParam(), and samp_sendMsg().

char* samp_envGet ( handle_t  handle,
String  recip,
String  name 
)

Get an environment variable in a remote application.

SAMP_ENVGET -- Get an environment variable in a remote application.

Parameters:
handle samp struct handle
recip name of recipient (or 'all')
name Name of variable in receiver's environment
Returns:
Value of variable or NULL

References Samp::errortxt, Samp::hub, hub, Hub::id, Hub::privateKey, samp_app2id(), samp_freeMsg(), samp_msgParam(), samp_newMsg(), samp_newParam(), and Hub::timeout.

int samp_envSet ( handle_t  handle,
String  recip,
String  name,
String  value 
)

Set an environment variable in a remote application.

SAMP_ENVSET -- Set an environment variable in a remote application.

Parameters:
handle samp struct handle
recip name of recipient (or 'all')
name Name of variable in receiver's environment
value Value of variable or NULL
Returns:
SAMP_OK or SAMP_ERR

References Samp::hub, hub, samp_freeMsg(), samp_msgParam(), samp_newMsg(), samp_newParam(), and samp_sendMsg().

int samp_imageLoadFITS ( handle_t  handle,
String  recip,
String  url,
String  imageId,
String  name 
)

Tell an app to load a FITS image.

SAMP_IMAGELOADFITS -- Tell an app to load a FITS image.

Parameters:
handle samp struct handle
recip Message recipient (or "all" for broadcast)
url URL to table to be loaded
imageId ID assigned to image (optional)
name Name assigned to image (optional)
Returns:
SAMP_OK or SAMP_ERR

References Samp::hub, hub, samp_freeMsg(), samp_msgParam(), samp_newMsg(), samp_newParam(), and samp_sendMsg().

char* samp_paramGet ( handle_t  handle,
String  recip,
String  name 
)

Get an parameter variable in a remote application.

SAMP_PARAMGET -- Get an parameter variable in a remote application.

Parameters:
handle samp struct handle
recip name of recipient (or 'all')
name Name of variable in receiver's environment
Returns:
Value of variable or NULL

References Samp::errortxt, Samp::hub, hub, Hub::id, Hub::privateKey, samp_app2id(), samp_freeMsg(), samp_msgParam(), samp_newMsg(), samp_newParam(), and Hub::timeout.

int samp_paramSet ( handle_t  handle,
String  recip,
String  name,
String  value 
)

Set an parameter variable in a remote application.

SAMP_PARAMSET -- Set an parameter variable in a remote application.

Parameters:
handle samp struct handle
recip name of recipient (or 'all')
name Name of variable in receiver's environment
value Value of variable or NULL
Returns:
SAMP_OK or SAMP_ERR

References Samp::hub, hub, samp_freeMsg(), samp_msgParam(), samp_newMsg(), samp_newParam(), and samp_sendMsg().

int samp_resourceLoad ( handle_t  handle,
String  recip,
String  type,
String  name,
Map  resMap 
)

Exchange a resource list.

SAMP_RESOURCELOAD -- Exchange a resource list.

Parameters:
handle samp struct handle
recip Name of recipient (or 'all')
type Resource type (or NULL)
name Descriptive name (optional)
resMap Resource map
Returns:
SAMP_OK or SAMP_ERR

References Samp::hub, hub, samp_addMapParam(), samp_freeMsg(), samp_msgParam(), samp_newMsg(), samp_newParam(), and samp_sendMsg().

int samp_sendMsg ( handle_t  handle,
String  recip,
Map  msg 
)

Send the specified message.

SAMP_SENDMSG -- Send the specified message.

Parameters:
handle samp struct handle
recip Name of recipient (or 'all')
msg Message map
Returns:
SAMP_OK or SAMP_ERR

References Samp::clients, Samp::msgMode, Samp::nclients, samp_app2id(), samp_call(), samp_callAll(), samp_callAndWait(), samp_notify(), samp_notifyAll(), and samp_setErr().

Referenced by samp_bibLoad(), samp_cmdExec(), samp_coordPointAtSky(), samp_envSet(), samp_imageLoadFITS(), samp_paramSet(), samp_resourceLoad(), samp_tableHighlightRow(), samp_tableLoadFITS(), and samp_tableLoadVOTable().

int samp_specLoadSSAGeneric ( handle_t  handle,
String  recip,
String  url,
Map  meta,
String  spectrumId,
String  name 
)

Load a generic spectrum from an SSA service.

SAMP_SPECLOADSSAGENERIC -- Load a generic spectrum from an SSA service.

Parameters:
handle samp struct handle
recip name of recipient (or 'all')
url URL of spectrum to load
meta Metadata map describing data found at the URL
spectrumId Identifier for spectrum (optional)
name Name used to label spectrum (optional);
Returns:
SAMP_OK or SAMP_ERR

References Samp::hub, and hub.

int samp_tableHighlightRow ( handle_t  handle,
String  recip,
String  tableId,
String  url,
int  row 
)

Tell an app to highlight a table row.

SAMP_TABLEHIGHLIGHTROW -- Tell an app to highlight a table row.

Parameters:
handle samp struct handle
recip Message recipient (or "all" for broadcast)
tableId ID associated with a previously loaded table
url URL to table to be loaded
rows List of (zero-based) row indices
Returns:
SAMP_OK or SAMP_ERR

References Samp::hub, hub, samp_addIntParam(), samp_freeMsg(), samp_msgParam(), samp_newMsg(), samp_newParam(), and samp_sendMsg().

int samp_tableLoadFITS ( handle_t  handle,
String  recip,
String  url,
String  tableId,
String  name 
)

Tell an app to load a FITS table.

SAMP_TABLELOADFITS -- Tell an app to load a FITS table.

Parameters:
handle samp struct handle
recip Message recipient (or "all" for broadcast)
url URL to table to be loaded
tableId ID assigned to table (optional)
name Name assigned to table (optional)
Returns:
SAMP_OK or SAMP_ERR

References Samp::hub, hub, samp_freeMsg(), samp_msgParam(), samp_newMsg(), samp_newParam(), and samp_sendMsg().

int samp_tableLoadVOTable ( handle_t  handle,
String  recip,
String  url,
String  tableId,
String  name 
)

Tell an app to load a VOTable.

SAMP_TABLELOADVOTABLE -- Tell an app to load a VOTable.

Parameters:
handle samp struct handle
recip Message recipient (or "all" for broadcast)
url URL to table to be loaded
tableId ID assigned to table (optional)
name Name assigned to table (optional)
Returns:
SAMP_OK or SAMP_ERR

References Samp::hub, hub, samp_freeMsg(), samp_msgParam(), samp_newMsg(), samp_newParam(), and samp_sendMsg().

int samp_tableSelectRowList ( handle_t  handle,
String  recip,
String  tableId,
String  url,
int  rows[] 
)

Tell an app to select a list of table rows.

SAMP_TABLESELECTROWLIST -- Tell an app to select a list of table rows.

Parameters:
handle samp struct handle
recip Message recipient (or "all" for broadcast)
tableId ID associated with a previously loaded table
url URL to table to be loaded
rows Array of (zero-based) row indices
Returns:
SAMP_OK or SAMP_ERR

References Samp::hub, and hub.


Generated on Wed Aug 31 13:23:14 2011 for SAMP Client Library by  doxygen 1.5.9