RTI Connext .Net APIs  Version 5.0.0
DDS::KeyedBytes Struct Reference

Built-in type consisting of a variable-length array of opaque bytes and a string that is the key. More...

#include <managed_keyedbytes.h>

Inheritance diagram for DDS::KeyedBytes:
DDS::ICopyable< T >

Public Member Functions

 KeyedBytes ()
 Default Constructor.
 
 KeyedBytes (System::Int32 size)
 Constructor that specifies the allocated sizes.
 
virtual System::Boolean copy_from (KeyedBytes^ src)
 Copy src into this object.
 

Public Attributes

System::String^ key
 Instance key associated with the specified value.
 
System::Int32 length
 Number of bytes to serialize.
 
System::Int32 offset
 Offset from which to start serializing bytes .
 
array< System::Byte >^ value
 DDS::Bytes array value.
 

Detailed Description

Built-in type consisting of a variable-length array of opaque bytes and a string that is the key.

Constructor & Destructor Documentation

DDS::KeyedBytes::KeyedBytes ( )

Default Constructor.

The default constructor initializes the newly created object with empty key, null value, zero length, and zero offset.

DDS::KeyedBytes::KeyedBytes ( System::Int32  size)

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
size<<in>> Size of the allocated bytes array.

Member Function Documentation

virtual System::Boolean DDS::KeyedBytes::copy_from ( KeyedBytes src)
virtual

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
true if success. Otherwise, false.
Exceptions
ArgumentNullExceptionif src is null.

Member Data Documentation

System::String ^ DDS::KeyedBytes::key

Instance key associated with the specified value.

System::Int32 DDS::KeyedBytes::length

Number of bytes to serialize.

System::Int32 DDS::KeyedBytes::offset

Offset from which to start serializing bytes .

The first position of the bytes array has offset 0.

array<System::Byte> ^ DDS::KeyedBytes::value

DDS::Bytes array value.


RTI Connext .Net APIs Version 5.0.0 Copyright © Thu Aug 30 2012 Real-Time Innovations, Inc