#include <hps.h>
Public Member Functions | |
| ConditionControl (SegmentKey &in_seg) | |
| ConditionControl (ConditionControl const &in_that) | |
| ConditionControl (ConditionControl &&in_that) | |
| ConditionControl & | operator= (ConditionControl &&in_that) |
| ~ConditionControl () | |
| HPS::Type | ObjectType () const |
| ConditionControl & | operator= (ConditionControl const &in_that) |
| size_t | GetCount () const |
| ConditionControl & | AddCondition (char const *in_condition) |
| ConditionControl & | SetCondition (char const *in_condition) |
| ConditionControl & | SetConditions (UTF8Array const &in_conditions) |
| ConditionControl & | SetConditions (size_t in_count, UTF8 const in_conditions[]) |
| ConditionControl & | UnsetCondition (char const *in_condition) |
| ConditionControl & | UnsetEverything () |
| bool | ShowCondition (char const *in_condition) const |
| bool | ShowConditions (UTF8Array &out_conditions) const |
Public Member Functions inherited from HPS::Object | |
| 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 | |
Static Public Member Functions inherited from HPS::Object | |
| template<typename T > | |
| static intptr_t | ClassID () |
Protected Member Functions inherited from HPS::Control | |
| Control (Control &&in_that) | |
| Control & | operator= (Control &&in_that) |
The ConditionControl class is a smart pointer that is tied to a database object. This class is used to set and unset conditions on a segment. A condition can be used to control when a style is applied, or to control when an included segment is included.
|
explicit |
Initializes a control tied to the segment in_seg.
| HPS::ConditionControl::ConditionControl | ( | ConditionControl const & | in_that | ) |
Initializes a control tied to the same object as in_that.
| HPS::ConditionControl::ConditionControl | ( | ConditionControl && | in_that | ) |
The move constructor creates a ConditionControl by transferring the underlying impl of the rvalue reference to this ConditionControl thereby avoiding a copy and allocation.
| in_that | An rvalue reference to a ConditionControl to take the impl from. |
| HPS::ConditionControl::~ConditionControl | ( | ) |
Releases a reference to the database object this control is tied to.
| ConditionControl& HPS::ConditionControl::AddCondition | ( | char const * | in_condition | ) |
Adds a condition to the collection of active conditions on this segment.
| in_condition | the condition to enable. |
| size_t HPS::ConditionControl::GetCount | ( | ) | const |
Retrieves the number of conditions set on this segment.
|
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::Control.
| ConditionControl& HPS::ConditionControl::operator= | ( | ConditionControl && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this ConditionControl thereby avoiding a copy.
| in_that | An rvalue reference to a ConditionControl to take the impl from. |
| ConditionControl& HPS::ConditionControl::operator= | ( | ConditionControl const & | in_that | ) |
Share the smart-pointer.
| ConditionControl& HPS::ConditionControl::SetCondition | ( | char const * | in_condition | ) |
Sets a condition as the only active condition on this segment, replacing any existing conditions.
| in_condition | the condition to enable. |
| ConditionControl& HPS::ConditionControl::SetConditions | ( | UTF8Array const & | in_conditions | ) |
Sets a collection of conditions as the only active conditions on this segment, replacing any existing conditions.
| in_conditions | An array of conditions to enable. |
| ConditionControl& HPS::ConditionControl::SetConditions | ( | size_t | in_count, |
| UTF8 const | in_conditions[] | ||
| ) |
Sets a collection of conditions as the only active conditions on this segment, replacing any existing conditions.
| in_count | the number of conditions in the array. |
| in_conditions | An array of conditions to enable. |
| bool HPS::ConditionControl::ShowCondition | ( | char const * | in_condition | ) | const |
Queries the existence of one condition on this segment.
| in_condition | The condition in question. |
| bool HPS::ConditionControl::ShowConditions | ( | UTF8Array & | out_conditions | ) | const |
Shows all conditions on this segment.
| out_conditions | An array of conditions that are active on the segment. |
| ConditionControl& HPS::ConditionControl::UnsetCondition | ( | char const * | in_condition | ) |
Removes a specified condition from the active conditions on this segment.
| in_condition | The condition to remove. |
| ConditionControl& HPS::ConditionControl::UnsetEverything | ( | ) |
Unsets all conditions on this segment.