RTI Connext Modern C++ API  Version 5.3.0
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
dds::core Namespace Reference

The core namespace contains infrastructure types and functions. More...

Namespaces

namespace  cond
 Contains the Condition classes.
 
namespace  xtypes
 Contains the types and functions to support Extensible Types.
 
namespace  policy
 Contains the standard Qos policy classes.
 
namespace  status
 Contains the Status and State classes.
 

Classes

class  Duration
 <<value-type>> Represents a time interval More...
 
class  Exception
 The abstract base class for all of the DDS exceptions which may be thrown by the API. More...
 
class  Error
 A generic, unspecified Error. More...
 
class  AlreadyClosedError
 Indicates that an object has been closed. More...
 
class  IllegalOperationError
 Indicates that an operation was called under improper circumstances. More...
 
class  NotAllowedBySecError
 Indicates that an operation on the DDS API fails because the security plugins do not allow it. More...
 
class  ImmutablePolicyError
 Indicates that the application attempted to modify an immutable QoS policy. More...
 
class  InconsistentPolicyError
 Indicates that the application specified a set of QoS policies that are not consistent with each other. More...
 
class  InvalidArgumentError
 Indicates that the application passed an illegal parameter value into an operation. More...
 
class  NotEnabledError
 A NotEnabledError is thrown when an operation is invoked on a dds::core::Entity that is not yet enabled. More...
 
class  OutOfResourcesError
 Indicates that RTI Connext ran out of the resources needed to complete the operation. More...
 
class  PreconditionNotMetError
 A PreconditionNotMetError is thrown when a pre-condition for the operation was not met. More...
 
class  TimeoutError
 Indicates that an operation has timed out. More...
 
class  UnsupportedError
 Indicates that the application used an unsupported operation. More...
 
class  InvalidDowncastError
 Indicates that a dds::core::Entity downcast was incorrect. More...
 
class  external
 A managed reference to an object. More...
 
class  safe_enum
 <<value-type>> Provides a safe, scoped enumeration based on def::type More...
 
class  basic_string
 <<value-type>> A string convertible to std::string and with similar functionality More...
 
class  BytesTopicType
 Built-in type consisting of a variable-length array of opaque bytes. More...
 
class  StringTopicType
 Built-in type consisting of a single character string. More...
 
class  KeyedStringTopicType
 Built-in type consisting of a string payload and a second string that is the key. More...
 
class  KeyedBytesTopicType
 Built-in type consisting of a variable-length array of opaque bytes and a string that is the key. More...
 
class  Entity
 <<reference-type>> This is the abstract base class for all the DDS objects that support QoS policies, a listener and a status condition. More...
 
class  TEntityQos
 Acts as a container for Qos policies allowing to set and retrieve all the policies of an entity as a unit. More...
 
class  Time
 <<extension>> Represents a point in time More...
 
class  InstanceHandle
 <<value-type>> Handle to identiy different instances of the same dds::topic::Topic of a certain type. More...
 
class  QosProvider
 <<reference-type>> The QosProvider class provides a way for a user to control and access the XML QoS profiles that are loaded by RTI Connext More...
 
class  Value
 
class  WeakReference
 
class  optional
 <<value-type>> Represents an object that may not contain a valid value More...
 
class  vector
 <<value-type>> A vector convertible to std::vector and with similar functionality More...
 

Typedefs

typedef boost_or_std_array array
 Represents an IDL array.
 
typedef std::vector
< InstanceHandle
InstanceHandleSeq
 A sequence of dds::core::InstanceHandle.
 
typedef basic_string< char,
rti::core::memory::OsapiAllocator
< char > > 
string
 A string convertible to std::string and with similar functionality.
 
typedef basic_string
< DDS_Wchar,
rti::core::memory::OsapiAllocator
< DDS_Wchar > > 
wstring
 An IDL-derived wide string.
 
typedef std::vector< uint8_t > ByteSeq
 A vector of bytes.
 
typedef std::vector< std::string > StringSeq
 A vector of strings.
 
typedef std::nullptr_t null_type
 <<C++11>> The type of dds::core::null
 
typedef ::std::true_type true_type
 True type used by trait types.
 
typedef ::std::false_type false_type
 False type used by trait types.
 

Functions

template<typename TO , typename FROM >
TO polymorphic_cast (FROM &from)
 Downcasts an Entity to a subclass.
 
Duration operator* (uint32_t lhs, const Duration &rhs)
 Multiply a Duration object by an unsigned integer.
 
Duration operator* (const Duration &lhs, uint32_t rhs)
 Multiply a Duration object by an unsigned integer.
 
Duration operator/ (const Duration &lhs, uint32_t rhs)
 Divide a Duration object by an unsigned integer.
 
void swap (Duration &lhs, Duration &rhs) OMG_NOEXCEPT
 Swap the contents of two Duration objects.
 
template<typename def , typename inner >
std::ostream & operator<< (std::ostream &out, const safe_enum< def, inner > &the_enum)
 Applies operator<< to the underlying enum.
 
template<typename CharType , typename Allocator >
std::ostream & operator<< (std::ostream &out, const basic_string< CharType, Allocator > &the_string)
 Prints the string.
 
Time operator+ (const Time &time, const Duration &duration)
 Add a Time and a Duration together.
 
Time operator+ (const Duration &duration, const Time &time)
 Add a Time and a Duration together.
 
Time operator- (const Time &time, const Duration &duration)
 Subtract a Duration from a Time.
 
Duration operator- (const Time &time1, const Time &time2)
 Calculate the duration between two times.
 
template<typename T >
bool operator== (const optional< T > &a, const optional< T > &b)
 Compares two optional values.
 
