REFERENCE MANUAL
The OperatorControl class is a smart pointer that is tied to a database object. More...
Public Member Functions | |
override void | Dispose () |
ulong | GetCount () |
Returns the number of operators in use here. More... | |
ulong | GetCount (HPS.Operator.Priority in_priority) |
Returns the number of operators of the specified priority in use here. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
OperatorControl (HPS.View in_view) | |
Initializes a control tied to the view in_view. More... | |
OperatorControl (HPS.OperatorControl in_that) | |
Initializes a control tied to the same object as in_that. More... | |
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. More... | |
bool | Pop () |
Removes the top operator from the operator stack of the specified priority and frees the memory associated with it. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
bool | Show (out HPS.Operator[] out_operators) |
Shows all Normal priority operators in use on this segment. More... | |
bool | Show (HPS.Operator.Priority in_priority, out HPS.Operator[] out_operators) |
Shows all operators in use on this segment of the specified priority. More... | |
bool | ShowTop (out HPS.Operator out_operator) |
Shows the top operator on the Normal priority operator stack. More... | |
bool | ShowTop (HPS.Operator.Priority in_priority, out HPS.Operator out_operator) |
Shows the top operator on the operator stack of the specified priority. More... | |
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. More... | |
HPS.OperatorControl | UnsetEverything () |
Removes all operators from the operator stack of any priority and frees the memory associated with them. More... | |
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. More... | |
HPS.OperatorControl | UnsetTop () |
Removes the top operator from the operator stack of the specified priority and frees the memory associated with it. More... | |
![]() | |
override void | Dispose () |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
SprocketControl (HPS.SprocketControl in_that) | |
![]() | |
Sprocket (HPS.Sprocket in_that) | |
![]() | |
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... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
enum | UpdateType { Synchronous = 0, Asynchronous = 1 } |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
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.
HPS.OperatorControl.OperatorControl | ( | HPS.View | in_view | ) |
Initializes a control tied to the view in_view.
HPS.OperatorControl.OperatorControl | ( | HPS.OperatorControl | in_that | ) |
Initializes a control tied to the same object as in_that.
ulong HPS.OperatorControl.GetCount | ( | ) |
Returns the number of operators in use here.
ulong HPS.OperatorControl.GetCount | ( | HPS.Operator.Priority | in_priority | ) |
Returns the number of operators of the specified priority in use here.
in_priority | The priority of the operators to be counted. |
|
virtual |
This function returns the type the object, as declared.
This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
bool HPS.OperatorControl.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.
in_priority | The priority of the operator to be removed. |
bool HPS.OperatorControl.Pop | ( | ) |
Removes the top operator from the operator stack of the specified priority and frees the memory associated with it.
bool HPS.OperatorControl.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.
out_operator | A handle to the top operator, passed to the user. |
bool HPS.OperatorControl.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.
in_priority | The priority of the operator to be removed. |
out_operator | A handle to the top operator, passed to the user. |
HPS.OperatorControl 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.
in_operator | The operator to push to the top of the operator stack. |
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. |
HPS.OperatorControl 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.
in_operator | The operator to push to the top of the operator stack. |
HPS.OperatorControl 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.
in_operator | An operator to use on this view. |
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. |
HPS.OperatorControl 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.
in_operator | An operator to use on this view. |
HPS.OperatorControl 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.
in_operators | An array of source operators to be used. |
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. |
HPS.OperatorControl 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.
in_operators | An array of source operators to be used. |
bool HPS.OperatorControl.Show | ( | out HPS.Operator[] | out_operators | ) |
Shows all Normal priority operators in use on this segment.
The operator stack is unmodified.
out_operators | Handles to all Normal priority operators used by this <ref refid="class_h_p_s_1_1_view" kindref="compound">View</ref>. |
bool HPS.OperatorControl.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.
in_priority | The priority of the operators to be shown. |
out_operators | Handles to all operators of the specified priority used by this <ref refid="class_h_p_s_1_1_view" kindref="compound">View</ref>. |
bool HPS.OperatorControl.ShowTop | ( | out HPS.Operator | out_operator | ) |
Shows the top operator on the Normal priority operator stack.
The operator stack is unmodified.
out_operator | The operator at the top of the operator stack |
bool HPS.OperatorControl.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.
in_priority | The priority of the operator to be shown. |
out_operator | The operator at the top of the operator stack |
HPS.OperatorControl 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.
in_priority | The priority of the operator to be removed. |
HPS.OperatorControl HPS.OperatorControl.UnsetEverything | ( | ) |
Removes all operators from the operator stack of any priority and frees the memory associated with them.
HPS.OperatorControl 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.
in_priority | The priority of the operator to be removed. |
HPS.OperatorControl HPS.OperatorControl.UnsetTop | ( | ) |
Removes the top operator from the operator stack of the specified priority and frees the memory associated with it.