Inheritance diagram for HPS.ConditionalExpression:
HPS.Object

Public Member Functions

HPS.ConditionalExpression AND (HPS.ConditionalExpression in_operand2)
 
 ConditionalExpression (string in_condition)
 
 ConditionalExpression (float in_number)
 
 ConditionalExpression (HPS.Condition.Intrinsic in_special)
 
 ConditionalExpression (HPS.ConditionalExpression in_that)
 
override void Dispose ()
 
HPS.ConditionalExpression EQ (HPS.ConditionalExpression in_operand2)
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.ConditionalExpression in_that)
 
override int GetHashCode ()
 
HPS.ConditionalExpression GT (HPS.ConditionalExpression in_operand2)
 
HPS.ConditionalExpression GTEQ (HPS.ConditionalExpression in_operand2)
 
bool IsSatisfiedBy (string[] in_conditions)
 
bool IsSatisfiedBy (string in_condition)
 
HPS.ConditionalExpression LT (HPS.ConditionalExpression in_operand2)
 
HPS.ConditionalExpression LTEQ (HPS.ConditionalExpression in_operand2)
 
HPS.ConditionalExpression NEQ (HPS.ConditionalExpression in_operand2)
 
override HPS.Type ObjectType ()
 
HPS.ConditionalExpression OR (HPS.ConditionalExpression in_operand2)
 
bool ShowCondition (out string out_condition)
 
bool ShowIntrinsic (out HPS.Condition.Intrinsic out_special)
 
bool ShowNumber (out float out_number)
 
bool ShowOperands (out HPS.ConditionalExpression[] out_operands)
 
HPS.ConditionalExpression XOR (HPS.ConditionalExpression in_operand2)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

Static Public Member Functions

static HPS.ConditionalExpression AND (HPS.ConditionalExpression in_operand1, HPS.ConditionalExpression in_operand2)
 
static HPS.ConditionalExpression EQ (HPS.ConditionalExpression in_operand1, HPS.ConditionalExpression in_operand2)
 
static HPS.ConditionalExpression GT (HPS.ConditionalExpression in_operand1, HPS.ConditionalExpression in_operand2)
 
static HPS.ConditionalExpression GTEQ (HPS.ConditionalExpression in_operand1, HPS.ConditionalExpression in_operand2)
 
static HPS.ConditionalExpression LT (HPS.ConditionalExpression in_operand1, HPS.ConditionalExpression in_operand2)
 
static HPS.ConditionalExpression LTEQ (HPS.ConditionalExpression in_operand1, HPS.ConditionalExpression in_operand2)
 
static HPS.ConditionalExpression NEQ (HPS.ConditionalExpression in_operand1, HPS.ConditionalExpression in_operand2)
 
static HPS.ConditionalExpression NOT (HPS.ConditionalExpression in_operand)
 
static bool operator!= (HPS.ConditionalExpression a, HPS.ConditionalExpression b)
 
static bool operator== (HPS.ConditionalExpression a, HPS.ConditionalExpression b)
 
static HPS.ConditionalExpression OR (HPS.ConditionalExpression in_operand1, HPS.ConditionalExpression in_operand2)
 
static HPS.ConditionalExpression XOR (HPS.ConditionalExpression in_operand1, HPS.ConditionalExpression in_operand2)
 
- 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
 

Detailed Description

A ConditionalExpression is a string or collection of strings separated by logical operators. In practice, conditional expressions form a tree with the leaves being strings (the actual Conditions that must be satisfied) and the interior nodes being logical operators.

Constructor & Destructor Documentation

◆ ConditionalExpression() [1/4]

HPS.ConditionalExpression.ConditionalExpression ( string  in_condition)
inline

This constructor is the way to construct a ConditionalExpression object from a string.

Parameters
in_conditionThe string to use as the condition, assumed to be utf8 encoded.

◆ ConditionalExpression() [2/4]

HPS.ConditionalExpression.ConditionalExpression ( float  in_number)
inline

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

◆ ConditionalExpression() [3/4]

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

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

Parameters
in_specialThe intrinsic type to use as the condition.

◆ ConditionalExpression() [4/4]

HPS.ConditionalExpression.ConditionalExpression ( HPS.ConditionalExpression  in_that)
inline

The copy constructor copies the source condition.

Parameters
in_thatthe source to be copied.

Member Function Documentation

◆ AND() [1/2]

