TAO_EC_Filter Class Reference

Abstract base class for the filter hierarchy. More...

#include <EC_Filter.h>

Inheritance diagram for TAO_EC_Filter:

Inheritance graph
[legend]
Collaboration diagram for TAO_EC_Filter:

Collaboration graph
[legend]
List of all members.

Public Types

typedef TAO_EC_Filter * value_type
typedef TAO_EC_Filter *const const_value_type
typedef const_value_type * ChildrenIterator

Public Member Functions

 TAO_EC_Filter (void)
 constructor...
virtual ~TAO_EC_Filter (void)
 destructor...
TAO_EC_Filter * parent (void) const
 Obtain the parent of this filter.
void adopt_child (TAO_EC_Filter *child)
 Become the parent of child.
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)=0
virtual int filter_nocopy (RtecEventComm::EventSet &event, TAO_EC_QOS_Info &qos_info)=0
virtual void push (const RtecEventComm::EventSet &event, TAO_EC_QOS_Info &qos_info)=0
virtual void push_nocopy (RtecEventComm::EventSet &event, TAO_EC_QOS_Info &qos_info)=0
virtual void clear (void)=0
virtual CORBA::ULong max_event_size (void) const =0
 Returns the maximum size of the events pushed by this filter.
virtual int can_match (const RtecEventComm::EventHeader &header) const =0
virtual int add_dependencies (const RtecEventComm::EventHeader &header, const TAO_EC_QOS_Info &qos_info)=0
virtual void get_qos_info (TAO_EC_QOS_Info &qos_info)

Static Public Member Functions

static int matches (const RtecEventComm::EventHeader &rhs, const RtecEventComm::EventHeader &lhs)

Private Attributes

TAO_EC_Filter * parent_
 The parent...

Detailed Description

Abstract base class for the filter hierarchy.

The per-consumer filtering mechanisms. The EC needs to filter data passed to the consumers, so it can correctly satisfy its subscription requirements. This filtering can include correlations, sequences, timeouts, etc. each consumer can request different filtering criteria. Different filtering objects are associated with each consumer, the filters are organized in a hierarchical structure, corresponding to the subscription "expression" that the events must satisfy. The hierarchy is constructed using the "Builder" pattern.

Memory Management

It does *not* assume ownership of its parent.

Definition at line 51 of file EC_Filter.h.

Member Typedef Documentation

typedef const_value_type* TAO_EC_Filter::ChildrenIterator

Definition at line 73 of file EC_Filter.h.

typedef TAO_EC_Filter* const TAO_EC_Filter::const_value_type

Definition at line 72 of file EC_Filter.h.

typedef TAO_EC_Filter* TAO_EC_Filter::value_type

Definition at line 71 of file EC_Filter.h.

Constructor & Destructor Documentation

TAO_BEGIN_VERSIONED_NAMESPACE_DECL ACE_INLINE TAO_EC_Filter::TAO_EC_Filter ( void   ) 

constructor...

Definition at line 8 of file EC_Filter.inl.

00009   :  parent_ (0)
00010 {
00011 }

TAO_BEGIN_VERSIONED_NAMESPACE_DECL TAO_EC_Filter::~TAO_EC_Filter ( void   )  [virtual]

destructor...

Definition at line 18 of file EC_Filter.cpp.

00019 {
00020 }

Member Function Documentation

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

Implemented in TAO_EC_And_Filter, TAO_EC_Bitmask_Filter, TAO_EC_Conjunction_Filter, TAO_EC_Disjunction_Filter, TAO_EC_Null_Filter, TAO_EC_Kokyu_Filter, TAO_EC_Masked_Type_Filter, TAO_EC_Negation_Filter, TAO_EC_ProxyPushSupplier, TAO_EC_Sched_Filter, TAO_EC_Timeout_Filter, and TAO_EC_Type_Filter.

Referenced by TAO_EC_Sched_Filter::add_dependencies(), TAO_EC_ProxyPushSupplier::add_dependencies(), and TAO_EC_Kokyu_Filter::add_dependencies().

void TAO_EC_Filter::adopt_child ( TAO_EC_Filter *  child  ) 

Become the parent of child.

Definition at line 23 of file EC_Filter.cpp.

References parent_.

Referenced by TAO_EC_Default_ProxyPushSupplier::connect_push_consumer().

00024 {
00025   child->parent_ = this;
00026 }

TAO_EC_Filter::ChildrenIterator TAO_EC_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 in TAO_EC_And_Filter, TAO_EC_Bitmask_Filter, TAO_EC_Conjunction_Filter, TAO_EC_Disjunction_Filter, TAO_EC_Kokyu_Filter, TAO_EC_Masked_Type_Filter, TAO_EC_Negation_Filter, and TAO_EC_Sched_Filter.

Definition at line 29 of file EC_Filter.cpp.

