Sdp Class Reference

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

#include <Sdp.h>

Static Public Member Functions
static void	CreateItem (const SdsId &parsys, SdsId &item, StatusType *status)
	Create a new parameter by inserting an SDS item.
static void	Get (const char *name, bool *value, StatusType *status)
	Fetch a boolean value from a named parameter.
static void	Get (const char *name, char *value, StatusType *status)
	Fetch a char value from a named parameter.
static void	Get (const char *name, double *value, StatusType *status)
	Fetch a double size real value from a named parameter.
static void	Get (const char *name, float *value, StatusType *status)
	Fetch a float size real value from a named parameter.
static void	Get (const char *name, int len, char *value, StatusType *status)
	Fetch a char * value from a named parameter.
static void	Get (const char *name, INT32 *value, StatusType *status)
	Fetch a 32 bit integer value from a named parameter.
static void	Get (const char *name, INT64 *value, StatusType *status)
	Fetch a 64 bit integer value from a named parameter.
static void	Get (const char *name, SdsId *value, StatusType *status)
	Access an parameter using an SDS id.
static void	Get (const char *name, short *value, StatusType *status)
	Fetch a short integer value from a named parameter.
static 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.
static void	Get (const char *name, UINT32 *value, StatusType *status)
	Fetch an unsigned 32 bit integer value from a named parameter.
static void	Get (const char *name, UINT64 *value, StatusType *status)
	Fetch a unsigned 64 bit integer value from a named parameter.
static void	Get (const char *name, unsigned short *value, StatusType *status)
	Fetch an unsigned short integer value from a named parameter.
static void	Get (const std::string &name, bool *value, StatusType *const status)
	Fetch a boolean value from a named parameter.
static void	Get (const std::string &name, char *value, StatusType *const status)
	Fetch a char value from a named parameter.
static void	Get (const std::string &name, double *value, StatusType *const status)
	Fetch a double size real value from a named parameter.
static void	Get (const std::string &name, float *value, StatusType *const status)
	Fetch a float size real value from a named parameter.
static void	Get (const std::string &name, INT32 *value, StatusType *const status)
	Fetch a 32 bit integer value from a named parameter.
static void	Get (const std::string &name, INT64 *value, StatusType *const status)
	Fetch a 64 bit integer value from a named parameter.
static void	Get (const std::string &name, SdsId *value, StatusType *status)
	Access an parameter using an SDS id.
static void	Get (const std::string &name, short *value, StatusType *const status)
	Fetch a short integer value from a named parameter.
static 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.
static void	Get (const std::string &name, UINT32 *value, StatusType *const status)
	Fetch a 32 bit unsigned integer value from a named parameter.
static void	Get (const std::string &name, UINT64 *value, StatusType *const status)
	Fetch A Unsigned 64 Bit Integer Value From A Named Parameter.
static void	Get (const std::string &name, unsigned short *value, StatusType *const status)
	Fetch an unsigned short integer value from a named parameters.
static void	GetSds (const char *name, SdsIdType *value, StatusType *status)
	Access an parameter using an SDS id.
static void	GetSds (const std::string &name, SdsIdType *value, StatusType *status)
	Access an parameter using an SDS id.
static void	Put (const char *name, bool value, StatusType *status)
	Put a boolean value into a named parameter.
static void	Put (const char *name, char value, StatusType *status)
	Put a char value into a named parameter.
static void	Put (const char *name, const char *value, StatusType *status)
	Put a character string value into a named parameter.
static void	Put (const char *name, const SdsId &value, StatusType *status)
	Put a SDS item a named parameter.
static void	Put (const char *name, const std::string &value, StatusType *status)
	Put a character string value into a named parameter.
static void	Put (const char *name, double value, StatusType *status)
	Put a double length floating point value into a named parameter.
static void	Put (const char *name, float value, StatusType *status)
	Put a floating point value into a named parameter.
static void	Put (const char *name, INT32 value, StatusType *status)
	Put a 32 bit integer value into a named parameter.
static void	Put (const char *name, INT64 value, StatusType *status)
	Put a INT64 value into a named parameter.
static void	Put (const char *name, short value, StatusType *status)
	Put a short value into a named parameter.
static void	Put (const char *name, UINT32 value, StatusType *status)
	Put a unsigned 32 bit integer value into a named parameter.
static void	Put (const char *name, UINT64 value, StatusType *status)
	Put a UINT64 bit value into a named parameter.
static void	Put (const char *name, unsigned short value, StatusType *status)
	Put an unsigned short value into a named parameter.
static void	Put (const std::string &name, bool value, StatusType *const status)
	Put a boolean value into a named parameter.
static void	Put (const std::string &name, char value, StatusType *const status)
	Put a char value into a named parameter.
static void	Put (const std::string &name, const SdsId &value, StatusType *status)
	Put a SDS item a named parameter.
static void	Put (const std::string &name, const std::string &value, StatusType *status)
	Put a char string value into a named parameter.
static void	Put (const std::string &name, double value, StatusType *const status)
	Put a double length floating point value into a named parameter.
static void	Put (const std::string &name, float value, StatusType *const status)
	Put a floating point value into a named parameter.
static void	Put (const std::string &name, INT32 value, StatusType *const status)
	Put a 32 bit integer value into a named parameter.
static void	Put (const std::string &name, INT64 value, StatusType *const status)
	Put a INT64 value into a named parameter.
static void	Put (const std::string &name, short value, StatusType *const status)
	Put a short value into a named parameter.
static void	Put (const std::string &name, UINT32 value, StatusType *const status)
	Put a unsigned 32 bit value into a named parameter.
static void	Put (const std::string &name, UINT64 value, StatusType *const status)
	Put a UINT64 bit value into a named parameter.
static void	Put (const std::string &name, unsigned short value, StatusType *const status)
	Put a unsigned short value into a named parameter.
static void	PutSds (const char *name, SdsIdType value, StatusType *status)
	Put a SDS item a named parameter.
static 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.
static void	PutStruct (const char *name, SdsId *value, StatusType *status, const bool create=true)
	Put a SDS item a named parameter - replacing the existing value.
static 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.
static 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.
static void	Update (const char *name, StatusType *status)
	Indicate a parameter value has been updated by other means.
static void	Update (SdsIdType id, StatusType *status)
	Indicate a parameter value has been updated by SDS.

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.

---

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

• Sdp.h