CoreDX Data Distribution Service
The High Performance, Small Footprint DDS from Twin Oaks Computing, Inc
com.toc.coredx.dynamictype.DynamicData Class Reference

A DynamicData object represents an individual data sample. It provides reflective getters and setters for the members of that sample. More...

Inherits DDS.DynamicData.

Public Member Functions

ReturnCode_t get_descriptor (DDS.MemberDescriptorHolder value, int id)
 This provides access to the descriptor for each value in this object, identified by the member ID. More...
 
ReturnCode_t set_descriptor (int id, DDS.MemberDescriptor value)
 Set the descriptor of the member specified by 'id'.
 
boolean equals (DDS.DynamicData otherdd)
 Compare two DynamicData instances for equality. More...
 
int get_member_id_by_name (String name)
 Access the 'id' of a member matching 'name'.
 
int get_member_id_at_index (int index)
 Access the 'id' of a member at the specified index.
 
int get_item_count ()
 Access the "item count" of the DDS_DynamicData. More...
 
ReturnCode_t clear_all_values ()
 Clears all values from the instance. More...
 
ReturnCode_t clear_nonkey_values ()
 Clear all non-key values from the instance. More...
 
ReturnCode_t clear_value (int id)
 Clear the specified value from the instance. More...
 
DynamicData loan_value (int id)
 The "loan" operations loan to the application a DynamicData object representing a value within this sample. More...
 
ReturnCode_t return_loaned_value (DDS.DynamicData value)
 Return a "loaned" data sample. More...
 
DynamicData clone ()
 Create and return a new data sample with the same contents as this one. More...
 
ReturnCode_t get_int32_value (IntegerHolder value, int id)
 Access a 32bit integer value, identified by 'id', in the sample. More...
 
ReturnCode_t set_int32_value (int id, int value)
 Set a 32bit integer value, identified by 'id', in the sample. More...
 
ReturnCode_t get_uint32_value (IntegerHolder value, int id)
 Access an unsigned 32bit integer value, identified by 'id', in the sample. More...
 
ReturnCode_t set_uint32_value (int id, int value)
 Set an unsigned 32bit integer value, identified by 'id', in the sample. More...
 
ReturnCode_t get_int16_value (ShortHolder value, int id)
 Access a 16bit integer value, identified by 'id', in the sample. More...
 
ReturnCode_t set_int16_value (int id, short value)
 Set a 16bit integer value, identified by 'id', in the sample. More...
 
ReturnCode_t get_uint16_value (ShortHolder value, int id)
 Access an unsigned 16bit integer value, identified by 'id', in the sample. More...
 
ReturnCode_t set_uint16_value (int id, short value)
 Set an unsigned 16bit integer value, identified by 'id', in the sample. More...
 
ReturnCode_t get_int64_value (LongHolder value, int id)
 Access a 64bit integer value, identified by 'id', in the sample. More...
 
ReturnCode_t set_int64_value (int id, long value)
 Set a 64bit integer value, identified by 'id', in the sample. More...
 
ReturnCode_t get_uint64_value (LongHolder value, int id)
 Access an unsigned 64bit integer value, identified by 'id', in the sample. More...
 
ReturnCode_t set_uint64_value (int id, long value)
 Set an unsigned 64bit integer value, identified by 'id', in the sample. More...
 
ReturnCode_t get_float32_value (FloatHolder value, int id)
 Access a float value, identified by 'id', in the sample. More...
 
ReturnCode_t set_float32_value (int id, float value)
 Set a float value, identified by 'id', in the sample. More...
 
ReturnCode_t get_float64_value (DoubleHolder value, int id)
 Access a double value, identified by 'id', in the sample. More...
 
ReturnCode_t set_float64_value (int id, double value)
 Set a double value, identified by 'id', in the sample. More...
 
ReturnCode_t get_char8_value (CharacterHolder value, int id)
 Access an 8bit character value, identified by 'id', in the sample. More...
 
ReturnCode_t set_char8_value (int id, char value)
 Set an 8bit character value, identified by 'id', in the sample. More...
 
ReturnCode_t get_char32_value (IntegerHolder value, int id)
 Access a 32bit character value, identified by 'id', in the sample. More...
 
ReturnCode_t set_char32_value (int id, int value)
 Set a 32bit character value, identified by 'id', in the sample. More...
 
