#include <QueryConditionImpl.h>

Inheritance diagram for OpenDDS::DCPS::QueryConditionImpl:

[legend]

Collaboration diagram for OpenDDS::DCPS::QueryConditionImpl:

[legend]

Public Member Functions
	QueryConditionImpl (DataReaderImpl dr, DDS::SampleStateMask sample_states, DDS::ViewStateMask view_states, DDS::InstanceStateMask instance_states, const char query_expression)

virtual	~QueryConditionImpl ()

char *	get_query_expression ()

DDS::ReturnCode_t	get_query_parameters (DDS::StringSeq &query_parameters)

DDS::ReturnCode_t	set_query_parameters (const DDS::StringSeq &query_parameters)

CORBA::Boolean	get_trigger_value ()

std::vector< OPENDDS_STRING >	getOrderBys () const

bool	hasFilter () const

template<typename Sample >
bool	filter (const Sample &s, bool sample_only_has_key_fields) const

Public Member Functions inherited from DDS::QueryCondition
ReturnCode_t	get_query_parameters (inout StringSeq query_parameters)

ReturnCode_t	set_query_parameters (in StringSeq query_parameters)

Public Member Functions inherited from OpenDDS::DCPS::LocalObjectBase
virtual void	_add_ref ()

virtual void	_remove_ref ()

virtual CORBA::ULong	_refcount_value () const

Public Member Functions inherited from CORBA::LocalObject
virtual	~LocalObject (void)

virtual CORBA::Boolean	_non_existent (void)

virtual char *	_repository_id (void)

virtual CORBA::InterfaceDef_ptr	_get_interface (void)

virtual CORBA::Object_ptr	_get_component (void)

virtual void	_create_request (CORBA::Context_ptr ctx, const char *operation, CORBA::NVList_ptr arg_list, CORBA::NamedValue_ptr result, CORBA::Request_ptr &request, CORBA::Flags req_flags)

virtual void	_create_request (CORBA::Context_ptr ctx, const char *operation, CORBA::NVList_ptr arg_list, CORBA::NamedValue_ptr result, CORBA::ExceptionList_ptr exclist, CORBA::ContextList_ptr ctxtlist, CORBA::Request_ptr &request, CORBA::Flags req_flags)

virtual CORBA::Request_ptr	_request (const char *operation)

CORBA::Policy_ptr	_get_policy (CORBA::PolicyType type)

CORBA::Policy_ptr	_get_cached_policy (TAO_Cached_Policy_Type type)

CORBA::Object_ptr	_set_policy_overrides (const CORBA::PolicyList &policies, CORBA::SetOverrideType set_add)

CORBA::PolicyList *	_get_policy_overrides (const CORBA::PolicyTypeSeq &types)

CORBA::Boolean	_validate_connection (CORBA::PolicyList_out inconsistent_policies)

virtual CORBA::ULong	_hash (CORBA::ULong maximum)

virtual CORBA::Boolean	_is_equivalent (CORBA::Object_ptr other_obj)

virtual CORBA::ORB_ptr	_get_orb (void)

virtual TAO::ObjectKey *	_key (void)

Public Member Functions inherited from CORBA::Object
virtual	~Object (void)

virtual TAO_Abstract_ServantBase *	_servant (void) const

virtual CORBA::Boolean	_is_collocated (void) const

virtual CORBA::Boolean	_is_local (void) const

	Object (TAO_Stub p, CORBA::Boolean collocated=false, TAO_Abstract_ServantBase servant=0, TAO_ORB_Core *orb_core=0)

	Object (IOP::IOR ior, TAO_ORB_Core orb_core)

virtual TAO_Stub *	_stubobj (void) const

virtual TAO_Stub *	_stubobj (void)

virtual void	_proxy_broker (TAO::Object_Proxy_Broker *proxy_broker)

virtual CORBA::Boolean	marshal (TAO_OutputCDR &cdr)

