sampParam.c File Reference

(Internal) Interface to Param objects. More...

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

Functions
Param	samp_newParam ()
	Create a new Param object.
void	samp_freeParam (Param param)
	Free the given Msg object.
Param	samp_paramInit (Msg msg)
	Get number of Params.
void	samp_addStringParam (Msg msg, char *keyw, String val)
void	samp_addMapParam (Msg msg, char *keyw, Map val)
	Add a parameter to the Param.
void	samp_addListParam (Msg msg, char *keyw, List val)
	Add a parameter to the Param.
void	samp_addIntParam (Msg msg, char *keyw, int val)
	Add a <SAMP int>=""> parameter to the Param.
void	samp_addFloatParam (Msg msg, char *keyw, float val)
	Add a <SAMP float>=""> parameter to the Param.
int	samp_paramLen (Msg msg)
	Get number of Params.

---

Detailed Description

(Internal) Interface to Param objects.

SAMPPARAM.C -- (Internal) Interface to Param objects.

param = samp_newParam () samp_freeParam (Param param)

param = samp_paramInit (Msg msg); samp_addStringParam (Msg msg, char *keyw, String val) samp_addListParam (Msg msg, char *keyw, List val) samp_addMapParam (Msg msg, char *keyw, Map val) N = samp_paramLen (Msg msg)

Author:

Mike Fitzpatrick

Date:

7/10/11

---

Function Documentation

void samp_addFloatParam	(	Msg	msg,
		char *	keyw,
		float	val
	)

Add a <SAMP float>=""> parameter to the Param.

SAMP_ADDFLOATPARAM -- Add a <SAMP float>=""> parameter to the Param.

Parameters:

	msg	handle to Msg object
	keyw	map keyword
	val	floating point value

Returns:

nothing

References samp_paramInit().

Referenced by samp_coordPointAtSky(), and samp_sendGeneric().

void samp_addIntParam	(	Msg	msg,
		char *	keyw,
		int	val
	)

Add a <SAMP int>=""> parameter to the Param.

SAMP_ADDINTPARAM -- Add a <SAMP int>=""> parameter to the Param.

Parameters:

	msg	handle to Msg object
	keyw	map keyword
	val	integer value

Returns:

nothing

References samp_paramInit().

Referenced by samp_sendGeneric(), and samp_tableHighlightRow().

void samp_addListParam	(	Msg	msg,
		char *	keyw,
		List	val
	)

Add a parameter to the Param.

SAMP_ADDLISTPARAM -- Add a List parameter to the Param.

Parameters:

	msg	handle to Msg object
	keyw	map keyword
	val	value list

Returns:

nothing

References samp_paramInit().

Referenced by samp_tableSelectRowList().

void samp_addMapParam	(	Msg	msg,
		char *	keyw,
		Map	val
	)

Add a parameter to the Param.

SAMP_ADDMAPPARAM -- Add a Map parameter to the Param.

Parameters:

	msg	handle to Msg object
	keyw	map keyword
	val	value map

Returns:

nothing

References samp_paramInit().

Referenced by samp_resourceLoad(), and samp_specLoadSSAGeneric().

void samp_freeParam

(

Param

param

)

Free the given Msg object.

SAMP_FREEPARAM -- Free the given Param object

Parameters:

param

Param object to free

Returns:

nothing

Param samp_newParam

(

void

)

Create a new Param object.

SAMP_NEWPARAM -- Create a new Param object

Returns:

handle to new Param

Referenced by samp_bibLoad(), samp_cmdExec(), samp_coordPointAtSky(), samp_envGet(), samp_envSet(), samp_imageLoadFITS(), samp_paramGet(), samp_paramSet(), samp_Ping(), samp_resourceLoad(), samp_sendGeneric(), samp_specLoadSSAGeneric(), samp_tableHighlightRow(), samp_tableLoadFITS(), samp_tableLoadVOTable(), and samp_tableSelectRowList().

Param samp_paramInit

(

Msg

msg

)

Get number of Params.

SAMP_PARAMINIT -- Get number of Params.

Parameters:

msg

handle to Msg object

Returns:

nothing

Referenced by samp_addFloatParam(), samp_addIntParam(), samp_addListParam(), and samp_addMapParam().

int samp_paramLen

(

Msg

msg

)

Get number of Params.

SAMP_PARAMLEN -- Get number of Params.

Parameters:

msg

handle to Msg object

Returns:

nothing