DRAMA C++ Intro   Class Hierarchy   Alphabetical List of types   List of Classes   File List   Class Member Index   File Members Index   Related Pages  

Sdp Class Reference

#include <Sdp.h>

List of all members.


Detailed Description

A C++ Interface to the DRAMA Simple DITS Parameter System (SDP).

Sdp provides simpler interfaces to constructing, putting and fetching data from simple the SDP parameter system.

Note that there is no actual object, just static members which provide access to the parameters.

Note that if the macro DRAMA_ALLOW_CPP_STDLIB is defined, then it is presume that the C++ standard library is available and relevant methods (such as those which use std::string types) are compiled. Otherwise they are not defined.


Static Public Methods

void CreateItem (const SdsId &parsys, SdsId &item, StatusType *status)
 Create a new parameter by inserting an SDS item.

void Put (const char *name, bool value, StatusType *status)
 Put a boolean value into a named parameter.

void Put (const char *name, char value, StatusType *status)
 Put a char value into a named parameter.

void Put (const char *name, unsigned short value, StatusType *status)
 Put an unsigned short value into a named parameter.

void Put (const char *name, short value, StatusType *status)
 Put a short value into a named parameter.

void Put (const char *name, INT32 value, StatusType *status)
 Put a 32 bit integer value into a named parameter.

void Put (const char *name, UINT32 value, StatusType *status)
 Put a unsigned 32 bit integer value into a named parameter.

void Put (const char *name, INT64 value, StatusType *status)
 Put a INT64 value into a named parameter.

void Put (const char *name, UINT64 value, StatusType *status)
 Put a UINT64 bit value into a named parameter.

void Put (const char *name, float value, StatusType *status)
 Put a floating point value into a named parameter.

void Put (const char *name, double value, StatusType *status)
 Put a double length floating point value into a named parameter.

void Put (const char *name, const char *value, StatusType *status)
 Put a character string value into a named parameter.

void PutSds (const char *name, SdsIdType value, StatusType *status)
 Put a SDS item a named parameter.

void Update (SdsIdType id, StatusType *status)
 Indicate a parameter value has been updated by SDS.

void Get (const char *name, bool *value, StatusType *status)
 Fetch a boolean value from a named parameter.

void Get (const char *name, char *value, StatusType *status)
 Fetch a char value from a named parameter.

void Get (const char *name, short *value, StatusType *status)
 Fetch a short integer value from a named parameter.

void Get (const char *name, unsigned short *value, StatusType *status)
 Fetch an unsigned short integer value from a named parameter.

void Get (const char *name, INT32 *value, StatusType *status)
 Fetch a 32 bit integer value from a named parameter.

void Get (const char *name, UINT32 *value, StatusType *status)
 Fetch an unsigned 32 bit integer value from a named parameter.

void Get (const char *name, INT64 *value, StatusType *status)
 Fetch a 64 bit integer value from a named parameter.

void Get (const char *name, UINT64 *value, StatusType *status)
 Fetch a unsigned 64 bit integer value from a named parameter.

void Get (const char *name, float *value, StatusType *status)
 Fetch a float size real value from a named parameter.

void Get (const char *name, double *value, StatusType *status)
 Fetch a double size real value from a named parameter.

void Get (const char *name, int len, char *value, StatusType *status)
 Fetch a char * value from a named parameter.

void GetSds (const char *name, SdsIdType *value, StatusType *status)
 Access an parameter using an SDS id.

void Get (const char *name, SdsId *value, StatusType *status)
 Access an parameter using an SDS id.

void Put (const char *name, const SdsId &value, StatusType *status)
 Put a SDS item a named parameter.

void PutStruct (const char *name, const SdsId &value, StatusType *status, const bool create=true)
 Put a SDS item a named parameter - replacing the existing value.

void PutStruct (const char *name, SdsId *value, StatusType *status, const bool create=true)
 Put a SDS item a named parameter - replacing the existing value.

void Put (const std::string &name, bool value, StatusType *const status)
 Put a boolean value into a named parameter.

void Put (const std::string &name, char value, StatusType *const status)
 Put a char value into a named parameter.

void Put (const std::string &name, short value, StatusType *const status)
 Put a short value into a named parameter.

void Put (const std::string &name, unsigned short value, StatusType *const status)
 Put a unsigned short value into a named parameter.

void Put (const std::string &name, INT32 value, StatusType *const status)
 Put a 32 bit integer value into a named parameter.