ReturnCode_t get_byte_value (ByteHolder value, int id)
 Access an 8bit value, identified by 'id', in the sample. More...
 
ReturnCode_t set_byte_value (int id, byte value)
 Set an 8bit value, identified by 'id', in the sample. More...
 
ReturnCode_t get_boolean_value (BooleanHolder value, int id)
 Access a boolean value, identified by 'id', in the sample. More...
 
ReturnCode_t set_boolean_value (int id, boolean value)
 Set a boolean value, identified by 'id', in the sample. More...
 
ReturnCode_t get_string_value (StringHolder value, int id)
 Access a string value, identified by 'id', in the sample. More...
 
ReturnCode_t set_string_value (int id, String value)
 Set a string value, identified by 'id', in the sample. More...
 
ReturnCode_t get_wstring_value (StringHolder value, int id)
 Access a wstring value, identified by 'id', in the sample. More...
 
ReturnCode_t set_wstring_value (int id, String value)
 Set a wstring value, identified by 'id', in the sample. More...
 
ReturnCode_t get_complex_value (DDS.DynamicDataHolder value, int id)
 Access a complex value, identified by 'id', in the sample. More...
 
ReturnCode_t set_complex_value (int id, DDS.DynamicData value)
 Set a complex value, identified by 'id', in the sample. More...
 
ReturnCode_t get_int32_values (Int32SeqHolder value, int id)
 
ReturnCode_t set_int32_values (int id, int[] value)
 
ReturnCode_t get_uint32_values (UInt32SeqHolder value, int id)
 
ReturnCode_t set_uint32_values (int id, int[] value)
 
ReturnCode_t get_int16_values (Int16SeqHolder value, int id)
 
ReturnCode_t set_int16_values (int id, short[] value)
 
ReturnCode_t get_uint16_values (UInt16SeqHolder value, int id)
 
ReturnCode_t set_uint16_values (int id, short[] value)
 
ReturnCode_t get_int64_values (Int64SeqHolder value, int id)
 
ReturnCode_t set_int64_values (int id, long[] value)
 
ReturnCode_t get_uint64_values (UInt64SeqHolder value, int id)
 
ReturnCode_t set_uint64_values (int id, long[] value)
 
ReturnCode_t get_float32_values (Float32SeqHolder value, int id)
 
ReturnCode_t set_float32_values (int id, float[] value)
 
ReturnCode_t get_float64_values (Float64SeqHolder value, int id)
 
ReturnCode_t set_float64_values (int id, double[] value)
 
ReturnCode_t get_char8_values (CharSeqHolder value, int id)
 
ReturnCode_t set_char8_values (int id, char[] value)
 
ReturnCode_t get_char32_values (WcharSeqHolder value, int id)
 
ReturnCode_t set_char32_values (int id, int[] value)
 
ReturnCode_t get_byte_values (ByteSeqHolder value, int id)
 
ReturnCode_t set_byte_values (int id, byte[] value)
 
ReturnCode_t get_boolean_values (BooleanSeqHolder value, int id)
 
ReturnCode_t set_boolean_values (int id, boolean[] value)
 
ReturnCode_t get_string_values (StringSeqHolder value, int id)
 
ReturnCode_t set_string_values (int id, String[] value)
 
ReturnCode_t get_wstring_values (WstringSeqHolder value, int id)
 
ReturnCode_t set_wstring_values (int id, String[] value)
 

Detailed Description

A DynamicData object represents an individual data sample. It provides reflective getters and setters for the members of that sample.

Many of the properties and operations on DynamicData refer to values within the sample, which are identified by name, member ID, or index.

What constitutes a value within a sample, and which means of accessing it are valid, depends on the type of the sample.

  • If this instance is of an aggregated type, values correspond to the type’s members and can be accessed by name, member ID, or index.
  • If this instance is of a sequence or string type, values correspond to the elements of the collection. These elements must be accessed by index; the mapping from index to member ID is unspecified.
  • If this object is of a map type, values correspond to the values of the map. Map keys are implicitly converted to strings and can thus be used to look up map values by name. Map values can also be accessed by index, although the order is unspecified.
  • If the object is of an array type, values correspond to the elements of the array. These elements must be accessed by index; the mapping from index to member ID is unspecified. If the array is multi-dimensional, elements are accessed as if they were “flattened” into a single-dimensional array in the order specified by the IDL specification.
  • If the object is of a bit set type, values correspond to the flags within the bit set and are all of Boolean type. Named flags can be accessed using that name; any bit within the bound of the bit set may be accessed by its index. The mappings from name and index to member ID are unspecified.
  • If the object is of an enumeration or primitive type, it has no contained values. However, the value of the sample itself may be indicated by "name" using a nil or empty string, by "ID" by passing MEMBER_ID_INVALID, or by "index" by passing index 0.

