OperatorControl

class HPS.OperatorControl : public HPS.SprocketControl

The OperatorControl class is a smart pointer that is tied to a database object. This control allows you to add, remove, or otherwise manipulate operators associated with a view.

Public Functions

override void Dispose ()

ulong GetCount ()

Returns the number of operators in use here.

ulong GetCount (HPS.Operator.Priority in_priority)

Returns the number of operators of the specified priority in use here.

Param in_priority

The priority of the operators to be counted.

override HPS.Type ObjectType ()

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

Return

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

OperatorControl (HPS.OperatorControl in_that)

Initializes a control tied to the same object as in_that.

OperatorControl (HPS.View in_view)

Initializes a control tied to the view in_view.

bool Pop ()

Removes the top operator from the operator stack of the specified priority and frees the memory associated with it.

Return

true if an operator was present, false otherwise.

bool Pop (HPS.Operator.Priority in_priority)

Removes the top operator from the operator stack of the specified priority and frees the memory associated with it.

Param in_priority

The priority of the operator to be removed.

Return

true if an operator was present, false otherwise.

bool Pop (HPS.Operator.Priority in_priority, out HPS.Operator out_operator)

Removes the top operator from the operator stack of the specified priority and passes a handle to it to the user. The user is responsible for freeing memory associated with the operator.

Param in_priority

The priority of the operator to be removed.

Param out_operator

A handle to the top operator, passed to the user.

Return

true if an operator was present, false otherwise.

bool Pop (out HPS.Operator out_operator)

Removes the top operator from the Normal priority operator stack and passes a handle to it to the user. The user is responsible for freeing memory associated with the operator.

Param out_operator

A handle to the top operator, passed to the user.

Return

true if an operator was present, false otherwise.

HPS.OperatorControl Push (HPS.Operator in_operator)

Adds an operator to the top of the operator stack within its priority and assumes control of its memory. Existing operators in use are unmodified but operators on top get priority.

Param in_operator

The operator to push to the top of the operator stack.

Return

A reference to this object.

HPS.OperatorControl Push (HPS.Operator in_operator, HPS.Operator.Priority in_priority)

Adds an operator to the top of the operator stack within its priority and assumes control of its memory. Existing operators in use are unmodified but operators on top get priority.

Param in_operator

The operator to push to the top of the operator stack.

Param in_priority

The priority of the operator. All those with Low priority will be below all those with Normal priority which will, in turn, be below High priority operators.

Return

A reference to this object.

HPS.OperatorControl Set (HPS.Operator in_operator)

Sets an operator as the only operator in use of the specified priority and assumes control of its memory. This replaces any existing operators of the same priority in use and frees the memory associated with them.

Param in_operator

An operator to use on this view.

Return

A reference to this object.

HPS.OperatorControl Set (HPS.Operator in_operator, HPS.Operator.Priority in_priority)

Sets an operator as the only operator in use of the specified priority and assumes control of its memory. This replaces any existing operators of the same priority in use and frees the memory associated with them.

Param in_operator

An operator to use on this view.

Param in_priority

The priority of the operator. All those with Low priority will be below all those with Normal priority which will, in turn, be below High priority operators.

Return

A reference to this object.

HPS.OperatorControl Set (HPS.Operator[] in_operators)

Sets a collection of operators as the only operators in use of the specified priority and assumes control of their memory. This replaces any existing operators in use and frees the memory associated with them.

Param in_operators

An array of source operators to be used.

Return

A reference to this object.

HPS.OperatorControl Set (HPS.Operator[] in_operators, HPS.Operator.Priority in_priority)

Sets a collection of operators as the only operators in use of the specified priority and assumes control of their memory. This replaces any existing operators in use and frees the memory associated with them.

Param in_operators

An array of source operators to be used.

Param in_priority

The priority of the operators. All those with Low priority will be below all those with Normal priority which will, in turn, be below High priority operators.

Return

A reference to this object.

bool Show (HPS.Operator.Priority in_priority, out HPS.Operator[] out_operators)

Shows all operators in use on this segment of the specified priority. The operator stack is unmodified.

Param in_priority

The priority of the operators to be shown.

Param out_operators

Handles to all operators of the specified priority used by this View.

Return

true if any operator was present, false otherwise.

bool Show (out HPS.Operator[] out_operators)

Shows all Normal priority operators in use on this segment. The operator stack is unmodified.

Param out_operators

Handles to all Normal priority operators used by this View.

Return

true if any operator was present, false otherwise.

bool ShowTop (HPS.Operator.Priority in_priority, out HPS.Operator out_operator)

Shows the top operator on the operator stack of the specified priority. The operator stack is unmodified.

Param in_priority

The priority of the operator to be shown.

Param out_operator

The operator at the top of the operator stack

Return

true if an operator was present, false otherwise.

bool ShowTop (out HPS.Operator out_operator)

Shows the top operator on the Normal priority operator stack. The operator stack is unmodified.

Param out_operator

The operator at the top of the operator stack

Return

true if an operator was present, false otherwise.

HPS.OperatorControl UnsetEverything ()

Removes all operators from the operator stack of any priority and frees the memory associated with them.

Return

A reference to this object.

HPS.OperatorControl UnsetEverything (HPS.Operator.Priority in_priority)

Removes all operators from the operator stack of the specified priority and frees the memory associated with them.

Param in_priority

The priority of the operator to be removed.

Return

A reference to this object.

HPS.OperatorControl UnsetTop ()

Removes the top operator from the operator stack of the specified priority and frees the memory associated with it.

Return

A reference to this object.

HPS.OperatorControl UnsetTop (HPS.Operator.Priority in_priority)

Removes the top operator from the operator stack of the specified priority and frees the memory associated with it.

Param in_priority

The priority of the operator to be removed.

Return

A reference to this object.