void Put (const std::string &name, UINT32 value, StatusType *const status)
 Put a unsigned 32 bit value into a named parameter.

void Put (const std::string &name, INT64 value, StatusType *const status)
 Put a INT64 value into a named parameter.

void Put (const std::string &name, UINT64 value, StatusType *const status)
 Put a UINT64 bit value into a named parameter.

void Put (const std::string &name, float value, StatusType *const status)
 Put a floating point value into a named parameter.

void Put (const std::string &name, double value, StatusType *const status)
 Put a double length floating point value into a named parameter.

void Put (const char *name, const std::string &value, StatusType *status)
 Put a character string value into a named parameter.

void Put (const std::string &name, const std::string &value, StatusType *status)
 Put a char string value into a named parameter.

void Get (const std::string &name, bool *value, StatusType *const status)
 Fetch a boolean value from a named parameter.

void Get (const std::string &name, char *value, StatusType *const status)
 Fetch a char value from a named parameter.

void Get (const std::string &name, short *value, StatusType *const status)
 Fetch a short integer value from a named parameter.

void Get (const std::string &name, unsigned short *value, StatusType *const status)
 Fetch an unsigned short integer value from a named parameters.

void Get (const std::string &name, INT32 *value, StatusType *const status)
 Fetch a 32 bit integer value from a named parameter.

void Get (const std::string &name, UINT32 *value, StatusType *const status)
 Fetch a 32 bit unsigned integer value from a named parameter.

void Get (const std::string &name, INT64 *value, StatusType *const status)
 Fetch a 64 bit integer value from a named parameter.

void Get (const std::string &name, UINT64 *value, StatusType *const status)
 Fetch A Unsigned 64 Bit Integer Value From A Named Parameter.

void Get (const std::string &name, float *value, StatusType *const status)
 Fetch a float size real value from a named parameter.

void Get (const std::string &name, double *value, StatusType *const status)
 Fetch a double size real value from a named parameter.

void Get (const char *name, std::string *value, StatusType *status, int buflen=100)
 Fetch a string value as a std::string from a named parameter.

void Get (const std::string &name, std::string *value, StatusType *status, int buflen=100)
 Fetch a string value as a std::string from a named parameter.

void GetSds (const std::string &name, SdsIdType *value, StatusType *status)
 Access an parameter using an SDS id.

void Get (const std::string &name, SdsId *value, StatusType *status)
 Access an parameter using an SDS id.

void Put (const std::string &name, const SdsId &value, StatusType *status)
 Put a SDS item a named parameter.

void PutStruct (const std::string &name, const SdsId &value, StatusType *status, const bool create=true)
 Put a SDS item a named parameter - replacing the existing value.

void PutStruct (const std::string &name, SdsId *value, StatusType *status, const bool create=true)
 Put a SDS item a named parameter - replacing the existing value.


Member Function Documentation

void Sdp::CreateItem const SdsId   parsys,
SdsId   item,
StatusType *    status
[inline, static]
 

Create a new parameter by inserting an SDS item.

The supplied SDS item is inserted into the specified parameter system. Any existing item of the same name is deleted.

See also:
SdpCreateItem() , SdpInit() , SdsInsert()
Parameters:
parsys  The Id of the Sdp structure as returned by SdpInit.
item  The Id of the SDS item to be inserted into the parameter system. This will be inserted using SdsInsert() so the name of the parameter will be the top level name and the structure must not be an external SDS structure.
status  Inherited status.

void Sdp::Get const std::string &    name,
SdsId   value,
StatusType *    status
[inline, static]
 

Access an parameter using an SDS id.

An SDS id refering to the named parameter is generated and returned as an SdsId.

Remarks:
If you update the parameter value via this SDS id, then you should use SdpUpdate() or Sdp::Update to tell DRAMA about this change.
Remarks:
Only available if the macro DRAMA_ALLOW_CPP_STDLIB is defined.
See also:
SdsId , Sdp::Update , SdpUpdate()
Parameters:
name  The name of the parameter.
value  the SDS id is retuned here.
status  Inherited status.

void Sdp::Get const std::string &    name,
std::string *    value,
StatusType *    status,
int    buflen = 100
[inline, static]
 

Fetch a string value as a std::string from a named parameter.

If the named parameter exists, then fetch its value and convert it to a std::string, if possible.

Note that this does not work for non-char items array items which require more then buflen bytes - since it is not possible to ensure we resize the string appropiately.

