RTI Connext Modern C++ API Version 7.3.0
|
The base class of types that have members and an extensibility kind. More...
#include <DynamicTypeImpl.hpp>
Public Types | |
typedef MemberType | Member |
The member type (specified by the subclasses of this class) More... | |
typedef uint32_t | MemberIndex |
The member index type. More... | |
Public Member Functions | |
dds::core::xtypes::ExtensibilityKind | extensibility_kind () const |
Gets the extensibility kind. More... | |
size_t | member_count () const |
Gets the number of members. More... | |
const MemberType & | member (MemberIndex index) const |
Gets a member by its index. More... | |
const MemberType & | member (const std::string &name) const |
Gets a member by its name. More... | |
MemberIndex | find_member_by_name (const std::string &name) const |
Obtains the member index from its name. More... | |
std::vector< MemberType > | members () const |
Gets a copy of all the members. More... | |
uint32_t | cdr_serialized_sample_max_size (dds::core::policy::DataRepresentationId representation_id=DDS_AUTO_DATA_REPRESENTATION) const |
Gets the maximum serialized size of samples of this type. More... | |
uint32_t | cdr_serialized_sample_min_size (dds::core::policy::DataRepresentationId representation_id=DDS_AUTO_DATA_REPRESENTATION) const |
Gets the minimum serialized size of samples of this type. More... | |
uint32_t | cdr_serialized_sample_key_max_size (dds::core::policy::DataRepresentationId representation_id=DDS_AUTO_DATA_REPRESENTATION) const |
Gets the maximum serialized size of sample keys of this type. More... | |
![]() | |
dds::core::xtypes::TypeKind | kind () const |
Gets the type kind. More... | |
std::string | name () const |
Gets the name. More... | |
Static Public Attributes | |
static OMG_DDS_API_CLASS_VARIABLE const MemberIndex | INVALID_INDEX |
Indicates that a member doesn't exist. More... | |
Additional Inherited Members | |
![]() | |
bool | is_primitive_type (const DynamicType &t) |
Determines if a DynamicType is a PrimitiveType. More... | |
bool | is_constructed_type (const DynamicType &t) |
Determines if a DynamicType is a constructed type. More... | |
bool | is_collection_type (const DynamicType &t) |
Determines if a DynamicType is a CollectionType. More... | |
bool | is_aggregation_type (const DynamicType &t) |
Determines if a DynamicType is an aggregation type. More... | |
std::ostream & | operator<< (std::ostream &out, const DynamicType &type) |
<<extension>> Converts the DynamicType to a string. More... | |
void | print_idl (const DynamicType &type, unsigned int indent=0) |
<<extension>> Prints the IDL representation of this DynamicType to the standard output More... | |
std::ostream & | to_string (std::ostream &out, const DynamicType &type, const rti::core::xtypes::DynamicTypePrintFormatProperty &format=DynamicTypePrintFormatProperty()) |
<<extension>> Writes the string representation of this DynamicType to an output stream. More... | |
std::string | to_string (const DynamicType &type, const rti::core::xtypes::DynamicTypePrintFormatProperty &format=DynamicTypePrintFormatProperty()) |
<<extension>> Creates the string representation of this DynamicType to a string. More... | |
The base class of types that have members and an extensibility kind.
MemberType | The concrete member type, specified by the subclasses, can be Member, UnionMember and EnumMember |
This is the base class of StructType, UnionType and EnumType.
typedef MemberType dds::core::xtypes::AbstractConstructedType< MemberType >::Member |
The member type (specified by the subclasses of this class)
typedef uint32_t dds::core::xtypes::AbstractConstructedType< MemberType >::MemberIndex |
The member index type.
dds::core::xtypes::ExtensibilityKind dds::core::xtypes::AbstractConstructedType< MemberType >::extensibility_kind | ( | ) | const |
Gets the extensibility kind.
size_t dds::core::xtypes::AbstractConstructedType< MemberType >::member_count | ( | ) | const |
Gets the number of members.
const MemberType & dds::core::xtypes::AbstractConstructedType< MemberType >::member | ( | MemberIndex | index | ) | const |
Gets a member by its index.
index | The index of the member (0 to member_count() - 1) |
const MemberType & dds::core::xtypes::AbstractConstructedType< MemberType >::member | ( | const std::string & | name | ) | const |
Gets a member by its name.
MemberIndex dds::core::xtypes::AbstractConstructedType< MemberType >::find_member_by_name | ( | const std::string & | name | ) | const |
Obtains the member index from its name.
This method is applicable to dds::core::xtypes::DynamicType objects representing structs (dds::core::xtypes::TypeKind_def::STRUCTURE_TYPE) and union (dds::core::xtypes::TypeKind_def::UNION_TYPE) types.
name | <<in>> The member name. |
std::vector< MemberType > dds::core::xtypes::AbstractConstructedType< MemberType >::members | ( | ) | const |
Gets a copy of all the members.
uint32_t dds::core::xtypes::AbstractConstructedType< MemberType >::cdr_serialized_sample_max_size | ( | dds::core::policy::DataRepresentationId | representation_id = DDS_AUTO_DATA_REPRESENTATION | ) | const |
Gets the maximum serialized size of samples of this type.
Obtains the maximum possible size in bytes of any serialized data sample of this type.
representation_id | The serialized data representation for which we calculate the maximum size. |
uint32_t dds::core::xtypes::AbstractConstructedType< MemberType >::cdr_serialized_sample_min_size | ( | dds::core::policy::DataRepresentationId | representation_id = DDS_AUTO_DATA_REPRESENTATION | ) | const |
Gets the minimum serialized size of samples of this type.
Obtains the minimum possible size in bytes of any serialized data sample of this type.
representation_id | The serialized data representation for which we calculate the minimum size. |
uint32_t dds::core::xtypes::AbstractConstructedType< MemberType >::cdr_serialized_sample_key_max_size | ( | dds::core::policy::DataRepresentationId | representation_id = DDS_AUTO_DATA_REPRESENTATION | ) | const |
Gets the maximum serialized size of sample keys of this type.
Obtains the maximum possible size in bytes of the serialized keys of any data sample of this type
representation_id | The serialized data representation for which we calculate the maximum key size. |
|
static |
Indicates that a member doesn't exist.