Note that indices used here are always relative to other values in a particular DynamicData object. Even though member definitions within aggregate types have a well-defined order, the same is not true within data samples or across data samples.

Specifically, the index at which a member of an aggregated type appears in a particular data sample may not match that in which it appears in the corresponding type and may not match the index at which it appears in a different data sample.

There are several reasons for these inconsistencies:

  • The producer of the sample may be using a slightly different variant of the type than the consumer, which may add to, or omit elements from, the set of members known to the consumer.
  • An optional member may have no value; in such a case, it will be omitted, thereby decreasing the index of every subsequent member.
  • A non-optional member may likewise be omitted (which semantically is equivalent to it taking its default value). An implementation may discretionarily omit such members (e.g., to save space).
  • Preserving member order is not necessary or even desirable (e.g., for performance reasons) for certain data representations.
    See also
    DynamicType
    DynamicDataFactory

Member Function Documentation

◆ clear_all_values()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.clear_all_values ( )

Clears all values from the instance.

The meaning of "clearing" a member depends on the type of data represented by this sample:

  • If this sample is of an aggregated type, and the indicated member is optional, remove it. If the indicated member is not optional, set it to its default value.
  • If this sample is of a variable-length collection type, remove the indicated element, shifting any subsequent elements to the next-lowest index.
  • If the sample is of an array type, set the indicated element to its default value.
  • If the sample is of a bit set type, clear the indicated bit.
  • If the sample is of an enumerated type, set it to the first value of the enumerated type.
  • If the sample is of a primitive type, set it to its default value.
  • The clear_all_members takes the above action for each value in turn.
  • The clear_nonkey_value operation has exactly the same effect as clear_all_values with one exception: the values of key fields of aggregated types retain their values.

◆ clear_nonkey_values()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.clear_nonkey_values ( )

Clear all non-key values from the instance.

See also
DynamicData::clear_all_values
Not Yet Supported:

◆ clear_value()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.clear_value ( int  id)

Clear the specified value from the instance.

See also
DynamicData::clear_all_values

◆ clone()

DynamicData com.toc.coredx.dynamictype.DynamicData.clone ( )

Create and return a new data sample with the same contents as this one.

A comparison of this object and the clone using equals immediately following this call will return true.

◆ equals()

boolean com.toc.coredx.dynamictype.DynamicData.equals ( DDS.DynamicData  otherdd)

Compare two DynamicData instances for equality.

Two data samples are considered to be equal if and only if all of the following conditions hold:

  • Their respective type definitions are equal.
  • All contained values are equal and occur in the same order.

If the samples’ type is an aggregated type, the previous rule is amended as follows:

  • Members shall be compared without regard to their order.
  • One of the samples may omit a non-optional member that is present in the other if that member takes its default value in the latter sample.

◆ get_boolean_value()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.get_boolean_value ( BooleanHolder  value,
int  id 
)

Access a boolean value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ get_boolean_values()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.get_boolean_values ( BooleanSeqHolder  value,
int  id 
)
Not Yet Supported:
This operation is not yet implemented.

◆ get_byte_value()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.get_byte_value ( ByteHolder  value,
int  id 
)

Access an 8bit value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ get_byte_values()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.get_byte_values ( ByteSeqHolder  value,
int  id 
)
Not Yet Supported:
This operation is not yet implemented.

◆ get_char32_value()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.get_char32_value ( IntegerHolder  value,
int  id 
)

Access a 32bit character value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ get_char32_values()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.get_char32_values ( WcharSeqHolder  value,
int  id 
)
Not Yet Supported:
This operation is not yet implemented.

◆ get_char8_value()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.get_char8_value ( CharacterHolder  value,
int  id 
)

Access an 8bit character value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ get_char8_values()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.get_char8_values ( CharSeqHolder  value,
int  id 
)
Not Yet Supported:
This operation is not yet implemented.

