Rti.Dds.Subscription.Filter Class Reference

Defines a filter to create a Topics.ContentFilteredTopic<T>. More...

Inherits IEquatable< Filter >.

Public Member Functions
	Filter (string expression)
	Creates a filter with an expression with no parameters. More...
	Filter (string expression, IEnumerable< string > parameters)
	Creates a filter with an expression that contains parameters. More...
	Filter (string expression, IEnumerable< string > parameters, string name)
	Creates a filter with an expression containing parameters and a filter name. More...
bool	Equals (Filter other)
	Compares for equality More...
override bool	Equals (object obj)
	Compares for equality More...
override int	GetHashCode ()
	Gets the hash code More...
override string	ToString ()
	Converts to a string More...
Filter	WithParameters (IEnumerable< string > parameters)
	Creates a new Filter with the same expression as the existing filter but with new parameters More...

Static Public Member Functions
static implicit	operator Filter (string expression)
	Allows using a string wherever a no-parameter filter is expected More...

Static Public Attributes
const string	SqlFilterName = "DDSSQL"
	Filter name that identifies the SQL filter More...
const string	StringMatchFilterName = "DDSSTRINGMATCH"
	Filter name that identifies the "string match" filter More...

Properties
string	Expression [get]
	Gets the expression. More...
IEnumerable< string >	Parameters [get]
	Gets the parameters. More...
string	Name [get]
	Gets the filter name More...

Detailed Description

Defines a filter to create a Topics.ContentFilteredTopic<T>.

Constructor & Destructor Documentation

Filter() [1/3]

Rti.Dds.Subscription.Filter.Filter ( string  expression )

inline

Creates a filter with an expression with no parameters.

Filter() [2/3]

Rti.Dds.Subscription.Filter.Filter ( string  expression, IEnumerable< string >  parameters  )

inline

Creates a filter with an expression that contains parameters.

Parameters

expression	The filter expression
parameters	The values of the parameters used in the expression

Filter() [3/3]

Rti.Dds.Subscription.Filter.Filter ( string  expression, IEnumerable< string >  parameters, string  name  )

inline

Creates a filter with an expression containing parameters and a filter name.

Member Function Documentation

Equals() [1/2]

bool Rti.Dds.Subscription.Filter.Equals

(

Filter

other

)

Compares for equality

Equals() [2/2]

override bool Rti.Dds.Subscription.Filter.Equals

(

object

obj

)

Compares for equality

GetHashCode()

override int Rti.Dds.Subscription.Filter.GetHashCode

(

)

Gets the hash code

ToString()

override string Rti.Dds.Subscription.Filter.ToString

(

)

Converts to a string

WithParameters()

Filter Rti.Dds.Subscription.Filter.WithParameters

(

IEnumerable< string >

parameters

)

Creates a new Filter with the same expression as the existing filter but with new parameters

Parameters

parameters

The new parameters for the new filter

Returns

A new filter with the same expression and new parameters

operator Filter()

static implicit Rti.Dds.Subscription.Filter.operator Filter ( string  expression )

static

Allows using a string wherever a no-parameter filter is expected

Parameters

expression

The string to implicitly convert to a Filter with an expression and no parameters

Field Documentation

SqlFilterName

const string Rti.Dds.Subscription.Filter.SqlFilterName = "DDSSQL"

static

Filter name that identifies the SQL filter

StringMatchFilterName

const string Rti.Dds.Subscription.Filter.StringMatchFilterName = "DDSSTRINGMATCH"

static

Filter name that identifies the "string match" filter

Property Documentation

Expression

string Rti.Dds.Subscription.Filter.Expression

get

Gets the expression.

Parameters

IEnumerable<string> Rti.Dds.Subscription.Filter.Parameters

get

Gets the parameters.

Name

string Rti.Dds.Subscription.Filter.Name

get

Gets the filter name