arm4::ArmUser Class Reference
Represents a user on behalf of whom a transaction is executed. More...
Inheritance diagram for arm4::ArmUser:
Public Member Functions | |
| ArmUser (const std::string &name, const ArmID &id=ArmID::Null) | |
| Constructs an ArmUser object that represents the user who invoked (directly or indirectly) the transaction. | |
| const std::string & | getName () const |
| returns the name of the user | |
| const ArmID & | getID () const |
Detailed Description
Represents a user on behalf of whom a transaction is executed.
It has the following attributes, all of which are immutable:
-
Name: The maximum length is 127 characters (CIM allows 256 but ARM 2.0 allows 128 bytes, including the null-termination character, so 127 is used). The name must not be
NullStringor zero-length. -
(optional) A 16-byte ID is optionally associated with each
ArmUser. It is provided by the application. If the value isArmID::Null, no ID was provided.
Constructor & Destructor Documentation
| arm4::ArmUser::ArmUser | ( | const std::string & | name, | |
| const ArmID & | id = ArmID::Null | |||
| ) |
Constructs an ArmUser object that represents the user who invoked (directly or indirectly) the transaction.
- Parameters:
-
name name of the user. id An optional 16-byte ID associated with the user.
Member Function Documentation
| const ArmID& arm4::ArmUser::getID | ( | ) | const |
- Returns:
- a 16-byte ID associated with the identity of this user, or
ArmID::Null.
| const std::string& arm4::ArmUser::getName | ( | ) | const |
returns the name of the user
- Returns:
- the name of the user.
The documentation for this class was generated from the following file:
- Arm4/ArmUser
