# WOK
TKWOK
WOKTools

# WOKTools_Message Class Reference

`#include <WOKTools_Message_proto.hxx>`

Inheritance diagram for WOKTools_Message:

[legend]

## Public Member Functions

Standard_EXPORT void | Init ()
virtual Standard_EXPORT Standard_Character | Code () const =0
Standard_EXPORT WOKTools_Message & | Print (const Standard_CString astr)
WOKTools_Message & | operator<< (const Standard_CString astr)
Standard_EXPORT WOKTools_Message & | Print (const Handle(TCollection_HAsciiString)&astr)
WOKTools_Message & | operator<< (const Handle(TCollection_HAsciiString)&astr)
Standard_EXPORT WOKTools_Message & | Print (const Standard_Integer aint)
WOKTools_Message & | operator<< (const Standard_Integer aint)
Standard_EXPORT WOKTools_Message & | Print (const Standard_Character achar)
WOKTools_Message & | operator<< (const Standard_Character achar)
Standard_EXPORT WOKTools_Message & | MsgControl (const WOKTools_MsgControl ahandler)
WOKTools_Message & | operator<< (const WOKTools_MsgControl ahandler)
Standard_EXPORT void | Set ()
Standard_EXPORT void | UnSet ()
Standard_EXPORT void | DoPrintHeader ()
Standard_EXPORT void | DontPrintHeader ()
Standard_EXPORT void | DoPrintContext ()
Standard_EXPORT void | DontPrintContext ()
Standard_EXPORT void | SetEndMsgHandler (const WOKTools_MsgHandler &ahandler)
Standard_EXPORT void | SetIndex (const Standard_Integer anindex)
Standard_EXPORT Standard_Boolean | LogToFile (const Handle(TCollection_HAsciiString)&afile)
Standard_EXPORT Standard_Boolean | LogToStream (const WOKTools_MsgStreamPtr &astream)
Standard_EXPORT void | EndLogging ()
WOKTools_MsgStreamPtr | LogStream () const
Standard_Boolean | IsSet () const
Standard_Boolean | PrintHeader () const
Standard_Boolean | PrintContext () const
WOKTools_MsgHandler | EndMsgHandler () const
Standard_Integer | Index () const
const | Handle (TCollection_HAsciiString)&Message() const
Standard_CString | ToPrint () const
virtual | ~WOKTools_Message ()
Standard_EXPORT void | Init ()
virtual Standard_EXPORT Standard_Character | Code () const =0
Standard_EXPORT WOKTools_Message & | Print (const Standard_CString astr)
WOKTools_Message & | operator<< (const Standard_CString astr)
Standard_EXPORT WOKTools_Message & | Print (const Handle(TCollection_HAsciiString)&astr)
WOKTools_Message & | operator<< (const Handle(TCollection_HAsciiString)&astr)
Standard_EXPORT WOKTools_Message & | Print (const Standard_Integer aint)
WOKTools_Message & | operator<< (const Standard_Integer aint)
Standard_EXPORT WOKTools_Message & | Print (const Standard_Character achar)
WOKTools_Message & | operator<< (const Standard_Character achar)
Standard_EXPORT WOKTools_Message & | MsgControl (const WOKTools_MsgControl ahandler)
WOKTools_Message & | operator<< (const WOKTools_MsgControl ahandler)
Standard_EXPORT void | Set ()
Standard_EXPORT void | UnSet ()
Standard_EXPORT void | DoPrintHeader ()
Standard_EXPORT void | DontPrintHeader ()
Standard_EXPORT void | DoPrintContext ()
Standard_EXPORT void | DontPrintContext ()
Standard_EXPORT void | SetEndMsgHandler (const WOKTools_MsgHandler &ahandler)
Standard_EXPORT void | SetIndex (const Standard_Integer anindex)
Standard_EXPORT Standard_Boolean | LogToFile (const Handle(TCollection_HAsciiString)&afile)
Standard_EXPORT Standard_Boolean | LogToStream (const WOKTools_MsgStreamPtr &astream)
Standard_EXPORT void | EndLogging ()
WOKTools_MsgStreamPtr | LogStream () const
Standard_Boolean | IsSet () const
Standard_Boolean | PrintHeader () const
Standard_Boolean | PrintContext () const
WOKTools_MsgHandler | EndMsgHandler () const
Standard_Integer | Index () const
const | Handle (TCollection_HAsciiString)&Message() const
Standard_CString | ToPrint () const
virtual | ~WOKTools_Message ()

## Protected Member Functions

Standard_EXPORT | WOKTools_Message (const Standard_CString aclass, const Standard_CString aheader)
Standard_CString | Switcher () const
Standard_EXPORT void | SetSwitcher (const Standard_CString aswitcher)
Standard_EXPORT | WOKTools_Message (const Standard_CString aclass, const Standard_CString aheader)
Standard_CString | Switcher () const
Standard_EXPORT void | SetSwitcher (const Standard_CString aswitcher)

