ERUCES::TEMessagePrincipal
#include <temsgprincipal.h>
The TEMessagePrincipal class provides methods for maintaining message principals.
The TEMessagePrincipal class is derived from the TEPrincipalInfo class.
Inheritance
- Inherits ERUCES::TEPrincipalInfo
Static Public Attributes
| Type | Name | Description |
|---|---|---|
| _TESTD string | CLASSNAME |
Public Member Functions
| Member | Description |
|---|---|
TEMessagePrincipal() | The TEMessagePrincipal constructor is the default class constructor. |
TEMessagePrincipal(const TEMessagePrincipal &) | The TEMessagePrincipal constructor copies a TEMessagePrincipal object. |
~TEMessagePrincipal() | The TEMessagePrincipal destructor is the class destructor. |
const _TESTD string getPrincipalName() const | The getPrincipalName method gets the name of a principal. It's the same as message. |
void setCode(const uint32_t code) | The setCode method sets message principal code. |
uint32_t getCode() const | The getCode method gets message principal code. |
void setMessage(const _TESTD string &msg) | The setMessage method sets a message principal's message. |
const _TESTD string getMessage() const | The getMessage method gets a message principal's message. |
TEObject * clone() const | The clone method clones an object. |
const _TESTD string getClassName() const | The getClassName method gets the name of the TEMessagePrincipal class. |
Member Function Documentation
TEMessagePrincipal()
The TEMessagePrincipal constructor is the default class constructor.
TEMessagePrincipal(const TEMessagePrincipal &)
The TEMessagePrincipal constructor copies a TEMessagePrincipal object.
~TEMessagePrincipal()
The TEMessagePrincipal destructor is the class destructor.
const _TESTD string getPrincipalName() const
The getPrincipalName method gets the name of a principal. It's the same as message.
Returns: Returns a string representing the name of a principal.
void setCode(const uint32_t code)
The setCode method sets message principal code.
Parameters
| Parameter | Description |
|---|---|
code | A message principal's code. |
uint32_t getCode() const
The getCode method gets message principal code.
Returns: Returns message principal code.
void setMessage(const _TESTD string &msg)
The setMessage method sets a message principal's message.
Parameters
| Parameter | Description |
|---|---|
msg | A string representing a message principal's message. |
const _TESTD string getMessage() const
The getMessage method gets a message principal's message.
Returns: Returns a string representing the message principal's message.
TEObject * clone() const
The clone method clones an object.
Returns: Returns a newly cloned TEMessagePrincipal object.
const _TESTD string getClassName() const
The getClassName method gets the name of the TEMessagePrincipal class.
Returns: Returns a string representing the name of the TEMessagePrincipal class.