CORBA::Boolean	is_evaluated (void) const

TAO_ORB_Core *	orb_core (void) const

IOP::IOR *	steal_ior (void)

const IOP::IOR &	ior (void) const

virtual bool	can_convert_to_ior (void) const

virtual char *	convert_to_ior (bool use_omg_ior_format, const char *ior_prefix) const

void	_decr_refcount (void)

virtual CORBA::Boolean	_is_a (const char *logical_type_id)

virtual const char *	_interface_repository_id (void) const

CORBA::Policy_ptr	_get_policy (CORBA::PolicyType type)

CORBA::Policy_ptr	_get_cached_policy (TAO_Cached_Policy_Type type)

CORBA::Object_ptr	_set_policy_overrides (const CORBA::PolicyList &policies, CORBA::SetOverrideType set_add)

CORBA::PolicyList *	_get_policy_overrides (const CORBA::PolicyTypeSeq &types)

CORBA::Boolean	_validate_connection (CORBA::PolicyList_out inconsistent_policies)

Public Member Functions inherited from OpenDDS::DCPS::RcObject
virtual	~RcObject ()

long	ref_count () const

WeakObject *	_get_weak_object () const

Public Member Functions inherited from OpenDDS::DCPS::ReadConditionImpl
	ReadConditionImpl (DataReaderImpl *dr, DDS::SampleStateMask sample_states, DDS::ViewStateMask view_states, DDS::InstanceStateMask instance_states)

virtual	~ReadConditionImpl ()

CORBA::Boolean	get_trigger_value ()

DDS::SampleStateMask	get_sample_state_mask ()

DDS::ViewStateMask	get_view_state_mask ()

DDS::InstanceStateMask	get_instance_state_mask ()

DDS::DataReader_ptr	get_datareader ()

Public Member Functions inherited from OpenDDS::DCPS::ConditionImpl
DDS::ReturnCode_t	attach_to_ws (DDS::WaitSet_ptr ws)

DDS::ReturnCode_t	detach_from_ws (DDS::WaitSet_ptr ws)

void	signal_all ()

Private Member Functions
TypeSupportImpl *	get_type_support () const

Private Attributes
CORBA::String_var	query_expression_

DDS::StringSeq	query_parameters_

FilterEvaluator	evaluator_

ACE_Recursive_Thread_Mutex	lock_
	Concurrent access to query_parameters_. More...

Additional Inherited Members
Public Types inherited from OpenDDS::DCPS::LocalObject< DDS::QueryCondition >
typedef DDS::QueryCondition ::_ptr_type	_ptr_type

typedef DDS::QueryCondition ::_var_type	_var_type

Public Types inherited from CORBA::LocalObject
typedef LocalObject_ptr	_ptr_type

typedef LocalObject_var	_var_type

typedef LocalObject_out	_out_type

Public Types inherited from CORBA::Object
typedef Object_ptr	_ptr_type

typedef Object_var	_var_type

typedef Object_out	_out_type

Public Types inherited from OpenDDS::DCPS::LocalObject< DDS::ReadCondition >
typedef DDS::ReadCondition ::_ptr_type	_ptr_type

typedef DDS::ReadCondition ::_var_type	_var_type

Public Types inherited from OpenDDS::DCPS::LocalObject< DDS::Condition >
typedef DDS::Condition ::_ptr_type	_ptr_type

typedef DDS::Condition ::_var_type	_var_type

Static Public Member Functions inherited from OpenDDS::DCPS::LocalObject< DDS::QueryCondition >
static _ptr_type	_narrow (CORBA::Object_ptr obj)

Static Public Member Functions inherited from CORBA::LocalObject
static LocalObject_ptr	_duplicate (LocalObject_ptr obj)

static LocalObject_ptr	_nil (void)

static LocalObject_ptr	_narrow (CORBA::Object_ptr obj)

Static Public Member Functions inherited from CORBA::Object
static CORBA::Boolean	marshal (const Object_ptr x, TAO_OutputCDR &cdr)