Remarks:
Only available if the macro DRAMA_ALLOW_CPP_STDLIB is defined.
See also:
SdpGetString()
Parameters:
name  The name of the parameter.
value  The value returned is written here.
status  Inherited status.
buflen  The number of bytes to allow in the string for the result. Only used if the underlying value is not an array of SDS_CHAR

void Sdp::Get const char *    name,
std::string *    value,
StatusType *    status,
int    buflen = 100
[inline, static]
 

Fetch a string value as a std::string from a named parameter.

If the named parameter exists, then fetch its value and convert it to a std::string, if possible.

Note that this does not work for non-char array items which require more then buflen bytes - since it is not possible to ensure we resize the string appropiately - a ARG__CNVERR code will be returned.

Remarks:
Only available if the macro DRAMA_ALLOW_CPP_STDLIB is defined.
See also:
SdpGetString()
Parameters:
name  The name of the parameter.
value  The value returned is written here.
status  Inherited status.
buflen  The number of bytes to allow in the string for the result. Only used if the underlying value is not an array of SDS_CHAR

void Sdp::Get const std::string &    name,
double *    value,
StatusType *const    status
[inline, static]
 

Fetch a double size real value from a named parameter.

If the named parameter exists, then fetch its value and convert it to a double, if possible.

Remarks:
Only available if the macro DRAMA_ALLOW_CPP_STDLIB is defined.
See also:
SdpGetd()
Parameters:
name  The name of the parameter.
value  The value returned is written here.
status  Inherited status.

void Sdp::Get const std::string &    name,
float *    value,
StatusType *const    status
[inline, static]
 

Fetch a float size real value from a named parameter.

If the named parameter exists, then fetch its value and convert it to a float, if possible.

Remarks:
Only available if the macro DRAMA_ALLOW_CPP_STDLIB is defined.
See also:
SdpGetf()
Parameters:
name  The name of the parameter.
value  The value returned is written here.
status  Inherited status.

void Sdp::Get const std::string &    name,
UINT64 *    value,
StatusType *const    status
[inline, static]
 

Fetch A Unsigned 64 Bit Integer Value From A Named Parameter.

If The Named Parameter Exists, Then Fetch Its Value And Convert It To A Uint64, If Possible.

Remarks:
Only available if the macro DRAMA_ALLOW_CPP_STDLIB is defined and long intergers are NOT 64 bit.
See also:
Sdpgetu64()
Parameters:
name  The Name Of The Parameter.
value  The Value Returned Is Written Here.
status  Inherited Status.

void Sdp::Get const std::string &    name,
INT64 *    value,
StatusType *const    status
[inline, static]
 

Fetch a 64 bit integer value from a named parameter.

If the named parameter exists, then fetch its value and convert it to a INT64, if possible.

Remarks:
Only available if the macro DRAMA_ALLOW_CPP_STDLIB is defined and long intergers are NOT 64 bit.
See also:
SdpGeti64()
Parameters:
name  The name of the parameter.
value  The value returned is written here.
status  Inherited status.

void Sdp::Get const std::string &    name,
UINT32 *    value,
StatusType *const    status
[inline, static]
 

Fetch a 32 bit unsigned integer value from a named parameter.

If the named parameter exists, then fetch its value and convert it to a unsigned long integer, if possible.

Remarks:
Only available if the macro DRAMA_ALLOW_CPP_STDLIB is defined.
See also:
SdpGetui()
Parameters:
name  The name of the parameter.
value  The value returned is written here.
status  Inherited status.

void Sdp::Get const std::string &    name,
INT32 *    value,
StatusType *const    status
[inline, static]
 

Fetch a 32 bit integer value from a named parameter.

If the named parameter exists, then fetch its value and convert it to a long integer, if possible.

Remarks:
Only available if the macro DRAMA_ALLOW_CPP_STDLIB is defined.
See also:
SdpGeti()
Parameters:
name  The name of the parameter.
value  The value returned is written here.
status  Inherited status.

void Sdp::Get const std::string &    name,
unsigned short *    value,
StatusType *const    status
[inline, static]
 

Fetch an unsigned short integer value from a named parameters.

If the named parameter exists, then fetch its value and convert it to a unsigned short, if possible.

Remarks:
Only available if the macro DRAMA_ALLOW_CPP_STDLIB is defined.
See also:
SdpGetus()
Parameters:
name  The name of the parameter.
value  The value returned is written here.
status  Inherited status.

void Sdp::Get const std::string &    name,
short *    value,
StatusType *const    status
[inline, static]
 

