< Home

< Table of Contents

REFERENCE MANUAL

HPS.Condition Class Reference

A Condition is a string or collection of strings separated by logical operators. More...

Inheritance diagram for HPS.Condition:
HPS.Object

Public Member Functions

HPS.Condition AND (HPS.Condition in_operand2)
 An AND condition is satisfied if both of its operand conditions are satisfied. More...
 
 Condition (string in_utf8)
 This constructor is the most common way to construct a Condition object from a string. More...
 
 Condition (HPS.Condition in_that)
 The copy constructor copies the source condition. More...
 
override void Dispose ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Condition in_that)
 Check if the source object is equivalent to this object. More...
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. More...
 
HPS.Condition OR (HPS.Condition in_operand2)
 An OR condition is satisfied if either of its operand conditions are satisfied. More...
 
bool ShowCondition (out string out_condition)
 Shows the condition string that has been set on this object, if any. More...
 
bool ShowOperands (out HPS.Condition[] out_operands)
 Retrieves the operands, if any, of this condition object. More...
 
HPS.Condition XOR (HPS.Condition in_operand2)
 An XOR condition is satisfied if either operand condition is satisfied, but not both. More...
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 Indicates whether this object has any values set on it. More...
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object in_that)
 The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
HPS.Type Type ()
 This function returns the true type of the underlying object. More...
 

Static Public Member Functions

static HPS.Condition AND (HPS.Condition in_operand1, HPS.Condition in_operand2)
 An AND condition is satisfied if both of its operand conditions are satisfied. More...
 
static HPS.Condition NOT (HPS.Condition in_operand)
 A NOT condition is satisfied if its operand condition is not satisfied. More...
 
static bool operator!= (HPS.Condition a, HPS.Condition b)
 
static bool operator== (HPS.Condition a, HPS.Condition b)
 
static HPS.Condition OR (HPS.Condition in_operand1, HPS.Condition in_operand2)
 An OR condition is satisfied if either of its operand conditions are satisfied. More...
 
static HPS.Condition XOR (HPS.Condition in_operand1, HPS.Condition in_operand2)
 An XOR condition is satisfied if either operand condition is satisfied, but not both. More...
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 
HandleRef scptr
 

Detailed Description

A Condition is a string or collection of strings separated by logical operators.

In practice, conditions form a tree with the leaves being strings (the actual Condition) and the interior nodes being logical operators.

Constructor & Destructor Documentation

HPS.Condition.Condition ( string  in_utf8)

This constructor is the most common way to construct a Condition object from a string.

Parameters
in_utf8The string to use as the condition, assumed to be utf8 encoded.
HPS.Condition.Condition ( HPS.Condition  in_that)

The copy constructor copies the source condition.

Parameters
in_thatthe source to be copied.

Member Function Documentation

HPS.Condition HPS.Condition.AND ( HPS.Condition  in_operand2)

An AND condition is satisfied if both of its operand conditions are satisfied.

Parameters
in_operand2The condition to AND with this object.
Returns
a new condition representing the logical AND of the operand condition with this object.
static HPS.Condition HPS.Condition.AND ( HPS.Condition  in_operand1,
HPS.Condition  in_operand2 
)
static

An AND condition is satisfied if both of its operand conditions are satisfied.

Parameters
in_operand1The first condition operand.
in_operand2The second condition operand.
Returns
a new condition representing the logical AND of the operand conditions.
bool HPS.Condition.Equals ( HPS.Condition  in_that)

Check if the source object is equivalent to this object.

Parameters
in_thatThe source object to compare to this object.
Returns
true if the objects are equivalent, false otherwise.
static HPS.Condition HPS.Condition.NOT ( HPS.Condition  in_operand)
static

A NOT condition is satisfied if its operand condition is not satisfied.

Parameters
in_operandThe condition operand.
Returns
a new condition representing the logical negation of the operand.
override HPS.Type HPS.Condition.ObjectType ( )
virtual

This function returns the type the object, as declared.

This does not necessarily give the true type of the underlying object.

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS.Object.

HPS.Condition HPS.Condition.OR ( HPS.Condition  in_operand2)

An OR condition is satisfied if either of its operand conditions are satisfied.

Parameters
in_operand2The condition to OR with this object.
Returns
a new condition representing the logical OR of the operand condition with this object.
static HPS.Condition HPS.Condition.OR ( HPS.Condition  in_operand1,
HPS.Condition  in_operand2 
)
static

An OR condition is satisfied if either of its operand conditions are satisfied.

Parameters
in_operand1The first condition operand.
in_operand2The second condition operand.
Returns
a new condition representing the logical OR of the operand conditions.
bool HPS.Condition.ShowCondition ( out string  out_condition)

Shows the condition string that has been set on this object, if any.

A Condition object cannot have both a condition string and operands simultaneously.

Parameters
out_conditionThe condition string.
Returns
true if a a condition string has been set, false otherwise.
bool HPS.Condition.ShowOperands ( out HPS.Condition[]  out_operands)

Retrieves the operands, if any, of this condition object.

A Condition object cannot have both a condition string and operands simultaneously.

Parameters
out_operandsAn array of condition operands.
Returns
true if operands are set on this object, false otherwise.
HPS.Condition HPS.Condition.XOR ( HPS.Condition  in_operand2)

An XOR condition is satisfied if either operand condition is satisfied, but not both.

Parameters
in_operand2The condition to XOR with this object.
Returns
a new condition representing the logical XOR of the operand condition with this object.
static HPS.Condition HPS.Condition.XOR ( HPS.Condition  in_operand1,
HPS.Condition  in_operand2 
)
static

An XOR condition is satisfied if either operand condition is satisfied, but not both.

Parameters
in_operand1The first condition operand.
in_operand2The second condition operand.
Returns
a new condition representing the logical XOR of the operand conditions.

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