static void	_tao_any_destructor (void *)

static CORBA::Boolean	is_nil_i (CORBA::Object_ptr obj)

static void	tao_object_initialize (Object *)

static CORBA::Object_ptr	_duplicate (CORBA::Object_ptr obj)

static CORBA::Object_ptr	_nil (void)

static CORBA::Object_ptr	_narrow (CORBA::Object_ptr obj)

Static Public Member Functions inherited from OpenDDS::DCPS::LocalObject< DDS::ReadCondition >
static _ptr_type	_narrow (CORBA::Object_ptr obj)

Static Public Member Functions inherited from OpenDDS::DCPS::LocalObject< DDS::Condition >
static _ptr_type	_narrow (CORBA::Object_ptr obj)

Protected Member Functions inherited from CORBA::LocalObject
	LocalObject (void)

Protected Member Functions inherited from CORBA::Object
	Object (int dummy=0)

TAO::Object_Proxy_Broker *	proxy_broker () const

Protected Member Functions inherited from OpenDDS::DCPS::RcObject
	RcObject ()

Protected Member Functions inherited from OpenDDS::DCPS::ConditionImpl
	ConditionImpl ()

virtual	~ConditionImpl ()

typedef	OPENDDS_SET (OpenDDS::DCPS::WeakRcHandle< DDS::WaitSet >) WaitSetSet

Protected Attributes inherited from CORBA::Object
ACE_Atomic_Op< TAO_SYNCH_MUTEX, unsigned long >	refcount_

Protected Attributes inherited from OpenDDS::DCPS::ReadConditionImpl
DataReaderImpl *	parent_

DDS::SampleStateMask	sample_states_

DDS::ViewStateMask	view_states_

DDS::InstanceStateMask	instance_states_

Protected Attributes inherited from OpenDDS::DCPS::ConditionImpl
WaitSetSet	waitsets_

ACE_Recursive_Thread_Mutex	lock_

Detailed Description

Definition at line 32 of file QueryConditionImpl.h.

Constructor & Destructor Documentation

◆ QueryConditionImpl()

OpenDDS::DCPS::QueryConditionImpl::QueryConditionImpl	(	DataReaderImpl *	dr,
		DDS::SampleStateMask	sample_states,
		DDS::ViewStateMask	view_states,
		DDS::InstanceStateMask	instance_states,
		const char *	query_expression
	)

Definition at line 19 of file QueryConditionImpl.cpp.

References ACE_DEBUG, ACE_TEXT(), OpenDDS::DCPS::DCPS_debug_level, evaluator_, LM_DEBUG, and OpenDDS::DCPS::FilterEvaluator::number_parameters().

   : ReadConditionImpl(dr, sample_states, view_states, instance_states)
   , query_expression_(query_expression)
   , evaluator_(query_expression, true)
 {
   if (DCPS_debug_level > 5) {
     ACE_DEBUG((LM_DEBUG,
       ACE_TEXT("(%P|%t) QueryConditionImpl::QueryConditionImpl() - ")
       ACE_TEXT("Creating qc with query <%C> which requires <%d> parameters\n"),
       query_expression, evaluator_.number_parameters()));
   }
 }

◆ ~QueryConditionImpl()

virtual OpenDDS::DCPS::QueryConditionImpl::~QueryConditionImpl ( )

inlinevirtual

Definition at line 40 of file QueryConditionImpl.h.

40 {}

Member Function Documentation

◆ filter()

template<typename Sample >

bool OpenDDS::DCPS::QueryConditionImpl::filter	(	const Sample &	s,
		bool	sample_only_has_key_fields
	)		const

inline

Returns true if the sample matches the query.

Definition at line 59 of file QueryConditionImpl.h.

References ACE_DEBUG, ACE_GUARD_RETURN, ACE_TEXT(), OpenDDS::DCPS::DCPS_debug_level, LM_DEBUG, and lock_.

