RTI Connext .NET API (legacy)
Version 6.1.2
|
The definition of a particular data type, which you can use to inspect the name, members, and other properties of types generated with rtiddsgen or to modify types you define yourself at runtime. More...
#include <managed_typecode.h>
Public Member Functions | |
TCKind | kind () |
Gets the DDS::TCKind value of a type code. More... | |
ExtensibilityKind | extensibility_kind () |
Gets the DDS::ExtensibilityKind value of a type code. More... | |
System::Boolean | equal (TypeCode^ tc) |
Compares two DDS::TypeCode objects for equality. More... | |
System::String ^ | name () |
Retrieves the simple name identifying this DDS::TypeCode object within its enclosing scope. More... | |
System::UInt32 | member_count () |
Returns the number of members of the type code. More... | |
System::String ^ | member_name (System::UInt32 index) |
Returns the name of a type code member identified by the given index. More... | |
System::UInt32 | find_member_by_name (System::String^ name) |
Get the index of the member of the given name. More... | |
DDS::TypeCode ^ | member_type (System::UInt32 index) |
Retrieves the DDS::TypeCode object describing the type of the member identified by the given index. More... | |
System::UInt32 | member_label_count (System::UInt32 index) |
Returns the number of labels associated to the index-th union member. More... | |
System::Int32 | member_label (System::UInt32 member_index, System::UInt32 label_index) |
Return the label_index-th label associated to the member_index-th member. More... | |
System::Int32 | member_ordinal (System::UInt32 index) |
Returns the ordinal that corresponds to the index-th enum value. More... | |
System::Boolean | is_member_key (System::UInt32 index) |
Function that tells if a member is a key or not. More... | |
System::Boolean | is_member_required (System::UInt32 index) |
Indicates whether a given member of a type is required to be present in every sample of that type. More... | |
System::Boolean | is_member_pointer (System::UInt32 index) |
Function that tells if a member is a pointer or not. More... | |
System::Boolean | is_member_bitfield (System::UInt32 index) |
Function that tells if a member is a bitfield or not. More... | |
System::Int16 | member_bitfield_bits (System::UInt32 index) |
Returns the number of bits of a bitfield member. More... | |
Visibility | member_visibility (System::UInt32 index) |
Returns the constant that indicates the visibility of the index-th member. More... | |
TypeCode ^ | discriminator_type () |
Returns the discriminator type code. More... | |
System::UInt32 | length () |
Returns the number of elements in the type described by this type code. More... | |
System::UInt32 | array_dimension_count () |
This function returns the number of dimensions of an array type code. More... | |
System::UInt32 | array_dimension (System::UInt32 index) |
This function returns the index-th dimension of an array type code. More... | |
System::UInt32 | element_count () |
The number of elements in an array. More... | |
DDS::TypeCode ^ | content_type () |
Returns the DDS::TypeCode object representing the type for the members of the object described by this DDS::TypeCode object. More... | |
System::Boolean | is_alias_pointer () |
Function that tells if an alias is a pointer or not. More... | |
System::Int32 | default_index () |
Returns the index of the default member, or -1 if there is no default member. More... | |
DDS::TypeCode ^ | concrete_base_type () |
Returns the DDS::TypeCode that describes the concrete base type of the value type that this DDS::TypeCode object describes. More... | |
ValueModifier | type_modifier () |
Returns a constant indicating the modifier of the value type that this DDS::TypeCode object describes. More... | |
System::Int32 | member_id (System::UInt32 index) |
Returns the ID of the TypeCode member identified by the given index. More... | |
System::UInt32 | find_member_by_id (System::Int32 id) |
Get the index of the member of the given ID. More... | |
System::UInt32 | add_member_to_enum (System::String^ name, System::Int32 ordinal) |
Add a new enumerated constant to this enum DDS::TypeCode. More... | |
System::UInt32 | add_member_to_union (System::String^ name, System::Int32 id, IntSeq^ labels, DDS::TypeCode^ tc, System::Boolean is_pointer) |
Add a new member to a union DDS::TypeCode. More... | |
System::UInt32 | add_member (System::String^ name, System::Int32 id, DDS::TypeCode^ tc, System::Byte member_flags) |
Add a new member to this DDS::TypeCode. More... | |
System::UInt32 | add_member_ex (System::String^ name, System::Int32 id, DDS::TypeCode^ tc, System::Byte member_flags, Visibility visibility, System::Boolean is_pointer, System::Int16 bits) |
Add a new member to this DDS::TypeCode. More... | |
System::UInt32 | get_type_object_serialized_size () |
Gets the serialized size of the TypeObject created from this DDS::TypeCode. More... | |
System::UInt32 | cdr_serialized_sample_max_size (System::Int16 representation_id) |
System::UInt32 | cdr_serialized_sample_max_size () |
System::UInt32 | cdr_serialized_sample_min_size (System::Int16 representation_id) |
System::UInt32 | cdr_serialized_sample_min_size () |
System::UInt32 | cdr_serialized_sample_key_max_size (System::Int16 representation_id) |
System::UInt32 | cdr_serialized_sample_key_max_size () |
void | print_IDL (System::UInt32 indent) |
Prints a DDS::TypeCode in IDL notation. More... | |
System::String ^ | to_string () |
Get a string representation of this DDS::TypeCode object using the default values for DDS::TypeCodePrintFormatProperty. More... | |
System::String ^ | to_string (DDS::TypeCodePrintFormatProperty^ format) |
Get a string representation of this DDS::TypeCode object using the format described by DDS::TypeCodePrintFormatProperty. More... | |
Public Attributes | |
TypeCode ^ | TC_NULL |
Basic null type. More... | |
TypeCode ^ | TC_SHORT |
Basic 16-bit signed integer type. More... | |
TypeCode ^ | TC_LONG |
Basic 32-bit signed integer type. More... | |
TypeCode ^ | TC_USHORT |
Basic unsigned 16-bit integer type. More... | |
TypeCode ^ | TC_ULONG |
Basic unsigned 32-bit integer type. More... | |
TypeCode ^ | TC_FLOAT |
Basic 32-bit floating point type. More... | |
TypeCode ^ | TC_DOUBLE |
Basic 64-bit floating point type. More... | |
TypeCode ^ | TC_BOOLEAN |
Basic Boolean type. More... | |
TypeCode ^ | TC_CHAR |
Basic single-byte character type. More... | |
TypeCode ^ | TC_OCTET |
Basic octet/byte type. More... | |
TypeCode ^ | TC_LONGLONG |
Basic 64-bit integer type. More... | |
TypeCode ^ | TC_ULONGLONG |
Basic unsigned 64-bit integer type. More... | |
TypeCode ^ | TC_LONGDOUBLE |
Basic 128-bit floating point type. More... | |
TypeCode ^ | TC_WCHAR |
Basic four-byte character type. More... | |
System::Int32 | MEMBER_ID_INVALID |
A sentinel indicating an invalid DDS::TypeCode member ID. More... | |
System::UInt32 | INDEX_INVALID |
A sentinel indicating an invalid DDS::TypeCode member index. More... | |
System::Int16 | NOT_BITFIELD |
Indicates that a member of a type is not a bitfield. More... | |
System::Byte | NONKEY_MEMBER |
A flag indicating that a type member is optional and not part of the key. More... | |
System::Byte | KEY_MEMBER |
A flag indicating that a type member is part of the key for that type, and therefore required. More... | |
System::Byte | NONKEY_REQUIRED_MEMBER |
A flag indicating that a type member is not part of the key but is nevertheless required. More... | |
The definition of a particular data type, which you can use to inspect the name, members, and other properties of types generated with rtiddsgen or to modify types you define yourself at runtime.
You create DDS::TypeCode objects using the DDS::TypeCodeFactory singleton. Then you can use the methods on this class to inspect and modify the data type definition.
This class is based on a similar class from CORBA.
TCKind DDS::TypeCode::kind | ( | ) |
Gets the DDS::TCKind value of a type code.
Retrieves the kind of this DDS::TypeCode object. The kind of a type code determines which DDS::TypeCode methods may legally be invoked on it.
ExtensibilityKind DDS::TypeCode::extensibility_kind | ( | ) |
Gets the DDS::ExtensibilityKind value of a type code.
Retrieves the extensibility kind of this DDS::TypeCode object.
In some cases, it is desirable for types to evolve without breaking interoperability with deployed components already using those types. For example:
A new set of applications to be integrated into an existing system may want to introduce additional fields into a structure. These new fields can be safely ignored by already deployed applications, but applications that do understand the new fields can benefit from their presence.
In order to support use cases such as these, the type system introduces the concept of extensible and mutable types.
A type may be final, indicating that the range of its possible data values is strictly defined. In particular, it is not possible to add elements to members of collection or aggregated types while maintaining type assignability.
A type may be extensible, indicating that two types, where one contains all of the elements/members of the other plus additional elements/members appended to the end, may remain assignable.
The extensibility of TK_STRUCT, TK_UNION, TK_VALUE, and TK_ENUM can be change using the built-in "Extensibility" annotation when the type is declared.
IDL examples:
XML example:
XSD example:
For TypeCodes built at run-time using the DDS::TypeCodeFactory API, the extensibility can be provided as a parameter of the following APIs:
System::Boolean DDS::TypeCode::equal | ( | TypeCode^ | tc | ) |
Compares two DDS::TypeCode objects for equality.
For equality and assignability purposes, TK_STRUCT and TK_VALUE are considered equivalent.
The DDS::TypeCode of structs inheriting from other structs has a TK_VALUE kind.
For example:
The code generation for the previous type will generate a DDS::TypeCode with TK_VALUE kind.
tc | <<in>> Type code that will be compared with this DDS::TypeCode. |
DDS_BAD_PARAM_SYSTEM_EXCEPTION_CODE | if tc is null. |
System::String ^ DDS::TypeCode::name | ( | ) |
Retrieves the simple name identifying this DDS::TypeCode object within its enclosing scope.
DDS_BADKIND_USER_EXCEPTION_CODE | if the method is invoked on an inappropriate kind of TypeCode object. |
System::UInt32 DDS::TypeCode::member_count | ( | ) |
Returns the number of members of the type code.
The method member_count can be invoked on structure, union, and enumeration DDS::TypeCode objects.
DDS_BADKIND_USER_EXCEPTION_CODE | if the method is invoked on an inappropriate kind of TypeCode object. |
System::String ^ DDS::TypeCode::member_name | ( | System::UInt32 | index | ) |
Returns the name of a type code member identified by the given index.
The method member_name can be invoked on structure, union, and enumeration DDS::TypeCode objects.
index | <<in>> Member index in the interval [0,(member count-1)]. |
DDS_BADKIND_USER_EXCEPTION_CODE | if the method is invoked on an inappropriate kind of TypeCode object. |
BAD_BOUNDS_USER_EXCEPTION_CODE | - if the index parameter/s are out of range. |
System::UInt32 DDS::TypeCode::find_member_by_name | ( | System::String^ | name | ) |
Get the index of the member of the given name.
This method is applicable to DDS::TypeCode objects representing structs (TK_STRUCT) and union (TK_UNION) types.
name | <<in>> The member name. |
DDS_BADKIND_USER_EXCEPTION_CODE | if the method is invoked on an inappropriate kind of TypeCode object. |
DDS::TypeCode ^ DDS::TypeCode::member_type | ( | System::UInt32 | index | ) |
Retrieves the DDS::TypeCode object describing the type of the member identified by the given index.
The method member_type can be invoked on structure and union type codes.
index | <<in>> Member index in the interval [0,(member count-1)]. |
DDS_BADKIND_USER_EXCEPTION_CODE | if the method is invoked on an inappropriate kind of TypeCode object. |
BAD_BOUNDS_USER_EXCEPTION_CODE | - if the index parameter/s are out of range. |
System::UInt32 DDS::TypeCode::member_label_count | ( | System::UInt32 | index | ) |
Returns the number of labels associated to the index-th union member.
The method can be invoked on union DDS::TypeCode objects.
This function is an RTI Connext extension to the CORBA Type Code Specification.
index | <<in>> Member index in the interval [0,(member count-1)]. |
DDS_BADKIND_USER_EXCEPTION_CODE | if the method is invoked on an inappropriate kind of TypeCode object. |
BAD_BOUNDS_USER_EXCEPTION_CODE | - if the index parameter/s are out of range. |
System::Int32 DDS::TypeCode::member_label | ( | System::UInt32 | member_index, |
System::UInt32 | label_index | ||
) |
Return the label_index-th label associated to the member_index-th member.
This method has been modified for RTI Connext from the CORBA Type code Specification.
Example:
case 1: Label index 0
case 2: Label index 1
short short_member;
The method can be invoked on union DDS::TypeCode objects.
DDS_BADKIND_USER_EXCEPTION_CODE | if the method is invoked on an inappropriate kind of TypeCode object. |
BAD_BOUNDS_USER_EXCEPTION_CODE | - if the index parameter/s are out of range. |
System::Int32 DDS::TypeCode::member_ordinal | ( | System::UInt32 | index | ) |
Returns the ordinal that corresponds to the index-th enum value.
The method can be invoked on enum DDS::TypeCode objects.
This function is an RTI Connext extension to the CORBA Type Code Specification.
index | <<in>> Member index in the interval [0,(member count-1)]. |
DDS_BADKIND_USER_EXCEPTION_CODE | if the method is invoked on an inappropriate kind of TypeCode object. |
BAD_BOUNDS_USER_EXCEPTION_CODE | - if the index parameter/s are out of range. |
System::Boolean DDS::TypeCode::is_member_key | ( | System::UInt32 | index | ) |
Function that tells if a member is a key or not.
This function is an RTI Connext extension to the CORBA Type Code Specification.
index | <<in>> Member index in the interval [0,(member count-1)]. |
DDS_BADKIND_USER_EXCEPTION_CODE | if the method is invoked on an inappropriate kind of TypeCode object. |
BAD_BOUNDS_USER_EXCEPTION_CODE | - if the index parameter/s are out of range. |
System::Boolean DDS::TypeCode::is_member_required | ( | System::UInt32 | index | ) |
Indicates whether a given member of a type is required to be present in every sample of that type.
A non-key member is required if it has not been marked as optional. All key members are required.
System::Boolean DDS::TypeCode::is_member_pointer | ( | System::UInt32 | index | ) |
Function that tells if a member is a pointer or not.
The method is_member_pointer can be invoked on union and structs type objects
This function is an RTI Connext extension to the CORBA Type Code Specification.
index | <<in>> Index of the member for which type information is begin requested. |
DDS_BADKIND_USER_EXCEPTION_CODE | if the method is invoked on an inappropriate kind of TypeCode object. |
BAD_BOUNDS_USER_EXCEPTION_CODE | - if the index parameter/s are out of range. |
System::Boolean DDS::TypeCode::is_member_bitfield | ( | System::UInt32 | index | ) |
Function that tells if a member is a bitfield or not.
The method can be invoked on struct type objects.
This function is an RTI Connext extension to the CORBA Type Code Specification.
index | <<in>> Member index in the interval [0,(member count-1)]. |
DDS_BADKIND_USER_EXCEPTION_CODE | if the method is invoked on an inappropriate kind of TypeCode object. |
BAD_BOUNDS_USER_EXCEPTION_CODE | - if the index parameter/s are out of range. |
System::Int16 DDS::TypeCode::member_bitfield_bits | ( | System::UInt32 | index | ) |
Returns the number of bits of a bitfield member.
The method can be invoked on struct type objects.
This function is an RTI Connext extension to the CORBA Type Code Specification.
index | <<in>> Member index in the interval [0,(member count-1)]. |
DDS_BADKIND_USER_EXCEPTION_CODE | if the method is invoked on an inappropriate kind of TypeCode object. |
BAD_BOUNDS_USER_EXCEPTION_CODE | - if the index parameter/s are out of range. |
Visibility DDS::TypeCode::member_visibility | ( | System::UInt32 | index | ) |
Returns the constant that indicates the visibility of the index-th member.
For TK_STRUCT, this method always returns PUBLIC_MEMBER.
index | <<in>> Member index in the interval [0,(member count-1)]. |
DDS_BADKIND_USER_EXCEPTION_CODE | if the method is invoked on an inappropriate kind of TypeCode object. |
BAD_BOUNDS_USER_EXCEPTION_CODE | - if the index parameter/s are out of range. |
TypeCode ^ DDS::TypeCode::discriminator_type | ( | ) |
Returns the discriminator type code.
The method discriminator_type can be invoked only on union DDS::TypeCode objects.
DDS_BADKIND_USER_EXCEPTION_CODE | if the method is invoked on an inappropriate kind of TypeCode object. |
System::UInt32 DDS::TypeCode::length | ( | ) |
Returns the number of elements in the type described by this type code.
Length is:
DDS_BADKIND_USER_EXCEPTION_CODE | if the method is invoked on an inappropriate kind of TypeCode object. |
System::UInt32 DDS::TypeCode::array_dimension_count | ( | ) |
This function returns the number of dimensions of an array type code.
This function is an RTI Connext extension to the CORBA Type Code Specification.
DDS_BADKIND_USER_EXCEPTION_CODE | if the method is invoked on an inappropriate kind of TypeCode object. |
System::UInt32 DDS::TypeCode::array_dimension | ( | System::UInt32 | index | ) |
This function returns the index-th dimension of an array type code.
This function is an RTI Connext extension to the CORBA Type Code Specification.
index | <<in>> Dimension index in the interval [0,(dimensions count-1)]. |
DDS_BADKIND_USER_EXCEPTION_CODE | if the method is invoked on an inappropriate kind of TypeCode object. |
BAD_BOUNDS_USER_EXCEPTION_CODE | - if the index parameter/s are out of range. |
System::UInt32 DDS::TypeCode::element_count | ( | ) |
The number of elements in an array.
This operation isn't relevant for other kinds of types.
DDS::TypeCode ^ DDS::TypeCode::content_type | ( | ) |
Returns the DDS::TypeCode object representing the type for the members of the object described by this DDS::TypeCode object.
For sequences and arrays, it returns the element type. For aliases, it returns the original type.
DDS_BADKIND_USER_EXCEPTION_CODE | if the method is invoked on an inappropriate kind of TypeCode object. |
System::Boolean DDS::TypeCode::is_alias_pointer | ( | ) |
Function that tells if an alias is a pointer or not.
This function is an RTI Connext extension to the CORBA Type Code Specification.
DDS_BADKIND_USER_EXCEPTION_CODE | if the method is invoked on an inappropriate kind of TypeCode object. |
System::Int32 DDS::TypeCode::default_index | ( | ) |
Returns the index of the default member, or -1 if there is no default member.
The method default_index can be invoked only on union DDS::TypeCode objects.
DDS_BADKIND_USER_EXCEPTION_CODE | if the method is invoked on an inappropriate kind of TypeCode object. |
DDS::TypeCode ^ DDS::TypeCode::concrete_base_type | ( | ) |
Returns the DDS::TypeCode that describes the concrete base type of the value type that this DDS::TypeCode object describes.
For TK_STRUCT, this method always returns TK_NULL.
The DDS::TypeCode of structs inheriting from other structs has a TK_VALUE kind.
For example:
The code generation for the previous type will generate a DDS::TypeCode with TK_VALUE kind.
DDS_BADKIND_USER_EXCEPTION_CODE | if the method is invoked on an inappropriate kind of TypeCode object. |
ValueModifier DDS::TypeCode::type_modifier | ( | ) |
Returns a constant indicating the modifier of the value type that this DDS::TypeCode object describes.
For TK_STRUCT, this method always returns VM_NONE.
DDS_BADKIND_USER_EXCEPTION_CODE | if the method is invoked on an inappropriate kind of TypeCode object. |
System::Int32 DDS::TypeCode::member_id | ( | System::UInt32 | index | ) |
Returns the ID of the TypeCode member identified by the given index.
This function is an RTI Connext extension to the CORBA Type Code Specification.
The method can be invoked on aggregation DDS::TypeCode objects.
All members of aggregated types have an integral member ID that uniquely identifies them within their defining type.
In IDL, you can specify the member ID using the built-in annotation ID. For example:
In XML, you can specify the member ID using the attribute 'id':
In XSD, you can specify the member ID using the built-in annotation ID
index | <<in>> Member index in the interval [0,(member count-1)]. |
DDS_BADKIND_USER_EXCEPTION_CODE | if the method is invoked on an inappropriate kind of TypeCode object. |
BAD_BOUNDS_USER_EXCEPTION_CODE | - if the index parameter/s are out of range. |
System::UInt32 DDS::TypeCode::find_member_by_id | ( | System::Int32 | id | ) |
Get the index of the member of the given ID.
This method is applicable to DDS::TypeCode objects representing structs (TK_STRUCT) and union (TK_UNION) types.
id | <<in>> The member ID. |
DDS_BADKIND_USER_EXCEPTION_CODE | if the method is invoked on an inappropriate kind of TypeCode object. |
System::UInt32 DDS::TypeCode::add_member_to_enum | ( | System::String^ | name, |
System::Int32 | ordinal | ||
) |
Add a new enumerated constant to this enum DDS::TypeCode.
This method is applicable to DDS::TypeCode objects representing enumerations (TK_ENUM). To add a field to a structured type, see DDS::TypeCode::add_member_to_enum.
Modifying a DDS::TypeCode – such as by adding a member – is important if you are using the Dynamic Data APIs.
name | <<in>> The name of the new member. This string must be unique within this type and must not be null. |
ordinal | <<in>> The relative order of the new member in this enum or a custom integer value. The value must be unique within the type. |
System::UInt32 DDS::TypeCode::add_member_to_union | ( | System::String^ | name, |
System::Int32 | id, | ||
IntSeq^ | labels, | ||
DDS::TypeCode^ | tc, | ||
System::Boolean | is_pointer | ||
) |
Add a new member to a union DDS::TypeCode.
This method is applicable to DDS::TypeCode objects representing unions (TK_UNION).
Modifying a DDS::TypeCode – such as by adding a member – is important if you are using the Dynamic Data APIs.
name | <<in>> The name of the new member. |
id | <<in>> The member ID. For automatic assignment of the member ID specify DDS::TypeCode::MEMBER_ID_INVALID. |
labels | <<in>> A sequence of labels or case values associated with the member. |
tc | <<in>> The type of the new member. You can get or create this DDS::TypeCode with the DDS::TypeCodeFactory. |
is_pointer | <<in>> Whether the data member, in its deserialized form, should be stored by pointer as opposed to by value. |
DDS_BADKIND_USER_EXCEPTION_CODE | DDS_BAD_MEMBER_NAME_USER_EXCEPTION_CODE DDS_BAD_MEMBER_ID_USER_EXCEPTION_CODE |
System::UInt32 DDS::TypeCode::add_member | ( | System::String^ | name, |
System::Int32 | id, | ||
DDS::TypeCode^ | tc, | ||
System::Byte | member_flags | ||
) |
Add a new member to this DDS::TypeCode.
This method is applicable to DDS::TypeCode objects representing structures (TK_STRUCT), value types (TK_VALUE), and unions (TK_UNION). To add a constant to an enumeration, see DDS::TypeCode::add_member_to_enum.
Calling this method clones the type code passed as the tc
parameter if the type code is not a builtin one. To delete this cloned type code, call DDS::TypeCodeFactory::delete_tc.
The ability to modify a DDS::TypeCode – such as by adding a member – is important if you are using the Dynamic Data APIs.
Here's a simple code example that adds two fields to a data type, one an integer and another a sequence of integers.
In C#:
In C++/CLI:
name | <<in>> The name of the new member. |
id | <<in>> Member ID or case value.
|
tc | <<in>> The type of the new member. You can get or create this DDS::TypeCode with the DDS::TypeCodeFactory. |
member_flags | <<in>> Indicates whether the member is part of the key and whether it is required. |
System::UInt32 DDS::TypeCode::add_member_ex | ( | System::String^ | name, |
System::Int32 | id, | ||
DDS::TypeCode^ | tc, | ||
System::Byte | member_flags, | ||
Visibility | visibility, | ||
System::Boolean | is_pointer, | ||
System::Int16 | bits | ||
) |
Add a new member to this DDS::TypeCode.
This method is applicable to DDS::TypeCode objects representing structures (TK_STRUCT), value types (TK_VALUE), and unions (TK_UNION). To add a constant to an enumeration, see DDS::TypeCode::add_member_to_enum.
Calling this method clones the type code passed in as the tc
parameter if the type code is not a builtin one. To delete this cloned type code, call DDS::TypeCodeFactory::delete_tc.
The ability to modify a DDS::TypeCode – such as by adding a member – is important if you are using the Dynamic Data APIs.
name | <<in>> The name of the new member. |
id | <<in>> Member ID or case value.
|
tc | <<in>> The type of the new member. You can get or create this DDS::TypeCode with the DDS::TypeCodeFactory. |
member_flags | <<in>> Indicates whether the member is part of the key and whether it is required. |
visibility | <<in>> Whether the new member is public or private. Non-public members are only relevant for types of kind TK_VALUE. Possible values include:
|
is_pointer | <<in>> Whether the data member, in its deserialized form, should be stored by pointer as opposed to by value. |
bits | <<in>> The number of bits, if this new member is a bit field, or DDS::TypeCode::NOT_BITFIELD. |
System::UInt32 DDS::TypeCode::get_type_object_serialized_size | ( | ) |
Gets the serialized size of the TypeObject created from this DDS::TypeCode.
The default buffer size used for storing a TypeObject is 8192 bytes. For a large TypeObject, this API can be used to determine the size that needs to be set in DDS::DomainParticipantResourceLimitsQosPolicy::type_object_max_serialized_length
System::UInt32 DDS::TypeCode::cdr_serialized_sample_max_size | ( | System::Int16 | representation_id | ) |
dref_TypeCode_cdr_serialized_sample_max_size
System::UInt32 DDS::TypeCode::cdr_serialized_sample_max_size | ( | ) |
dref_TypeCode_cdr_serialized_sample_max_size_wo_representation_id
System::UInt32 DDS::TypeCode::cdr_serialized_sample_min_size | ( | System::Int16 | representation_id | ) |
dref_TypeCode_cdr_serialized_sample_min_size
System::UInt32 DDS::TypeCode::cdr_serialized_sample_min_size | ( | ) |
dref_TypeCode_cdr_serialized_sample_min_size_wo_representation_id
System::UInt32 DDS::TypeCode::cdr_serialized_sample_key_max_size | ( | System::Int16 | representation_id | ) |
dref_TypeCode_cdr_serialized_sample_key_max_size
System::UInt32 DDS::TypeCode::cdr_serialized_sample_key_max_size | ( | ) |
dref_TypeCode_cdr_serialized_sample_key_max_size_wo_representation_id
void DDS::TypeCode::print_IDL | ( | System::UInt32 | indent | ) |
System::String ^ DDS::TypeCode::to_string | ( | ) |
Get a string representation of this DDS::TypeCode object using the default values for DDS::TypeCodePrintFormatProperty.
This function obtains a string representation of a DDS::TypeCode object, it creates this string using the default values of DDS::TypeCodePrintFormatProperty.
System::String ^ DDS::TypeCode::to_string | ( | DDS::TypeCodePrintFormatProperty^ | format | ) |
Get a string representation of this DDS::TypeCode object using the format described by DDS::TypeCodePrintFormatProperty.
This function behaves in the same way as DDS::TypeCode::to_string but allows the user to specify the format of the string using DDS::TypeCodePrintFormatProperty.
format | <<in>> The DDS::TypeCodePrintFormatProperty used to define the format of the string representation of the DDS::TypeCode. |