modulestate Class Reference

The Continuous Integration model communicates the modules state through a traffic light analogy. More...

#include <modulereport.h>

Inheritance diagram for modulestate:

Collaboration diagram for modulestate:

List of all members.

Public Types
enum	color { red, amber, green }
	Fail, risk and success respectively. More...
Public Member Functions
	modulestate ()
	Default red.
stringc	htmlimg (stringc &pathfront="") const
	Icon associated with state, relative to proj directory.
stringc	statecolor () const
	Write the state as text.
stringc	statestring () const
	Associated word with the colored state.
Public Attributes
color	state
	Call update() before reading.

---

Detailed Description

The Continuous Integration model communicates the modules state through a traffic light analogy.

Definition at line 11 of file modulereport.h.

---

Member Enumeration Documentation

enum modulestate::color

Fail, risk and success respectively.

Enumerator:

red
amber
green

Definition at line 16 of file modulereport.h.

{ red, amber, green };

---

Constructor & Destructor Documentation

modulestate::modulestate

(

)

Default red.

Definition at line 178 of file modulereport.cpp.

  : state(red)
{
}

---

Member Function Documentation

stringc modulestate::htmlimg

(

stringc &

pathfront = ""

)

const

Icon associated with state, relative to proj directory.

Definition at line 166 of file modulereport.cpp.

References amber, green, red, and state.

Referenced by modulereport::update(), and modulereport::update01().

{
  switch(state)
  {
    case green: return (" <img src=\""+pathfront+"documentation/images/success.gif\" alt=\""+pathfront+"documentation/images/success.gif\" />");
    case amber: return " <img src=\""+pathfront+"documentation/images/risk.gif\" alt=\""+pathfront+"documentation/images/risk.gif\" />";
    case red: return "<img src=\""+pathfront+"documentation/images/attention.png\" alt=\""+pathfront+"documentation/images/attention.png\" />";
  }

  return "";
}

stringc modulestate::statecolor

(

)

const

Write the state as text.

Definition at line 97 of file modulereport.cpp.

References amber, green, red, and state.

{
  string str;
  switch(state)
  {
    case red: str="red"; break; 
    case amber: str="amber"; break; 
    case green: str="green"; break; 
  }

  return str;
}

stringc modulestate::statestring

(

)

const

Associated word with the colored state.

Definition at line 110 of file modulereport.cpp.

References amber, green, red, and state.

Referenced by modulereport::summary01(), and modulereport::update01().

{
  string str;
  switch(state)
  {
    case red: str="Fail"; break; 
    case amber: str="Compiled"; break; 
    case green: str="Success"; break; 
  }

  return str;
}

---

Member Data Documentation

color modulestate::state

Call update() before reading.

Definition at line 18 of file modulereport.h.

Referenced by htmlimg(), modulereport::statecalc(), statecolor(), and statestring().

---

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

• makefilebuildtool/modulereport.h
• makefilebuildtool/modulereport.cpp