TAO_EC_Conjunction_Filter Class Reference

The conjunction filter. More...

#include <EC_Conjunction_Filter.h>

Inheritance diagram for TAO_EC_Conjunction_Filter:

Inheritance graph
[legend]
Collaboration diagram for TAO_EC_Conjunction_Filter:

Collaboration graph
[legend]
List of all members.

Public Types

typedef unsigned int Word

Public Member Functions

 TAO_EC_Conjunction_Filter (TAO_EC_Filter *children[], size_t n)
virtual ~TAO_EC_Conjunction_Filter (void)
 Destructor.
virtual ChildrenIterator begin (void) const
virtual ChildrenIterator end (void) const
virtual int size (void) const
virtual int filter (const RtecEventComm::EventSet &event, TAO_EC_QOS_Info &qos_info ACE_ENV_ARG_DECL)
virtual int filter_nocopy (RtecEventComm::EventSet &event, TAO_EC_QOS_Info &qos_info ACE_ENV_ARG_DECL)
virtual void push (const RtecEventComm::EventSet &event, TAO_EC_QOS_Info &qos_info ACE_ENV_ARG_DECL)
virtual void push_nocopy (RtecEventComm::EventSet &event, TAO_EC_QOS_Info &qos_info ACE_ENV_ARG_DECL)
virtual void clear (void)
virtual CORBA::ULong max_event_size (void) const
 Returns the maximum size of the events pushed by this filter.
virtual int can_match (const RtecEventComm::EventHeader &header) const
virtual int add_dependencies (const RtecEventComm::EventHeader &header, const TAO_EC_QOS_Info &qos_info ACE_ENV_ARG_DECL)

Private Member Functions

int all_received (void) const
 Determine if all the children have received their events.
 ACE_UNIMPLEMENTED_FUNC (TAO_EC_Conjunction_Filter(const TAO_EC_Conjunction_Filter &)) ACE_UNIMPLEMENTED_FUNC(TAO_EC_Conjunction_Filter &operator

Private Attributes

size_t n_
 The number of children.
RtecEventComm::EventSet event_
 The event we send up (once all the children have pushed theirs).
size_t nwords_
Wordbitvec_
ChildrenIterator current_child_
 The current child in the iteration, used in the push() method...

Detailed Description

The conjunction filter.

This filter waits until each one of its children has accepted at least one event. Only in that case it accepts and publishes the sequence formed by all the children events.

Memory Management

It assumes ownership of the children.


Member Typedef Documentation

typedef unsigned int TAO_EC_Conjunction_Filter::Word
 


Constructor & Destructor Documentation

TAO_EC_Conjunction_Filter::TAO_EC_Conjunction_Filter TAO_EC_Filter children[],
size_t  n
 

Constructor. It assumes ownership of both the array and the children.

TAO_EC_Conjunction_Filter::~TAO_EC_Conjunction_Filter void   )  [virtual]
 

Destructor.


Member Function Documentation

TAO_EC_Conjunction_Filter::ACE_UNIMPLEMENTED_FUNC TAO_EC_Conjunction_Filter(const TAO_EC_Conjunction_Filter &)   )  [private]
 

virtual int TAO_EC_Conjunction_Filter::add_dependencies const RtecEventComm::EventHeader header,
const TAO_EC_QOS_Info &qos_info  ACE_ENV_ARG_DECL
[virtual]
 

This is used for computing the scheduling dependencies:

Leaf filters check if the header could be matched, similar to the can_match() method; if it does they return 1, and 0 otherwise. Intermediate nodes always return 0.

This is used to build precise dependencies between the suppliers and the leaf of the filters that accept that event. Notice that only the nodes doing scheduling recurse through the list, so in configurations that do no require scheduling the recursion stops fairly soon.

Implements TAO_EC_Filter.

int TAO_EC_Conjunction_Filter::all_received void   )  const [private]
 

Determine if all the children have received their events.

TAO_EC_Filter::ChildrenIterator TAO_EC_Conjunction_Filter::begin void   )  const [virtual]
 

STL-like iterators Filters follow the Composite pattern. All filters expose the same interface as if they all had children, but for simple filters the iterators return an empty range.

Reimplemented from TAO_EC_Filter.

int TAO_EC_Conjunction_Filter::can_match const RtecEventComm::EventHeader header  )  const [virtual]
 

Returns 0 if an event with that header could never be accepted. This can used by the suppliers to filter out consumers that couldn't possibly be interested in their events. The rt_info and

Implements TAO_EC_Filter.

void TAO_EC_Conjunction_Filter::clear void   )  [virtual]
 

Clear any saved state, must reset and assume no events have been received.

Implements TAO_EC_Filter.

TAO_EC_Filter::ChildrenIterator TAO_EC_Conjunction_Filter::end void   )  const [virtual]
 

Reimplemented from TAO_EC_Filter.

int TAO_EC_Conjunction_Filter::filter const RtecEventComm::EventSet event,
TAO_EC_QOS_Info &qos_info  ACE_ENV_ARG_DECL
[virtual]
 

Filter this event, returns 1 if the event is accepted, 0 otherwise. Notice that there are two versions of the method, if the event is not const then filter can take ownership of the event.

Attention:
There seems to be a disparity in interfaces: Supplier always push event sets of size 1 to the EC_ProxyPushSupplier, and EC_Filters do not implement handling of sets of more than 1 event. Then, why is this not enforced by the interface by having EC_ProxyPushSupplier take an event rather than a set?

Implements TAO_EC_Filter.

int TAO_EC_Conjunction_Filter::filter_nocopy RtecEventComm::EventSet event,
TAO_EC_QOS_Info &qos_info  ACE_ENV_ARG_DECL
[virtual]
 

Implements TAO_EC_Filter.

CORBA::ULong TAO_EC_Conjunction_Filter::max_event_size void   )  const [virtual]
 

Returns the maximum size of the events pushed by this filter.

Implements TAO_EC_Filter.

void TAO_EC_Conjunction_Filter::push const RtecEventComm::EventSet event,
TAO_EC_QOS_Info &qos_info  ACE_ENV_ARG_DECL
[virtual]
 

This is called by the children when they accept an event and which to pass it up. Notice that there are two versions of the method, if the event is not const then filter can take ownership of the event.

Implements TAO_EC_Filter.

void TAO_EC_Conjunction_Filter::push_nocopy RtecEventComm::EventSet event,
TAO_EC_QOS_Info &qos_info  ACE_ENV_ARG_DECL
[virtual]
 

Implements TAO_EC_Filter.

int TAO_EC_Conjunction_Filter::size void   )  const [virtual]
 

Reimplemented from TAO_EC_Filter.


Member Data Documentation

Word* TAO_EC_Conjunction_Filter::bitvec_ [private]
 

The bit vector to keep track of the children that have received their events.

ChildrenIterator TAO_EC_Conjunction_Filter::current_child_ [private]
 

The current child in the iteration, used in the push() method...

RtecEventComm::EventSet TAO_EC_Conjunction_Filter::event_ [private]
 

The event we send up (once all the children have pushed theirs).

size_t TAO_EC_Conjunction_Filter::n_ [private]
 

The number of children.

size_t TAO_EC_Conjunction_Filter::nwords_ [private]
 

The number of words in the bit vector


The documentation for this class was generated from the following files:
Generated on Wed Nov 23 16:18:29 2005 for TAO_RTEvent by  doxygen 1.4.5