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

Public Member Functions

override void Dispose ()
 
ulong GetCount ()
 
ulong GetCount (HPS.Operator.Priority in_priority)
 
override HPS.Type ObjectType ()
 
 OperatorControl (HPS.View in_view)
 
 OperatorControl (HPS.OperatorControl in_that)
 
bool Pop (HPS.Operator.Priority in_priority)
 
bool Pop ()
 
bool Pop (out HPS.Operator out_operator)
 
bool Pop (HPS.Operator.Priority in_priority, out HPS.Operator out_operator)
 
HPS.OperatorControl Push (HPS.Operator in_operator, HPS.Operator.Priority in_priority)
 
HPS.OperatorControl Push (HPS.Operator in_operator)
 
HPS.OperatorControl Set (HPS.Operator in_operator, HPS.Operator.Priority in_priority)
 
HPS.OperatorControl Set (HPS.Operator in_operator)
 
HPS.OperatorControl Set (HPS.Operator[] in_operators, HPS.Operator.Priority in_priority)
 
HPS.OperatorControl Set (HPS.Operator[] in_operators)
 
bool Show (out HPS.Operator[] out_operators)
 
bool Show (HPS.Operator.Priority in_priority, out HPS.Operator[] out_operators)
 
bool ShowTop (out HPS.Operator out_operator)
 
bool ShowTop (HPS.Operator.Priority in_priority, out HPS.Operator out_operator)
 
HPS.OperatorControl UnsetEverything (HPS.Operator.Priority in_priority)
 
HPS.OperatorControl UnsetEverything ()
 
HPS.OperatorControl UnsetTop (HPS.Operator.Priority in_priority)
 
HPS.OperatorControl UnsetTop ()
 
- 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 ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

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

◆ OperatorControl() [1/2]

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

Initializes a control tied to the view in_view.

◆ OperatorControl() [2/2]

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

Initializes a control tied to the same object as in_that.

Member Function Documentation

◆ GetCount() [1/2]

ulong HPS.OperatorControl.GetCount ( )
inline

Returns the number of operators in use here.

◆ GetCount() [2/2]

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.

◆ ObjectType()

override HPS.Type HPS.OperatorControl.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.

◆ Pop() [1/4]

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.

◆ Pop() [2/4]

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.

◆ Pop() [3/4]

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.

◆ Pop() [4/4]

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.

◆ Push() [1/2]

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.

◆ Push() [2/2]

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.

◆ Set() [1/4]

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.

◆ Set() [2/4]

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.

◆ Set() [3/4]

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.

◆ Set() [4/4]

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.

◆ Show() [1/2]

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.

◆ Show() [2/2]

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.

◆ ShowTop() [1/2]

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.

◆ ShowTop() [2/2]

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.

◆ UnsetEverything() [1/2]

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.

◆ UnsetEverything() [2/2]

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.

◆ UnsetTop() [1/2]

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.

◆ UnsetTop() [2/2]

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