Referenced by OpenDDS::DCPS::RakeResults< MessageType >::insert_sample().

   {
     ACE_GUARD_RETURN(ACE_Recursive_Thread_Mutex, guard, lock_, false);
     /*
      * Omit the sample from results if the query references non-key fields
      * and the sample only has key fields.
      */
     TypeSupportImpl* const ts = get_type_support();
     if (!ts || (sample_only_has_key_fields && evaluator_.has_non_key_fields(*ts))) {
       if (DCPS_debug_level > 8) {
         ACE_DEBUG((LM_DEBUG,
           ACE_TEXT("(%P|%t) QueryConditionImpl::filter: ")
           ACE_TEXT("Sample has been filtered because the query ")
           ACE_TEXT("references fields that are not readable\n")
         ));
       }
       return false;
     }
     return evaluator_.eval(s, query_parameters_);
   }

◆ get_query_expression()

char * OpenDDS::DCPS::QueryConditionImpl::get_query_expression ( )

Implements DDS::QueryCondition.

Definition at line 35 of file QueryConditionImpl.cpp.

References query_expression_, and CORBA::string_dup().

 {
   return CORBA::string_dup(query_expression_);
 }

◆ get_query_parameters()

DDS::ReturnCode_t OpenDDS::DCPS::QueryConditionImpl::get_query_parameters ( DDS::StringSeq & query_parameters )

Definition at line 41 of file QueryConditionImpl.cpp.

References ACE_GUARD_RETURN, lock_, query_parameters_, and DDS::RETCODE_OK.

 {
   ACE_GUARD_RETURN(ACE_Recursive_Thread_Mutex, guard, lock_, false);
   query_parameters = query_parameters_;
   return DDS::RETCODE_OK;
 }

◆ get_trigger_value()

CORBA::Boolean OpenDDS::DCPS::QueryConditionImpl::get_trigger_value ( )

Implements DDS::Condition.

Definition at line 84 of file QueryConditionImpl.cpp.

References ACE_GUARD_RETURN, OpenDDS::DCPS::DataReaderImpl::contains_sample_filtered(), evaluator_, OpenDDS::DCPS::ReadConditionImpl::get_trigger_value(), hasFilter(), OpenDDS::DCPS::ReadConditionImpl::instance_states_, lock_, OpenDDS::DCPS::ReadConditionImpl::parent_, query_parameters_, OpenDDS::DCPS::DataReaderImpl::sample_lock_, OpenDDS::DCPS::ReadConditionImpl::sample_states_, and OpenDDS::DCPS::ReadConditionImpl::view_states_.

 {
   if (hasFilter()) {
     ACE_GUARD_RETURN(ACE_Recursive_Thread_Mutex, guard2, parent_->sample_lock_, false);
     ACE_GUARD_RETURN(ACE_Recursive_Thread_Mutex, guard, lock_, false);
     return parent_->contains_sample_filtered(sample_states_, view_states_,
       instance_states_, evaluator_, query_parameters_);
   } else {
     return ReadConditionImpl::get_trigger_value();
   }
 }

◆ get_type_support()

TypeSupportImpl * OpenDDS::DCPS::QueryConditionImpl::get_type_support ( ) const

private

Definition at line 96 of file QueryConditionImpl.cpp.

References OpenDDS::DCPS::DataReaderImpl::get_topicdescription(), OpenDDS::DCPS::TopicDescriptionImpl::get_type_support(), OPENDDS_END_VERSIONED_NAMESPACE_DECL, and OpenDDS::DCPS::ReadConditionImpl::parent_.

 {
   DDS::TopicDescription_var td = parent_->get_topicdescription();
   TopicDescriptionImpl* const tdi = dynamic_cast<TopicDescriptionImpl*>(td.in());
   TypeSupport* const ts = tdi ? tdi->get_type_support() : 0;
   return dynamic_cast<TypeSupportImpl*>(ts);
 }

