DDS-PSM-C++  1.0
ISO C++ API for OpenSplice DDS
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
Public Types | Public Member Functions | List of all members
dds::topic::Topic< T, DELEGATE > Class Template Reference

#include <TTopic.hpp>

Inheritance diagram for dds::topic::Topic< T, DELEGATE >:
Inheritance graph
[legend]

Public Types

typedef TopicListener< T > Listener
 
- Public Types inherited from dds::topic::TopicDescription< T, DELEGATE >
typedef T DataType
 

Public Member Functions

 Topic (const dds::domain::DomainParticipant &dp, const std::string &topic_name)
 
 Topic (const dds::domain::DomainParticipant &dp, const std::string &topic_name, const std::string &type_name)
 
 Topic (const dds::domain::DomainParticipant &dp, const std::string &topic_name, const dds::topic::qos::TopicQos &qos, dds::topic::TopicListener< T > *listener=NULL, const dds::core::status::StatusMask &mask=dds::core::status::StatusMask::all())
 
 Topic (const dds::domain::DomainParticipant &dp, const std::string &topic_name, const std::string &type_name, const dds::topic::qos::TopicQos &qos, dds::topic::TopicListener< T > *listener=NULL, const dds::core::status::StatusMask &mask=dds::core::status::StatusMask::all())
 
 ~Topic ()
 
const
::dds::core::status::InconsistentTopicStatus & 		inconsistent_topic_status () const
 
void listener (Listener *the_listener, const ::dds::core::status::StatusMask &event_mask)
 
Listener * listener () const
 
const dds::topic::qos::TopicQos & qos () const
 
void qos (const dds::topic::qos::TopicQos &the_qos)
 
- Public Member Functions inherited from dds::topic::TopicDescription< T, DELEGATE >
virtual ~TopicDescription ()
 
const
dds::domain::DomainParticipant & 		domain_participant () const
 
const std::string & name () const
 
const std::string & type_name () const
 
- Public Member Functions inherited from dds::core::TEntity< DELEGATE< T > >
 ~TEntity ()
 
void close ()
 
void enable ()
 
const dds::core::InstanceHandle instance_handle () const
 
void retain ()
 
const dds::core::status::StatusMask status_changes ()
 
- Public Member Functions inherited from dds::core::Reference< DELEGATE< T > >
 Reference (dds::core::null_type &)
 
 Reference (const Reference &ref)
 
 Reference (const Reference< D > &ref)
 
 Reference (DELEGATE_T *p)
 
 ~Reference ()
 
const DELEGATE_REF_T & delegate () const
 
DELEGATE_REF_T & delegate ()
 
bool is_nil () const
 
 operator const DELEGATE_REF_T & () const
 
 operator DELEGATE_REF_T () const
 
 operator DELEGATE_REF_T & ()
 
bool operator!= (const R &ref) const
 
bool operator!= (const null_type nil) const
 
DELEGATE< T > * operator-> ()
 
const DELEGATE< T > * operator-> () const
 
Reference & operator= (const Reference< D > &that)
 
Reference & operator= (const R &rhs)
 
Reference & operator= (const null_type)
 
bool operator== (const R &ref) const
 
bool operator== (const null_type) const
 

Additional Inherited Members

- Protected Member Functions inherited from dds::topic::TopicDescription< T, DELEGATE >
 TopicDescription (const dds::domain::DomainParticipant &dp, const std::string &name, const std::string &type_name=dds::topic::topic_type_name< T >::value())
 
- Protected Attributes inherited from dds::core::Reference< DELEGATE< T > >
DELEGATE_REF_T impl_
 

Detailed Description

template<typename T, template< typename Q > class DELEGATE>
class dds::topic::Topic< T, DELEGATE >

Topic is the most basic description of the data to be published and subscribed.

A Topic is identified by its name, which must be unique in the whole Domain. In addition (by virtue of extending TopicDescription) it fully specifies the type of the data that can be communicated when publishing or subscribing to the Topic. Topic is the only TopicDescription that can be used for publications and therefore associated to a DataWriter.

