- Generated by
1.8.16
|
Cyclone ISO C++ API Reference Guide
|
Base class for reference-counted objects. More...
#include "Reference.hpp"
Inherited by dds::core::cond::Condition [virtual], dds::core::cond::WaitSet, dds::core::Entity [virtual], dds::core::QosProvider, dds::sub::Query [virtual], and dds::topic::TopicDescription [virtual].
Public Member Functions | |
| Reference (const Reference &ref) | |
| template<typename D > | |
| Reference (const Reference< D > &ref) | |
| Reference (dds::core::null_type &) | |
| ~Reference () | |
| bool | is_nil () const |
| bool | operator!= (const null_type nil) const |
| template<typename R > | |
| bool | operator!= (const R &ref) const |
| DELEGATE * | operator-> () |
| const DELEGATE * | operator-> () const |
| Reference & | operator= (const null_type) |
| template<typename R > | |
| Reference & | operator= (const R &rhs) |
| template<typename D > | |
| Reference & | operator= (const Reference< D > &that) |
| bool | operator== (const null_type) const |
| template<typename R > | |
| bool | operator== (const R &ref) const |
Base class for reference-counted objects.
All objects that have a reference-type have an associated shallow (polymorphic) assignment operator that simply changes the value of the reference. Furthermore, reference-types are safe, meaning that under no circumstances can a reference point to an invalid object. At any single point in time a reference can either refer to the null object or to a valid object.
The semantics for Reference types is defined by the DDS-PSM-Cxx class dds::core::Reference. In the context of this specification the semantics implied by the ReferenceType is mandatory, yet the implementation supplied as part of this standard is provided to show one possible way of implementing this semantics.
List of reference types:
Instances of reference types are created using C++ constructors. The trivial constructor is not defined for reference types; the only alternative to properly constructing a reference is to initialize it to a null reference by assigning dds::core::null.
Resource management for some reference types might involve relatively heavyweight operating-system resources (such as threads, mutexes, and network sockets) in addition to memory. These objects therefore provide a function close() that shall halt network communication (in the case of entities) and dispose of any appropriate operating-system resources.
Users of this PSM are recommended to call close on objects of all reference types once they are finished using them. In addition, implementations may automatically close objects that they deem to be no longer in use, subject to the following restrictions:
Definition at line 94 of file Reference.hpp.
|
explicit |
Creates a "null" Reference.
| null |
|
explicit |
Creates a Reference from another.
| ref | the other reference |
|
explicit |
| dds::core::Reference< DELEGATE >::~Reference | ( | ) |
| bool dds::core::Reference< DELEGATE >::is_nil | ( | ) | const |
Check if the referenced object is nil.
In other words, check if the reference is pointing to a null object.
| bool dds::core::Reference< DELEGATE >::operator!= | ( | const null_type | nil | ) | const |
Special operator!= used to check if this reference object does not equal the dds::core::null reference.
The non-null-check can be done like this:
| bool dds::core::Reference< DELEGATE >::operator!= | ( | const R & | ref | ) | const |
| DELEGATE* dds::core::Reference< DELEGATE >::operator-> | ( | ) |
The operator->() is provided to be able to directly invoke functions on the delegate.
The decision to provide direct access to the delegate was motivated by the need for providing a way that was not invasive with respect to the CXXDDS API and yet would allow for vendor-specific extension. Thus vendor-specific extensions can be invoked on the Reference and on all its subclasses as follows:
| const DELEGATE* dds::core::Reference< DELEGATE >::operator-> | ( | ) | const |
The operator->() is provided to be able to directly invoke functions on the delegate.
The decision to provide direct access to the delegate was motivated by the need for providing a way that was not invasive with respect to the CXXDDS API and yet would allow for vendor-specific extension. Thus vendor-specific extensions can be invoked on the Reference and on all its subclasses as follows:
| Reference& dds::core::Reference< DELEGATE >::operator= | ( | const | null_type | ) |
Special assignment operators that takes care of assigning dds::core::null to this reference.
When assigning null, there might be an associated garbage collection activity.
| Reference& dds::core::Reference< DELEGATE >::operator= | ( | const R & | rhs | ) |
Assign new referenced object to this dds reference.
There might be an associated garbage collection activity when the current reference is not empty.
| Reference& dds::core::Reference< DELEGATE >::operator= | ( | const Reference< D > & | that | ) |
Assign new referenced object to this dds reference.
There might be an associated garbage collection activity when the current reference is not empty.
| bool dds::core::Reference< DELEGATE >::operator== | ( | const | null_type | ) | const |
Special operator== used to check if this reference object equals the dds::core::null reference.
The null-check can be done like this:
| bool dds::core::Reference< DELEGATE >::operator== | ( | const R & | ref | ) | const |
1.8.16