## Private Attributes

Standard_CString | myheader
Handle_TCollection_HAsciiString | mymessage
Standard_Integer | myindex
Standard_Boolean | myison
Standard_Boolean | myprintcontext
Standard_Boolean | myprintheader
Standard_CString | myswitcher
WOKTools_MsgHandler | myendmsghandlr
Standard_Boolean | mylogflag
Handle_TCollection_HAsciiString | mylogfile
WOKTools_MsgStreamPtr | mylogstream

## Constructor & Destructor Documentation

virtual WOKTools_Message::~WOKTools_Message | ( |  | ) | `[inline, virtual]`

Standard_EXPORT WOKTools_Message::WOKTools_Message | ( | const Standard_CString | aclass,
|  | const Standard_CString | aheader
| ) | `[protected]`

virtual WOKTools_Message::~WOKTools_Message | ( |  | ) | `[inline, virtual]`

Standard_EXPORT WOKTools_Message::WOKTools_Message | ( | const Standard_CString | aclass,
|  | const Standard_CString | aheader
| ) | `[protected]`

## Member Function Documentation

virtual Standard_EXPORT Standard_Character WOKTools_Message::Code | ( |  | ) | const`[pure virtual]`

| Implemented in WOKTools_Error, WOKTools_Info, WOKTools_Verbose, and WOKTools_Warning.

virtual Standard_EXPORT Standard_Character WOKTools_Message::Code | ( |  | ) | const`[pure virtual]`

| Implemented in WOKTools_Error, WOKTools_Info, WOKTools_Verbose, and WOKTools_Warning.

Standard_EXPORT void WOKTools_Message::DontPrintContext | ( |  | ) |

Standard_EXPORT void WOKTools_Message::DontPrintContext | ( |  | ) |

Standard_EXPORT void WOKTools_Message::DontPrintHeader | ( |  | ) |

Standard_EXPORT void WOKTools_Message::DontPrintHeader | ( |  | ) |

Standard_EXPORT void WOKTools_Message::DoPrintContext | ( |  | ) |

Standard_EXPORT void WOKTools_Message::DoPrintContext | ( |  | ) |

Standard_EXPORT void WOKTools_Message::DoPrintHeader | ( |  | ) |

Standard_EXPORT void WOKTools_Message::DoPrintHeader | ( |  | ) |

Standard_EXPORT void WOKTools_Message::EndLogging | ( |  | ) |

Standard_EXPORT void WOKTools_Message::EndLogging | ( |  | ) |

WOKTools_MsgHandler WOKTools_Message::EndMsgHandler | ( |  | ) | const

WOKTools_MsgHandler WOKTools_Message::EndMsgHandler | ( |  | ) | const`[inline]`

const WOKTools_Message::Handle | ( | TCollection_HAsciiString |  | ) | const

const WOKTools_Message::Handle | ( | TCollection_HAsciiString |  | ) | const

Standard_Integer WOKTools_Message::Index | ( |  | ) | const

Standard_Integer WOKTools_Message::Index | ( |  | ) | const`[inline]`

Standard_EXPORT void WOKTools_Message::Init | ( |  | ) |

Standard_EXPORT void WOKTools_Message::Init | ( |  | ) |

Standard_Boolean WOKTools_Message::IsSet | ( |  | ) | const

Standard_Boolean WOKTools_Message::IsSet | ( |  | ) | const`[inline]`

WOKTools_MsgStreamPtr WOKTools_Message::LogStream | ( |  | ) | const

WOKTools_MsgStreamPtr WOKTools_Message::LogStream | ( |  | ) | const`[inline]`

Standard_EXPORT Standard_Boolean WOKTools_Message::LogToFile | ( | const Handle(TCollection_HAsciiString)& | afile | ) |

Standard_EXPORT Standard_Boolean WOKTools_Message::LogToFile | ( | const Handle(TCollection_HAsciiString)& | afile | ) |

Standard_EXPORT Standard_Boolean WOKTools_Message::LogToStream | ( | const WOKTools_MsgStreamPtr & | astream | ) |

Standard_EXPORT Standard_Boolean WOKTools_Message::LogToStream | ( | const WOKTools_MsgStreamPtr & | astream | ) |

Standard_EXPORT WOKTools_Message& WOKTools_Message::MsgControl | ( | const WOKTools_MsgControl | ahandler | ) |

Standard_EXPORT WOKTools_Message& WOKTools_Message::MsgControl | ( | const WOKTools_MsgControl | ahandler | ) |

WOKTools_Message& WOKTools_Message::operator<< | ( | const WOKTools_MsgControl | ahandler | ) | `[inline]`

WOKTools_Message& WOKTools_Message::operator<< | ( | const Standard_Character | achar | ) | `[inline]`

