Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
HPS.Condition Class Reference

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. More...

Inheritance diagram for HPS.Condition:
HPS.Object

Public Types

enum  Intrinsic { Extent = 0, DrawPass = 1 }
 

Public Member Functions

override void Dispose ()
 
 Condition (string in_utf8)
 This constructor is the way to construct a Condition object from a string. More...
 
 Condition (float in_number)
 This constructor is the way to construct a Condition object from a number. More...
 
 Condition (HPS.Condition.Intrinsic in_special)
 This constructor is the way to construct a Condition object from a special intrinsic type. More...
 
 Condition (HPS.Condition in_that)
 The copy constructor copies the source condition. More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More...
 
bool ShowCondition (out string out_condition)
 Shows the condition string that has been set on this object, if any. A Condition object can only have either a number, condition string, intrinsic type, or operands. More...
 
bool ShowNumber (out float out_number)
 Shows the number that has been set on this object, if any. A Condition object can only have either a number, condition string, intrinsic type, or operands. More...
 
bool ShowIntrinsic (out HPS.Condition.Intrinsic out_special)
 Shows the intrinsic type that has been set on this object, if any. A Condition object can only have either a number, condition string, intrinsic type, or operands. More...
 
bool ShowOperands (out HPS.Condition[] out_operands)
 Retrieves the operands, if any, of this condition object. A Condition object can only have either a number, condition string, intrinsic type, or operands. More...
 
override bool Equals (System.Object obj)
 
override int GetHashCode ()
 
bool Equals (HPS.Condition in_that)
 Check if the source object is equivalent to this object. More...
 
bool IsSatisfiedBy (string[] in_conditions)
 Determines if the source Condition object is satisfied by the given conditions. More...
 
bool IsSatisfiedBy (string in_condition)
 Determines if the source Condition object is satisfied by the given condition. More...
 
HPS.Condition OR (HPS.Condition in_operand2)
 An OR condition is satisfied if either of its operand conditions are satisfied. More...
 
HPS.Condition XOR (HPS.Condition in_operand2)
 An XOR condition is satisfied if either operand condition is satisfied, but not both. More...
 
HPS.Condition AND (HPS.Condition in_operand2)
 An AND condition is satisfied if both of its operand conditions are satisfied. More...
 
HPS.Condition EQ (HPS.Condition in_operand2)
 An EQ conditional expression is satisfied if its operand expressions are equal. More...
 
HPS.Condition NEQ (HPS.Condition in_operand2)
 An NEQ conditional expression is satisfied if its operand expressions are not equal. More...
 
HPS.Condition GT (HPS.Condition in_operand2)
 An GT conditional expression is satisfied if its second operand is greater than the first operand. More...
 
HPS.Condition LT (HPS.Condition in_operand2)
 An LT conditional expression is satisfied if its second operand is less than the first operand. More...
 
HPS.Condition GTEQ (HPS.Condition in_operand2)
 An GTEQ conditional expression is satisfied if its second operand is greater than or equal to the first operand. More...
 
HPS.Condition LTEQ (HPS.Condition in_operand2)
 An LTEQ conditional expression is satisfied if its second operand is less than or equal to the first operand. More...
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
 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...
 
HPS.Type Type ()
 This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More...
 
virtual bool Empty ()
 Indicates whether this object has any values set on it. More...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More...
 

Static Public Member Functions

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 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 EQ (HPS.Condition in_operand1, HPS.Condition in_operand2)
 An EQ conditional expression is satisfied if its operand expressions are equal. More...
 
static HPS.Condition NEQ (HPS.Condition in_operand1, HPS.Condition in_operand2)
 An NEQ conditional expression is satisfied if its operand expressions are not equal. More...
 
static HPS.Condition GT (HPS.Condition in_operand1, HPS.Condition in_operand2)
 An GT conditional expression is satisfied if its second operand is greater than the first operand. More...
 
static HPS.Condition LT (HPS.Condition in_operand1, HPS.Condition in_operand2)
 An LT conditional expression is satisfied if its second operand is less than the first operand. More...
 
static HPS.Condition GTEQ (HPS.Condition in_operand1, HPS.Condition in_operand2)
 An GTEQ conditional expression is satisfied if its second operand is greater than or equal to the first operand. More...
 
static HPS.Condition LTEQ (HPS.Condition in_operand1, HPS.Condition in_operand2)
 An LTEQ conditional expression is satisfied if its second operand is less than or equal to the first operand. More...
 
static HPS.Condition NOT (HPS.Condition in_operand)
 A NOT condition is satisfied if its operand condition is not satisfied. 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
HandleRef cptr
 
HandleRef scptr
 
bool cMemOwn
 

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)
inline

This constructor is the 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 ( float  in_number)
inline

This constructor is the way to construct a Condition object from a number.

HPS.Condition.Condition ( HPS.Condition.Intrinsic  in_special)
inline

This constructor is the way to construct a Condition object from a special intrinsic type.

Parameters
in_specialThe intrinsic type to use as the condition.
HPS.Condition.Condition ( HPS.Condition  in_that)
inline

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)
inline

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 
)
inlinestatic

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.
HPS.Condition HPS.Condition.EQ ( HPS.Condition  in_operand2)
inline

An EQ conditional expression is satisfied if its operand expressions are equal.

Parameters
in_operand2The expression to compare to this object.
Returns
a new conditional expression representing the equality comparison of the operand expression with this object.
static HPS.Condition HPS.Condition.EQ ( HPS.Condition  in_operand1,
HPS.Condition  in_operand2 
)
inlinestatic

An EQ conditional expression is satisfied if its operand expressions are equal.

