RTI Connext C# API  6.1.0
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
 Filter name that identifies the SQL filter More...
 
const string StringMatchFilterName
 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]

Filter ( string  expression)

Creates a filter with an expression with no parameters.

◆ Filter() [2/3]

Filter ( string  expression,
IEnumerable< string >  parameters 
)

Creates a filter with an expression that contains parameters.

Parameters
expressionThe filter expression
parametersThe values of the parameters used in the expression

◆ Filter() [3/3]

Filter ( string  expression,
IEnumerable< string >  parameters,
string  name 
)

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

Member Function Documentation

◆ Equals() [1/2]

bool Equals ( Filter  other)

Compares for equality

◆ Equals() [2/2]

override bool Equals ( object  obj)

Compares for equality

◆ GetHashCode()

override int GetHashCode ( )

Gets the hash code

◆ operator Filter()

static implicit operator Filter ( string  expression)
static

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

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

◆ ToString()

override string ToString ( )

Converts to a string

◆ WithParameters()

Filter WithParameters ( IEnumerable< string >  parameters)

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

Parameters
parametersThe new parameters for the new filter
Returns
A new filter with the same expression and new parameters

Member Data Documentation

◆ SqlFilterName

const string SqlFilterName
static

Filter name that identifies the SQL filter

◆ StringMatchFilterName

const string StringMatchFilterName
static

Filter name that identifies the "string match" filter

Property Documentation

◆ Expression

string Expression
get

Gets the expression.

◆ Name

string Name
get

Gets the filter name

◆ Parameters

IEnumerable<string> Parameters
get

Gets the parameters.