HPS.ConditionalExpression HPS.ConditionalExpression.AND ( HPS.ConditionalExpression  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.

◆ AND() [2/2]

static HPS.ConditionalExpression HPS.ConditionalExpression.AND ( HPS.ConditionalExpression  in_operand1,
HPS.ConditionalExpression  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.

◆ EQ() [1/2]

HPS.ConditionalExpression HPS.ConditionalExpression.EQ ( HPS.ConditionalExpression  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.

◆ EQ() [2/2]

static HPS.ConditionalExpression HPS.ConditionalExpression.EQ ( HPS.ConditionalExpression  in_operand1,
HPS.ConditionalExpression  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.

◆ Equals()

bool HPS.ConditionalExpression.Equals ( HPS.ConditionalExpression  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.

◆ GT() [1/2]

HPS.ConditionalExpression HPS.ConditionalExpression.GT ( HPS.ConditionalExpression  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.

◆ GT() [2/2]

static HPS.ConditionalExpression HPS.ConditionalExpression.GT ( HPS.ConditionalExpression  in_operand1,
HPS.ConditionalExpression  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.

◆ GTEQ() [1/2]

HPS.ConditionalExpression HPS.ConditionalExpression.GTEQ ( HPS.ConditionalExpression  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.

◆ GTEQ() [2/2]

static HPS.ConditionalExpression HPS.ConditionalExpression.GTEQ ( HPS.ConditionalExpression  in_operand1,
HPS.ConditionalExpression  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.

◆ IsSatisfiedBy() [1/2]

bool HPS.ConditionalExpression.IsSatisfiedBy ( string []  in_conditions)
inline

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

Parameters
in_conditionsThe conditions to test against the ConditionalExpression object.
Returns
true if the ConditionalExpression object is satisfied, false otherwise.

◆ IsSatisfiedBy() [2/2]

bool HPS.ConditionalExpression.IsSatisfiedBy ( string  in_condition)
inline

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

Parameters
in_conditionThe condition to test against the ConditionalExpression object.
Returns
true if the ConditionalExpression object is satisfied, false otherwise.

◆ LT() [1/2]

HPS.ConditionalExpression HPS.ConditionalExpression.LT ( HPS.ConditionalExpression  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.

◆ LT() [2/2]

static HPS.ConditionalExpression HPS.ConditionalExpression.LT ( HPS.ConditionalExpression  in_operand1,
HPS.ConditionalExpression  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.

◆ LTEQ() [1/2]

HPS.ConditionalExpression HPS.ConditionalExpression.LTEQ ( HPS.ConditionalExpression  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.

◆ LTEQ() [2/2]

static HPS.ConditionalExpression HPS.ConditionalExpression.LTEQ ( HPS.ConditionalExpression  in_operand1,
HPS.ConditionalExpression  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.

◆ NEQ() [1/2]

HPS.ConditionalExpression HPS.ConditionalExpression.NEQ ( HPS.ConditionalExpression  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.

◆ NEQ() [2/2]

static HPS.ConditionalExpression HPS.ConditionalExpression.NEQ ( HPS.ConditionalExpression  in_operand1,
HPS.ConditionalExpression  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.

◆ NOT()

static HPS.ConditionalExpression HPS.ConditionalExpression.NOT ( HPS.ConditionalExpression  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.

◆ ObjectType()

override HPS.Type HPS.ConditionalExpression.ObjectType ( )
inlinevirtual

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

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

Reimplemented from HPS.Object.

◆ OR() [1/2]

HPS.ConditionalExpression HPS.ConditionalExpression.OR ( HPS.ConditionalExpression  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.

◆ OR() [2/2]

static HPS.ConditionalExpression HPS.ConditionalExpression.OR ( HPS.ConditionalExpression  in_operand1,
HPS.ConditionalExpression  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.

◆ ShowCondition()

bool HPS.ConditionalExpression.ShowCondition ( out string  out_condition)
inline

Shows the condition string that has been set on this object, if any. A ConditionalExpression 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.

◆ ShowIntrinsic()

bool HPS.ConditionalExpression.ShowIntrinsic ( out HPS.Condition.Intrinsic  out_special)
inline

Shows the intrinsic type that has been set on this object, if any. A ConditionalExpression 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.

◆ ShowNumber()

bool HPS.ConditionalExpression.ShowNumber ( out float  out_number)
inline

Shows the number that has been set on this object, if any. A ConditionalExpression 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.

◆ ShowOperands()

bool HPS.ConditionalExpression.ShowOperands ( out HPS.ConditionalExpression []  out_operands)
inline

Retrieves the operands, if any, of this condition object. A ConditionalExpression 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.

◆ XOR() [1/2]

HPS.ConditionalExpression HPS.ConditionalExpression.XOR ( HPS.ConditionalExpression  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.

◆ XOR() [2/2]

static HPS.ConditionalExpression HPS.ConditionalExpression.XOR ( HPS.ConditionalExpression  in_operand1,
HPS.ConditionalExpression  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:
  • internals/hps_core/source/cs/HPS.ConditionalExpression.cs