TAO_EC_Negation_Filter Class Reference

The negation filter. More...

#include <EC_Negation_Filter.h>

Inheritance diagram for TAO_EC_Negation_Filter:

Inheritance graph
[legend]
Collaboration diagram for TAO_EC_Negation_Filter:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 TAO_EC_Negation_Filter (TAO_EC_Filter *child)
 Constructor. It assumes ownership of the child.
virtual ~TAO_EC_Negation_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)
virtual int filter_nocopy (RtecEventComm::EventSet &event, TAO_EC_QOS_Info &qos_info)
virtual void push (const RtecEventComm::EventSet &event, TAO_EC_QOS_Info &qos_info)
virtual void push_nocopy (RtecEventComm::EventSet &event, TAO_EC_QOS_Info &qos_info)
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)

Private Member Functions

 TAO_EC_Negation_Filter (const TAO_EC_Negation_Filter &)
TAO_EC_Negation_Filter & operator= (const TAO_EC_Negation_Filter &)

Private Attributes

TAO_EC_Filter * child_
 The child.

Detailed Description

The negation filter.

This filter accepts all the events rejected by its child, and rejects any events accepted by the child.

Memory Management

It assumes ownership of its child.

Definition at line 40 of file EC_Negation_Filter.h.

Constructor & Destructor Documentation

TAO_BEGIN_VERSIONED_NAMESPACE_DECL TAO_EC_Negation_Filter::TAO_EC_Negation_Filter ( TAO_EC_Filter *  child  ) 

Constructor. It assumes ownership of the child.

Definition at line 9 of file EC_Negation_Filter.cpp.

00010   :  child_ (child)
00011 {
00012   this->adopt_child (this->child_);
00013 }

TAO_EC_Negation_Filter::~TAO_EC_Negation_Filter ( void   )  [virtual]

Destructor.

Definition at line 15 of file EC_Negation_Filter.cpp.

References child_.

00016 {
00017   delete this->child_;
00018 }

TAO_EC_Negation_Filter::TAO_EC_Negation_Filter ( const TAO_EC_Negation_Filter &   )  [private]

Member Function Documentation

int TAO_EC_Negation_Filter::add_dependencies ( const RtecEventComm::EventHeader &  header,
const TAO_EC_QOS_Info &  qos_info 
) [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.

Definition at line 98 of file EC_Negation_Filter.cpp.

00101 {
00102   return 0;
00103 }

TAO_EC_Filter::ChildrenIterator TAO_EC_Negation_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.

Definition at line 21 of file EC_Negation_Filter.cpp.

References child_.

00022 {
00023   return const_cast<TAO_EC_Filter**> (&this->child_);
00024 }

int TAO_EC_Negation_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.

Definition at line 91 of file EC_Negation_Filter.cpp.

References TAO_EC_Filter::can_match(), and child_.

00093 {
00094   return !this->child_->can_match (header);
00095 }

void TAO_EC_Negation_Filter::clear ( void   )  [virtual]

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

Implements TAO_EC_Filter.

Definition at line 79 of file EC_Negation_Filter.cpp.

References child_, and TAO_EC_Filter::clear().

00080 {
00081   this->child_->clear ();
00082 }

TAO_EC_Filter::ChildrenIterator TAO_EC_Negation_Filter::end ( void   )  const [virtual]

Reimplemented from TAO_EC_Filter.

Definition at line 27 of file EC_Negation_Filter.cpp.

References child_.

00028 {
00029   return const_cast<TAO_EC_Filter**> (&this->child_) + 1;
00030 }

int TAO_EC_Negation_Filter::filter ( const RtecEventComm::EventSet &  event,
TAO_EC_QOS_Info &  qos_info 
) [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.

Definition at line 39 of file EC_Negation_Filter.cpp.

References child_, and TAO_EC_Filter::filter().

00041 {
00042   int n =
00043     this->child_->filter (event, qos_info);
00044   if (this->parent () != 0 && n == 0)
00045     {
00046       this->parent ()->push (event, qos_info);
00047       return 1;
00048     }
00049   return 0;
00050 }

int TAO_EC_Negation_Filter::filter_nocopy ( RtecEventComm::EventSet &  event,
TAO_EC_QOS_Info &  qos_info 
) [virtual]

Implements TAO_EC_Filter.

Definition at line 53 of file EC_Negation_Filter.cpp.

References child_, and TAO_EC_Filter::filter_nocopy().

00055 {
00056   int n =
00057     this->child_->filter_nocopy (event, qos_info);
00058   if (this->parent () != 0 && n == 0)
00059     {
00060       this->parent ()->push_nocopy (event, qos_info);
00061       return 1;
00062     }
00063   return 0;
00064 }

CORBA::ULong TAO_EC_Negation_Filter::max_event_size ( void   )  const [virtual]

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

Implements TAO_EC_Filter.

Definition at line 85 of file EC_Negation_Filter.cpp.

References child_, and TAO_EC_Filter::max_event_size().

00086 {
00087   return this->child_->max_event_size ();
00088 }

TAO_EC_Negation_Filter& TAO_EC_Negation_Filter::operator= ( const TAO_EC_Negation_Filter &   )  [private]

void TAO_EC_Negation_Filter::push ( const RtecEventComm::EventSet &  event,
TAO_EC_QOS_Info &  qos_info 
) [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.

Definition at line 67 of file EC_Negation_Filter.cpp.

00069 {
00070 }

void TAO_EC_Negation_Filter::push_nocopy ( RtecEventComm::EventSet &  event,
TAO_EC_QOS_Info &  qos_info 
) [virtual]

Implements TAO_EC_Filter.

Definition at line 73 of file EC_Negation_Filter.cpp.

00075 {
00076 }

int TAO_EC_Negation_Filter::size ( void   )  const [virtual]

Reimplemented from TAO_EC_Filter.

Definition at line 33 of file EC_Negation_Filter.cpp.

00034 {
00035   return 1;
00036 }

Member Data Documentation

TAO_EC_Filter* TAO_EC_Negation_Filter::child_ [private]

The child.

Definition at line 75 of file EC_Negation_Filter.h.

Referenced by begin(), can_match(), clear(), end(), filter(), filter_nocopy(), max_event_size(), and ~TAO_EC_Negation_Filter().

The documentation for this class was generated from the following files:
Generated on Tue Feb 2 17:44:31 2010 for TAO_RTEvent by  doxygen 1.4.7