RTI Connext .Net APIs
Version 5.0.0
|
<<interface>> <<generic>> User data type specific interface. More...
#include <managed_topic.h>
Static Public Member Functions | |
static System::String^ | get_type_name () |
Get the default name for this type. | |
static void | register_type (DDS::DomainParticipant^ participant, System::String^ type_name) |
Allows an application to communicate to RTI Connext the existence of a data type. | |
static void | unregister_type (DDS::DomainParticipant^ participant, System::String^ type_name) |
Allows an application to unregister a data type from RTI Connext. After calling unregister_type, no further communication using that type is possible. | |
static Foo^ | create_data () |
<<eXtension>> Create a data type and initialize it. | |
static void | delete_data (Foo^ a_data) |
<<eXtension>> Destroy a user data type instance. | |
static void | print_data (Foo^ a_data) |
<<eXtension>> Print value of data type to standard out. | |
static void | copy_data (Foo^ dst_data, Foo^ src_data) |
<<eXtension>> Copy data type. | |
<<interface>> <<generic>> User data type specific interface.
Defines the user data type specific interface generated for each application class.
The concrete user data type automatically generated by the implementation is an incarnation of this class.
|
static |
Get the default name for this type.
Can be used for calling FooTypeSupport::register_type or creating DDS::Topic
|
static |
Allows an application to communicate to RTI Connext the existence of a data type.
The generated implementation of the operation embeds all the knowledge that has to be communicated to the middleware in order to make it able to manage the contents of data of that type. This includes in particular the key definition that will allow RTI Connext to distinguish different instances of the same type.
The same DDS::TypeSupport can be registered multiple times with a DDS::DomainParticipant using the same or different values for the type_name
. If register_type
is called multiple times on the same DDS::TypeSupport with the same DDS::DomainParticipant and type_name
, the second (and subsequent) registrations are ignored by the operation fails with ::DDS::Exception::RETCODE_OK.
type_name
to register two different DDS::TypeSupport with the same DDS::DomainParticipant, or else the operation will fail and DDS::Retcode_PreconditionNotMet will be returned. participant | <<in>> the DDS::DomainParticipant to register the data type Foo with. Cannot be NULL. |
type_name | <<in>> the type name under with the data type Foo 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. |
|
static |
Allows an application to unregister a data type from RTI Connext. After calling unregister_type, no further communication using that type is possible.
The generated implementation of the operation removes all the information about a type from RTI Connext. No further communication using that 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 Foo from. Cannot be NULL. |
type_name | <<in>> the type name under with the data type Foo 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 |
|
static |
<<eXtension>> Create a data type and initialize it.
The generated implementation of the operation knows how to instantiate a data type and initialize it properly.
All memory for the type is deeply allocated.
|
static |
<<eXtension>> Destroy a user data type instance.
The generated implementation of the operation knows how to destroy a data type and return all resources.
a_data | <<in>> Cannot be NULL. |
One | of the Standard Return Codes |
|
static |
<<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>> Data type to be printed. |
<<eXtension>> Copy data type.
The generated implementation of the operation knows how to copy value of a data type.
dst_data | <<inout>> Data type to copy value to. Cannot be NULL. |
src_data | <<in>> Data type to copy value from. Cannot be NULL. |
One | of the Standard Return Codes |