RTI Connext .NET API (legacy)
Version 6.1.1
|
<<interface>> String type support. More...
#include <managed_stringwrapperSupport.h>
Inherits DDS::TypedTypeSupport< T >.
Static Public Member Functions | |
static System::String ^ | get_type_name () |
Get the default name for the System::String type. More... | |
static void | print_data (System::String^ a_data) |
<<extension>> Print value of data type to standard out. More... | |
static void | register_type (DDS::DomainParticipant^ participant, System::String^ type_name) |
Allows an application to communicate to RTI Connext the existence of the System::String data type. More... | |
static void | unregister_type (DDS::DomainParticipant^ participant, System::String^ type_name) |
Allows an application to unregister the System::String data type from RTI Connext. After calling unregister_type, no further communication using this type is possible. More... | |
static void | serialize_data_to_cdr_buffer (array< System::Byte >^ buffer, System::UInt32% length, String^ a_data) |
<<extension>> Serializes the input sample into a CDR buffer of octets. More... | |
static void | serialize_data_to_cdr_buffer (array< System::Byte >^ buffer, System::UInt32% length, String^ a_data, System::Int16 representation) |
<<extension>> Serializes the input sample into a buffer of octets. More... | |
static String ^ | deserialize_data_from_cdr_buffer (array< System::Byte >^ buffer, System::UInt32 length) |
<<extension>> Deserializes a sample from a buffer of octets. More... | |
static System::String ^ | data_to_string (String^ sample, PrintFormatProperty^ formatProperty) |
<<extension>> Get the string representation of an input sample. More... | |
static System::String ^ | data_to_string (String^ sample) |
<<extension>> Get the string representation of an input sample. More... | |
static DDS::TypeCode ^ | get_typecode () |
<<extension>> Retrieves the TypeCode for the Type. More... | |
<<interface>> String type support.
|
static |
Get the default name for the System::String type.
Can be used for calling DDS::StringTypeSupport::register_type or creating DDS::Topic.
|
inlinestatic |
<<extension>> Print value of data type to standard out.
The generated implementation of the operation knows how to print value of a data type.
a_data | <<in>> String to be printed. |
|
static |
Allows an application to communicate to RTI Connext the existence of the System::String data type.
By default, The System::String built-in type is automatically registered when a DomainParticipant is created using the type_name returned by DDS::StringTypeSupport::get_type_name. Therefore, the usage of this function is optional and it is only required when the automatic built-in type registration is disabled using the participant property "dds.builtin_type.auto_register".
This method can also be used to register the same DDS::StringTypeSupport with a DDS::DomainParticipant using different values for the type_name.
If register_type
is called multiple times with the same DDS::DomainParticipant and type_name
, the second (and subsequent) registrations are ignored by the operation.
participant | <<in>> the DDS::DomainParticipant to register the data type System::String with. Cannot be null. |
type_name | <<in>> the type name under with the data type System::String is registered with the participant; this type name is used when creating a new DDS::Topic. (See DDS::DomainParticipant::create_topic.) The name may not be null or longer than 255 characters. |
One | of the Standard Return Codes, DDS::Retcode_PreconditionNotMet or DDS::Retcode_OutOfResources. |
Referenced by print_data().
|
static |
Allows an application to unregister the System::String data type from RTI Connext. After calling unregister_type, no further communication using this type is possible.
type_name
is registered with the participant and all DDS::Topic objects referencing the type have been destroyed. If the type is not registered with the participant, or if any DDS::Topic is associated with the type, the operation will fail with DDS::Retcode_Error. participant | <<in>> the DDS::DomainParticipant to unregister the data type System::String from. Cannot be null. |
type_name | <<in>> the type name under with the data type System::String is registered with the participant. The name should match a name that has been previously used to register a type with the participant. Cannot be null. |
One | of the Standard Return Codes, DDS::Retcode_BadParameter or DDS::Retcode_Error |
Referenced by print_data().
|
static |
<<extension>> Serializes the input sample into a CDR buffer of octets.
Referenced by print_data().
|
static |
<<extension>> Serializes the input sample into a buffer of octets.
|
static |
<<extension>> Deserializes a sample from a buffer of octets.
Referenced by print_data().
|
static |
<<extension>> Get the string representation of an input sample.
Referenced by print_data().
|
static |
<<extension>> Get the string representation of an input sample.
Use the default values for DDS::PrintFormatProperty to create the output string.
|
static |
<<extension>> Retrieves the TypeCode for the Type.
Referenced by print_data().