#include <managed_dynamicdata.h>
Public Member Functions | |
virtual System::Boolean | copy_from (DynamicData^ other) |
Deeply copy from the given object to this object. | |
DynamicData (DDS::TypeCode^ type, DynamicDataProperty_t^ property) | |
The constructor for new DDS::DynamicData objects. | |
System::Boolean | is_valid () |
Indicates whether the object was constructed properly. | |
void | copy (DynamicData^ src) |
Deeply copy from the given object to this object. | |
System::Boolean | equal (DynamicData^ other) |
Indicate whether the contents of another DDS::DynamicData sample are the same as those of this one. | |
void | clear_all_members () |
Clear the contents of all data members of this object, including key members. | |
void | clear_nonkey_members () |
Clear the contents of all data members of this object, not including key members. | |
void | clear_member (System::String^ member_name, System::Int32 member_id) |
Clear the contents of a single data member of this object. | |
void | get_info (DynamicDataInfo^ info_out) |
Fill in the given descriptor with information about this DDS::DynamicData. | |
void | bind_type (DDS::TypeCode^ type) |
If this DDS::DynamicData object is not yet associated with a data type, set that type now to the given DDS::TypeCode. | |
void | unbind_type () |
Dissociate this DDS::DynamicData object from any particular data type. | |
void | bind_complex_member (DynamicData^ value_out, System::String^ member_name, System::Int32 member_id) |
Use another DDS::DynamicData object to provide access to a complex field of this DDS::DynamicData object. | |
void | unbind_complex_member (DynamicData^ value) |
Tear down the association created by a DDS::DynamicData::bind_complex_member operation, committing any changes to the outer object since then. | |
DDS::TypeCode^ | get_type () |
Get the data type, of which this DDS::DynamicData represents an instance. | |
TCKind | get_type_kind () |
Get the kind of this object's data type. | |
System::UInt32 | get_member_count () |
Get the number of members in this sample. | |
System::Boolean | member_exists (System::String^ member_name, System::Int32 member_id) |
Indicates whether a member of a particular name/ID exists in this data sample. | |
System::Boolean | member_exists_in_type (System::String^ member_name, System::Int32 member_id) |
Indicates whether a member of a particular name/ID exists in this data sample's type. | |
void | get_member_info (DynamicDataMemberInfo^ info, System::String^ member_name, System::Int32 member_id) |
Fill in the given descriptor with information about the identified member of this DDS::DynamicData sample. | |
void | get_member_info_by_index (DynamicDataMemberInfo^ info, System::UInt32 index) |
Fill in the given descriptor with information about the identified member of this DDS::DynamicData sample. | |
void | get_member_type (DDS::TypeCode^ %type_out, System::String^ member_name, System::Int32 member_id) |
Get the type of the given member of this sample. | |
System::Boolean | is_member_key (System::String^ member_name, System::Int32 member_id) |
Indicates whether a given member forms part of the key of this sample's data type. | |
System::Int32 | get_int (System::String^ member_name, System::Int32 member_id) |
Get the value of the given field, which is of type System::Int32 or another type implicitly convertible to it. | |
System::Int16 | get_short (System::String^ member_name, System::Int32 member_id) |
Get the value of the given field, which is of type System::Int16 or another type implicitly convertible to it. | |
System::UInt32 | get_uint (System::String^ member_name, System::Int32 member_id) |
Get the value of the given field, which is of type System::UInt32 or another type implicitly convertible to it. | |
System::UInt16 | get_ushort (System::String^ member_name, System::Int32 member_id) |
Get the value of the given field, which is of type System::UInt16 or another type implicitly convertible to it. | |
System::Single | get_float (System::String^ member_name, System::Int32 member_id) |
Get the value of the given field, which is of type System::Single or another type implicitly convertible to it. | |
System::Double | get_double (System::String^ member_name, System::Int32 member_id) |
Get the value of the given field, which is of type System::Double or another type implicitly convertible to it. | |
System::Boolean | get_boolean (System::String^ member_name, System::Int32 member_id) |
Get the value of the given field, which is of type System::Boolean. | |
System::Char | get_char (System::String^ member_name, System::Int32 member_id) |
Get the value of the given field, which is of type System::Char or another type implicitly convertible to it. | |
System::Byte | get_byte (System::String^ member_name, System::Int32 member_id) |
Get the value of the given field, which is of type System::Byte or another type implicitly convertible to it. | |
System::Int64 | get_long (System::String^ member_name, System::Int32 member_id) |
Get the value of the given field, which is of type System::Int64 or another type implicitly convertible to it. | |
System::UInt64 | get_ulong (System::String^ member_name, System::Int32 member_id) |
Get the value of the given field, which is of type System::UInt64 or another type implicitly convertible to it. | |
LongDouble | get_longdouble (System::String^ member_name, System::Int32 member_id) |
Get the value of the given field, which is of type DDS::LongDouble or another type implicitly convertible to it. | |
System::Char | get_wchar (System::String^ member_name, System::Int32 member_id) |
Get the value of the given field, which is of type System::Char or another type implicitly convertible to it. | |
System::String^ | get_string (System::String^ member_name, System::Int32 member_id) |
Get the value of the given field, which is of type System::String. | |
System::String^ | get_wstring (System::String^ member_name, System::Int32 member_id) |
Get the value of the given field, which is of type System::String. | |
void | get_complex_member (DynamicData^ value_out, System::String^ member_name, System::Int32 member_id) |
Get a copy of the value of the given field, which is of some composed type. | |
void | get_int_array (array< System::Int32 >^array, System::String^ member_name, System::Int32 member_id) |
Get a copy of the given array member. | |
void | get_short_array (array< System::Int16 >^array, System::String^ member_name, System::Int32 member_id) |
Get a copy of the given array member. | |
void | get_uint_array (array< System::UInt32 >^array, System::String^ member_name, System::Int32 member_id) |
Get a copy of the given array member. | |
void | get_ushort_array (array< System::UInt16 >^array, System::String^ member_name, System::Int32 member_id) |
Get a copy of the given array member. | |
void | get_float_array (array< System::Single >^array, System::String^ member_name, System::Int32 member_id) |
Get a copy of the given array member. | |
void | get_double_array (array< System::Double >^array, System::String^ member_name, System::Int32 member_id) |
Get a copy of the given array member. | |
void | get_boolean_array (array< System::Boolean >^array, System::String^ member_name, System::Int32 member_id) |
Get a copy of the given array member. | |
void | get_char_array (array< System::Char >^array, System::String^ member_name, System::Int32 member_id) |
Get a copy of the given array member. | |
void | get_byte_array (array< System::Byte >^array, System::String^ member_name, System::Int32 member_id) |
Get a copy of the given array member. | |
void | get_long_array (array< System::Int64 >^array, System::String^ member_name, System::Int32 member_id) |
Get a copy of the given array member. | |
void | get_ulong_array (array< System::UInt64 >^array, System::String^ member_name, System::Int32 member_id) |
Get a copy of the given array member. | |
void | get_longdouble_array (array< LongDouble >^array, System::String^ member_name, System::Int32 member_id) |
Get a copy of the given array member. | |
void | get_wchar_array (array< System::Char >^array, System::String^ member_name, System::Int32 member_id) |
Get a copy of the given array member. | |
void | get_int_seq (IntSeq^ seq, System::String^ member_name, System::Int32 member_id) |
Get a copy of the given sequence member. | |
void | get_short_seq (ShortSeq^ seq, System::String^ member_name, System::Int32 member_id) |
Get a copy of the given sequence member. | |
void | get_uint_seq (UnsignedIntSeq^ seq, System::String^ member_name, System::Int32 member_id) |
Get a copy of the given sequence member. | |
void | get_ushort_seq (UnsignedShortSeq^ seq, System::String^ member_name, System::Int32 member_id) |
Get a copy of the given sequence member. | |
void | get_float_seq (FloatSeq^ seq, System::String^ member_name, System::Int32 member_id) |
Get a copy of the given sequence member. | |
void | get_double_seq (DoubleSeq^ seq, System::String^ member_name, System::Int32 member_id) |
Get a copy of the given sequence member. | |
void | get_boolean_seq (BooleanSeq^ seq, System::String^ member_name, System::Int32 member_id) |
Get a copy of the given sequence member. | |
void | get_char_seq (CharSeq^ seq, System::String^ member_name, System::Int32 member_id) |
Get a copy of the given sequence member. | |
void | get_byte_seq (ByteSeq^ seq, System::String^ member_name, System::Int32 member_id) |
Get a copy of the given sequence member. | |
void | get_long_seq (LongSeq^ seq, System::String^ member_name, System::Int32 member_id) |
Get a copy of the given sequence member. | |
void | get_ulong_seq (UnsignedLongSeq^ seq, System::String^ member_name, System::Int32 member_id) |
Get a copy of the given sequence member. | |
void | get_longdouble_seq (LongDoubleSeq^ seq, System::String^ member_name, System::Int32 member_id) |
Get a copy of the given sequence member. | |
void | get_wchar_seq (WcharSeq^ seq, System::String^ member_name, System::Int32 member_id) |
Get a copy of the given sequence member. | |
void | set_int (System::String^ member_name, System::Int32 member_id, System::Int32 value) |
Set the value of the given field, which is of type System::Int32. | |
void | set_short (System::String^ member_name, System::Int32 member_id, System::Int16 value) |
Set the value of the given field, which is of type System::Int16. | |
void | set_uint (System::String^ member_name, System::Int32 member_id, System::UInt32 value) |
Set the value of the given field, which is of type System::UInt32. | |
void | set_ushort (System::String^ member_name, System::Int32 member_id, System::UInt16 value) |
Set the value of the given field, which is of type System::UInt16. | |
void | set_float (System::String^ member_name, System::Int32 member_id, System::Single value) |
Set the value of the given field, which is of type System::Single. | |
void | set_double (System::String^ member_name, System::Int32 member_id, System::Double value) |
Set the value of the given field, which is of type System::Double. | |
void | set_boolean (System::String^ member_name, System::Int32 member_id, System::Boolean value) |
Set the value of the given field, which is of type System::Boolean. | |
void | set_char (System::String^ member_name, System::Int32 member_id, System::Char value) |
Set the value of the given field, which is of type System::Char. | |
void | set_byte (System::String^ member_name, System::Int32 member_id, System::Byte value) |
Set the value of the given field, which is of type System::Byte. | |
void | set_long (System::String^ member_name, System::Int32 member_id, System::Int64 value) |
Set the value of the given field, which is of type System::Int64. | |
void | set_ulong (System::String^ member_name, System::Int32 member_id, System::UInt64 value) |
Set the value of the given field, which is of type System::UInt64. | |
void | set_longdouble (System::String^ member_name, System::Int32 member_id, LongDouble value) |
Set the value of the given field, which is of type DDS::LongDouble. | |
void | set_wchar (System::String^ member_name, System::Int32 member_id, System::Char value) |
Set the value of the given field, which is of type System::Char. | |
void | set_string (System::String^ member_name, System::Int32 member_id, System::String^ value) |
Set the value of the given field of type System::String. | |
void | set_wstring (System::String^ member_name, System::Int32 member_id, System::String^ value) |
Set the value of the given field of type System::String. | |
void | set_complex_member (System::String^ member_name, System::Int32 member_id, DynamicData^ value) |
Copy the state of the given DDS::DynamicData object into a member of this object. | |
void | set_int_array (System::String^ member_name, System::Int32 member_id, array< System::Int32 >^array) |
Set the contents of the given array member. | |
void | set_short_array (System::String^ member_name, System::Int32 member_id, array< System::Int16 >^array) |
Set the contents of the given array member. | |
void | set_uint_array (System::String^ member_name, System::Int32 member_id, array< System::UInt32 >^array) |
Set the contents of the given array member. | |
void | set_ushort_array (System::String^ member_name, System::Int32 member_id, array< System::UInt16 >^array) |
Set the contents of the given array member. | |
void | set_float_array (System::String^ member_name, System::Int32 member_id, array< System::Single >^array) |
Set the contents of the given array member. | |
void | set_double_array (System::String^ member_name, System::Int32 member_id, array< System::Double >^array) |
Set the contents of the given array member. | |
void | set_boolean_array (System::String^ member_name, System::Int32 member_id, array< System::Boolean >^array) |
Set the contents of the given array member. | |
void | set_char_array (System::String^ member_name, System::Int32 member_id, array< System::Char >^array) |
Set the contents of the given array member. | |
void | set_byte_array (System::String^ member_name, System::Int32 member_id, array< System::Byte >^array) |
Set the contents of the given array member. | |
void | set_long_array (System::String^ member_name, System::Int32 member_id, array< System::Int64 >^array) |
Set the contents of the given array member. | |
void | set_ulong_array (System::String^ member_name, System::Int32 member_id, array< System::UInt64 >^array) |
Set the contents of the given array member. | |
void | set_longdouble_array (System::String^ member_name, System::Int32 member_id, array< LongDouble >^array) |
Set the contents of the given array member. | |
void | set_wchar_array (System::String^ member_name, System::Int32 member_id, array< System::Char >^array) |
Set the contents of the given array member. | |
void | set_int_seq (System::String^ member_name, System::Int32 member_id, IntSeq^ value) |
Set the contents of the given sequence member. | |
void | set_short_seq (System::String^ member_name, System::Int32 member_id, ShortSeq^ value) |
Set the contents of the given sequence member. | |
void | set_uint_seq (System::String^ member_name, System::Int32 member_id, UnsignedIntSeq^ value) |
Set the contents of the given sequence member. | |
void | set_ushort_seq (System::String^ member_name, System::Int32 member_id, UnsignedShortSeq^ value) |
Set the contents of the given sequence member. | |
void | set_float_seq (System::String^ member_name, System::Int32 member_id, FloatSeq^ value) |
Set the contents of the given sequence member. | |
void | set_double_seq (System::String^ member_name, System::Int32 member_id, DoubleSeq^ value) |
Set the contents of the given sequence member. | |
void | set_boolean_seq (System::String^ member_name, System::Int32 member_id, BooleanSeq^ value) |
Set the contents of the given sequence member. | |
void | set_char_seq (System::String^ member_name, System::Int32 member_id, CharSeq^ value) |
Set the contents of the given sequence member. | |
void | set_byte_seq (System::String^ member_name, System::Int32 member_id, ByteSeq^ value) |
Set the contents of the given sequence member. | |
void | set_long_seq (System::String^ member_name, System::Int32 member_id, LongSeq^ value) |
Set the contents of the given sequence member. | |
void | set_ulong_seq (System::String^ member_name, System::Int32 member_id, UnsignedLongSeq^ value) |
Set the contents of the given sequence member. | |
void | set_longdouble_seq (System::String^ member_name, System::Int32 member_id, LongDoubleSeq^ value) |
Set the contents of the given sequence member. | |
void | set_wchar_seq (System::String^ member_name, System::Int32 member_id, WcharSeq^ value) |
Set the contents of the given sequence member. | |
~DynamicData () | |
Finalize and deallocate this DDS::DynamicData sample. | |
Static Public Attributes | |
static System::Int32 | MEMBER_ID_UNSPECIFIED |
A sentinel value that indicates that no member ID is needed in order to perform some operation. | |
static DynamicDataProperty_t^ | DYNAMIC_DATA_PROPERTY_DEFAULT |
Sentinel constant indicating default values for DDS::DynamicDataProperty_t. |
Objects of type DDS::DynamicData represent corresponding objects of the type identified by their DDS::TypeCode. Because the definition of these types may not have existed at compile time on the system on which the application is running, you will interact with the data using an API of reflective getters and setters.
For example, if you had access to your data types at compile time, you could do this:
theValue = theObject.theField;
Instead, you will do something like this:
theValue = get(theObject, "theField");
DDS::DynamicData objects can represent any complex data type, including those of type kinds DDS::TCKind::TK_ARRAY, DDS::TCKind::TK_SEQUENCE, DDS::TCKind::TK_STRUCT, DDS::TCKind::TK_UNION, DDS::TCKind::TK_VALUE, and DDS::TCKind::TK_SPARSE. They cannot represent objects of basic types (e.g. integers and strings). Since those type definitions always exist on every system, you can examine their objects directly.
You define the name and ID of a type member when you add that member to that type. When you define a sparse type, you will typically choose both explicitly. If you define your type in IDL or XML, the name will be the field name that appears in the type definition; the ID will be the one-based index of the field in declaration order. For example, in the following IDL structure, the ID of theLong
is 2.
struct MyType { short theShort; long theLong; };
IDs work the same way for DDS::DynamicData objects representing arrays and sequences, since the elements of these collections have no explicit IDs: the ID is one more than the index. (The first element is ID 1, the second is 2, etc.) Array and sequence elements do not have names.
Multi-dimensional arrays are effectively flattened by the DDS::DynamicData API. For example, for an array theArray
[4][5], accessing ID 7 is equivalent to index 6, or the second element of the second group of 5.
For unions (DDS::TCKind::TK_UNION), the ID of a member is the discriminator value corresponding to that member.
DDS::DynamicDataTypeSupport | DDS::DynamicData |
---|---|
DDS::DynamicDataTypeSupport::create_data | DDS::DynamicData::DynamicData |
You can also copy DDS::DynamicData objects:
You can test them for equality:
When working with a DDS::DynamicData object representing an array or sequence, calling one of the "get" methods below for an index that is out of bounds will result in DDS::Retcode_NoData. Calling "set" for an index that is past the end of a sequence will cause that sequence to automatically lengthen (filling with default contents).
Get | Set |
---|---|
DDS::DynamicData::get_complex_member | DDS::DynamicData::set_complex_member |
In addition to getting or setting a field, you can "clear" its value; that is, set it to a default zero value.
For example, suppose a type definition like the following:
struct MyType { float my_float; sequence<octet> my_bytes; short my_short; };
The richness of the type system makes it difficult to fully characterize the performance differences between all access patterns. Nevertheless, the following are generally true:
my_float
, then my_bytes
, and finally my_short
. DDS::DynamicData::DynamicData | ( | DDS::TypeCode^ | type, | |
DynamicDataProperty_t^ | property | |||
) |
The constructor for new DDS::DynamicData objects.
The type parameter may be null. In that case, this DDS::DynamicData must be bound with DDS::DynamicData::bind_type or DDS::DynamicData::bind_complex_member before it can be used.
If the DDS::TypeCode is not null, the newly constructed DDS::DynamicData object will retain a reference to it. It is not safe to delete the DDS::TypeCode until all samples that use it have themselves been deleted.
In most cases, it is not necessary to call this constructor explicitly. Instead, use DDS::DynamicDataTypeSupport::create_data, and the DDS::TypeCode and properties will be specified for you. Using the factory method also ensures that the memory management contract documented above is followed correctly, because the DDS::DynamicDataTypeSupport object maintains the DDS::TypeCode used by the samples it creates.
However you create a DDS::DynamicData object, you must delete it when you are finished with it. If you choose to use this constructor, delete the object with the destructor: DDS::DynamicData::delete.
In C#:
DynamicData sample = new DynamicData( myType, myProperties); // Do something... sample.dispose();
In C++/CLI:
DynamicData^ sample = gcnew DynamicData( myType, myProperties); // Do something... delete sample;
type | <<in>> The type of which the new object will represent an object. | |
property | <<in>> Properties that configure the behavior of the new object. Most users can simply use DDS::DynamicDataProperty_t::DYNAMIC_DATA_PROPERTY_DEFAULT. |
DDS::DynamicData::~DynamicData | ( | ) |
Finalize and deallocate this DDS::DynamicData sample.
virtual System::Boolean DDS::DynamicData::copy_from | ( | DynamicData^ | other | ) | [virtual] |
Deeply copy from the given object to this object.
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
System::Boolean DDS::DynamicData::is_valid | ( | ) |
Indicates whether the object was constructed properly.
This method returns true if the constructor succeeded; it returns false if the constructor failed for any reason, which should also have resulted in a log message. It is only necessary to call this method if you created the DDS::DynamicData object using the constructor, DDS::DynamicData::DynamicData.
Possible failure reasons include passing an invalid type or invalid properties to the constructor.
This method is necessary because C++ exception support is not consistent across all of the platforms on which RTI Data Distribution Service runs. Therefore, the implementation does not throw any exceptions in the constructor.
void DDS::DynamicData::copy | ( | DynamicData^ | src | ) |
Deeply copy from the given object to this object.
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
System::Boolean DDS::DynamicData::equal | ( | DynamicData^ | other | ) |
Indicate whether the contents of another DDS::DynamicData sample are the same as those of this one.
This operation compares the data and type of existing members. The types of non-instantiated members may differ in sparse types.
void DDS::DynamicData::clear_all_members | ( | ) |
Clear the contents of all data members of this object, including key members.
One | of the Standard Return Codes |
void DDS::DynamicData::clear_nonkey_members | ( | ) |
Clear the contents of all data members of this object, not including key members.
This method is only applicable to sparse value types.
One | of the Standard Return Codes |
void DDS::DynamicData::clear_member | ( | System::String^ | member_name, | |
System::Int32 | member_id | |||
) |
Clear the contents of a single data member of this object.
This method is only applicable to sparse value types.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
One | of the Standard Return Codes |
void DDS::DynamicData::get_info | ( | DynamicDataInfo^ | info_out | ) |
Fill in the given descriptor with information about this DDS::DynamicData.
info_out | <<out>> The descriptor object whose contents will be overwritten by this operation. |
void DDS::DynamicData::bind_type | ( | DDS::TypeCode^ | type | ) |
If this DDS::DynamicData object is not yet associated with a data type, set that type now to the given DDS::TypeCode.
This advanced operation allows you to reuse a single DDS::DynamicData object with multiple data types.
In C#:
DynamicData myData = new DynamicData(null, myProperties); TypeCode myType = ...; myData.bind_type(myType); try { // Do something... } finally { myData.unbind_type(); } myData.Dispose()
In C++/CLI:
DynamicData^ myData = gcnew DynamicData(nullptr, myProperties); TypeCode^ myType = ...; myData->bind_type(myType); try { // Do something... } finally { myData->unbind_type(); } delete myData;
Note that the DDS::DynamicData object will retain a reference to the DDS::TypeCode object you provide. It is not safe to delete the DDS::TypeCode until after it is unbound.
type | <<in>> The type to associate with this DDS::DynamicData object. |
One | of the Standard Return Codes |
void DDS::DynamicData::unbind_type | ( | ) |
Dissociate this DDS::DynamicData object from any particular data type.
This step is necessary before the object can be associated with a new data type.
This operation clears all members as a side effect.
One | of the Standard Return Codes |
void DDS::DynamicData::bind_complex_member | ( | DynamicData^ | value_out, | |
System::String^ | member_name, | |||
System::Int32 | member_id | |||
) |
Use another DDS::DynamicData object to provide access to a complex field of this DDS::DynamicData object.
For example, consider the following data types:
struct MyFieldType { float theFloat; }; struct MyOuterType { MyFieldType complexMember; };
Suppose you have an instance of MyOuterType
, and you would like to examine the contents of its member complexMember
. To do this, you must bind another DDS::DynamicData object to that member. This operation will bind the type code of the member to the provided DDS::DynamicData object and perform additional initialization.
The following example demonstrates the usage pattern. Note that error handling has been omitted for brevity.
In C#:
DynamicData outer = ...; DynamicData toBeBound = new DynamicData(null, myProperties); outer.bind_complex_member( toBeBound, "complexMember", DynamicData.MEMBER_ID_UNSPECIFIED); try { float theFloatValue = toBeBound.get_float( "theFloat" DynamicData.MEMBER_ID_UNSPECIFIED); } finally { outer.unbind_complex_member(toBeBound); } toBeBound.Dispose();
In C++/CLI:
DynamicData^ outer = ...; DynamicData^ toBeBound = gcnew DynamicData(nullptr, myProperties); outer->bind_complex_member( toBeBound, "complexMember", DynamicData::MEMBER_ID_UNSPECIFIED); try { float theFloatValue = toBeBound->get_float( "theFloat" DynamicData::MEMBER_ID_UNSPECIFIED); } finally { outer->unbind_complex_member(toBeBound); } delete toBeBound;
This operation is only permitted when the object toBeBound
(named as in the example above) is not currently associated with any type, including already being bound to another member. You can see in the example that this object is created directly with the constructer and is not provided with a DDS::TypeCode.
Only a single member of a given DDS::DynamicData object may be bound at one time -- however, members of members may be recursively bound to any depth. Furthermore, while the outer object has a bound member, it may only be modified through that bound member. That is, after calling this member, all "set" operations on the outer object will be disabled until DDS::DynamicData::unbind_complex_member has been called. Furthermore, any bound member must be unbound before a sample can be written or deleted.
This method is logically related to DDS::DynamicData::get_complex_member in that both allow you to examine the state of nested objects. They are different in an important way: this method provides a view into an outer object, such that any change made to the inner object will be reflected in the outer. But the DDS::DynamicData::get_complex_member operation copies the state of the nested object; changes to it will not be reflected in the source object.
Note that you can bind to a member of a sequence at an index that is past the current length of that sequence. In that case, this method behaves like a "set" method: it automatically lengthens the sequence (filling in default elements) to allow the bind to take place. See Getters and Setters.
value_out | <<out>> The object that you wish to bind to the field. | |
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
One | of the Standard Return Codes |
void DDS::DynamicData::unbind_complex_member | ( | DynamicData^ | value | ) |
Tear down the association created by a DDS::DynamicData::bind_complex_member operation, committing any changes to the outer object since then.
Some changes to the outer object will not be observable until after you have performed this operation.
If you have called DDS::DynamicData::bind_complex_member on a data sample, you must unbind before writing or deleting the sample.
value | <<in>> The same object you passed to DDS::DynamicData::bind_complex_member. This argument is used for error checking purposes. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
DDS::TypeCode ^ DDS::DynamicData::get_type | ( | ) |
TCKind DDS::DynamicData::get_type_kind | ( | ) |
Get the kind of this object's data type.
This is a convenience method. It's equivalent to calling DDS::DynamicData::get_type followed by DDS::TypeCode::kind.
System::UInt32 DDS::DynamicData::get_member_count | ( | ) |
Get the number of members in this sample.
For objects of type kind DDS::TCKind::TK_ARRAY or DDS::TCKind::TK_SEQUENCE, this method returns the number of elements in the collection.
For objects of type kind DDS::TCKind::TK_STRUCT or DDS::TCKind::TK_VALUE, it returns the number of fields in the sample, which will always be the same as the number of fields in the type.
For objects of type kind DDS::TCKind::TK_SPARSE, it returns the number of fields in the sample, which may be less than or equal to the number of fields in the type.
System::Boolean DDS::DynamicData::member_exists | ( | System::String^ | member_name, | |
System::Int32 | member_id | |||
) |
Indicates whether a member of a particular name/ID exists in this data sample.
Only one of the name and/or ID need by specified.
For objects of type kinds other than DDS::TCKind::TK_SPARSE, the result of this method will always be the same as that of DDS::DynamicData::member_exists_in_type.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
System::Boolean DDS::DynamicData::member_exists_in_type | ( | System::String^ | member_name, | |
System::Int32 | member_id | |||
) |
Indicates whether a member of a particular name/ID exists in this data sample's type.
Only one of the name and/or ID need by specified.
For objects of type kinds other than DDS::TCKind::TK_SPARSE, the result of this method will always be the same as that of DDS::DynamicData::member_exists.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
void DDS::DynamicData::get_member_info | ( | DynamicDataMemberInfo^ | info, | |
System::String^ | member_name, | |||
System::Int32 | member_id | |||
) |
Fill in the given descriptor with information about the identified member of this DDS::DynamicData sample.
This operation is valid for objects of DDS::TCKind DDS::TCKind::TK_ARRAY, DDS::TCKind::TK_SEQUENCE, DDS::TCKind::TK_STRUCT, DDS::TCKind::TK_VALUE, and DDS::TCKind::TK_SPARSE.
info | <<out>> The descriptor object whose contents will be overwritten by this operations. | |
member_name | <<in>> The name of the member for which to get the info or null to look up the member by its ID. Only one of the name and the ID may be unspecified. | |
member_id | <<in>> The ID of the member for which to get the info, or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
One | of the Standard Return Codes |
void DDS::DynamicData::get_member_info_by_index | ( | DynamicDataMemberInfo^ | info, | |
System::UInt32 | index | |||
) |
Fill in the given descriptor with information about the identified member of this DDS::DynamicData sample.
This operation is valid for objects of DDS::TCKind DDS::TCKind::TK_ARRAY, DDS::TCKind::TK_SEQUENCE, DDS::TCKind::TK_STRUCT, DDS::TCKind::TK_VALUE, and DDS::TCKind::TK_SPARSE.
info | <<out>> The descriptor object whose contents will be overwritten by this operations. | |
index | <<in>> The zero-based of the member for which to get the info. |
One | of the Standard Return Codes |
void DDS::DynamicData::get_member_type | ( | DDS::TypeCode^ % | type_out, | |
System::String^ | member_name, | |||
System::Int32 | member_id | |||
) |
Get the type of the given member of this sample.
The member can be looked up either by name or by ID.
This operation is valid for objects of DDS::TCKind DDS::TCKind::TK_ARRAY, DDS::TCKind::TK_SEQUENCE, DDS::TCKind::TK_STRUCT, DDS::TCKind::TK_VALUE, and DDS::TCKind::TK_SPARSE. For type kinds DDS::TCKind::TK_ARRAY and DDS::TCKind::TK_SEQUENCE, the index into the collection is taken to be one less than the ID, if specified. If this index is valid, this operation will return the content type of this collection.
type_out | <<out>> If this method returned success, this argument refers to the found member's type. | |
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
One | of the Standard Return Codes |
System::Boolean DDS::DynamicData::is_member_key | ( | System::String^ | member_name, | |
System::Int32 | member_id | |||
) |
Indicates whether a given member forms part of the key of this sample's data type.
This operation is only valid for samples of types of kind DDS::TCKind::TK_STRUCT, DDS::TCKind::TK_VALUE, or DDS::TCKind::TK_SPARSE.
Note to users of sparse types: A key member may only have a single representation and is required to exist in every sample.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
One | of the Standard Return Codes |
System::Int32 DDS::DynamicData::get_int | ( | System::String^ | member_name, | |
System::Int32 | member_id | |||
) |
Get the value of the given field, which is of type System::Int32 or another type implicitly convertible to it.
The member may be specified by name or by ID.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
One | of the Standard Return Codes |
System::Int16 DDS::DynamicData::get_short | ( | System::String^ | member_name, | |
System::Int32 | member_id | |||
) |
Get the value of the given field, which is of type System::Int16 or another type implicitly convertible to it.
The member may be specified by name or by ID.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
One | of the Standard Return Codes |
System::UInt32 DDS::DynamicData::get_uint | ( | System::String^ | member_name, | |
System::Int32 | member_id | |||
) |
Get the value of the given field, which is of type System::UInt32 or another type implicitly convertible to it.
The member may be specified by name or by ID.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
One | of the Standard Return Codes |
System::UInt16 DDS::DynamicData::get_ushort | ( | System::String^ | member_name, | |
System::Int32 | member_id | |||
) |
Get the value of the given field, which is of type System::UInt16 or another type implicitly convertible to it.
The member may be specified by name or by ID.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
One | of the Standard Return Codes |
System::Single DDS::DynamicData::get_float | ( | System::String^ | member_name, | |
System::Int32 | member_id | |||
) |
Get the value of the given field, which is of type System::Single or another type implicitly convertible to it.
The member may be specified by name or by ID.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
One | of the Standard Return Codes |
System::Double DDS::DynamicData::get_double | ( | System::String^ | member_name, | |
System::Int32 | member_id | |||
) |
Get the value of the given field, which is of type System::Double or another type implicitly convertible to it.
The member may be specified by name or by ID.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
One | of the Standard Return Codes |
System::Boolean DDS::DynamicData::get_boolean | ( | System::String^ | member_name, | |
System::Int32 | member_id | |||
) |
Get the value of the given field, which is of type System::Boolean.
The member may be specified by name or by ID.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
One | of the Standard Return Codes |
System::Char DDS::DynamicData::get_char | ( | System::String^ | member_name, | |
System::Int32 | member_id | |||
) |
Get the value of the given field, which is of type System::Char or another type implicitly convertible to it.
The member may be specified by name or by ID.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
One | of the Standard Return Codes |
System::Byte DDS::DynamicData::get_byte | ( | System::String^ | member_name, | |
System::Int32 | member_id | |||
) |
Get the value of the given field, which is of type System::Byte or another type implicitly convertible to it.
The member may be specified by name or by ID.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
One | of the Standard Return Codes |
System::Int64 DDS::DynamicData::get_long | ( | System::String^ | member_name, | |
System::Int32 | member_id | |||
) |
Get the value of the given field, which is of type System::Int64 or another type implicitly convertible to it.
The member may be specified by name or by ID.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
One | of the Standard Return Codes |
System::UInt64 DDS::DynamicData::get_ulong | ( | System::String^ | member_name, | |
System::Int32 | member_id | |||
) |
Get the value of the given field, which is of type System::UInt64 or another type implicitly convertible to it.
The member may be specified by name or by ID.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
One | of the Standard Return Codes |
LongDouble DDS::DynamicData::get_longdouble | ( | System::String^ | member_name, | |
System::Int32 | member_id | |||
) |
Get the value of the given field, which is of type DDS::LongDouble or another type implicitly convertible to it.
The member may be specified by name or by ID.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
One | of the Standard Return Codes |
System::Char DDS::DynamicData::get_wchar | ( | System::String^ | member_name, | |
System::Int32 | member_id | |||
) |
Get the value of the given field, which is of type System::Char or another type implicitly convertible to it.
The member may be specified by name or by ID.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
One | of the Standard Return Codes |
System::String ^ DDS::DynamicData::get_string | ( | System::String^ | member_name, | |
System::Int32 | member_id | |||
) |
Get the value of the given field, which is of type System::String.
The member may be specified by name or by ID.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
System::String ^ DDS::DynamicData::get_wstring | ( | System::String^ | member_name, | |
System::Int32 | member_id | |||
) |
Get the value of the given field, which is of type System::String.
The member may be specified by name or by ID.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
void DDS::DynamicData::get_complex_member | ( | DynamicData^ | value_out, | |
System::String^ | member_name, | |||
System::Int32 | member_id | |||
) |
Get a copy of the value of the given field, which is of some composed type.
The member may be of type kind DDS::TCKind::TK_ARRAY, DDS::TCKind::TK_SEQUENCE, DDS::TCKind::TK_STRUCT, DDS::TCKind::TK_VALUE, DDS::TCKind::TK_UNION, or DDS::TCKind::TK_SPARSE. It may be specified by name or by ID.
This method is logically related to DDS::DynamicData::bind_complex_member in that both allow you to examine the state of nested objects. They are different in an important way: this method provides a copy of the data; changes to it will not be reflected in the source object.
value_out | <<out>> The DDS::DynamicData sample whose contents will be overwritten by this operation. This object must not be a bound member of another DDS::DynamicData sample. | |
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
void DDS::DynamicData::get_int_array | ( | array< System::Int32 >^ | array, | |
System::String^ | member_name, | |||
System::Int32 | member_id | |||
) |
Get a copy of the given array member.
This method will perform an automatic conversion from IntSeq.
If the destination array is insufficiently long to store the data, this operation will fail without copying anything.
array | <<out>> An already-allocated array, into which the elements will be copied. | |
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
One | of the Standard Return Codes |
void DDS::DynamicData::get_short_array | ( | array< System::Int16 >^ | array, | |
System::String^ | member_name, | |||
System::Int32 | member_id | |||
) |
Get a copy of the given array member.
This method will perform an automatic conversion from DDS::ShortSeq.
If the destination array is insufficiently long to store the data, this operation will fail without copying anything.
array | <<out>> An already-allocated array, into which the elements will be copied. | |
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
One | of the Standard Return Codes |
void DDS::DynamicData::get_uint_array | ( | array< System::UInt32 >^ | array, | |
System::String^ | member_name, | |||
System::Int32 | member_id | |||
) |
Get a copy of the given array member.
This method will perform an automatic conversion from UnsignedIntSeq.
If the destination array is insufficiently long to store the data, this operation will fail without copying anything.
array | <<out>> An already-allocated array, into which the elements will be copied. | |
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
One | of the Standard Return Codes |
void DDS::DynamicData::get_ushort_array | ( | array< System::UInt16 >^ | array, | |
System::String^ | member_name, | |||
System::Int32 | member_id | |||
) |
Get a copy of the given array member.
This method will perform an automatic conversion from DDS::UnsignedShortSeq.
If the destination array is insufficiently long to store the data, this operation will fail without copying anything.
array | <<out>> An already-allocated array, into which the elements will be copied. | |
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
One | of the Standard Return Codes |
void DDS::DynamicData::get_float_array | ( | array< System::Single >^ | array, | |
System::String^ | member_name, | |||
System::Int32 | member_id | |||
) |
Get a copy of the given array member.
This method will perform an automatic conversion from DDS::FloatSeq.
If the destination array is insufficiently long to store the data, this operation will fail without copying anything.
array | <<out>> An already-allocated array, into which the elements will be copied. | |
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
One | of the Standard Return Codes |
void DDS::DynamicData::get_double_array | ( | array< System::Double >^ | array, | |
System::String^ | member_name, | |||
System::Int32 | member_id | |||
) |
Get a copy of the given array member.
This method will perform an automatic conversion from DDS::DoubleSeq.
If the destination array is insufficiently long to store the data, this operation will fail without copying anything.
array | <<out>> An already-allocated array, into which the elements will be copied. | |
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
One | of the Standard Return Codes |
void DDS::DynamicData::get_boolean_array | ( | array< System::Boolean >^ | array, | |
System::String^ | member_name, | |||
System::Int32 | member_id | |||
) |
Get a copy of the given array member.
This method will perform an automatic conversion from DDS::BooleanSeq.
If the destination array is insufficiently long to store the data, this operation will fail without copying anything.
array | <<out>> An already-allocated array, into which the elements will be copied. | |
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
One | of the Standard Return Codes |
void DDS::DynamicData::get_char_array | ( | array< System::Char >^ | array, | |
System::String^ | member_name, | |||
System::Int32 | member_id | |||
) |
Get a copy of the given array member.
This method will perform an automatic conversion from DDS::CharSeq.
If the destination array is insufficiently long to store the data, this operation will fail without copying anything.
array | <<out>> An already-allocated array, into which the elements will be copied. | |
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
One | of the Standard Return Codes |
void DDS::DynamicData::get_byte_array | ( | array< System::Byte >^ | array, | |
System::String^ | member_name, | |||
System::Int32 | member_id | |||
) |
Get a copy of the given array member.
This method will perform an automatic conversion from ByteSeq.
If the destination array is insufficiently long to store the data, this operation will fail without copying anything.
array | <<out>> An already-allocated array, into which the elements will be copied. | |
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
One | of the Standard Return Codes |
void DDS::DynamicData::get_long_array | ( | array< System::Int64 >^ | array, | |
System::String^ | member_name, | |||
System::Int32 | member_id | |||
) |
Get a copy of the given array member.
This method will perform an automatic conversion from LongSeq.
If the destination array is insufficiently long to store the data, this operation will fail without copying anything.
array | <<out>> An already-allocated array, into which the elements will be copied. | |
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
One | of the Standard Return Codes |
void DDS::DynamicData::get_ulong_array | ( | array< System::UInt64 >^ | array, | |
System::String^ | member_name, | |||
System::Int32 | member_id | |||
) |
Get a copy of the given array member.
This method will perform an automatic conversion from DDS::UnsignedLongLongSeq.
If the destination array is insufficiently long to store the data, this operation will fail without copying anything.
array | <<out>> An already-allocated array, into which the elements will be copied. | |
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
One | of the Standard Return Codes |
void DDS::DynamicData::get_longdouble_array | ( | array< LongDouble >^ | array, | |
System::String^ | member_name, | |||
System::Int32 | member_id | |||
) |
Get a copy of the given array member.
This method will perform an automatic conversion from DDS::LongDoubleSeq.
If the destination array is insufficiently long to store the data, this operation will fail without copying anything.
array | <<out>> An already-allocated array, into which the elements will be copied. | |
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
One | of the Standard Return Codes |
void DDS::DynamicData::get_wchar_array | ( | array< System::Char >^ | array, | |
System::String^ | member_name, | |||
System::Int32 | member_id | |||
) |
Get a copy of the given array member.
This method will perform an automatic conversion from DDS::WcharSeq.
If the destination array is insufficiently long to store the data, this operation will fail without copying anything.
array | <<out>> An already-allocated array, into which the elements will be copied. | |
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
One | of the Standard Return Codes |
void DDS::DynamicData::get_int_seq | ( | IntSeq^ | seq, | |
System::String^ | member_name, | |||
System::Int32 | member_id | |||
) |
Get a copy of the given sequence member.
The provided sequence will be automatically resized as necessary.
This method will perform an automatic conversion from an array of System::Int32.
seq | <<out>> A sequence, into which the elements will be copied. | |
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
void DDS::DynamicData::get_short_seq | ( | ShortSeq^ | seq, | |
System::String^ | member_name, | |||
System::Int32 | member_id | |||
) |
Get a copy of the given sequence member.
The provided sequence will be automatically resized as necessary.
This method will perform an automatic conversion from an array of System::Int16.
seq | <<out>> A sequence, into which the elements will be copied. | |
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
void DDS::DynamicData::get_uint_seq | ( | UnsignedIntSeq^ | seq, | |
System::String^ | member_name, | |||
System::Int32 | member_id | |||
) |
Get a copy of the given sequence member.
The provided sequence will be automatically resized as necessary.
This method will perform an automatic conversion from an array of System::UInt32.
seq | <<out>> A sequence, into which the elements will be copied. | |
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
void DDS::DynamicData::get_ushort_seq | ( | UnsignedShortSeq^ | seq, | |
System::String^ | member_name, | |||
System::Int32 | member_id | |||
) |
Get a copy of the given sequence member.
The provided sequence will be automatically resized as necessary.
This method will perform an automatic conversion from an array of System::UInt16.
seq | <<out>> A sequence, into which the elements will be copied. | |
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
void DDS::DynamicData::get_float_seq | ( | FloatSeq^ | seq, | |
System::String^ | member_name, | |||
System::Int32 | member_id | |||
) |
Get a copy of the given sequence member.
The provided sequence will be automatically resized as necessary.
This method will perform an automatic conversion from an array of System::Single.
seq | <<out>> A sequence, into which the elements will be copied. | |
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
void DDS::DynamicData::get_double_seq | ( | DoubleSeq^ | seq, | |
System::String^ | member_name, | |||
System::Int32 | member_id | |||
) |
Get a copy of the given sequence member.
The provided sequence will be automatically resized as necessary.
This method will perform an automatic conversion from an array of System::Double.
seq | <<out>> A sequence, into which the elements will be copied. | |
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
void DDS::DynamicData::get_boolean_seq | ( | BooleanSeq^ | seq, | |
System::String^ | member_name, | |||
System::Int32 | member_id | |||
) |
Get a copy of the given sequence member.
The provided sequence will be automatically resized as necessary.
This method will perform an automatic conversion from an array of System::Boolean.
seq | <<out>> A sequence, into which the elements will be copied. | |
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
void DDS::DynamicData::get_char_seq | ( | CharSeq^ | seq, | |
System::String^ | member_name, | |||
System::Int32 | member_id | |||
) |
Get a copy of the given sequence member.
The provided sequence will be automatically resized as necessary.
This method will perform an automatic conversion from an array of System::Char.
seq | <<out>> A sequence, into which the elements will be copied. | |
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
void DDS::DynamicData::get_byte_seq | ( | ByteSeq^ | seq, | |
System::String^ | member_name, | |||
System::Int32 | member_id | |||
) |
Get a copy of the given sequence member.
The provided sequence will be automatically resized as necessary.
This method will perform an automatic conversion from an array of System::Byte.
seq | <<out>> A sequence, into which the elements will be copied. | |
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
void DDS::DynamicData::get_long_seq | ( | LongSeq^ | seq, | |
System::String^ | member_name, | |||
System::Int32 | member_id | |||
) |
Get a copy of the given sequence member.
The provided sequence will be automatically resized as necessary.
This method will perform an automatic conversion from an array of System::Int64.
seq | <<out>> A sequence, into which the elements will be copied. | |
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
void DDS::DynamicData::get_ulong_seq | ( | UnsignedLongSeq^ | seq, | |
System::String^ | member_name, | |||
System::Int32 | member_id | |||
) |
Get a copy of the given sequence member.
The provided sequence will be automatically resized as necessary.
This method will perform an automatic conversion from an array of System::UInt64.
seq | <<out>> A sequence, into which the elements will be copied. | |
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
void DDS::DynamicData::get_longdouble_seq | ( | LongDoubleSeq^ | seq, | |
System::String^ | member_name, | |||
System::Int32 | member_id | |||
) |
Get a copy of the given sequence member.
The provided sequence will be automatically resized as necessary.
This method will perform an automatic conversion from an array of DDS::LongDouble.
seq | <<out>> A sequence, into which the elements will be copied. | |
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
void DDS::DynamicData::get_wchar_seq | ( | WcharSeq^ | seq, | |
System::String^ | member_name, | |||
System::Int32 | member_id | |||
) |
Get a copy of the given sequence member.
The provided sequence will be automatically resized as necessary.
This method will perform an automatic conversion from an array of System::Char.
seq | <<out>> A sequence, into which the elements will be copied. | |
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
void DDS::DynamicData::set_int | ( | System::String^ | member_name, | |
System::Int32 | member_id, | |||
System::Int32 | value | |||
) |
Set the value of the given field, which is of type System::Int32.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. | |
value | <<in>> The value to which to set the member. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
void DDS::DynamicData::set_short | ( | System::String^ | member_name, | |
System::Int32 | member_id, | |||
System::Int16 | value | |||
) |
Set the value of the given field, which is of type System::Int16.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. | |
value | <<in>> The value to which to set the member. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
void DDS::DynamicData::set_uint | ( | System::String^ | member_name, | |
System::Int32 | member_id, | |||
System::UInt32 | value | |||
) |
Set the value of the given field, which is of type System::UInt32.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. | |
value | <<in>> The value to which to set the member. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
void DDS::DynamicData::set_ushort | ( | System::String^ | member_name, | |
System::Int32 | member_id, | |||
System::UInt16 | value | |||
) |
Set the value of the given field, which is of type System::UInt16.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. | |
value | <<in>> The value to which to set the member. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
void DDS::DynamicData::set_float | ( | System::String^ | member_name, | |
System::Int32 | member_id, | |||
System::Single | value | |||
) |
Set the value of the given field, which is of type System::Single.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. | |
value | <<in>> The value to which to set the member. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
void DDS::DynamicData::set_double | ( | System::String^ | member_name, | |
System::Int32 | member_id, | |||
System::Double | value | |||
) |
Set the value of the given field, which is of type System::Double.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. | |
value | <<in>> The value to which to set the member. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
void DDS::DynamicData::set_boolean | ( | System::String^ | member_name, | |
System::Int32 | member_id, | |||
System::Boolean | value | |||
) |
Set the value of the given field, which is of type System::Boolean.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. | |
value | <<in>> The value to which to set the member. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
void DDS::DynamicData::set_char | ( | System::String^ | member_name, | |
System::Int32 | member_id, | |||
System::Char | value | |||
) |
Set the value of the given field, which is of type System::Char.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. | |
value | <<in>> The value to which to set the member. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
void DDS::DynamicData::set_byte | ( | System::String^ | member_name, | |
System::Int32 | member_id, | |||
System::Byte | value | |||
) |
Set the value of the given field, which is of type System::Byte.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. | |
value | <<in>> The value to which to set the member. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
void DDS::DynamicData::set_long | ( | System::String^ | member_name, | |
System::Int32 | member_id, | |||
System::Int64 | value | |||
) |
Set the value of the given field, which is of type System::Int64.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. | |
value | <<in>> The value to which to set the member. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
void DDS::DynamicData::set_ulong | ( | System::String^ | member_name, | |
System::Int32 | member_id, | |||
System::UInt64 | value | |||
) |
Set the value of the given field, which is of type System::UInt64.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. | |
value | <<in>> The value to which to set the member. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
void DDS::DynamicData::set_longdouble | ( | System::String^ | member_name, | |
System::Int32 | member_id, | |||
LongDouble | value | |||
) |
Set the value of the given field, which is of type DDS::LongDouble.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. | |
value | <<in>> The value to which to set the member. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
void DDS::DynamicData::set_wchar | ( | System::String^ | member_name, | |
System::Int32 | member_id, | |||
System::Char | value | |||
) |
Set the value of the given field, which is of type System::Char.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. | |
value | <<in>> The value to which to set the member. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
void DDS::DynamicData::set_string | ( | System::String^ | member_name, | |
System::Int32 | member_id, | |||
System::String^ | value | |||
) |
Set the value of the given field of type System::String.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. | |
value | <<in>> The value to which to set the member. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
void DDS::DynamicData::set_wstring | ( | System::String^ | member_name, | |
System::Int32 | member_id, | |||
System::String^ | value | |||
) |
Set the value of the given field of type System::String.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. | |
value | <<in>> The value to which to set the member. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
void DDS::DynamicData::set_complex_member | ( | System::String^ | member_name, | |
System::Int32 | member_id, | |||
DynamicData^ | value | |||
) |
Copy the state of the given DDS::DynamicData object into a member of this object.
The member may be of type kind DDS::TCKind::TK_ARRAY, DDS::TCKind::TK_SEQUENCE, DDS::TCKind::TK_STRUCT, DDS::TCKind::TK_VALUE, DDS::TCKind::TK_UNION, or DDS::TCKind::TK_SPARSE. It may be specified by name or by ID.
Example: Copying Data
This method can be used with DDS::DynamicData::bind_complex_member to copy from one DDS::DynamicData object to another efficiently. Suppose the following data structure:
struct Bar { short theShort; }; struct Foo { Bar theBar; };
Support we have two instances of Foo:
foo_dst
and foo_src
. We want to replace the contents of foo_dst.theBar
with the contents of foo_src.theBar
. Error handling has been omitted for the sake of brevity.
In C#:
DynamicData foo_dst = ...; DynamicData foo_src = ...; DynamicData bar = new DynamicData(null, myProperties); // Point to the source of the copy: foo_src.bind_complex_member( "theBar", DynamicData.MEMBER_ID_UNSPECIFIED, bar); try { // Just one copy: foo_dst.set_complex_member( "theBar", DynamicData.MEMBER_ID_UNSPECIFIED, bar); } finally { // Tear down: foo_src.unbind_complex_member(bar); } bar.Dispose();
In C++/CLI:
DynamicData^ foo_dst = ...; DynamicData^ foo_src = ...; DynamicData^ bar = gcnew DynamicData(nullptr, myProperties); // Point to the source of the copy: foo_src->bind_complex_member( "theBar", DynamicData::MEMBER_ID_UNSPECIFIED, bar); try { // Just one copy: foo_dst->set_complex_member( "theBar", DynamicData::MEMBER_ID_UNSPECIFIED, bar); } finally { // Tear down: foo_src->unbind_complex_member(bar); } delete bar;
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. | |
value | <<in>> The source DDS::DynamicData object whose contents will be copied. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
void DDS::DynamicData::set_int_array | ( | System::String^ | member_name, | |
System::Int32 | member_id, | |||
array< System::Int32 >^ | array | |||
) |
Set the contents of the given array member.
This method will perform an automatic conversion to IntSeq.
If the destination array is insufficiently long to store the data, this operation will fail without copying anything.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. | |
array | <<in>> The elements to copy. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
void DDS::DynamicData::set_short_array | ( | System::String^ | member_name, | |
System::Int32 | member_id, | |||
array< System::Int16 >^ | array | |||
) |
Set the contents of the given array member.
This method will perform an automatic conversion to DDS::ShortSeq.
If the destination array is insufficiently long to store the data, this operation will fail without copying anything.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. | |
array | <<in>> The elements to copy. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
void DDS::DynamicData::set_uint_array | ( | System::String^ | member_name, | |
System::Int32 | member_id, | |||
array< System::UInt32 >^ | array | |||
) |
Set the contents of the given array member.
This method will perform an automatic conversion to UnsignedIntSeq.
If the destination array is insufficiently long to store the data, this operation will fail without copying anything.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. | |
array | <<in>> The elements to copy. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
void DDS::DynamicData::set_ushort_array | ( | System::String^ | member_name, | |
System::Int32 | member_id, | |||
array< System::UInt16 >^ | array | |||
) |
Set the contents of the given array member.
This method will perform an automatic conversion to DDS::UnsignedShortSeq.
If the destination array is insufficiently long to store the data, this operation will fail without copying anything.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. | |
array | <<in>> The elements to copy. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
void DDS::DynamicData::set_float_array | ( | System::String^ | member_name, | |
System::Int32 | member_id, | |||
array< System::Single >^ | array | |||
) |
Set the contents of the given array member.
This method will perform an automatic conversion to DDS::FloatSeq.
If the destination array is insufficiently long to store the data, this operation will fail without copying anything.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. | |
array | <<in>> The elements to copy. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
void DDS::DynamicData::set_double_array | ( | System::String^ | member_name, | |
System::Int32 | member_id, | |||
array< System::Double >^ | array | |||
) |
Set the contents of the given array member.
This method will perform an automatic conversion to DDS::DoubleSeq.
If the destination array is insufficiently long to store the data, this operation will fail without copying anything.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. | |
array | <<in>> The elements to copy. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
void DDS::DynamicData::set_boolean_array | ( | System::String^ | member_name, | |
System::Int32 | member_id, | |||
array< System::Boolean >^ | array | |||
) |
Set the contents of the given array member.
This method will perform an automatic conversion to DDS::BooleanSeq.
If the destination array is insufficiently long to store the data, this operation will fail without copying anything.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. | |
array | <<in>> The elements to copy. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
void DDS::DynamicData::set_char_array | ( | System::String^ | member_name, | |
System::Int32 | member_id, | |||
array< System::Char >^ | array | |||
) |
Set the contents of the given array member.
This method will perform an automatic conversion to DDS::CharSeq.
If the destination array is insufficiently long to store the data, this operation will fail without copying anything.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. | |
array | <<in>> The elements to copy. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
void DDS::DynamicData::set_byte_array | ( | System::String^ | member_name, | |
System::Int32 | member_id, | |||
array< System::Byte >^ | array | |||
) |
Set the contents of the given array member.
This method will perform an automatic conversion to ByteSeq.
If the destination array is insufficiently long to store the data, this operation will fail without copying anything.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. | |
array | <<in>> The elements to copy. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
void DDS::DynamicData::set_long_array | ( | System::String^ | member_name, | |
System::Int32 | member_id, | |||
array< System::Int64 >^ | array | |||
) |
Set the contents of the given array member.
This method will perform an automatic conversion to LongSeq.
If the destination array is insufficiently long to store the data, this operation will fail without copying anything.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. | |
array | <<in>> The elements to copy. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
void DDS::DynamicData::set_ulong_array | ( | System::String^ | member_name, | |
System::Int32 | member_id, | |||
array< System::UInt64 >^ | array | |||
) |
Set the contents of the given array member.
This method will perform an automatic conversion to DDS::UnsignedLongLongSeq.
If the destination array is insufficiently long to store the data, this operation will fail without copying anything.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. | |
array | <<in>> The elements to copy. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
void DDS::DynamicData::set_longdouble_array | ( | System::String^ | member_name, | |
System::Int32 | member_id, | |||
array< LongDouble >^ | array | |||
) |
Set the contents of the given array member.
This method will perform an automatic conversion to DDS::LongDoubleSeq.
If the destination array is insufficiently long to store the data, this operation will fail without copying anything.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. | |
array | <<in>> The elements to copy. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
void DDS::DynamicData::set_wchar_array | ( | System::String^ | member_name, | |
System::Int32 | member_id, | |||
array< System::Char >^ | array | |||
) |
Set the contents of the given array member.
This method will perform an automatic conversion to DDS::WcharSeq.
If the destination array is insufficiently long to store the data, this operation will fail without copying anything.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. | |
array | <<in>> The elements to copy. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
void DDS::DynamicData::set_int_seq | ( | System::String^ | member_name, | |
System::Int32 | member_id, | |||
IntSeq^ | value | |||
) |
Set the contents of the given sequence member.
This method will perform an automatic conversion to an array of System::Int32.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. | |
value | <<out>> A sequence, from which the elements will be copied. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
void DDS::DynamicData::set_short_seq | ( | System::String^ | member_name, | |
System::Int32 | member_id, | |||
ShortSeq^ | value | |||
) |
Set the contents of the given sequence member.
This method will perform an automatic conversion to an array of System::Int16.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. | |
value | <<out>> A sequence, from which the elements will be copied. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
void DDS::DynamicData::set_uint_seq | ( | System::String^ | member_name, | |
System::Int32 | member_id, | |||
UnsignedIntSeq^ | value | |||
) |
Set the contents of the given sequence member.
This method will perform an automatic conversion to an array of System::UInt32.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. | |
value | <<out>> A sequence, from which the elements will be copied. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
void DDS::DynamicData::set_ushort_seq | ( | System::String^ | member_name, | |
System::Int32 | member_id, | |||
UnsignedShortSeq^ | value | |||
) |
Set the contents of the given sequence member.
This method will perform an automatic conversion to an array of System::UInt16.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. | |
value | <<out>> A sequence, from which the elements will be copied. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
void DDS::DynamicData::set_float_seq | ( | System::String^ | member_name, | |
System::Int32 | member_id, | |||
FloatSeq^ | value | |||
) |
Set the contents of the given sequence member.
This method will perform an automatic conversion to an array of System::Single.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. | |
value | <<out>> A sequence, from which the elements will be copied. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
void DDS::DynamicData::set_double_seq | ( | System::String^ | member_name, | |
System::Int32 | member_id, | |||
DoubleSeq^ | value | |||
) |
Set the contents of the given sequence member.
This method will perform an automatic conversion to an array of System::Double.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. | |
value | <<out>> A sequence, from which the elements will be copied. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
void DDS::DynamicData::set_boolean_seq | ( | System::String^ | member_name, | |
System::Int32 | member_id, | |||
BooleanSeq^ | value | |||
) |
Set the contents of the given sequence member.
This method will perform an automatic conversion to an array of System::Boolean.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. | |
value | <<out>> A sequence, from which the elements will be copied. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
void DDS::DynamicData::set_char_seq | ( | System::String^ | member_name, | |
System::Int32 | member_id, | |||
CharSeq^ | value | |||
) |
Set the contents of the given sequence member.
This method will perform an automatic conversion to an array of System::Char.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. | |
value | <<out>> A sequence, from which the elements will be copied. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
void DDS::DynamicData::set_byte_seq | ( | System::String^ | member_name, | |
System::Int32 | member_id, | |||
ByteSeq^ | value | |||
) |
Set the contents of the given sequence member.
This method will perform an automatic conversion to an array of System::Byte.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. | |
value | <<out>> A sequence, from which the elements will be copied. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
void DDS::DynamicData::set_long_seq | ( | System::String^ | member_name, | |
System::Int32 | member_id, | |||
LongSeq^ | value | |||
) |
Set the contents of the given sequence member.
This method will perform an automatic conversion to an array of System::Int64.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. | |
value | <<out>> A sequence, from which the elements will be copied. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
void DDS::DynamicData::set_ulong_seq | ( | System::String^ | member_name, | |
System::Int32 | member_id, | |||
UnsignedLongSeq^ | value | |||
) |
Set the contents of the given sequence member.
This method will perform an automatic conversion to an array of System::UInt64.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. | |
value | <<out>> A sequence, from which the elements will be copied. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
void DDS::DynamicData::set_longdouble_seq | ( | System::String^ | member_name, | |
System::Int32 | member_id, | |||
LongDoubleSeq^ | value | |||
) |
Set the contents of the given sequence member.
This method will perform an automatic conversion to an array of DDS::LongDouble.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. | |
value | <<out>> A sequence, from which the elements will be copied. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |
void DDS::DynamicData::set_wchar_seq | ( | System::String^ | member_name, | |
System::Int32 | member_id, | |||
WcharSeq^ | value | |||
) |
Set the contents of the given sequence member.
This method will perform an automatic conversion to an array of System::Char.
member_name | <<in>> The name of the member or null to look up the member by its ID. | |
member_id | <<in>> The ID of the member or DDS::DynamicData::MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. | |
value | <<out>> A sequence, from which the elements will be copied. |
One | of the Standard Return Codes or DDS::Retcode_OutOfResources |