dds::core Namespace Reference

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

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

Classes
class	AlreadyClosedError
	Indicates that an object has been closed. 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	Duration
	<<value-type>> Represents a time interval 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	Error
	A generic, unspecified Error. More...
class	Exception
	The abstract base class for all of the DDS exceptions which may be thrown by the API. More...
class	external
	A managed reference to an object. More...
class	IllegalOperationError
	Indicates that an operation was called under improper circumstances. 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	InstanceHandle
	<<value-type>> Handle to identify different instances of the same dds::topic::Topic of a certain type. More...
class	InvalidArgumentError
	Indicates that the application passed an illegal parameter value into an operation. More...
class	InvalidDowncastError
	Indicates that a downcast was incorrect. More...
class	KeyedBytesTopicType
	Built-in type consisting of a variable-length array of opaque bytes and a string that is the key. More...
class	KeyedStringTopicType
	Built-in type consisting of a string payload and a second string that is the key. More...
class	NotAllowedBySecurityError
	Indicates that an operation on the DDS API fails because the security plugins do not allow it. More...
class	NotEnabledError
	A NotEnabledError is thrown when an operation is invoked on a dds::core::Entity that is not yet enabled. More...
class	NullReferenceError
	Indicates an attempt to access a null object. More...
class	optional
	<<value-type>> Represents an object that may not contain a valid value 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	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	Reference
	Base class for all reference types. More...
class	safe_enum
	<<value-type>> Provides a safe, scoped enumeration based on def::type More...
class	StringTopicType
	Built-in type consisting of a single character string. 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	TimeoutError
	Indicates that an operation has timed out. More...
class	UnsupportedError
	Indicates that the application used an unsupported operation. More...
class	Value
class	vector
	<<value-type>> A vector convertible to std::vector and with similar functionality More...
class	WeakReference

Typedefs
typedef std::vector< InstanceHandle >	InstanceHandleSeq
	A sequence of dds::core::InstanceHandle. More...
typedef basic_string< char, rti::core::memory::OsapiAllocator< char > >	string
	A string convertible to std::string and with similar functionality. More...
typedef basic_string< DDS_Wchar, rti::core::memory::OsapiAllocator< DDS_Wchar > >	wstring
	An IDL-derived wide string. More...
typedef std::vector< uint8_t >	ByteSeq
	A vector of bytes. More...
typedef std::vector< std::string >	StringSeq
	A vector of strings. More...
typedef std::nullptr_t	null_type
	<<C++11>> The type of dds::core::null More...

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

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

Detailed Description

The core namespace contains infrastructure types and functions.

Typedef Documentation

InstanceHandleSeq

typedef std::vector<InstanceHandle> dds::core::InstanceHandleSeq

A sequence of dds::core::InstanceHandle.

Function Documentation

polymorphic_cast()

template<typename TO , typename FROM >

TO polymorphic_cast

(

const FROM &

from

)

Downcasts an Entity to a subclass.

Note

• Header: <dds/core/ref_traits.hpp>
• Namespace: dds::core

Template Parameters

TO	The type to cast to
FROM	The type to cast from

Parameters

from	The 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
DomainParticipant participant2 = polymorphic_cast<DomainParticipant>(entity);
assert (participant == participant2); // Same reference

See also

Reference types

operator*() [1/2]

Duration operator*	(	uint32_t	lhs,
		const Duration &	rhs
	)

Multiply a Duration object by an unsigned integer.

Parameters

lhs	The unsigned integer to multiply the Duration object by
rhs	The Duration object to multiply

Returns

Duration The result of the multiplication

operator*() [2/2]

Duration operator*	(	const Duration &	lhs,
		uint32_t	rhs
	)

Multiply a Duration object by an unsigned integer.

Parameters

lhs	The Duration object to multiply
rhs	The unsigned integer to multiply the Duration object by

Returns

Duration The result of the multiplication

operator/()

Duration operator/	(	const Duration &	lhs,
		uint32_t	rhs
	)

Divide a Duration object by an unsigned integer.

Parameters

lhs	The dividend
rhs	The divisor

Returns

Duration The result of dividing the two Duration objects

swap()

void swap	(	Duration &	lhs,
		Duration &	rhs
	)

Swap the contents of two Duration objects.

Parameters

lhs	One of the Duration objects
rhs	One of the Duration objects

operator<<() [1/4]

template<typename def , typename inner >

std::ostream & operator<<	(	std::ostream &	out,
		const safe_enum< def, inner > &	the_enum
	)

Applies operator<< to the underlying enum.

operator<<() [2/4]

template<typename CharType , typename Allocator >

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

Prints the string.

operator+() [1/2]

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

Add a Time and a Duration together.

Parameters

time	The Time object to add
duration	The Duration object to add

Returns

Time The result of the addition represented as a Time object

operator+() [2/2]

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

Add a Time and a Duration together.

Parameters

duration	The Duration object to add
time	The Time object to add

Returns

Time The result of the addition represented as a Time object

operator-() [1/2]

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

Subtract a Duration from a Time.

Parameters

time	The Time object to subtract from
duration	The Duration object to subtract

Returns

Time The result of the subtraction represented as a Time object

operator-() [2/2]

Duration operator-	(	const Time &	time1,
		const Time &	time2
	)

Calculate the duration between two times.

Parameters

time1	The first ("before") time
time2	The second ("after") time

Exceptions

std::overflow_error

if duration exceeds the infinite limit

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();

operator==() [1/3]

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 == *b.

operator!=() [1/3]

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 == *b.

operator==() [2/3]

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 == value

operator==() [3/3]

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 == value

operator!=() [2/3]

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 == value

operator!=() [3/3]

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 == value

operator<<() [3/4]

template<typename T >

std::ostream & operator<<	(	std::ostream &	out,
		const optional< T > &	optional
	)

Applies operator<< to *optional or to the string "NULL" if !optional.has_value().

operator<<() [4/4]

template<typename T >

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

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