API Search || Global Search

More...

Inheritance diagram for HPS.OperatorControl:
HPS.SprocketControl HPS.Sprocket HPS.Object

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 ()
 
 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. The user is responsible for freeing memory associated with the operator. 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. The user is responsible for freeing memory associated with the operator. 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. Existing operators in use are unmodified but operators on top get priority. 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. Existing operators in use are unmodified but operators on top get priority. 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. This replaces any existing operators of the same priority in use and frees the memory associated with them. 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. This replaces any existing operators of the same priority in use and frees the memory associated with them. 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. This replaces any existing operators in use and frees the memory associated with them. 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. This replaces any existing operators in use and frees the memory associated with them. More...
 
bool Show (out HPS.Operator[] out_operators)
 Shows all Normal priority operators in use on this segment. The operator stack is unmodified. 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. The operator stack is unmodified. More...
 
bool ShowTop (out HPS.Operator out_operator)
 Shows the top operator on the Normal priority operator stack. The operator stack is unmodified. 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. The operator stack is unmodified. 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...
 
- Public Member Functions inherited from HPS.SprocketControl
override void Dispose ()
 
override HPS.Type ObjectType ()
 
 SprocketControl (HPS.SprocketControl in_that)
 
- Public Member Functions inherited from HPS.Sprocket
 Sprocket (HPS.Sprocket in_that)
 
- 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. Different keys and controls will return the same value if they are backed by the same database resource. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object that)
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
virtual 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...
 

Protected Member Functions

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

Additional Inherited Members

- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

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.

Constructor & Destructor Documentation

HPS.OperatorControl.OperatorControl ( HPS.View  in_view)
inline

Initializes a control tied to the view in_view.

HPS.OperatorControl.OperatorControl ( HPS.OperatorControl  in_that)
inline

Initializes a control tied to the same object as in_that.

Member Function Documentation

ulong HPS.OperatorControl.GetCount ( )
inline

Returns the number of operators in use here.

ulong HPS.OperatorControl.GetCount ( HPS.Operator.Priority  in_priority)
inline

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

Parameters
in_priorityThe priority of the operators to be counted.
bool HPS.OperatorControl.Pop ( HPS.Operator.Priority  in_priority)
inline

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

Parameters
in_priorityThe priority of the operator to be removed.
Returns
    true if an operator was present, false otherwise.
bool HPS.OperatorControl.Pop ( )
inline

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

Returns
    true if an operator was present, false otherwise.
bool HPS.OperatorControl.Pop ( out HPS.Operator  out_operator)
inline

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.

Parameters
out_operatorA handle to the top operator, passed to the user.
Returns
    true if an operator was present, false otherwise.
bool HPS.OperatorControl.Pop ( HPS.Operator.Priority  in_priority,
out HPS.Operator  out_operator 
)
inline

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.

Parameters
in_priorityThe priority of the operator to be removed.
out_operatorA handle to the top operator, passed to the user.
Returns
    true if an operator was present, false otherwise.
HPS.OperatorControl HPS.OperatorControl.Push ( HPS.Operator  in_operator,
HPS.Operator.Priority  in_priority 
)
inline

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.

Parameters
in_operatorThe operator to push to the top of the operator stack.
in_priorityThe 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.
Returns
    A reference to this object.
HPS.OperatorControl HPS.OperatorControl.Push ( HPS.Operator  in_operator)
inline

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.

Parameters
in_operatorThe operator to push to the top of the operator stack.
Returns
    A reference to this object.
HPS.OperatorControl HPS.OperatorControl.Set ( HPS.Operator  in_operator,
HPS.Operator.Priority  in_priority 
)
inline

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.

Parameters
in_operatorAn operator to use on this view.
in_priorityThe 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.
Returns
    A reference to this object.
HPS.OperatorControl HPS.OperatorControl.Set ( HPS.Operator  in_operator)
inline

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.

Parameters
in_operatorAn operator to use on this view.
Returns
    A reference to this object.
HPS.OperatorControl HPS.OperatorControl.Set ( HPS.Operator[]  in_operators,
HPS.Operator.Priority  in_priority 
)
inline

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.

Parameters
in_operatorsAn array of source operators to be used.
in_priorityThe 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.
Returns
    A reference to this object.
HPS.OperatorControl HPS.OperatorControl.Set ( HPS.Operator[]  in_operators)
inline

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.

Parameters
in_operatorsAn array of source operators to be used.
Returns
    A reference to this object.
bool HPS.OperatorControl.Show ( out HPS.Operator[]  out_operators)
inline

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

Parameters
out_operatorsHandles to all Normal priority operators used by this View.
Returns
    true if any operator was present, false otherwise.
bool HPS.OperatorControl.Show ( HPS.Operator.Priority  in_priority,
out HPS.Operator[]  out_operators 
)
inline

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

Parameters
in_priorityThe priority of the operators to be shown.
out_operatorsHandles to all operators of the specified priority used by this View.
Returns
    true if any operator was present, false otherwise.
bool HPS.OperatorControl.ShowTop ( out HPS.Operator  out_operator)
inline

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

Parameters
out_operatorThe operator at the top of the operator stack
Returns
    true if an operator was present, false otherwise.
bool HPS.OperatorControl.ShowTop ( HPS.Operator.Priority  in_priority,
out HPS.Operator  out_operator 
)
inline

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

Parameters
in_priorityThe priority of the operator to be shown.
out_operatorThe operator at the top of the operator stack
Returns
    true if an operator was present, false otherwise.
HPS.OperatorControl HPS.OperatorControl.UnsetEverything ( HPS.Operator.Priority  in_priority)
inline

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

Parameters
in_priorityThe priority of the operator to be removed.
Returns
    A reference to this object.
HPS.OperatorControl HPS.OperatorControl.UnsetEverything ( )
inline

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

Returns
    A reference to this object.
HPS.OperatorControl HPS.OperatorControl.UnsetTop ( HPS.Operator.Priority  in_priority)
inline

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

Parameters
in_priorityThe priority of the operator to be removed.
Returns
    A reference to this object.
HPS.OperatorControl HPS.OperatorControl.UnsetTop ( )
inline

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

Returns
    A reference to this object.

The documentation for this class was generated from the following file:
  • internals/hps_sprk/source/cs/HPS.OperatorControl.cs