HCE::handlers::AdminCommandParameters Class Reference

#include <AdminCommandParameters.hpp>

Inheritance diagram for HCE::handlers::AdminCommandParameters:

Collaboration diagram for HCE::handlers::AdminCommandParameters:

Public Types
enum	ErrorCodes { NO_ERROR = 0, ERROR_SERIALIZE = 1, ERROR_UNSERIALIZE = 2 }
Public Types inherited from HCE::IJsonSerializable
enum	{ NO_ERROR = 0 }

Public Member Functions
	AdminCommandParameters (const std::string &str="")
	~AdminCommandParameters (void)
bool	serialize (std::string &json)
bool	unserialize (const std::string &json)
void	clear (void)
void	setParameters (const std::string &parameters_)
std::string	getParameters (void) const
void	setRealtime (unsigned int realtime_)
unsigned int	getRealtime (void) const
bool	isRealtime (void) const
bool	isJsonString (void) const
Public Member Functions inherited from HCE::IJsonSerializable
	IJsonSerializable (void)
virtual	~IJsonSerializable (void)
void	setErrorMsg (const std::string &errorMsg_)
std::string	getErrorMsg (void) const
void	setErrorCode (unsigned int errorCode_)
unsigned int	getErrorCode (void) const
void	setIsError (bool isError_)
bool	isError (void) const
void	resetError (void)

Additional Inherited Members
Protected Member Functions inherited from HCE::IJsonSerializable
template<class T = unsigned long long>
T	convertVarToNumeric (Poco::Dynamic::Var &var, T defaultValue)
Protected Attributes inherited from HCE::IJsonSerializable
std::string	errorMsg
unsigned int	errorCode
bool	_isError

Detailed Description

Definition at line 24 of file AdminCommandParameters.hpp.

Member Enumeration Documentation

enum HCE::handlers::AdminCommandParameters::ErrorCodes

Enumerator:

NO_ERROR
ERROR_SERIALIZE
ERROR_UNSERIALIZE

Definition at line 30 of file AdminCommandParameters.hpp.

Constructor & Destructor Documentation

HCE::handlers::AdminCommandParameters::AdminCommandParameters ( const std::string &  str = "" )

explicit

Definition at line 17 of file AdminCommandParameters.cpp.

Here is the call graph for this function:

HCE::handlers::AdminCommandParameters::~AdminCommandParameters ( void  )

inline

Definition at line 38 of file AdminCommandParameters.hpp.

Member Function Documentation

void HCE::handlers::AdminCommandParameters::clear

(

void

)

Definition at line 109 of file AdminCommandParameters.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

std::string HCE::handlers::AdminCommandParameters::getParameters ( void  ) const

inline

Definition at line 46 of file AdminCommandParameters.hpp.

Here is the caller graph for this function:

unsigned int HCE::handlers::AdminCommandParameters::getRealtime ( void  ) const

inline

Definition at line 49 of file AdminCommandParameters.hpp.

Here is the caller graph for this function:

bool HCE::handlers::AdminCommandParameters::isJsonString ( void  ) const

inline

Definition at line 52 of file AdminCommandParameters.hpp.

Here is the caller graph for this function:

bool HCE::handlers::AdminCommandParameters::isRealtime

(

void

)

const

Definition at line 116 of file AdminCommandParameters.cpp.

Here is the caller graph for this function:

bool HCE::handlers::AdminCommandParameters::serialize ( std::string &  json )

virtual

Implements HCE::IJsonSerializable.

Definition at line 33 of file AdminCommandParameters.cpp.

Here is the call graph for this function:

void HCE::handlers::AdminCommandParameters::setParameters ( const std::string &  parameters_ )

inline

Definition at line 45 of file AdminCommandParameters.hpp.

void HCE::handlers::AdminCommandParameters::setRealtime ( unsigned int  realtime_ )

inline

Definition at line 48 of file AdminCommandParameters.hpp.

bool HCE::handlers::AdminCommandParameters::unserialize ( const std::string &  json )

virtual

Implements HCE::IJsonSerializable.

Definition at line 66 of file AdminCommandParameters.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• sources/src/AdminCommandParameters.hpp
• sources/src/AdminCommandParameters.cpp