CodeSonar C++ API
[For improved navigation, enable JavaScript.]
Public Member Functions | List of all members
cs::xform_query_bounds_result Class Reference

The return type of step_xform::query_bounds() More...

Public Member Functions

std::string as_repr () const
 Get a representation of a xform_query_bounds_result object that includes information useful for debugging. More...
 
std::string as_string () const
 Get a simple string representation of a xform_query_bounds_result object. More...
 
bool feasible () const
 Check: was the query executed on a feasible step_xform object? More...
 
csint32 get_lower () const
 Get the lower bound determined by the query. More...
 
bool get_lower_suspect () const
 Check: is the lower bound suspected? More...
 
csint32 get_upper () const
 Get the upper bound determined by the query. More...
 
bool get_upper_suspect () const
 Check: is the upper bound suspected? More...
 
bool has_lower () const
 Check: did the query determine a lower bound? More...
 
bool has_upper () const
 Check: did the query determine an upper bound? More...
 
bool modified () const
 Check: was step_xform::query_bounds() executed on a step_xform object that represented a modification to the symbol of interest? More...
 

Detailed Description

The return type of step_xform::query_bounds()

Member Function Documentation

◆ as_repr()

std::string cs::xform_query_bounds_result::as_repr ( ) const
inline

Get a representation of a xform_query_bounds_result object that includes information useful for debugging.

Returns
The string representation.

◆ as_string()

std::string cs::xform_query_bounds_result::as_string ( ) const
inline

Get a simple string representation of a xform_query_bounds_result object.

Returns
The string representation.

◆ feasible()

bool cs::xform_query_bounds_result::feasible ( ) const
inline

Check: was the query executed on a feasible step_xform object?

Returns
true if the query was executed on a feasible step_xform object, false otherwise.

◆ get_lower()

csint32 cs::xform_query_bounds_result::get_lower ( ) const
inline

Get the lower bound determined by the query.

Returns
The lower bound determined by the query.
Exceptions
result::NO_LOWER_BOUND

◆ get_lower_suspect()

bool cs::xform_query_bounds_result::get_lower_suspect ( ) const
inline

Check: is the lower bound suspected?

Returns
true if the query suspected the lower bound, false otherwise.

◆ get_upper()

csint32 cs::xform_query_bounds_result::get_upper ( ) const
inline

Get the upper bound determined by the query.

Returns
The upper bound determined by the query.
Exceptions
result::NO_UPPER_BOUND

◆ get_upper_suspect()

bool cs::xform_query_bounds_result::get_upper_suspect ( ) const
inline

Check: is the upper bound suspected?

Returns
true if the query suspected the upper bound, false otherwise.

◆ has_lower()

bool cs::xform_query_bounds_result::has_lower ( ) const
inline

Check: did the query determine a lower bound?

Returns
true if the query determined a lower bound, false otherwise.

◆ has_upper()

bool cs::xform_query_bounds_result::has_upper ( ) const
inline

Check: did the query determine an upper bound?

Returns
true if the query determined an upper bound, false otherwise.

◆ modified()

bool cs::xform_query_bounds_result::modified ( ) const
inline

Check: was step_xform::query_bounds() executed on a step_xform object that represented a modification to the symbol of interest?

Returns
true if this was returned from a step_xform::query_bounds() invocation S.query_bounds(e) where step_xform object S describes a transformation that modifies the symbol referenced by xform_expr e, false otherwise.

The returned value is only meaningful if step_xform::query_bounds() was executed with an xform_expr argument e whose xform_expr_mode is one of { xform_expr_mode::POST, xform_expr_mode::POST_DEREFS_PRE, xform_expr_mode::POST_DEREFS_PRE_STRICT, xform_expr_mode::POST_STRICT }. In particular, it is not meaningful if e is constant-valued, since all constant-valued xform_expr objects are created with xform_expr_mode::PRE.


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