Fetch a short integer value from a named parameter.

If the named parameter exists, then fetch its value and convert it to short, if possible.

Remarks:
Only available if the macro DRAMA_ALLOW_CPP_STDLIB is defined.
See also:
SdpGets()
Parameters:
name  The name of the parameter.
value  The value returned is written here.
status  Inherited status.

void Sdp::Get const std::string &    name,
char *    value,
StatusType *const    status
[inline, static]
 

Fetch a char value from a named parameter.

If the named parameter exists, then fetch its value and convert it to a char, if possible.

Remarks:
Only available if the macro DRAMA_ALLOW_CPP_STDLIB is defined.
See also:
SdpGetc()
Parameters:
name  The name of the parameter.
value  The value returned is written here.
status  Inherited status.

void Sdp::Get const std::string &    name,
bool *    value,
StatusType *const    status
[inline, static]
 

Fetch a boolean value from a named parameter.

If the named parameter exists, then fetch its value and convert it to a boolean, if possible.

Note that SDS does not directly support boolean values, so an integer representation is used internally and converted to bool.

Remarks:
Only available if the macro DRAMA_ALLOW_CPP_STDLIB is defined.
See also:
SdpGetus()
Parameters:
name  The name of the parameter.
value  The value returned is written here.
status  Inherited status.

void Sdp::Get const char *    name,
SdsId   value,
StatusType *    status
[inline, static]
 

Access an parameter using an SDS id.

An SDS id refering to the named parameter is generated and returned as an SdsId.

Remarks:
If you update the parameter value via this SDS id, then you should use SdpUpdate() or Sdp::Update to tell DRAMA about this change.
See also:
SdsId , Sdp::Update , SdpUpdate()
Parameters:
name  The name of the parameter.
value  the SDS id is retuned here.
status  Inherited status.

void Sdp::Get const char *    name,
int    len,
char *    value,
StatusType *    status
[inline, static]
 

Fetch a char * value from a named parameter.