template<typename T >
bool operator!= (const optional< T > &a, const optional< T > &b)
 Compares two optional values.
 
template<typename T >
bool operator== (const optional< T > &optional_value, const T &value)
 Compares an optional member and a value of the underlying type.
 
template<typename T >
bool operator== (const T &value, const optional< T > &optional_value)
 Compares an optional member and a value of the underlying type.
 
template<typename T >
bool operator!= (const optional< T > &optional_value, const T &value)
 Compares an optional member and a value of the underlying type.
 
template<typename T >
bool operator!= (const T &value, const optional< T > &optional_value)
 Compares an optional member and a value of the underlying type.
 
template<typename T >
std::ostream & operator<< (std::ostream &out, const optional< T > &optional)
 Applies the operator<< to optional.get() or the string "NULL" if !optional.is_set()
 
template<typename T >
std::ostream & operator<< (std::ostream &out, const vector< T > &v)
 Print a vector applying << to all of its elements.
 

Variables

const int32_t LENGTH_UNLIMITED = -1
 A special value indicating an unlimited quantity.
 
const null_type null
 Indicates an empty reference.
 

Detailed Description

The core namespace contains infrastructure types and functions.

Typedef Documentation

Function Documentation

template<typename TO , typename FROM >
TO polymorphic_cast ( FROM &  from)

Downcasts an Entity to a subclass.

Template Parameters
TOThe type to cast to
FROMThe type to cast from
Parameters
fromThe object to cast to type TO
Returns
A reference to the same object from, but cast to the type TO. Both objects share ownership of the underlying entity.

For example:

using namespace dds::core;
using namespace dds::domain;
DomainParticipant participant(0);
Entity entity = participant; // Assignment to base
assert (participant == participant2); // Same reference
See Also
Reference types
Duration operator* ( uint32_t  lhs,
const Duration &  rhs 
)

Multiply a Duration object by an unsigned integer.

Parameters
lhsThe unsigned integer to multiply the Duration object by
rhsThe Duration object to multiply
Returns
Duration The result of the multiplication
Duration operator* ( const Duration &  lhs,
uint32_t  rhs 
)

Multiply a Duration object by an unsigned integer.

Parameters
lhsThe Duration object to multiply
rhsThe unsigned integer to multiply the Duration object by
Returns
Duration The result of the multiplication
Duration operator/ ( const Duration &  lhs,
uint32_t  rhs 
)

Divide a Duration object by an unsigned integer.

Parameters
lhsThe dividend
rhsThe divisor
Returns
Duration The result of dividing the two Duration objects
void swap ( Duration &  lhs,
Duration &  rhs 
)

Swap the contents of two Duration objects.

Parameters
lhsOne of the Duration objects
rhsOne of the Duration objects
template<typename def , typename inner >
std::ostream & operator<< ( std::ostream &  out,
const safe_enum< def, inner > &  the_enum 
)

Applies operator<< to the underlying enum.

template<typename CharType , typename Allocator >
std::ostream & operator<< ( std::ostream &  out,
const basic_string< CharType, Allocator > &  the_string 
)

Prints the string.

Time operator+ ( const Time &  time,
const Duration &  duration 
)

Add a Time and a Duration together.

Parameters
timeThe Time object to add
durationThe Duration object to add
Returns
Time The result of the addition represented as a Time object
Time operator+ ( const Duration &  duration,
const Time &  time 
)

Add a Time and a Duration together.

Parameters
durationThe Duration object to add
timeThe Time object to add
Returns
Time The result of the addition represented as a Time object
Time operator- ( const Time &  time,
const Duration &  duration 
)

Subtract a Duration from a Time.

Parameters
timeThe Time object to subtract from
durationThe Duration object to subtract
Returns
Time The result of the subtraction represented as a Time object
Duration operator- ( const Time &  time1,
const Time &  time2 
)

Calculate the duration between two times.

Parameters
time1The first ("before") time
time2The second ("after") time
Returns
The duration elapsed between time1 and time2. If time1 > time2 the duration is zero. If time1 is Time::maximum(), the duration is Duration::infinite();
template<typename T >
bool operator== ( const optional< T > &  a,
const optional< T > &  b 
)

Compares two optional values.

Returns
true if both are unset or both are set and a.get() == b.get().
template<typename T >
bool operator!= ( const optional< T > &  a,
const optional< T > &  b 
)

Compares two optional values.

Returns
false if both are unset or both are set and a.get() == b.get().
template<typename T >
bool operator== ( const optional< T > &  optional_value,
const T &  value 
)

Compares an optional member and a value of the underlying type.

Returns
Return true if optional_value is set and optional_value.get() == value
template<typename T >
bool operator== ( const T &  value,
const optional< T > &  optional_value 
)

Compares an optional member and a value of the underlying type.

Returns
Return true if optional_value is set and optional_value.get() == value
template<typename T >
bool operator!= ( const optional< T > &  optional_value,
const T &  value 
)

Compares an optional member and a value of the underlying type.

Returns
Return false if optional_value is set and optional_value.get() == value
template<typename T >
bool operator!= ( const T &  value,
const optional< T > &  optional_value 
)

Compares an optional member and a value of the underlying type.

Returns
Return false if optional_value is set and optional_value.get() == value
template<typename T >
std::ostream & operator<< ( std::ostream &  out,
const optional< T > &  optional 
)

Applies the operator<< to optional.get() or the string "NULL" if !optional.is_set()

template<typename T >
std::ostream & operator<< ( std::ostream &  out,
const vector< T > &  v 
)

Print a vector applying << to all of its elements.


RTI Connext Modern C++ API Version 5.3.0 Copyright © Sun Jun 25 2017 Real-Time Innovations, Inc