cs::warning_retraction_info Class Reference

Describes the cases in which a warning instance should be retracted. More...

Public Member Functions
	warning_retraction_info (const std::vector< procedure > &_bottom_up_procedures, const std::vector< procedure > &_procedures, const std::vector< compunit > &_compunits)
	Constructor. More...
std::string	as_repr () const
	Get a representation of a warning_retraction_info object that includes information useful for debugging. More...
std::string	as_string () const
	Get a simple string representation of a warning_retraction_info object. More...

Related Functions
(Note that these are not member functions.)
std::ostream &	operator<< (std::ostream &out, const warning_retraction_info &a)
	Print a representation of a warning_retraction_info object to the specified stream. More...

Detailed Description

Describes the cases in which a warning instance should be retracted.

A number of warningclass report() and report_return_warning() methods take warning_retraction_info parameters.

The reported warning will be retracted during the drop phase if the specified conditions are met.

Note that a new warning instance in the same group may be issued in one of the later analysis phases (serial depth-first, parallel depth-first, or bottom-up) if the analysis determines that the problem still exists.

Constructor & Destructor Documentation

warning_retraction_info()

cs::warning_retraction_info::warning_retraction_info ( const std::vector< procedure > &  _bottom_up_procedures, const std::vector< procedure > &  _procedures, const std::vector< compunit > &  _compunits  )

inline

Constructor.

Parameters

[in]	_bottom_up_procedures	If any procedure in this list is visited in the bottom-up phase, retract the warning instance. Note that retraction always occurs in the drop phase: the bottom-up phase has not yet occurred at this point, but the set of procedures to be visited in the bottom-up phase is known.
[in]	_procedures	If any procedure in this list is modified between incremental analyses, retract the warning instance.
[in]	_compunits	If any compilation unit (compunit) in this list is modified between incremental analyses, retract the warning instance.

Member Function Documentation

as_repr()

std::string cs::warning_retraction_info::as_repr ( ) const

inline

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

Returns

The string representation.

as_string()

std::string cs::warning_retraction_info::as_string ( ) const

inline

Get a simple string representation of a warning_retraction_info object.

Returns

The string representation.

Friends And Related Function Documentation

operator<<()

std::ostream & operator<< ( std::ostream &  out, const warning_retraction_info &  a  )

related

Print a representation of a warning_retraction_info object to the specified stream.

Parameters

[in]	out	The stream to print to.
[in]	a	The warning_retraction_info object to print.

Returns

void

---

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

• csonar_warningclass.hpp