#include <sprk.h>
Public Member Functions | |
OperatorControl (View const &in_view) | |
OperatorControl (OperatorControl const &in_that) | |
OperatorControl (OperatorControl &&in_that) | |
OperatorControl & | operator= (OperatorControl &&in_that) |
~OperatorControl () | |
HPS::Type | ObjectType () const |
OperatorControl & | operator= (OperatorControl const &in_that) |
size_t | GetCount () |
size_t | GetCount (Operator::Priority in_priority) |
OperatorControl & | Push (OperatorPtr const &in_operator, Operator::Priority in_priority=Operator::Priority::Normal) |
OperatorControl & | Push (Operator *in_operator, Operator::Priority in_priority=Operator::Priority::Normal) |
bool | Pop (Operator::Priority in_priority=Operator::Priority::Normal) |
bool | Pop (OperatorPtr &out_operator) |
bool | Pop (Operator::Priority in_priority, OperatorPtr &out_operator) |
OperatorControl & | Set (OperatorPtr const &in_operator, Operator::Priority in_priority=Operator::Priority::Normal) |
OperatorControl & | Set (Operator *in_operator, Operator::Priority in_priority=Operator::Priority::Normal) |
OperatorControl & | Set (OperatorPtrArray &in_operators, Operator::Priority in_priority=Operator::Priority::Normal) |
OperatorControl & | Set (size_t in_count, OperatorPtr in_operators[], Operator::Priority in_priority=Operator::Priority::Normal) |
OperatorControl & | UnsetTop (Operator::Priority in_priority=Operator::Priority::Normal) |
OperatorControl & | UnsetEverything (Operator::Priority in_priority) |
OperatorControl & | UnsetEverything () |
bool | ShowTop (OperatorPtr &out_operator) const |
bool | ShowTop (Operator::Priority in_priority, OperatorPtr &out_operator) const |
bool | Show (OperatorPtrArray &out_operators) const |
bool | Show (Operator::Priority in_priority, OperatorPtrArray &out_operators) const |
![]() | |
SprocketControl (HPS::SprocketControl const &in_that)=default | |
![]() | |
Sprocket (HPS::Sprocket const &in_that)=default | |
Sprocket (Sprocket &&in_that) | |
![]() | |
Object (Object const &that) | |
Object & | operator= (Object const &other_object) |
Object (Object &&in_that) | |
Object & | operator= (Object &&in_that) |
HPS::Type | Type () const |
virtual bool | Empty () const |
virtual void | Reset () |
bool | HasType (HPS::Type in_mask) const |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
Additional Inherited Members | |
![]() | |
enum | UpdateType { Synchronous, Asynchronous } |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
![]() | |
SprocketControl (SprocketControl &&in_that) | |
SprocketControl & | operator= (SprocketControl &&in_that) |
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.
|
explicit |
Initializes a control tied to the view in_view.
HPS::OperatorControl::OperatorControl | ( | OperatorControl const & | in_that | ) |
Initializes a control tied to the same object as in_that.
HPS::OperatorControl::OperatorControl | ( | OperatorControl && | in_that | ) |
The move constructor creates a OperatorControl by transferring the underlying impl of the rvalue reference to this OperatorControl thereby avoiding a copy and allocation.
in_that | An rvalue reference to a OperatorControl to take the impl from. |
HPS::OperatorControl::~OperatorControl | ( | ) |
Releases a reference to the database object this control is tied to.
size_t HPS::OperatorControl::GetCount | ( | ) |
Returns the number of operators in use here.
size_t HPS::OperatorControl::GetCount | ( | 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. |
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from HPS::SprocketControl.
OperatorControl& HPS::OperatorControl::operator= | ( | OperatorControl && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this OperatorControl thereby avoiding a copy.
in_that | An rvalue reference to a OperatorControl to take the impl from. |
OperatorControl& HPS::OperatorControl::operator= | ( | OperatorControl const & | in_that | ) |
Share the smart-pointer.
bool HPS::OperatorControl::Pop | ( | Operator::Priority | in_priority = Operator::Priority::Normal | ) |
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 | ( | OperatorPtr & | 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 | ( | Operator::Priority | in_priority, |
OperatorPtr & | 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. |
OperatorControl& HPS::OperatorControl::Push | ( | OperatorPtr const & | in_operator, |
Operator::Priority | in_priority = Operator::Priority::Normal |
||
) |
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. |
OperatorControl& HPS::OperatorControl::Push | ( | Operator * | in_operator, |
Operator::Priority | in_priority = Operator::Priority::Normal |
||
) |
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. |
OperatorControl& HPS::OperatorControl::Set | ( | OperatorPtr const & | in_operator, |
Operator::Priority | in_priority = Operator::Priority::Normal |
||
) |
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. |
OperatorControl& HPS::OperatorControl::Set | ( | Operator * | in_operator, |
Operator::Priority | in_priority = Operator::Priority::Normal |
||
) |
Sets an operator as the only operator in use of the specified priority and assumes control of its memory. This replaces any existing operators 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. |
OperatorControl& HPS::OperatorControl::Set | ( | OperatorPtrArray & | in_operators, |
Operator::Priority | in_priority = Operator::Priority::Normal |
||
) |
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. |
OperatorControl& HPS::OperatorControl::Set | ( | size_t | in_count, |
OperatorPtr | in_operators[], | ||
Operator::Priority | in_priority = Operator::Priority::Normal |
||
) |
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_count | The number of elements in the operator array. |
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. |
bool HPS::OperatorControl::Show | ( | OperatorPtrArray & | out_operators | ) | const |
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 View. |
bool HPS::OperatorControl::Show | ( | Operator::Priority | in_priority, |
OperatorPtrArray & | out_operators | ||
) | const |
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 View. |
bool HPS::OperatorControl::ShowTop | ( | OperatorPtr & | out_operator | ) | const |
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 | ( | Operator::Priority | in_priority, |
OperatorPtr & | out_operator | ||
) | const |
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 |
OperatorControl& HPS::OperatorControl::UnsetEverything | ( | 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. |
OperatorControl& HPS::OperatorControl::UnsetEverything | ( | ) |
Removes all operators from the operator stack of any priority and frees the memory associated with them.
OperatorControl& HPS::OperatorControl::UnsetTop | ( | Operator::Priority | in_priority = Operator::Priority::Normal | ) |
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. |