RTI Connext Modern C++ API  Version 6.0.0
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
rti::flat::StringOffset Class Reference

Offset to a string. More...

#include <SequenceOffsets.hpp>

Inheritance diagram for rti::flat::StringOffset:
rti::flat::PrimitiveSequenceOffset< char > rti::flat::AbstractPrimitiveList< char > rti::flat::OffsetBase

Public Member Functions

char * get_string ()
 Gets the string.
const char * get_string () const
 Gets the string (const)
unsigned int element_count () const
 Returns the number of characters.
- Public Member Functions inherited from rti::flat::PrimitiveSequenceOffset< char >
unsigned int element_count () const
 Returns the number of elements.
- Public Member Functions inherited from rti::flat::AbstractPrimitiveList< char >
char get_element (unsigned int i) const
 Returns an element by index.
bool set_element (unsigned int i, charvalue)
 Sets an element by index.
- Public Member Functions inherited from rti::flat::OffsetBase
bool is_null () const
 Indicates whether this Offset doesn't point to a valid element.
bool is_cpp_compatible () const
 Indicates whether rti::flat::plain_cast() is possible.
const unsigned char * get_buffer () const
 Gets this member's position in the buffer.
offset_t get_buffer_size () const
 Gets the size, in bytes, of this member in the buffer.

Detailed Description

Offset to a string.

Member Function Documentation

char* rti::flat::StringOffset::get_string ( )

Gets the string.

The string returned can be modified as long as its size doesn't change.

const char* rti::flat::StringOffset::get_string ( ) const

Gets the string (const)

unsigned int rti::flat::StringOffset::element_count ( ) const

Returns the number of characters.

This number doesn't include the null terminating character.

RTI Connext Modern C++ API Version 6.0.0 Copyright © Sun Mar 3 2019 Real-Time Innovations, Inc