Definition at line 50 of file TTopic.hpp.

Member Typedef Documentation

template<typename T, template< typename Q > class DELEGATE>
typedef TopicListener<T> dds::topic::Topic< T, DELEGATE >::Listener

Definition at line 52 of file TTopic.hpp.

Constructor & Destructor Documentation

template<typename T, template< typename Q > class DELEGATE>
dds::topic::Topic< T, DELEGATE >::~Topic ( )
inline

Definition at line 57 of file TTopic.hpp.

template<typename T, template< typename Q > class DELEGATE>
dds::topic::Topic< T, DELEGATE >::Topic ( const dds::domain::DomainParticipant &  dp,
const std::string &  topic_name 
)

Create a new topic.

Parameters
dpthe domain participant on which the topic will be defined.
topic_namethe topic's name. The QoS will be set to dp.default_topic_qos().
template<typename T, template< typename Q > class DELEGATE>
dds::topic::Topic< T, DELEGATE >::Topic ( const dds::domain::DomainParticipant &  dp,
const std::string &  topic_name,
const std::string &  type_name 
)

Create a new topic.The QoS will be set to dp.default_topic_qos().

Parameters
dpthe domain participant on which the topic will be defined.
topic_namethe topic's name.
type_namethe name associated with the topic type.
template<typename T, template< typename Q > class DELEGATE>
dds::topic::Topic< T, DELEGATE >::Topic ( const dds::domain::DomainParticipant &  dp,
const std::string &  topic_name,
const dds::topic::qos::TopicQos &  qos,
dds::topic::TopicListener< T > *  listener = NULL,
const dds::core::status::StatusMask &  mask = dds::core::status::StatusMask::all() 
)

Create a new topic.

Parameters
dpthe domain participant on which the topic will be defined.
topic_namethe topic's name.
qosthe topic listener.
listenerthe topic listener.
maskthe listener event mask.
template<typename T, template< typename Q > class DELEGATE>
dds::topic::Topic< T, DELEGATE >::Topic ( const dds::domain::DomainParticipant &  dp,
const std::string &  topic_name,
const std::string &  type_name,
const dds::topic::qos::TopicQos &  qos,
dds::topic::TopicListener< T > *  listener = NULL,
const dds::core::status::StatusMask &  mask = dds::core::status::StatusMask::all() 
)

Create a new topic.

Parameters
dpthe domain participant on which the topic will be defined.
topic_namethe topic's name.
type_namethe name associated with the topic type.
qosthe topic listener.
listenerthe topic listener.
maskthe listener event mask.

Member Function Documentation

template<typename T, template< typename Q > class DELEGATE>
const ::dds::core::status::InconsistentTopicStatus& dds::topic::Topic< T, DELEGATE >::inconsistent_topic_status ( ) const

This method allows the application to retrieve the INCONSISTENT_TOPIC status of the Topic. Each DomainEntity has a set of relevant communication statuses. A change of status causes the corresponding Listener to be invoked and can also be monitored by means of the associated StatusCondition. The complete list of communication status, their values, and the DomainEntities they apply to is provided in Section 7.1.4.1, Communication Status, on page 120.

template<typename T, template< typename Q > class DELEGATE>
void dds::topic::Topic< T, DELEGATE >::listener ( Listener *  the_listener,
const ::dds::core::status::StatusMask &  event_mask 
)

Set the Topic listener.

template<typename T, template< typename Q > class DELEGATE>
Listener* dds::topic::Topic< T, DELEGATE >::listener ( ) const

Get the Topic listener.

template<typename T, template< typename Q > class DELEGATE>
const dds::topic::qos::TopicQos& dds::topic::Topic< T, DELEGATE >::qos ( ) const

Get the Topic QoS.

template<typename T, template< typename Q > class DELEGATE>
void dds::topic::Topic< T, DELEGATE >::qos ( const dds::topic::qos::TopicQos &  the_qos)

Set the Topic QoS.

The documentation for this class was generated from the following file:
Generated on Sat Nov 3 2012 00:02:22 for DDS-PSM-C++ by   doxygen 1.8.2