Inheritance diagram for HPS.ConditionControl:
HPS.Control HPS.Object

Public Member Functions

HPS.ConditionControl AddCondition (string in_condition)
 
 ConditionControl (HPS.SegmentKey in_seg)
 
 ConditionControl (HPS.ConditionControl in_that)
 
override void Dispose ()
 
ulong GetCount ()
 
override HPS.Type ObjectType ()
 
HPS.ConditionControl SetCondition (string in_condition)
 
HPS.ConditionControl SetConditions (string[] in_conditions)
 
bool ShowCondition (string in_condition)
 
bool ShowConditions (out string[] out_conditions)
 
override HPS.Type Type ()
 
HPS.ConditionControl UnsetCondition (string in_condition)
 
HPS.ConditionControl UnsetEverything ()
 
- Public Member Functions inherited from HPS.Control
 Control (HPS.Control in_that)
 
override void Dispose ()
 
override HPS.Type ObjectType ()
 
override HPS.Type Type ()
 
- 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 ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Control
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 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.

Constructor & Destructor Documentation

◆ ConditionControl() [1/2]

HPS.ConditionControl.ConditionControl ( HPS.SegmentKey  in_seg)
inline

Initializes a control tied to the segment in_seg.

◆ ConditionControl() [2/2]

HPS.ConditionControl.ConditionControl ( HPS.ConditionControl  in_that)
inline

Initializes a control tied to the same object as in_that.

Member Function Documentation

◆ AddCondition()

HPS.ConditionControl HPS.ConditionControl.AddCondition ( string  in_condition)
inline

Adds a condition to the collection of active conditions on this segment.

Parameters
in_conditionthe condition to enable.
Returns
a reference to this object.

◆ GetCount()

ulong HPS.ConditionControl.GetCount ( )
inline

Retrieves the number of conditions set on this segment.

Returns
The number of conditions set on this segment.

◆ ObjectType()

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

◆ SetCondition()

HPS.ConditionControl HPS.ConditionControl.SetCondition ( string  in_condition)
inline

Sets a condition as the only active condition on this segment, replacing any existing conditions.

Parameters
in_conditionthe condition to enable.
Returns
a reference to this object.

◆ SetConditions()

HPS.ConditionControl HPS.ConditionControl.SetConditions ( string []  in_conditions)
inline

Sets a collection of conditions as the only active conditions on this segment, replacing any existing conditions.

Parameters
in_conditionsAn array of conditions to enable.
Returns
a reference to this object.

◆ ShowCondition()

bool HPS.ConditionControl.ShowCondition ( string  in_condition)
inline

Queries the existence of one condition on this segment.

Parameters
in_conditionThe condition in question.
Returns
true if the setting is valid, false otherwise.

◆ ShowConditions()

bool HPS.ConditionControl.ShowConditions ( out string []  out_conditions)
inline

Shows all conditions on this segment.

Parameters
out_conditionsAn array of conditions that are active on the segment.
Returns
true if any conditions are set, false otherwise.

◆ Type()

override HPS.Type HPS.ConditionControl.Type ( )
inlinevirtual

This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types.

Warning
This function must synchronize the database (by waiting for all pending database operations to complete) in order to know the type status of this object with certainty. Therefore this function can negatively impact performance. You should vigorously avoid using this function in high-traffic or peformance-critical areas of your code.
Returns
The true type of the object in question.

Reimplemented from HPS.Object.

◆ UnsetCondition()

HPS.ConditionControl HPS.ConditionControl.UnsetCondition ( string  in_condition)
inline

Removes a specified condition from the active conditions on this segment.

Parameters
in_conditionThe condition to remove.
Returns
a reference to this object.

◆ UnsetEverything()

HPS.ConditionControl HPS.ConditionControl.UnsetEverything ( )
inline

Unsets all conditions on this segment.

Returns
a reference to this object.

The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.ConditionControl.cs