( If the named parameter exists, then fetch its value and convert it to a char *, if possible.

See also:
SdpGetString()
Parameters:
name  The name of the parameter.
len  The of the buffer value points to.
value  The value returned is written here as a null terminated string.
status  Inherited status.

void Sdp::Get const char *    name,
double *    value,
StatusType *    status
[inline, static]
 

Fetch a double size real value from a named parameter.

If the named parameter exists, then fetch its value and convert it to a double, if possible.

See also:
SdpGetd()
Parameters:
name  The name of the parameter.
value  The value returned is written here.
status  Inherited status.

void Sdp::Get const char *    name,
float *    value,
StatusType *    status
[inline, static]
 

Fetch a float size real value from a named parameter.

If the named parameter exists, then fetch its value and convert it to a float, if possible.

See also:
SdpGetf()
Parameters:
name  The name of the parameter.
value  The value returned is written here.
status  Inherited status.

void Sdp::Get const char *    name,
UINT64 *    value,
StatusType *    status
[inline, static]
 

Fetch a unsigned 64 bit integer value from a named parameter.

If the named parameter exists, then fetch its value and convert it to a UINT64, if possible.

Remarks:
Only available on machines where long is NOT 64 bits.
See also:
SdpGetu64()
Parameters:
name  The name of the parameter.
value  The value returned is written here.
status  Inherited status.

void Sdp::Get const char *    name,
INT64 *    value,
StatusType *    status
[inline, static]
 

Fetch a 64 bit integer value from a named parameter.

If the named parameter exists, then fetch its value and convert it to a INT64, if possible.

Remarks:
Only available on machines where long is NOT 64 bits.
See also:
SdpGeti64()
Parameters:
name  The name of the parameter.
value  The value returned is written here.
status  Inherited status.

void Sdp::Get const char *    name,
UINT32 *    value,
StatusType *    status
[inline, static]
 

Fetch an unsigned 32 bit integer value from a named parameter.

If the named parameter exists, then fetch its value and convert it to a unsigned long integer, if possible.

See also:
SdpGetui()
Parameters:
name  The name of the parameter.
value  The value returned is written here.
status  Inherited status.

void Sdp::Get const char *    name,
INT32 *    value,
StatusType *    status
[inline, static]
 

Fetch a 32 bit integer value from a named parameter.

If the named parameter exists, then fetch its value and convert it to a long integer, if possible.

See also:
SdpGeti()
Parameters:
name  The name of the parameter.
value  The value returned is written here.
status  Inherited status.

void Sdp::Get const char *    name,
unsigned short *    value,
StatusType *    status
[inline, static]
 

Fetch an unsigned short integer value from a named parameter.

If the named parameter exists, then fetch its value and convert it to a unsigned short, if possible.

See also:
SdpGetus()
Parameters:
name  The name of the parameter.
value  The value returned is written here.
status  Inherited status.

void Sdp::Get const char *    name,
short *    value,
StatusType *    status
[inline, static]
 

Fetch a short integer value from a named parameter.

If the named parameter exists, then fetch its value and convert it to short, if possible.

See also:
SdpGets()
Parameters:
name  The name of the parameter.
value  The value returned is written here.
status  Inherited status.

void Sdp::Get const char *    name,
char *    value,
StatusType *    status
[inline, static]
 

Fetch a char value from a named parameter.

If the named parameter exists, then fetch its value and convert it to a char, if possible.

See also:
SdpGetc()
Parameters:
name  The name of the parameter.
value  The value returned is written here.
status  Inherited status.

void Sdp::Get const char *    name,
bool *    value,
StatusType *    status
[inline, static]
 

Fetch a boolean value from a named parameter.

If the named parameter exists, then fetch its value and convert it to a boolean, if possible.

Note that SDS does not directly support boolean values, so an integer representation is used internally and converted to bool.

See also:
SdpGetus()
Parameters:
name  The name of the parameter.
value  The value returned is written here.
status  Inherited status.

void Sdp::GetSds const std::string &    name,
SdsIdType *    value,
StatusType *    status
[inline, static]
 

Access an parameter using an SDS id.

An SDS id refering to the named parameter is generated and returned.

Remarks:
This can't be a plain Get - as SdsIdType is just an int and will get confused.
Remarks:
If you update the parameter value via this SDS id, then you should use SdpUpdate() or Sdp::Update to tell DRAMA about this change.
Remarks:
Only available if the macro DRAMA_ALLOW_CPP_STDLIB is defined.
See also:
Sdp::Update , SdpUpdate()
Parameters:
name  The name of the parameter.
value  the SDS id is retuned here.
status  Inherited status.

void Sdp::GetSds const char *    name,
SdsIdType *    value,
StatusType *    status
[inline, static]
 

Access an parameter using an SDS id.

An SDS id refering to the named parameter is generated and returned.

Remarks:
This can't be a plain Get - as SdsIdType is just an int and will get confused.
Remarks:
If you update the parameter value via this SDS id, then you should use SdpUpdate() or Sdp::Update to tell DRAMA about this change.
See also:
Sdp::Update , SdpUpdate()
Parameters:
name  The name of the parameter.
value  the SDS id is retuned here.
status  Inherited status.

void Sdp::Put const std::string &    name,
const SdsId   value,
StatusType *    status
[inline, static]
 

Put a SDS item a named parameter.

An SDS item is written into a named parameter. Conversion is carried out using ArgCvt. This means that if both input and output items are scaler or strings, they will be converted if possible. Otherwise, a conversion error will occur.

To put the value of a structured SDS item, use SdpGetSds() to get an id for it and then write the value using that id. Follow your update by a call to SdpUpdate. Alternatively, use SdsPutStruct() which replaces the old structure with a new one.

Remarks:
Only available if the macro DRAMA_ALLOW_CPP_STDLIB is defined.
See also:
SdpPutSds() , SdpPutStruct() , ArgCvt() , Sdp::GetSds
Parameters:
name  The name of the parameter.
value  The value to be inserted. T
status  Inherited status.

void Sdp::Put const std::string &    name,
const std::string &    value,
StatusType *    status
[inline, static]
 

Put a char string value into a named parameter.

The the value is converted to the type of the parameter and (if possible) and inserted.

Remarks:
Only available if the macro DRAMA_ALLOW_CPP_STDLIB is defined.
See also:
SdpPutString()
Parameters:
name  The name of the parameter.
value  The value to be inserted. The null terminated string extracted form this is what is inserted.
status  Inherited status.

void Sdp::Put const char *    name,
const std::string &    value,
StatusType *    status
[inline, static]
 

Put a character string value into a named parameter.

The the value is converted to the type of the parameter and (if possible) and inserted.

Remarks:
Only available if the macro DRAMA_ALLOW_CPP_STDLIB is defined.
See also:
SdpPutString()
Parameters:
name  The name of the parameter.
value  The value to be inserted. The null terminated string extracted form this is what is inserted.
status  Inherited status.

void Sdp::Put const std::string &    name,
double    value,
StatusType *const    status
[inline, static]
 

Put a double length floating point value into a named parameter.

The the value is converted to the type of the parameter and (if possible) and inserted.

Remarks:
Only available if the macro DRAMA_ALLOW_CPP_STDLIB is defined.
See also:
SdpPutd()
Parameters:
name  The name of the parameter.
value  The value to be inserted.
status  Inherited status.

void Sdp::Put const std::string &    name,
float    value,
StatusType *const    status
[inline, static]
 

Put a floating point value into a named parameter.

The the value is converted to the type of the parameter and (if possible) and inserted.

Remarks:
Only available if the macro DRAMA_ALLOW_CPP_STDLIB is defined.
See also:
SdpPutf()
Parameters:
name  The name of the parameter.
value  The value to be inserted.
status  Inherited status.

void Sdp::Put const std::string &    name,
UINT64    value,
StatusType *const    status
[inline, static]
 

Put a UINT64 bit value into a named parameter.

The the value is converted to the type of the parameter and (if possible) and inserted.

Remarks:
Only available if the macro DRAMA_ALLOW_CPP_STDLIB is defined.
See also:
SdpPutui64()
Parameters:
name  The name of the parameter.
value  The value to be inserted.
status  Inherited status.

void Sdp::Put const std::string &    name,
INT64    value,
StatusType *const    status
[inline, static]
 

Put a INT64 value into a named parameter.

The the value is converted to the type of the parameter and (if possible) and inserted.

Remarks:
Only available if the macro DRAMA_ALLOW_CPP_STDLIB is defined.
See also:
SdpPuti64()
Parameters:
name  The name of the parameter.
value  The value to be inserted.
status  Inherited status.

void Sdp::Put const std::string &    name,
UINT32    value,
StatusType *const    status
[inline, static]
 

Put a unsigned 32 bit value into a named parameter.

The the value is converted to the type of the parameter and (if possible) and inserted.

Remarks:
Only available if the macro DRAMA_ALLOW_CPP_STDLIB is defined.
See also:
SdpPutu()
Parameters:
name  The name of the parameter.
value  The value to be inserted.
status  Inherited status.

void Sdp::Put const std::string &    name,
INT32    value,
StatusType *const    status
[inline, static]
 

Put a 32 bit integer value into a named parameter.

The the value is converted to the type of the parameter and (if possible) and inserted.

Remarks:
Only available if the macro DRAMA_ALLOW_CPP_STDLIB is defined.
See also:
SdpPuti()
Parameters:
name  The name of the parameter.
value  The value to be inserted.
status  Inherited status.

void Sdp::Put const std::string &    name,
unsigned short    value,
StatusType *const    status
[inline, static]
 

Put a unsigned short value into a named parameter.

The the value is converted to the type of the parameter and (if possible) and inserted.

Remarks:
Only available if the macro DRAMA_ALLOW_CPP_STDLIB is defined.
See also:
SdpPutus()
Parameters:
name  The name of the parameter.
value  The value to be inserted.
status  Inherited status.

void Sdp::Put const std::string &    name,
short    value,
StatusType *const    status
[inline, static]
 

Put a short value into a named parameter.

The the value is converted to the type of the parameter and (if possible) and inserted.

Remarks:
Only available if the macro DRAMA_ALLOW_CPP_STDLIB is defined.
See also:
SdpPuts()
Parameters:
name  The name of the parameter.
value  The value to be inserted.
status  Inherited status.

void Sdp::Put const std::string &    name,
char    value,
StatusType *const    status
[inline, static]
 

Put a char value into a named parameter.

The the value is converted to the type of the parameter and (if possible) and inserted.

Remarks:
Only available if the macro DRAMA_ALLOW_CPP_STDLIB is defined.
See also:
SdpPutc()
Parameters:
name  The name of the item within the SDS structure.
value  The value to be inserted.
status  Inherited status.

void Sdp::Put const std::string &    name,
bool    value,
StatusType *const    status
[inline, static]
 

Put a boolean value into a named parameter.

The the value is converted to the type of the parameter and (if possible) and inserted.

Note that SDS does not directly support boolean values, so an integer representation is used.

Remarks:
Only available if the macro DRAMA_ALLOW_CPP_STDLIB is defined.
See also:
SdpPutus()
Parameters:
name  The name of the parameter.
value  The value to be inserted.
status  Inherited status.

void Sdp::Put const char *    name,
const SdsId   value,
StatusType *    status
[inline, static]
 

Put a SDS item a named parameter.

An SDS item is written into a named parameter. Conversion is carried out using ArgCvt. This means that if both input and output items are scaler or strings, they will be converted if possible. Otherwise, a conversion error will occur.

To put the value of a structured SDS item, use SdpGetSds() to get an id for it and then write the value using that id. Follow your update by a call to SdpUpdate. Alternatively, use SdsPutStruct() which replaces the old structure with a new one.

See also:
SdpPutSds() , SdpPutStruct() , ArgCvt() , Sdp::GetSds
Parameters:
name  The name of the parameter.
value  The value to be inserted. T
status  Inherited status.

void Sdp::Put const char *    name,
const char *    value,
StatusType *    status
[inline, static]
 

Put a character string value into a named parameter.

The the value is converted to the type of the parameter and (if possible) and inserted.

See also:
SdpPutString()
Parameters:
name  The name of the parameter.
value  The value to be inserted. The null terminated string extracted form this is what is inserted.
status  Inherited status.

void Sdp::Put const char *    name,
double    value,
StatusType *    status
[inline, static]
 

Put a double length floating point value into a named parameter.

The the value is converted to the type of the parameter and (if possible) and inserted.

See also:
SdpPutd()
Parameters:
name  The name of the parameter.
value  The value to be inserted.
status  Inherited status.

void Sdp::Put const char *    name,
float    value,
StatusType *    status
[inline, static]
 

Put a floating point value into a named parameter.

The the value is converted to the type of the parameter and (if possible) and inserted.

See also:
SdpPutf()
Parameters:
name  The name of the parameter.
value  The value to be inserted.
status  Inherited status.

void Sdp::Put const char *    name,
UINT64    value,
StatusType *    status
[inline, static]
 

Put a UINT64 bit value into a named parameter.

The the value is converted to the type of the parameter and (if possible) and inserted.

See also:
SdpPutui64()
Parameters:
name  The name of the parameter.
value  The value to be inserted.
status  Inherited status.

void Sdp::Put const char *    name,
INT64    value,
StatusType *    status
[inline, static]
 

Put a INT64 value into a named parameter.

The the value is converted to the type of the parameter and (if possible) and inserted.

See also:
SdpPuti64()
Parameters:
name  The name of the parameter.
value  The value to be inserted.
status  Inherited status.

void Sdp::Put const char *    name,
UINT32    value,
StatusType *    status
[inline, static]
 

Put a unsigned 32 bit integer value into a named parameter.

The the value is converted to the type of the parameter and (if possible) and inserted.

See also:
SdpPutu()
Parameters:
name  The name of the parameter.
value  The value to be inserted.
status  Inherited status.

void Sdp::Put const char *    name,
INT32    value,
StatusType *    status
[inline, static]
 

Put a 32 bit integer value into a named parameter.

The the value is converted to the type of the parameter and (if possible) and inserted.

See also:
SdpPuti()
Parameters:
name  The name of the parameter.
value  The value to be inserted.
status  Inherited status.

void Sdp::Put const char *    name,
short    value,
StatusType *    status
[inline, static]
 

Put a short value into a named parameter.

The the value is converted to the type of the parameter and (if possible) and inserted.

See also:
SdpPuts()
Parameters:
name  The name of the parameter.
value  The value to be inserted.
status  Inherited status.

void Sdp::Put const char *    name,
unsigned short    value,
StatusType *    status
[inline, static]
 

Put an unsigned short value into a named parameter.

The the value is converted to the type of the parameter and (if possible) and inserted.

See also:
SdpPuts()
Parameters:
name  The name of the parameter.
value  The value to be inserted.
status  Inherited status.

void Sdp::Put const char *    name,
char    value,
StatusType *    status
[inline, static]
 

Put a char value into a named parameter.

The the value is converted to the type of the parameter and (if possible) and inserted.

See also:
SdpPutc()
Parameters:
name  The name of the item within the SDS structure.
value  The value to be inserted.
status  Inherited status.

void Sdp::Put const char *    name,
bool    value,
StatusType *    status
[inline, static]
 

Put a boolean value into a named parameter.

The the value is converted to the type of the parameter and (if possible) and inserted.

Note that SDS does not directly support boolean values, so an integer representation is used.

See also:
SdpPutus()
Parameters:
name  The name of the parameter.
value  The value to be inserted.
status  Inherited status.

void Sdp::PutSds const char *    name,
SdsIdType    value,
StatusType *    status
[inline, static]
 

Put a SDS item a named parameter.

An SDS item is written into a named parameter. Conversion is carried out using ArgCvt. This means that if both input and output items are scaler or strings, they will be converted if possible. Otherwise, a conversion error will occur.

To put the value of a structured SDS item, use SdpGetSds() to get an id for it and then write the value using that id. Follow your update by a call to SdpUpdate. Alternatively, use SdsPutStruct() which replaces the old structure with a new one.

See also:
SdpPutSds() , SdpPutStruct() , ArgCvt() , Sdp::GetSds
Parameters:
name  The name of the parameter.
value  The value to be inserted. T
status  Inherited status.

void Sdp::PutStruct const std::string &    name,
SdsId   value,
StatusType *    status,
const bool    create = true
[inline, static]
 

Put a SDS item a named parameter - replacing the existing value.

An SDS item is written into a named parameter. Rather then convering the value with ArgCvt(), the supplied value will replace the exiting parameter entirely.

In this version (SdsId *value) the value SDS item passed in is inserted directly, after being renamed to the specified name. It must not be an external item.

Remarks:
Only available if the macro DRAMA_ALLOW_CPP_STDLIB is defined.
See also:
SdpPutSds() , SdpPutStruct() , ArgCvt() , Sdp::GetSds
Parameters:
name  The name of the parameter.
value  The value to be inserted. Must not be an external item.
status  Inherited status.
create  If true, then the parameter is created if it does not already exist. Otherwise it must exist.

void Sdp::PutStruct const std::string &    name,
const SdsId   value,
StatusType *    status,
const bool    create = true
[inline, static]
 

Put a SDS item a named parameter - replacing the existing value.

An SDS item is written into a named parameter. Rather then convering the value with ArgCvt(), the supplied value will replace the exiting parameter entirely.

In this version (const SdsId & value) the value is copied using SdsCopy() and then the copy is inserted into SDS.

Remarks:
Only available if the macro DRAMA_ALLOW_CPP_STDLIB is defined.
See also:
SdpPutSds() , SdpPutStruct() , ArgCvt() , Sdp::GetSds
Parameters:
name  The name of the parameter.
value  The value to be inserted.
status  Inherited status.
create  If true, then the parameter is created if it does not already exist. Otherwise it must exist.

void Sdp::PutStruct const char *    name,
SdsId   value,
StatusType *    status,
const bool    create = true
[inline, static]
 

Put a SDS item a named parameter - replacing the existing value.

An SDS item is written into a named parameter. Rather then convering the value with ArgCvt(), the supplied value will replace the exiting parameter entirely.

In this version (SdsId *value) the value SDS item passed in is inserted directly, after being renamed to the specified name. It must not be an external item.

See also:
SdpPutSds() , SdpPutStruct() , ArgCvt() , Sdp::GetSds
Parameters:
name  The name of the parameter.
value  The value to be inserted. Must not be an external item.
status  Inherited status.
create  If true, then the parameter is created if it does not already exist. Otherwise it must exist.

void Sdp::PutStruct const char *    name,
const SdsId   value,
StatusType *    status,
const bool    create = true
[inline, static]
 

Put a SDS item a named parameter - replacing the existing value.

An SDS item is written into a named parameter. Rather then convering the value with ArgCvt(), the supplied value will replace the exiting parameter entirely.

In this version (const SdsId & value) the value is copied using SdsCopy() and then the copy is inserted into SDS.

See also:
SdpPutSds() , SdpPutStruct() , ArgCvt() , Sdp::GetSds
Parameters:
name  The name of the parameter.
value  The value to be inserted.
status  Inherited status.
create  If true, then the parameter is created if it does not already exist. Otherwise it must exist.

void Sdp::Update SdsIdType    id,
StatusType *    status
[inline, static]
 

Indicate a parameter value has been updated by SDS.

This method should be invoked if a parameter value has been updated using SDS directory. It tells the DRAMA Parameter monitoring system that the parameter has been updated and sends appropiate messages to all tasks which are monitoring the parameter

See also:
Sdp::GetSds , SdpUpdate()
Parameters:
id  The parameter id - as returned by SdpGetSds().
status  Inherited status.


The documentation for this class was generated from the following file:

Click here for the DRAMA home page and here for the AAO home page.

For more information, contact tjf@aaoepp.aao.gov.au 

Generated on Tue Nov 3 09:09:56 2009 for AAO DRAMA C++ Interfaces by doxygen 1.2.18