DCPS_IR_Topic_Description Class Reference

Representative of a Topic Description. More...

#include <DCPS_IR_Topic_Description.h>

Collaboration diagram for DCPS_IR_Topic_Description:

[legend]List of all members.

Public Member Functions
	DCPS_IR_Topic_Description (DCPS_IR_Domain *domain, const char *name, const char *dataTypeName)
	~DCPS_IR_Topic_Description (void)
int	add_subscription_reference (DCPS_IR_Subscription *subscription, bool associate=true)
int	remove_subscription_reference (DCPS_IR_Subscription *subscription)
int	add_topic (DCPS_IR_Topic *topic)
int	remove_topic (DCPS_IR_Topic *topic)
DCPS_IR_Topic *	get_first_topic ()
	Gets the first topic in the topic list.
void	try_associate_publication (DCPS_IR_Publication *publication)
void	try_associate_subscription (DCPS_IR_Subscription *subscription)
void	try_associate (DCPS_IR_Publication *publication, DCPS_IR_Subscription *subscription)
void	associate (DCPS_IR_Publication *publication, DCPS_IR_Subscription *subscription)
	Associate the publication and subscription.
void	reevaluate_associations (DCPS_IR_Publication *publication)
void	reevaluate_associations (DCPS_IR_Subscription *subscription)
const char *	get_name () const
const char *	get_dataTypeName () const
CORBA::ULong	get_number_topics () const
	Returns the number of topics.
Private Attributes
ACE_SString	name_
ACE_SString	dataTypeName_
DCPS_IR_Domain *	domain_
DCPS_IR_Subscription_Set	subscriptionRefs_
DCPS_IR_Topic_Set	topics_

---

Detailed Description

Representative of a Topic Description.

---

Constructor & Destructor Documentation

DCPS_IR_Topic_Description::DCPS_IR_Topic_Description	(	DCPS_IR_Domain *	domain,
		const char *	name,
		const char *	dataTypeName
	)

DCPS_IR_Topic_Description::~DCPS_IR_Topic_Description

(

void

)

---

Member Function Documentation

int DCPS_IR_Topic_Description::add_subscription_reference	(	DCPS_IR_Subscription *	subscription,
		bool	associate = true
	)

Adds the subscription to the list of subscriptions Tries to associate with existing publications if successfully added 'associate' switch toggles association attempt. Returns 0 if added, 1 if already exists, -1 other failure

int DCPS_IR_Topic_Description::add_topic

(

DCPS_IR_Topic *

topic

)

Add a topic Takes ownership of memory pointed to by topic Returns 0 if added, 1 if already exists, -1 other failure

void DCPS_IR_Topic_Description::associate	(	DCPS_IR_Publication *	publication,
		DCPS_IR_Subscription *	subscription
	)

Associate the publication and subscription.

const char * DCPS_IR_Topic_Description::get_dataTypeName

(

)

const

DCPS_IR_Topic * DCPS_IR_Topic_Description::get_first_topic

(

)

Gets the first topic in the topic list.

const char * DCPS_IR_Topic_Description::get_name

(

)

const

CORBA::ULong DCPS_IR_Topic_Description::get_number_topics

(

)

const

Returns the number of topics.

void DCPS_IR_Topic_Description::reevaluate_associations

(

DCPS_IR_Subscription *

subscription

)

Re-evaluate the association between the provided subscription and the publications in all its maintained topics.

void DCPS_IR_Topic_Description::reevaluate_associations

(

DCPS_IR_Publication *

publication

)

Re-evaluate the association between the provided publication and the subscriptions it maintains.

int DCPS_IR_Topic_Description::remove_subscription_reference

(

DCPS_IR_Subscription *

subscription

)

Removes the subscription from the list of subscriptions Returns 0 if successful

int DCPS_IR_Topic_Description::remove_topic

(

DCPS_IR_Topic *

topic

)

Removes the topic from the list of topics Gives ownership of the memory pointed to by topic to the caller Returns 0 if successful

void DCPS_IR_Topic_Description::try_associate	(	DCPS_IR_Publication *	publication,
		DCPS_IR_Subscription *	subscription
	)

Checks to see if the publication and subscription can be associated.

void DCPS_IR_Topic_Description::try_associate_publication

(

DCPS_IR_Publication *

publication

)

Tries to associate the publication will each of the subscriptions in the subscription list

void DCPS_IR_Topic_Description::try_associate_subscription

(

DCPS_IR_Subscription *

subscription

)

Tries to associate the subscription will each of the publications in each topic in the topic list

---

Member Data Documentation

ACE_SString DCPS_IR_Topic_Description::dataTypeName_ [private]

DCPS_IR_Domain* DCPS_IR_Topic_Description::domain_ [private]

ACE_SString DCPS_IR_Topic_Description::name_ [private]

DCPS_IR_Subscription_Set DCPS_IR_Topic_Description::subscriptionRefs_ [private]

DCPS_IR_Topic_Set DCPS_IR_Topic_Description::topics_ [private]

---

The documentation for this class was generated from the following files:

• DCPS_IR_Topic_Description.h
• DCPS_IR_Topic_Description.cpp

---