◆ getOrderBys()

std::vector< OPENDDS_STRING > OpenDDS::DCPS::QueryConditionImpl::getOrderBys ( ) const

Definition at line 72 of file QueryConditionImpl.cpp.

References evaluator_.

Referenced by OpenDDS::DCPS::RakeResults< MessageType >::RakeResults().

 {
   return evaluator_.getOrderBys();
 }

◆ hasFilter()

bool OpenDDS::DCPS::QueryConditionImpl::hasFilter ( ) const

Definition at line 78 of file QueryConditionImpl.cpp.

References evaluator_, and OpenDDS::DCPS::FilterEvaluator::hasFilter().

Referenced by get_trigger_value(), and OpenDDS::DCPS::RakeResults< MessageType >::RakeResults().

 {
   return evaluator_.hasFilter();
 }

◆ set_query_parameters()

DDS::ReturnCode_t OpenDDS::DCPS::QueryConditionImpl::set_query_parameters ( const DDS::StringSeq & query_parameters )

Definition at line 49 of file QueryConditionImpl.cpp.

References ACE_ERROR, ACE_GUARD_RETURN, ACE_TEXT(), OpenDDS::DCPS::DCPS_debug_level, evaluator_, LM_ERROR, lock_, OpenDDS::DCPS::FilterEvaluator::number_parameters(), query_parameters_, DDS::RETCODE_ERROR, and DDS::RETCODE_OK.

 {
   ACE_GUARD_RETURN(ACE_Recursive_Thread_Mutex, guard, lock_, false);
 
   // Check sequence of strings that give values to the ‘parameters’ (i.e., "%n" tokens)
   // in the query_expression matches the size of the parameter sequence.
   // The tokens start with 0 which means that when the maximum number used is 1 we need
   // two parameters, (zero and one)
   if (query_parameters.length() != evaluator_.number_parameters()) {
     if (DCPS_debug_level > 1) {
       ACE_ERROR((LM_ERROR,
         ACE_TEXT("(%P|%t) QueryConditionImpl::set_expression_parameters() - ")
         ACE_TEXT("passed incorrect set of query parameters, expected %d received %d\n"),
         evaluator_.number_parameters (), query_parameters.length()));
     }
     return DDS::RETCODE_ERROR;
   }
 
   query_parameters_ = query_parameters;
   return DDS::RETCODE_OK;
 }

Member Data Documentation

◆ evaluator_

FilterEvaluator OpenDDS::DCPS::QueryConditionImpl::evaluator_

private

Definition at line 85 of file QueryConditionImpl.h.

Referenced by get_trigger_value(), getOrderBys(), hasFilter(), QueryConditionImpl(), and set_query_parameters().

◆ lock_

ACE_Recursive_Thread_Mutex OpenDDS::DCPS::QueryConditionImpl::lock_

mutableprivate

Concurrent access to query_parameters_.

Definition at line 87 of file QueryConditionImpl.h.

Referenced by get_query_parameters(), get_trigger_value(), and set_query_parameters().

◆ query_expression_

CORBA::String_var OpenDDS::DCPS::QueryConditionImpl::query_expression_

private

Definition at line 83 of file QueryConditionImpl.h.

Referenced by get_query_expression().

◆ query_parameters_

DDS::StringSeq OpenDDS::DCPS::QueryConditionImpl::query_parameters_

private

Definition at line 84 of file QueryConditionImpl.h.

Referenced by get_query_parameters(), get_trigger_value(), and set_query_parameters().

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

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QueryConditionImpl()

◆ ~QueryConditionImpl()

Member Function Documentation

◆ filter()

◆ get_query_expression()

◆ get_query_parameters()

◆ get_trigger_value()

◆ get_type_support()

◆ getOrderBys()

◆ hasFilter()

◆ set_query_parameters()

Member Data Documentation

◆ evaluator_

◆ lock_

◆ query_expression_

◆ query_parameters_