◆ get_complex_value()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.get_complex_value ( DDS.DynamicDataHolder  value,
int  id 
)

Access a complex value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ get_descriptor()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.get_descriptor ( DDS.MemberDescriptorHolder  value,
int  id 
)

This provides access to the descriptor for each value in this object, identified by the member ID.

See the description of DynamicData values.

◆ get_float32_value()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.get_float32_value ( FloatHolder  value,
int  id 
)

Access a float value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ get_float32_values()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.get_float32_values ( Float32SeqHolder  value,
int  id 
)
Not Yet Supported:
This operation is not yet implemented.

◆ get_float64_value()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.get_float64_value ( DoubleHolder  value,
int  id 
)

Access a double value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ get_float64_values()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.get_float64_values ( Float64SeqHolder  value,
int  id 
)
Not Yet Supported:
This operation is not yet implemented.

◆ get_int16_value()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.get_int16_value ( ShortHolder  value,
int  id 
)

Access a 16bit integer value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ get_int16_values()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.get_int16_values ( Int16SeqHolder  value,
int  id 
)
Not Yet Supported:
This operation is not yet implemented.

◆ get_int32_value()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.get_int32_value ( IntegerHolder  value,
int  id 
)

Access a 32bit integer value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ get_int32_values()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.get_int32_values ( Int32SeqHolder  value,
int  id 
)
Not Yet Supported:
This operation is not yet implemented.

◆ get_int64_value()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.get_int64_value ( LongHolder  value,
int  id 
)

Access a 64bit integer value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ get_int64_values()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.get_int64_values ( Int64SeqHolder  value,
int  id 
)
Not Yet Supported:
This operation is not yet implemented.

◆ get_item_count()

int com.toc.coredx.dynamictype.DynamicData.get_item_count ( )

Access the "item count" of the DDS_DynamicData.

The "item count" of the data depends on the type of the object.

  • If the object is of a collection type, return the number of elements currently in the collection.
  • In the case of an array type, this value will always be equal to the product of the bounds of all array dimensions.
  • If the object is of a bit set type, return the number of named flags that are currently set in the bit set.
  • If the object is of a structure or annotation type, return the number of members in the object. This value may be different than the number of members in the corresponding DDS_DynamicType; for example, some optional members may be omitted.
  • If the object is of a union type, return the number of members in the object. This value will always be two: the discriminator and the current member corresponding to it.
  • If the object is of a primitive or enumeration type, it is atomic, and the count is one.
  • If the object is of an alias type, return the value appropriate for the alias’s base type.

◆ get_string_value()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.get_string_value ( StringHolder  value,
int  id 
)

Access a string value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ get_string_values()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.get_string_values ( StringSeqHolder  value,
int  id 
)
Not Yet Supported:
This operation is not yet implemented.

◆ get_uint16_value()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.get_uint16_value ( ShortHolder  value,
int  id 
)

Access an unsigned 16bit integer value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ get_uint16_values()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.get_uint16_values ( UInt16SeqHolder  value,
int  id 
)
Not Yet Supported:
This operation is not yet implemented.

◆ get_uint32_value()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.get_uint32_value ( IntegerHolder  value,
int  id 
)

Access an unsigned 32bit integer value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ get_uint32_values()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.get_uint32_values ( UInt32SeqHolder  value,
int  id 
)
Not Yet Supported:
This operation is not yet implemented.

◆ get_uint64_value()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.get_uint64_value ( LongHolder  value,
int  id 
)

Access an unsigned 64bit integer value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ get_uint64_values()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.get_uint64_values ( UInt64SeqHolder  value,
int  id 
)
Not Yet Supported:
This operation is not yet implemented.

◆ get_wstring_value()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.get_wstring_value ( StringHolder  value,
int  id 
)

Access a wstring value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ get_wstring_values()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.get_wstring_values ( WstringSeqHolder  value,
int  id 
)
Not Yet Supported:
This operation is not yet implemented.

◆ loan_value()

DynamicData com.toc.coredx.dynamictype.DynamicData.loan_value ( int  id)

The "loan" operations loan to the application a DynamicData object representing a value within this sample.

This operation allows applications to visit values without allocating additional DynamicData objects or copying values. This loan shall be returned by the DDS_DynamicData_return_loaned_value operation.