Parameters
in_operand1The first condition operand.
in_operand2The second condition operand.
Returns
a new conditional expression representing the equality comparison of the operand expressions.
bool HPS.Condition.Equals ( HPS.Condition  in_that)
inline

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.
HPS.Condition HPS.Condition.GT ( HPS.Condition  in_operand2)
inline

An GT conditional expression is satisfied if its second operand is greater than the first operand.

Parameters
in_operand2The expression to compare to this object.
Returns
a new conditional expression representing the greater than comparison of the operand expression with this object.
static HPS.Condition HPS.Condition.GT ( HPS.Condition  in_operand1,
HPS.Condition  in_operand2 
)
inlinestatic

An GT conditional expression is satisfied if its second operand is greater than the first operand.

Parameters
in_operand1The first condition operand.
in_operand2The second condition operand.
Returns
a new conditional expression representing the greater than comparison of the operand expressions.
HPS.Condition HPS.Condition.GTEQ ( HPS.Condition  in_operand2)
inline

An GTEQ conditional expression is satisfied if its second operand is greater than or equal to the first operand.

Parameters
in_operand2The expression to compare to this object.
Returns
a new conditional expression representing the greater than or equal to comparison of the operand expression with this object.
static HPS.Condition HPS.Condition.GTEQ ( HPS.Condition  in_operand1,
HPS.Condition  in_operand2 
)
inlinestatic

An GTEQ conditional expression is satisfied if its second operand is greater than or equal to the first operand.

Parameters
in_operand1The first condition operand.
in_operand2The second condition operand.
Returns
a new conditional expression representing the greater than or equal to comparison of the operands.
bool HPS.Condition.IsSatisfiedBy ( string[]  in_conditions)
inline

Determines if the source Condition object is satisfied by the given conditions.

Parameters
in_conditionsThe conditions to test against the <ref refid="class_h_p_s_1_1_condition" kindref="compound">Condition</ref> object.
Returns
true if the Condition object is satisfied, false otherwise.
bool HPS.Condition.IsSatisfiedBy ( string  in_condition)
inline

Determines if the source Condition object is satisfied by the given condition.

Parameters
in_conditionThe condition to test against the <ref refid="class_h_p_s_1_1_condition" kindref="compound">Condition</ref> object.
Returns
true if the Condition object is satisfied, false otherwise.
HPS.Condition HPS.Condition.LT ( HPS.Condition  in_operand2)
inline

An LT conditional expression is satisfied if its second operand is less than the first operand.

Parameters
in_operand2The expression to compare to this object.
Returns
a new conditional expression representing the less than comparison of the operand expression with this object.
static HPS.Condition HPS.Condition.LT ( HPS.Condition  in_operand1,
HPS.Condition  in_operand2 
)
inlinestatic

An LT conditional expression is satisfied if its second operand is less than the first operand.

Parameters
in_operand1The first condition operand.
in_operand2The second condition operand.
Returns
a new conditional expression representing the less than comparison of the operand expressions.
HPS.Condition HPS.Condition.LTEQ ( HPS.Condition  in_operand2)
inline

An LTEQ conditional expression is satisfied if its second operand is less than or equal to the first operand.

Parameters
in_operand2The expression to compare to this object.
Returns
a new conditional expression representing the less than or equal to comparison of the operand expression with this object.
static HPS.Condition HPS.Condition.LTEQ ( HPS.Condition  in_operand1,
HPS.Condition  in_operand2 
)
inlinestatic

An LTEQ conditional expression is satisfied if its second operand is less than or equal to the first operand.

Parameters
in_operand1The first condition operand.
in_operand2The second condition operand.
Returns
a new conditional expression representing the less than or equal to comparison of the operand expressions.
HPS.Condition HPS.Condition.NEQ ( HPS.Condition  in_operand2)
inline

An NEQ conditional expression is satisfied if its operand expressions are not equal.

Parameters
in_operand2The expression to compare to this object.
Returns
a new conditional expression representing the non-equality comparison of the operand expression with this object.
static HPS.Condition HPS.Condition.NEQ ( HPS.Condition  in_operand1,
HPS.Condition  in_operand2 
)
inlinestatic

An NEQ conditional expression is satisfied if its operand expressions are not equal.

Parameters
in_operand1The first condition operand.
in_operand2The second condition operand.
Returns
a new conditional expression representing the non-equality comparison of the operand expressions.
static HPS.Condition HPS.Condition.NOT ( HPS.Condition  in_operand)
inlinestatic

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 ( )
inlinevirtual

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)
inline

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 
)
inlinestatic

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)
inline

Shows the condition string that has been set on this object, if any. A Condition object can only have either a number, condition string, intrinsic type, or operands.

Parameters
out_conditionThe condition string.
Returns
true if a condition string has been set, false otherwise.
bool HPS.Condition.ShowIntrinsic ( out HPS.Condition.Intrinsic  out_special)
inline

Shows the intrinsic type that has been set on this object, if any. A Condition object can only have either a number, condition string, intrinsic type, or operands.

Parameters
out_specialThe intrinsic type.
Returns
true if an intrinsic type has been set, false otherwise.
bool HPS.Condition.ShowNumber ( out float  out_number)
inline

Shows the number that has been set on this object, if any. A Condition object can only have either a number, condition string, intrinsic type, or operands.

Parameters
out_numberThe number.
Returns
true if a number has been set, false otherwise.
bool HPS.Condition.ShowOperands ( out HPS.Condition[]  out_operands)
inline

Retrieves the operands, if any, of this condition object. A Condition object can only have either a number, condition string, intrinsic type, or operands.

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)
inline

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 
)
inlinestatic

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: