#include <sprk.h>

Public Member Functions | |
size_t | GetCount () |
size_t | GetCount (Operator::Priority in_priority) |
HPS::Type | ObjectType () const |
OperatorControl & | operator= (OperatorControl &&in_that) |
OperatorControl & | operator= (OperatorControl const &in_that) |
OperatorControl (View const &in_view) | |
OperatorControl (OperatorControl const &in_that) | |
OperatorControl (OperatorControl &&in_that) | |
bool | Pop (Operator::Priority in_priority=Operator::Priority::Default) |
bool | Pop (OperatorPtr &out_operator) |
bool | Pop (Operator::Priority in_priority, OperatorPtr &out_operator) |
OperatorControl & | Push (OperatorPtr const &in_operator, Operator::Priority in_priority=Operator::Priority::Default) |
OperatorControl & | Push (Operator *in_operator, Operator::Priority in_priority=Operator::Priority::Default) |
OperatorControl & | Set (OperatorPtr const &in_operator, Operator::Priority in_priority=Operator::Priority::Default) |
OperatorControl & | Set (Operator *in_operator, Operator::Priority in_priority=Operator::Priority::Default) |
OperatorControl & | Set (OperatorPtrArray &in_operators, Operator::Priority in_priority=Operator::Priority::Default) |
OperatorControl & | Set (size_t in_count, OperatorPtr in_operators[], Operator::Priority in_priority=Operator::Priority::Default) |
bool | Show (OperatorPtrArray &out_operators) const |
bool | Show (Operator::Priority in_priority, OperatorPtrArray &out_operators) const |
bool | ShowTop (OperatorPtr &out_operator) const |
bool | ShowTop (Operator::Priority in_priority, OperatorPtr &out_operator) const |
OperatorControl & | UnsetEverything (Operator::Priority in_priority) |
OperatorControl & | UnsetEverything () |
OperatorControl & | UnsetTop (Operator::Priority in_priority=Operator::Priority::Default) |
~OperatorControl () | |
![]() | |
Sprocket (Sprocket &&in_that) | |
![]() | |
virtual bool | Empty () const |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
bool | HasType (HPS::Type in_mask) const |
Object (Object const &that) | |
Object (Object &&in_that) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
virtual HPS::Type | Type () const |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
![]() | |
SprocketControl & | operator= (SprocketControl &&in_that) |
SprocketControl (SprocketControl &&in_that) | |
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
|
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.
- Parameters
-
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.
Member Function Documentation
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.
- Parameters
-
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.
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
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.
- Parameters
-
in_that An rvalue reference to a OperatorControl to take the impl from.
- Returns
- A reference to this OperatorControl.
OperatorControl& HPS::OperatorControl::operator= | ( | OperatorControl const & | in_that | ) |
Share the smart-pointer.
bool HPS::OperatorControl::Pop | ( | Operator::Priority | in_priority = Operator::Priority::Default | ) |
Removes the top operator from the operator stack of the specified priority and frees the memory associated with it.
- Parameters
-
in_priority The priority of the operator to be removed.
- Returns
- true if an operator was present, false otherwise.
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.
- Parameters
-
out_operator A handle to the top operator, passed to the user.
- Returns
- true if an operator was present, false otherwise.
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.
- Parameters
-
in_priority The priority of the operator to be removed. out_operator A handle to the top operator, passed to the user.
- Returns
- true if an operator was present, false otherwise.
OperatorControl& HPS::OperatorControl::Push | ( | OperatorPtr const & | in_operator, |
Operator::Priority | in_priority = Operator::Priority::Default |
||
) |
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_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.
- Returns
- A reference to this object.
OperatorControl& HPS::OperatorControl::Push | ( | Operator * | in_operator, |
Operator::Priority | in_priority = Operator::Priority::Default |
||
) |
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_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.
- Returns
- A reference to this object.
OperatorControl& HPS::OperatorControl::Set | ( | OperatorPtr const & | in_operator, |
Operator::Priority | in_priority = Operator::Priority::Default |
||
) |
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_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.
- Returns
- A reference to this object.
OperatorControl& HPS::OperatorControl::Set | ( | Operator * | in_operator, |
Operator::Priority | in_priority = Operator::Priority::Default |
||
) |
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.
- Parameters
-
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.
- Returns
- A reference to this object.
OperatorControl& HPS::OperatorControl::Set | ( | OperatorPtrArray & | in_operators, |
Operator::Priority | in_priority = Operator::Priority::Default |
||
) |
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_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.
- Returns
- A reference to this object.
OperatorControl& HPS::OperatorControl::Set | ( | size_t | in_count, |
OperatorPtr | in_operators[], | ||
Operator::Priority | in_priority = Operator::Priority::Default |
||
) |
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_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.
- Returns
- A reference to this object.
bool HPS::OperatorControl::Show | ( | OperatorPtrArray & | out_operators | ) | const |
Shows all Normal priority operators in use on this segment. The operator stack is unmodified.
- Parameters
-
out_operators Handles to all Normal priority operators used by this View.
- Returns
- true if any operator was present, false otherwise.
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.
- Parameters
-
in_priority The priority of the operators to be shown. out_operators Handles to all operators of the specified priority used by this View.
- Returns
- true if any operator was present, false otherwise.
bool HPS::OperatorControl::ShowTop | ( | OperatorPtr & | out_operator | ) | const |
Shows the top operator on the Normal priority operator stack. The operator stack is unmodified.
- Parameters
-
out_operator The operator at the top of the operator stack
- Returns
- true if an operator was present, false otherwise.
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.
- Parameters
-
in_priority The priority of the operator to be shown. out_operator The operator at the top of the operator stack
- Returns
- true if an operator was present, false otherwise.
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.
- Parameters
-
in_priority The priority of the operator to be removed.
- Returns
- A reference to this object.
OperatorControl& HPS::OperatorControl::UnsetEverything | ( | ) |
Removes all operators from the operator stack of any priority and frees the memory associated with them.
- Returns
- A reference to this object.
OperatorControl& HPS::OperatorControl::UnsetTop | ( | Operator::Priority | in_priority = Operator::Priority::Default | ) |
Removes the top operator from the operator stack of the specified priority and frees the memory associated with it.
- Parameters
-
in_priority The priority of the operator to be removed.
- Returns
- A reference to this object.
The documentation for this class was generated from the following file:
- include/sprk.h