WOKTools_Message& WOKTools_Message::operator<< | ( | const Standard_Integer | aint | ) | `[inline]`

WOKTools_Message& WOKTools_Message::operator<< | ( | const Handle(TCollection_HAsciiString)& | astr | ) | `[inline]`

WOKTools_Message& WOKTools_Message::operator<< | ( | const Standard_CString | astr | ) | `[inline]`

WOKTools_Message& WOKTools_Message::operator<< | ( | const WOKTools_MsgControl | ahandler | ) | `[inline]`

WOKTools_Message& WOKTools_Message::operator<< | ( | const Standard_Character | achar | ) | `[inline]`

WOKTools_Message& WOKTools_Message::operator<< | ( | const Standard_Integer | aint | ) | `[inline]`

WOKTools_Message& WOKTools_Message::operator<< | ( | const Handle(TCollection_HAsciiString)& | astr | ) | `[inline]`

WOKTools_Message& WOKTools_Message::operator<< | ( | const Standard_CString | astr | ) | `[inline]`

Standard_EXPORT WOKTools_Message& WOKTools_Message::Print | ( | const Standard_Character | achar | ) |

Standard_EXPORT WOKTools_Message& WOKTools_Message::Print | ( | const Standard_Integer | aint | ) |

Standard_EXPORT WOKTools_Message& WOKTools_Message::Print | ( | const Handle(TCollection_HAsciiString)& | astr | ) |

Standard_EXPORT WOKTools_Message& WOKTools_Message::Print | ( | const Standard_CString | astr | ) |

Standard_EXPORT WOKTools_Message& WOKTools_Message::Print | ( | const Standard_Character | achar | ) |

Standard_EXPORT WOKTools_Message& WOKTools_Message::Print | ( | const Standard_Integer | aint | ) |

Standard_EXPORT WOKTools_Message& WOKTools_Message::Print | ( | const Handle(TCollection_HAsciiString)& | astr | ) |

Standard_EXPORT WOKTools_Message& WOKTools_Message::Print | ( | const Standard_CString | astr | ) |

Standard_Boolean WOKTools_Message::PrintContext | ( |  | ) | const

Standard_Boolean WOKTools_Message::PrintContext | ( |  | ) | const`[inline]`

Standard_Boolean WOKTools_Message::PrintHeader | ( |  | ) | const

Standard_Boolean WOKTools_Message::PrintHeader | ( |  | ) | const`[inline]`

Standard_EXPORT void WOKTools_Message::Set | ( |  | ) |

Standard_EXPORT void WOKTools_Message::Set | ( |  | ) |

Standard_EXPORT void WOKTools_Message::SetEndMsgHandler | ( | const WOKTools_MsgHandler & | ahandler | ) |

Standard_EXPORT void WOKTools_Message::SetEndMsgHandler | ( | const WOKTools_MsgHandler & | ahandler | ) |

Standard_EXPORT void WOKTools_Message::SetIndex | ( | const Standard_Integer | anindex | ) |

Standard_EXPORT void WOKTools_Message::SetIndex | ( | const Standard_Integer | anindex | ) |

Standard_EXPORT void WOKTools_Message::SetSwitcher | ( | const Standard_CString | aswitcher | ) | `[protected]`

Standard_EXPORT void WOKTools_Message::SetSwitcher | ( | const Standard_CString | aswitcher | ) | `[protected]`

Standard_CString WOKTools_Message::Switcher | ( |  | ) | const`[protected]`

Standard_CString WOKTools_Message::Switcher | ( |  | ) | const`[inline, protected]`

Standard_CString WOKTools_Message::ToPrint | ( |  | ) | const

Standard_CString WOKTools_Message::ToPrint | ( |  | ) | const`[inline]`

Standard_EXPORT void WOKTools_Message::UnSet | ( |  | ) |

Standard_EXPORT void WOKTools_Message::UnSet | ( |  | ) |

## Field Documentation

WOKTools_MsgHandler WOKTools_Message::myendmsghandlr `[private]`

Standard_CString WOKTools_Message::myheader `[private]`

Standard_Integer WOKTools_Message::myindex `[private]`

Standard_Boolean WOKTools_Message::myison `[private]`

Handle_TCollection_HAsciiString WOKTools_Message::mylogfile `[private]`

Standard_Boolean WOKTools_Message::mylogflag `[private]`

WOKTools_MsgStreamPtr WOKTools_Message::mylogstream `[private]`

Handle_TCollection_HAsciiString WOKTools_Message::mymessage `[private]`

Standard_Boolean WOKTools_Message::myprintcontext `[private]`

Standard_Boolean WOKTools_Message::myprintheader `[private]`

Standard_CString WOKTools_Message::myswitcher `[private]`

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

- WOKTools_Message.hxx
- WOKTools_Message_proto.hxx
- WOKTools_Message.lxx