Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

nc::SimpleSupplier Class Reference

#include <acsncSimpleSupplier.h>

Inheritance diagram for nc::SimpleSupplier:

Inheritance graph
[legend]
Collaboration diagram for nc::SimpleSupplier:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 SimpleSupplier (const char *channelName, acscomponent::ACSComponentImpl *component)
template<class T> void publishData (T data)

Protected Member Functions

virtual ~SimpleSupplier ()

Protected Attributes

CORBA::Any any_m

Private Member Functions

void operator= (const SimpleSupplier &)

Detailed Description

SimpleSupplier is used to publish data onto a notification channel defined by the string passed to SimpleSupplier's constructor. To publish data onto the channel, simply invoke the publishData method on the templated type. This particular class blocks until the event is received on manager's host and supports just about any number of event types for the channel it is connected to.

TODO:


Constructor & Destructor Documentation

nc::SimpleSupplier::SimpleSupplier const char *  channelName,
acscomponent::ACSComponentImpl component
 

Constructor. All the work is done in the superclass's constructor.

Parameters:
channlName The name of the channel events will be published to.
component A reference to a component is needed for the Event Description (which is normally hidden from Consumers).

virtual nc::SimpleSupplier::~SimpleSupplier  )  [protected, virtual]
 

Destructor is protected.


Member Function Documentation

void nc::SimpleSupplier::operator= const SimpleSupplier  )  [private]
 

ALMA C++ coding standards state copy operators should be disabled.

template<class T>
void nc::SimpleSupplier::publishData data  ) 
 

publishData is the templated method that actually sends the event to the channel. The templated parameter is the ICD event (i.e., IDL struct) to be sent. Really this is the only Supplier method developers should be invoking from their code.

Parameters:
data The templated data structure to be published.
Exceptions:
ACSErrTypeCommon::CORBAProblemEx 


Member Data Documentation

CORBA::Any nc::SimpleSupplier::any_m [protected]
 

CORBA Any taken out of the publishData method for a small performance increase.


The documentation for this class was generated from the following file:
Generated on Thu Apr 30 02:37:35 2009 for ACS C++ API by doxygen 1.3.8