arm4::ArmMetricString32 Class Reference
[ARM 4.0 Metric Strings]
Implements a string of 1 to 32 characters. More...
Inheritance diagram for arm4::ArmMetricString32:
Public Member Functions | |
ArmMetricString32 (const ArmMetricString32Definition &definition) | |
Constructs a new metric instance. | |
int32_t | set (const std::string &value) |
Sets the string value. |
Detailed Description
Implements a string of 1 to 32 characters.
It is the same as ARM 2.0 metric type=10 (ARM_String32
), with two differences:
- The characters should be in the standard UTF-8 format.
- The limit of 32 in the ARM 2.0 C language interface is a byte limit. The limit in the ARM 4.0 C bindings is a character limit. Because a character may be represented by more than one byte (e.g., a character in UTF-8 is represented as 1, 2, or 3 bytes), the ARM 4.0 C metric may be longer than 32 bytes.
Constructor & Destructor Documentation
arm4::ArmMetricString32::ArmMetricString32 | ( | const ArmMetricString32Definition & | definition | ) | [inline] |
Constructs a new metric instance.
- Parameters:
-
definition the metadata describing this metric.
Member Function Documentation
int32_t arm4::ArmMetricString32::set | ( | const std::string & | value | ) | [inline] |
Sets the string value.
- Parameters:
-
value new string value.
- Returns:
- 0 on sucess; otherwise, a non-zero error code is returned (as specified in ArmInterface).
The documentation for this class was generated from the following file:
- Arm4/ArmMetricString32