DecodeOut Class Reference

Class used for plain text output of decoded sections. More...

#include <decodeout.hpp>

List of all members.

Public Member Functions
	DecodeOut (std::ostream &output_stream, DecodeContext &decode_context)
	Constructor.
void	putSectionName (std::string const &section_name) const
	Output a section name.
void	putField (std::string const &field_name, unsigned width_of_field_in_bits) const
	Output a field within the section.
void	putLoopControl (std::string const &loop_control) const
	Output the loop control.
bool	testLoopExit () const
	Return true when a loop within the section should exit.
bool	putIf (std::string const &field_name, std::string const &operation, unsigned long const &value) const
	Output an "if" conditional.
bool	putElse ()
	Output an "else" conditional.
void	enterBlock ()
	Enter a nested block in the section.
void	leaveBlock ()
	Leave a nested block in the section.

---

Detailed Description

Class used for plain text output of decoded sections.

The (generated) section decoder drives the section decoding by calling the functions provided by this class.

---

Constructor & Destructor Documentation

DecodeOut::DecodeOut (  std::ostream &  output_stream, DecodeContext &  decode_context )

Constructor. Parameters: output_stream  decode_context

---

Member Function Documentation

void DecodeOut::enterBlock (   )

Enter a nested block in the section.

void DecodeOut::leaveBlock (   )

Leave a nested block in the section.

bool DecodeOut::putElse (   )

Output an "else" conditional. Returns: true

void DecodeOut::putField (  std::string const &  field_name, unsigned  width_of_field_in_bits )  const

Output a field within the section. Parameters: field_name  width_of_field_in_bits

bool DecodeOut::putIf (  std::string const &  field_name, std::string const &  operation, unsigned long const &  value )  const

Output an "if" conditional. Parameters: field_name  operation  For example, "==". value  Returns: The boolean result of evaluating the condition.

void DecodeOut::putLoopControl (  std::string const &  loop_control  )  const

Output the loop control. Parameters: loop_control  A string of the form "for(i=0;i<N;i++)"

void DecodeOut::putSectionName (  std::string const &  section_name  )  const

Output a section name. Parameters: section_name

bool DecodeOut::testLoopExit (   )  const

Return true when a loop within the section should exit.

---

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

• decodeout.hpp
• decodeout.cpp

---