A given DynamicData object may support only a single outstanding loan at a time. That is, after calling a "loan" operation, an application must subsequently call return_loaned_value before calling a loan operation again. If an application violates this constraint, the loan operation shall return a nil value.

A loan operation shall also return a nil value if the indicated value does not exist.

◆ return_loaned_value()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.return_loaned_value ( DDS.DynamicData  value)

Return a "loaned" data sample.

The DynamicData::return_loaned_value operation may return RETCODE_PRECONDITION_NOT_MET if the provided sample object does not represent an outstanding loan from the sample on which the operation is invoked.

◆ set_boolean_value()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.set_boolean_value ( int  id,
boolean  value 
)

Set a boolean value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ set_boolean_values()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.set_boolean_values ( int  id,
boolean []  value 
)
Not Yet Supported:
This operation is not yet implemented.

◆ set_byte_value()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.set_byte_value ( int  id,
byte  value 
)

Set an 8bit value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ set_byte_values()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.set_byte_values ( int  id,
byte []  value 
)
Not Yet Supported:
This operation is not yet implemented.

◆ set_char32_value()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.set_char32_value ( int  id,
int  value 
)

Set a 32bit character value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ set_char32_values()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.set_char32_values ( int  id,
int []  value 
)
Not Yet Supported:
This operation is not yet implemented.

◆ set_char8_value()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.set_char8_value ( int  id,
char  value 
)

Set an 8bit character value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ set_char8_values()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.set_char8_values ( int  id,
char []  value 
)
Not Yet Supported:
This operation is not yet implemented.

◆ set_complex_value()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.set_complex_value ( int  id,
DDS.DynamicData  value 
)

Set a complex value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ set_float32_value()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.set_float32_value ( int  id,
float  value 
)

Set a float value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ set_float32_values()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.set_float32_values ( int  id,
float []  value 
)
Not Yet Supported:
This operation is not yet implemented.

◆ set_float64_value()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.set_float64_value ( int  id,
double  value 
)

Set a double value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ set_float64_values()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.set_float64_values ( int  id,
double []  value 
)
Not Yet Supported:
This operation is not yet implemented.

◆ set_int16_value()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.set_int16_value ( int  id,
short  value 
)

Set a 16bit integer value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ set_int16_values()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.set_int16_values ( int  id,
short []  value 
)
Not Yet Supported:
This operation is not yet implemented.

◆ set_int32_value()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.set_int32_value ( int  id,
int  value 
)

Set a 32bit integer value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ set_int32_values()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.set_int32_values ( int  id,
int []  value 
)
Not Yet Supported:
This operation is not yet implemented.

◆ set_int64_value()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.set_int64_value ( int  id,
long  value 
)

Set a 64bit integer value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ set_int64_values()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.set_int64_values ( int  id,
long []  value 
)
Not Yet Supported:
This operation is not yet implemented.

◆ set_string_value()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.set_string_value ( int  id,
String  value 
)

Set a string value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ set_string_values()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.set_string_values ( int  id,
String []  value 
)
Not Yet Supported:
This operation is not yet implemented.

◆ set_uint16_value()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.set_uint16_value ( int  id,
short  value 
)

Set an unsigned 16bit integer value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ set_uint16_values()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.set_uint16_values ( int  id,
short []  value 
)
Not Yet Supported:
This operation is not yet implemented.

◆ set_uint32_value()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.set_uint32_value ( int  id,
int  value 
)

Set an unsigned 32bit integer value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ set_uint32_values()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.set_uint32_values ( int  id,
int []  value 
)
Not Yet Supported:
This operation is not yet implemented.

◆ set_uint64_value()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.set_uint64_value ( int  id,
long  value 
)

Set an unsigned 64bit integer value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ set_uint64_values()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.set_uint64_values ( int  id,
long []  value 
)
Not Yet Supported:
This operation is not yet implemented.

◆ set_wstring_value()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.set_wstring_value ( int  id,
String  value 
)

Set a wstring value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ set_wstring_values()

ReturnCode_t com.toc.coredx.dynamictype.DynamicData.set_wstring_values ( int  id,
String []  value 
)
Not Yet Supported:
This operation is not yet implemented.

© 2009-2020 Twin Oaks Computing, Inc
Castle Rock, CO 80104
All rights reserved.