Referenced by TAO_EC_Sched_Filter::begin(), and TAO_EC_Kokyu_Filter::begin().

00030 {
00031   return 0;
00032 }

virtual int TAO_EC_Filter::can_match ( const RtecEventComm::EventHeader &  header  )  const [pure 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

Implemented in TAO_EC_And_Filter, TAO_EC_Bitmask_Filter, TAO_EC_Conjunction_Filter, TAO_EC_Disjunction_Filter, TAO_EC_Null_Filter, TAO_EC_Kokyu_Filter, TAO_EC_Masked_Type_Filter, TAO_EC_Negation_Filter, TAO_EC_ProxyPushSupplier, TAO_EC_Sched_Filter, TAO_EC_Timeout_Filter, and TAO_EC_Type_Filter.

Referenced by TAO_EC_Sched_Filter::can_match(), TAO_EC_ProxyPushSupplier::can_match(), TAO_EC_Negation_Filter::can_match(), TAO_EC_Kokyu_Filter::can_match(), and TAO_EC_Bitmask_Filter::can_match().

virtual void TAO_EC_Filter::clear ( void   )  [pure virtual]

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

Implemented in TAO_EC_And_Filter, TAO_EC_Bitmask_Filter, TAO_EC_Conjunction_Filter, TAO_EC_Disjunction_Filter, TAO_EC_Null_Filter, TAO_EC_Kokyu_Filter, TAO_EC_Masked_Type_Filter, TAO_EC_Negation_Filter, TAO_EC_ProxyPushSupplier, TAO_EC_Sched_Filter, TAO_EC_Timeout_Filter, and TAO_EC_Type_Filter.

Referenced by TAO_EC_Sched_Filter::clear(), TAO_EC_ProxyPushSupplier::clear(), TAO_EC_Negation_Filter::clear(), TAO_EC_Kokyu_Filter::clear(), TAO_EC_Bitmask_Filter::clear(), TAO_EC_ProxyPushSupplier::push(), and TAO_EC_ProxyPushSupplier::push_nocopy().

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

Reimplemented in TAO_EC_And_Filter, TAO_EC_Bitmask_Filter, TAO_EC_Conjunction_Filter, TAO_EC_Disjunction_Filter, TAO_EC_Kokyu_Filter, TAO_EC_Masked_Type_Filter, TAO_EC_Negation_Filter, and TAO_EC_Sched_Filter.

Definition at line 35 of file EC_Filter.cpp.

Referenced by TAO_EC_Sched_Filter::end(), and TAO_EC_Kokyu_Filter::end().

00036 {
00037   return 0;
00038 }

virtual int TAO_EC_Filter::filter ( const RtecEventComm::EventSet &  event,
TAO_EC_QOS_Info &  qos_info 
) [pure 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?

Implemented in TAO_EC_And_Filter, TAO_EC_Bitmask_Filter, TAO_EC_Conjunction_Filter, TAO_EC_Disjunction_Filter, TAO_EC_Null_Filter, TAO_EC_Kokyu_Filter, TAO_EC_Masked_Type_Filter, TAO_EC_Negation_Filter, TAO_EC_ProxyPushSupplier, TAO_EC_Sched_Filter, TAO_EC_Timeout_Filter, and TAO_EC_Type_Filter.

Referenced by TAO_EC_Sched_Filter::filter(), TAO_EC_ProxyPushSupplier::filter(), TAO_EC_Negation_Filter::filter(), TAO_EC_Kokyu_Filter::filter(), and TAO_EC_Bitmask_Filter::filter().

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

Implemented in TAO_EC_And_Filter, TAO_EC_Bitmask_Filter, TAO_EC_Conjunction_Filter, TAO_EC_Disjunction_Filter, TAO_EC_Null_Filter, TAO_EC_Kokyu_Filter, TAO_EC_Masked_Type_Filter, TAO_EC_Negation_Filter, TAO_EC_ProxyPushSupplier, TAO_EC_Sched_Filter, TAO_EC_Timeout_Filter, and TAO_EC_Type_Filter.

Referenced by TAO_EC_Sched_Filter::filter_nocopy(), TAO_EC_ProxyPushSupplier::filter_nocopy(), TAO_EC_Negation_Filter::filter_nocopy(), TAO_EC_Kokyu_Filter::filter_nocopy(), and TAO_EC_Bitmask_Filter::filter_nocopy().

void TAO_EC_Filter::get_qos_info ( TAO_EC_QOS_Info &  qos_info  )  [virtual]

Obtain the QOS information for this filter, the default implementation returns an invalid QOS. Only the filters that support scheduling information implement this method.

Returns:
Returns 0 on success and -1 on failure

Reimplemented in TAO_EC_Kokyu_Filter, and TAO_EC_Sched_Filter.

Definition at line 47 of file EC_Filter.cpp.

References CORBA::COMPLETED_NO, and TAO::VMCID.

00048 {
00049   ACE_UNUSED_ARG (qos_info);
00050   throw CORBA::NO_IMPLEMENT (TAO::VMCID, CORBA::COMPLETED_NO);
00051 }

ACE_INLINE int TAO_EC_Filter::matches ( const RtecEventComm::EventHeader &  rhs,
const RtecEventComm::EventHeader &  lhs 
) [static]

Matches two event headers.

Todo:
Should we strategize the algorithm used to match headers?

Definition at line 20 of file EC_Filter.inl.

References RtecEventComm::EventHeader::source, and RtecEventComm::EventHeader::type.

Referenced by TAO_EC_Sched_Filter::add_dependencies(), TAO_EC_Kokyu_Filter::add_dependencies(), TAO_EC_Priority_Scheduling::schedule_event(), and TAO_EC_Kokyu_Scheduling::schedule_event().

00022 {
00023   if ((rhs.source == 0 && rhs.type == 0)
00024       || (lhs.source == 0 && lhs.type == 0))
00025     return 1;
00026 
00027   if (rhs.source == 0 || lhs.source == 0)
00028     return rhs.type == lhs.type;
00029 
00030   if (rhs.type == 0 || lhs.type == 0)
00031     return rhs.source == lhs.source;
00032 
00033   return (rhs.type == lhs.type && rhs.source == lhs.source);
00034 }

virtual CORBA::ULong TAO_EC_Filter::max_event_size ( void   )  const [pure virtual]

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

Implemented in TAO_EC_And_Filter, TAO_EC_Bitmask_Filter, TAO_EC_Conjunction_Filter, TAO_EC_Disjunction_Filter, TAO_EC_Null_Filter, TAO_EC_Kokyu_Filter, TAO_EC_Masked_Type_Filter, TAO_EC_Negation_Filter, TAO_EC_ProxyPushSupplier, TAO_EC_Sched_Filter, TAO_EC_Timeout_Filter, and TAO_EC_Type_Filter.

Referenced by TAO_EC_Sched_Filter::max_event_size(), TAO_EC_ProxyPushSupplier::max_event_size(), TAO_EC_Negation_Filter::max_event_size(), TAO_EC_Kokyu_Filter::max_event_size(), and TAO_EC_Bitmask_Filter::max_event_size().

ACE_INLINE TAO_EC_Filter * TAO_EC_Filter::parent ( void   )  const

Obtain the parent of this filter.

Definition at line 14 of file EC_Filter.inl.

References parent_.

Referenced by TAO_EC_Sched_Filter::push(), TAO_EC_Kokyu_Filter::push(), TAO_EC_Conjunction_Filter::push(), TAO_EC_Sched_Filter::push_nocopy(), and TAO_EC_Kokyu_Filter::push_nocopy().

00015 {
00016   return this->parent_;
00017 }

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

Implemented in TAO_EC_And_Filter, TAO_EC_Bitmask_Filter, TAO_EC_Conjunction_Filter, TAO_EC_Disjunction_Filter, TAO_EC_Null_Filter, TAO_EC_Kokyu_Filter, TAO_EC_Masked_Type_Filter, TAO_EC_Negation_Filter, TAO_EC_ProxyPushSupplier, TAO_EC_Sched_Filter, TAO_EC_Timeout_Filter, and TAO_EC_Type_Filter.

Referenced by TAO_EC_Sched_Filter::push(), and TAO_EC_Kokyu_Filter::push().

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

Implemented in TAO_EC_And_Filter, TAO_EC_Bitmask_Filter, TAO_EC_Conjunction_Filter, TAO_EC_Disjunction_Filter, TAO_EC_Null_Filter, TAO_EC_Kokyu_Filter, TAO_EC_Masked_Type_Filter, TAO_EC_Negation_Filter, TAO_EC_ProxyPushSupplier, TAO_EC_Sched_Filter, TAO_EC_Timeout_Filter, and TAO_EC_Type_Filter.

Referenced by TAO_EC_Sched_Filter::push_nocopy(), and TAO_EC_Kokyu_Filter::push_nocopy().

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

Reimplemented in TAO_EC_And_Filter, TAO_EC_Bitmask_Filter, TAO_EC_Conjunction_Filter, TAO_EC_Disjunction_Filter, TAO_EC_Kokyu_Filter, TAO_EC_Masked_Type_Filter, TAO_EC_Negation_Filter, and TAO_EC_Sched_Filter.

Definition at line 41 of file EC_Filter.cpp.

Referenced by TAO_EC_Sched_Filter::size(), and TAO_EC_Kokyu_Filter::size().

00042 {
00043   return 0;
00044 }

Member Data Documentation

TAO_EC_Filter* TAO_EC_Filter::parent_ [private]

The parent...

Definition at line 154 of file EC_Filter.h.

Referenced by adopt_child(), and parent().

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