Built-in type consisting of a variable-length array of opaque bytes and a string that is the key. More...
Public Member Functions | |
| KeyedBytes () | |
| Default Constructor. More... | |
| KeyedBytes (KeyedBytes src) | |
| Copy constructor. More... | |
| KeyedBytes (int theLength) | |
| Constructor that specifies the allocated sizes. More... | |
| Object | copy_from (Object src) |
| Copy src into this object. More... | |
Public Attributes | |
| String | key |
| Instance key associated with the specified value. More... | |
| int | length |
| Number of bytes to serialize. More... | |
| int | offset |
| Offset from which to start serializing bytes. More... | |
| byte [] | value |
| com.rti.dds.type.builtin.com.rti.dds.type.builtin.Bytes array value. More... | |
Detailed Description
Built-in type consisting of a variable-length array of opaque bytes and a string that is the key.
Constructor & Destructor Documentation
◆ KeyedBytes() [1/3]
| KeyedBytes | ( | ) |
Default Constructor.
The default constructor initializes the newly created object with empty key, null value, zero length, and zero offset.
Referenced by KeyedBytes.copy_from(), and KeyedBytes.KeyedBytes().
◆ KeyedBytes() [2/3]
| KeyedBytes | ( | KeyedBytes | src | ) |
Copy constructor.
- Parameters
-
src <<in>> Object to copy from.
- Exceptions
-
NullPointerException if src is null.
References KeyedBytes.copy_from().
◆ KeyedBytes() [3/3]
| KeyedBytes | ( | int | theLength | ) |
Constructor that specifies the allocated sizes.
After this method is called, key is initialized with the empty string and length and offset are set to zero.
- Parameters
-
theLength <<in>> Size of the allocated bytes array.
- Exceptions
-
IllegalArgumentException if size is negative
References KeyedBytes.key, KeyedBytes.KeyedBytes(), KeyedBytes.length, KeyedBytes.offset, and KeyedBytes.value.
Member Function Documentation
◆ copy_from()
| Object copy_from | ( | Object | src | ) |
Copy src into this object.
This method performs a deep copy of src and it allocates memory for the value if required.
- Parameters
-
src <<in>> Object to copy from.
- Returns
- this if success. Otherwise, null.
- Exceptions
-
NullPointerException if srcis null.
Implements Copyable.
References KeyedBytes.key, KeyedBytes.KeyedBytes(), KeyedBytes.length, KeyedBytes.offset, and KeyedBytes.value.
Referenced by KeyedBytesTypeSupport.get_type_name(), and KeyedBytes.KeyedBytes().
Member Data Documentation
◆ key
| String key |
Instance key associated with the specified value.
Referenced by KeyedBytes.copy_from(), KeyedBytesTypeSupport.data_to_string(), KeyedBytesTypeSupport.deserialize_from_cdr_buffer(), KeyedBytesDataWriter.dispose(), KeyedBytesDataWriter.dispose_w_timestamp(), KeyedBytesDataReader.get_key_value(), KeyedBytesDataWriter.get_key_value(), KeyedBytesTypeSupport.get_type_name(), KeyedBytes.KeyedBytes(), KeyedBytesDataReader.lookup_instance(), KeyedBytesDataWriter.lookup_instance(), KeyedBytesDataWriter.register_instance(), KeyedBytesDataWriter.register_instance_w_timestamp(), KeyedBytesDataWriter.unregister_instance(), KeyedBytesDataWriter.unregister_instance_w_timestamp(), KeyedBytesDataWriter.write(), and KeyedBytesDataWriter.write_w_timestamp().
◆ length
| int length |
Number of bytes to serialize.
Referenced by KeyedBytes.copy_from(), KeyedBytesTypeSupport.data_to_string(), KeyedBytesTypeSupport.get_type_name(), KeyedBytes.KeyedBytes(), KeyedBytesDataWriter.write(), and KeyedBytesDataWriter.write_w_timestamp().
◆ offset
| int offset |
Offset from which to start serializing bytes.
The first position of the bytes array has offset 0.
Referenced by KeyedBytes.copy_from(), KeyedBytesTypeSupport.data_to_string(), KeyedBytesTypeSupport.get_type_name(), KeyedBytes.KeyedBytes(), KeyedBytesDataWriter.write(), and KeyedBytesDataWriter.write_w_timestamp().
◆ value
| byte [] value |
com.rti.dds.type.builtin.com.rti.dds.type.builtin.Bytes array value.
Referenced by KeyedBytes.copy_from(), KeyedBytesTypeSupport.data_to_string(), KeyedBytesTypeSupport.get_type_name(), KeyedBytes.KeyedBytes(), KeyedBytesDataWriter.write(), and KeyedBytesDataWriter.write_w_timestamp().