API2::UserParams Class Reference

The API2_UserParams class. More...

#include <api2UserCommands.h>

Inheritance diagram for API2::UserParams:

Public Member Functions
	UserParams (const std::string &frontendDesign, const char *buf=NULL)
	API2_UserParams. More...
int	serialize (char *buf, int apiIndex)
	serialize More...
template<class T >
UserParamsError	setValue (const std::string &key, const T &val)
	setValue More...
template<class T >
UserParamsError	getValue (const std::string &key, T &val)
	getValue More...
Public Member Functions inherited from API2::AbstractUserParams
UNSIGNED_LONG	getStrategyVersion () const
	StrategyVersion.
UNSIGNED_LONG &	getRefStrategyVersion ()
void	setStrategyVersion (const UNSIGNED_LONG &value)
UNSIGNED_CHARACTER	getTransactionType () const
	TransactionType.
UNSIGNED_CHARACTER &	getRefTransactionType ()
void	setTransactionType (const UNSIGNED_CHARACTER &value)
UNSIGNED_INTEGER	getClientId () const
	ClientId.
UNSIGNED_INTEGER &	getRefClientId ()
void	setClientId (const UNSIGNED_INTEGER &value)
UNSIGNED_INTEGER	getStrategyId () const
	StrategyId.
UNSIGNED_INTEGER &	getRefStrategyId ()
void	setStrategyId (const UNSIGNED_INTEGER &value)
UNSIGNED_LONG	getAdminTokenId () const
	AdminTokenId.
UNSIGNED_LONG &	getRefAdminTokenId ()
void	setAdminTokenId (const UNSIGNED_LONG &value)
UNSIGNED_LONG	getSequenceNumber () const
	SequenceNumber.
UNSIGNED_LONG &	getRefSequenceNumber ()
void	setSequenceNumber (const UNSIGNED_LONG &value)
	AbstractUserParams ()
	AbstractUserParams.
virtual void	initialize ()
	initialize
int	serialize (char *buf, bool isResponse, UNSIGNED_CHARACTER cat, UNSIGNED_CHARACTER comCat)
	serialize More...
int	serializeApi (char *buf, bool isResponse, UNSIGNED_CHARACTER cat, UNSIGNED_CHARACTER comCat, int apiIndex)
	serializeApi More...
void	deSerialize (const char *buf)
	deSerialize More...
void	addType (BaseType *type)
	addType More...
void	dump ()
	dump
std::string	getString ()
void	writeToFile (FILE *fp)
int	getSerializeSize ()
void	deSerializeMemorySize (const char *buff)

Detailed Description

The API2_UserParams class.

Constructor & Destructor Documentation

API2::UserParams::UserParams	(	const std::string &	frontendDesign,
		const char *	buf = NULL
	)

API2_UserParams.

Parameters

frontendDesign
buf

Exceptions

DuplicateKeyException

Member Function Documentation

template<class T >

UserParamsError API2::UserParams::getValue ( const std::string &  key, T &  val  )

inline

getValue

Parameters

key
val

Returns

int API2::UserParams::serialize	(	char *	buf,
		int	apiIndex
	)

serialize

Parameters

buf
apiIndex

Returns

template<class T >

UserParamsError API2::UserParams::setValue ( const std::string &  key, const T &  val  )

inline

setValue

Parameters

key
val

Returns

---

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

• api_includes/api2UserCommands.h