HPS::OperatorControl Class Reference

#include <sprk.h>

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

Public Member Functions

size_t GetCount ()
 
size_t GetCount (Operator::Priority in_priority)
 
HPS::Type ObjectType () const
 
OperatorControloperator= (OperatorControl &&in_that)
 
OperatorControloperator= (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)
 
OperatorControlPush (OperatorPtr const &in_operator, Operator::Priority in_priority=Operator::Priority::Default)
 
OperatorControlPush (Operator *in_operator, Operator::Priority in_priority=Operator::Priority::Default)
 
OperatorControlSet (OperatorPtr const &in_operator, Operator::Priority in_priority=Operator::Priority::Default)
 
OperatorControlSet (Operator *in_operator, Operator::Priority in_priority=Operator::Priority::Default)
 
OperatorControlSet (OperatorPtrArray &in_operators, Operator::Priority in_priority=Operator::Priority::Default)
 
OperatorControlSet (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
 
OperatorControlUnsetEverything (Operator::Priority in_priority)
 
OperatorControlUnsetEverything ()
 
OperatorControlUnsetTop (Operator::Priority in_priority=Operator::Priority::Default)
 
 ~OperatorControl ()
 
- Public Member Functions inherited from HPS::Sprocket
 Sprocket (Sprocket &&in_that)
 
- Public Member Functions inherited from HPS::Object
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)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
virtual HPS::Type Type () const
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::OperatorControl
 
- Static Public Attributes inherited from HPS::SprocketControl
static const HPS::Type staticType = HPS::Type::SprocketControl
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 
- Protected Member Functions inherited from HPS::SprocketControl
SprocketControloperator= (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

◆ OperatorControl() [1/3]

HPS::OperatorControl::OperatorControl ( View const &  in_view)
explicit

Initializes a control tied to the view in_view.

◆ OperatorControl() [2/3]

HPS::OperatorControl::OperatorControl ( OperatorControl const &  in_that)

Initializes a control tied to the same object as in_that.

◆ OperatorControl() [3/3]

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_thatAn rvalue reference to a OperatorControl to take the impl from.

◆ ~OperatorControl()

HPS::OperatorControl::~OperatorControl ( )

Releases a reference to the database object this control is tied to.

Member Function Documentation

◆ GetCount() [1/2]

size_t HPS::OperatorControl::GetCount ( )

Returns the number of operators in use here.

◆ GetCount() [2/2]

size_t HPS::OperatorControl::GetCount ( Operator::Priority  in_priority)

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

Parameters
in_priorityThe priority of the operators to be counted.

◆ ObjectType()

HPS::Type HPS::OperatorControl::ObjectType ( ) const
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::SprocketControl.

◆ operator=() [1/2]

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_thatAn rvalue reference to a OperatorControl to take the impl from.
Returns
A reference to this OperatorControl.

◆ operator=() [2/2]

OperatorControl& HPS::OperatorControl::operator= ( OperatorControl const &  in_that)

Share the smart-pointer.

◆ Pop() [1/3]

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_priorityThe priority of the operator to be removed.
Returns
true if an operator was present, false otherwise.

◆ Pop() [2/3]

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_operatorA handle to the top operator, passed to the user.
Returns
true if an operator was present, false otherwise.

◆ Pop() [3/3]

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_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]

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_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]

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.

Deprecated:
It is recommended to use overloads which consume OperatorPtr as the object lifetime is simpler to reason about.
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.

◆ Set() [1/4]

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_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]

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.

Deprecated:
It is recommended to use overloads which consume OperatorPtr as the object lifetime is simpler to reason about.
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() [3/4]

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_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]

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_countThe number of elements in the operator array.
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.

◆ Show() [1/2]

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_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 ( 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_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 ( OperatorPtr out_operator) const

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 ( 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_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]

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_priorityThe priority of the operator to be removed.
Returns
A reference to this object.

◆ UnsetEverything() [2/2]

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.

◆ UnsetTop()

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_priorityThe priority of the operator to be removed.
Returns
A reference to this object.

The documentation for this class was generated from the following file: