Initializing help system before first use

IndicatorObjects

Data describing an indicator constraint. More...

#include <xpress_objects.hpp>

Public Member Functions
  IndicatorObjects (Variable indicatorVariable, bool indicatorValue, Inequality row)
  Create a indicator object descriptor.
 
auto  getIndicatorValue () const -> bool
  Whether the row becomes active if the indicator variable is.
 
auto  getIndicatorVariable () const -> Variable
  The indicator variable [get].
 
auto  getRow () const -> Inequality
  The row that is activated when the indicator condition is satisfied [get].
 

Detailed Description

Data describing an indicator constraint.

This is mainly used for querying indicator constraints.

Since
44.00

Constructor & Destructor Documentation

IndicatorObjects()

xpress::objects::IndicatorObjects::IndicatorObjects ( Variable indicatorVariable,
bool indicatorValue,
Inequality row )
inline

Create a indicator object descriptor.

Parameters
indicatorVariable Indicator variable.
indicatorValue Indicator value.
row The inequality that becomes active if indicatorVariable attains indicatorValue.
Since
44.00

Member Function Documentation

getIndicatorValue()

auto xpress::objects::IndicatorObjects::getIndicatorValue ( ) const -> bool
inline

Whether the row becomes active if the indicator variable is.

non-zero (indicator value is true) or zero

(indicator value is false [get].

Since
44.00

getIndicatorVariable()

auto xpress::objects::IndicatorObjects::getIndicatorVariable ( ) const -> Variable
inline

The indicator variable [get].

Since
44.00

getRow()

auto xpress::objects::IndicatorObjects::getRow ( ) const -> Inequality
inline

The row that is activated when the indicator condition is satisfied [get].

Since
44.00
The documentation for this class was generated from the following file:
  • xpress_objects.hpp
Parent Topic objects

© 2001-2024 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.