- removed functions with void *data in the interface

- added RemoveSetUpdateCallback
This commit is contained in:
zolliker
2008-05-14 14:21:48 +00:00
parent f996d69612
commit bbb0b971a9
2 changed files with 61 additions and 92 deletions

View File

@@ -54,11 +54,17 @@ pHdbCallback MakeReadOnlyCallback();
pHdbCallback MakeCheckPermissionCallback(int priv);
/**
* make a callback which directly updates a
* paramter after setting. Usefule for program parameters.
* paramter after setting. Useful for program parameters.
* @return a suitably initialized callback structure setting
* program parameters
*/
pHdbCallback MakeSetUpdateCallback();
/**
* Remove a SetUpdate callback. This is useful for chaning the
* behaviour of a node created with the hmake command
* @param node the node
*/
void RemoveSetUpdateCallback(pHdb node);
/**
* make a callback which starts a parameter driving.
* @param sicsObject The SICS object to drive.
@@ -149,19 +155,6 @@ pHdbCallback MakeMemSetCallback(float *address);
* @return A new suitably configured Hdb parameter or NULL when out of memory.
*/
pHdb MakeSICSHdbPar(char *name, int priv, hdbValue v);
/**
* make a simple SICS hdb parameter. Setting it will call update immediately. Use
* this for program parameters.
* @param name The name of the parameter
* @param priv The privilege required to change that parameter
* @param dataType The datatype for the new parameter.
* @param length The length of any arrays
* @param data Data to initalise the parameter with. Can be NULL, then
* no initialisation takes place.
* @return A new suitably configured Hdb parameter or NULL when out of memory.
*/
pHdb CreateSICSHdbPar(char *name, int priv, int dataType,
int length, void *data);
/**
* make a SICS hdb drivable parameter. Setting it will start the motor,
* virtual motor or environment parameter. This will call StartDevice
@@ -198,21 +191,6 @@ pHdb MakeSICSROPar(char *name, hdbValue v);
* @return A new suitably configured Hdb parameter or NULL when out of memory.
*/
pHdb MakeSICSScriptPar(char *name, char *setScript, char *readScript, hdbValue v);
/**
* make a SICS scriptable parameter. I.e. when this parameter is set or read,
* appropriate scripts are invoked.
* @param name The name of the parameter
* @param setScript
* @param readScript
* @param name The name of the parameter
* @param dataType The datatype for the new parameter.
* @param length The length of any arrays
* @param data Data to initalise the parameter with. Can be NULL, then
* no initialisation takes place.
* @return A new suitably configured Hdb parameter or NULL when out of memory.
*/
pHdb CreateSICSScriptPar(char *name, char *setScript, char *readScript,
int dataType, int length, void *data);
/**
* remove a SICS paramameter node and its children. In contrast to the
@@ -305,37 +283,28 @@ void RemoveSICSInternalCallback(void *internalID);
* @param obj The object for which to get a parameter.
* @param pCon The optional connection object to use for reporting errors.
* @param path The path to the parameter.
* @param dataType The datatype for the parameter.
* @param data Target pointer to which to copy data too.
* @param length The length of data
* @param v the value
* @return 1 on success, a negative error code else.
*/
int SICSHdbGetPar(void *obj, SConnection *pCon,
char *path, int dataType, void *data, int length);
int SICSHdbGetPar(void *obj, SConnection *pCon, char *path, hdbValue *v);
/**
* SICSHdbUpdatePar updates the value of a parameter.
* @param obj The object for which to get a parameter.
* @param pCon The optional connection object to use for reporting errors.
* @param path The path to the parameter.
* @param dataType The datatype for the parameter.
* @param data Pointer from which to copy data.
* @param length The length of data
* @param v the value
* @return 1 on success, a negative error code else.
*/
int SICSHdbUpdatePar(void *obj, SConnection *pCon,
char *path, int dataType, void *data, int length);
int SICSHdbUpdatePar(void *obj, SConnection *pCon, char *path, hdbValue v);
/**
* SICSHdbSetPar sets the value of a parameter.
* @param obj The object for which to get a parameter.
* @param pCon The optional connection object to use for reporting errors.
* @param path The path to the parameter.
* @param dataType The datatype for the parameter.
* @param data Pointer from which to copy data.
* @param length The length of data
* @return 1 on success, a negative error code else.
* @param v the value
* @return positive on success, a negative error code else.
*/
int SICSHdbSetPar(void *obj, SConnection *pCon,
char *path, int dataType, void *data, int length);
int SICSHdbSetPar(void *obj, SConnection *pCon, char *path, hdbValue v);
/**
* query function if a parameter is read only.
* @param node The ndoe to query