North State Framework in C#  V3.0.0
An object-oriented framework for implementing UML state machines.
Public Member Functions | Properties | List of all members
NSFDebugUtility Class Reference

Represents a debug utility class. More...

Inheritance diagram for NSFDebugUtility:
NSFTaggedObject NSFUniquelyNumberedObject INSFNamedObject

Public Member Functions

bool writeToConsole (NSFString text)
 Writes text to the console from a low priority thread. More...
 
bool writeLineToConsole (NSFString text)
 Writes a line of text to the console from a low priority thread. More...
 
bool allOutputTextWritten ()
 Checks if all output has been written to the console. More...
 
 NSFDebugUtility ()
 Creates a debug utility. More...
 
- Public Member Functions inherited from NSFTaggedObject
 NSFTaggedObject (NSFString name)
 Creates an object with a unique id and a name. More...
 
- Public Member Functions inherited from NSFUniquelyNumberedObject
 NSFUniquelyNumberedObject ()
 Creates a uniquely numbered object. More...
 
bool isSameObject (NSFUniquelyNumberedObject other)
 Checks if this object is the same as another object. More...
 

Properties

static NSFDebugUtility PrimaryDebugUtility [get]
 Gets the primary framework debug utility More...
 
int MaxPendingWrites [get, set]
 Gets and sets the maximum number of pending writes. More...
 
- Properties inherited from NSFTaggedObject
NSFString Name [get, set]
 
- Properties inherited from NSFUniquelyNumberedObject
NSFId UniqueId [get]
 Gets or sets the unique id of the object. More...
 
- Properties inherited from INSFNamedObject
NSFString Name [get]
 Gets the name of the object. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from NSFUniquelyNumberedObject
static NSFId getNextUniqueId ()
 Gets the next unique id. More...
 

Detailed Description

Represents a debug utility class.

Constructor & Destructor Documentation

Creates a debug utility.

Member Function Documentation

bool allOutputTextWritten ( )

Checks if all output has been written to the console.

Returns
True if all output text has been written, false otherwise.
bool writeLineToConsole ( NSFString  text)

Writes a line of text to the console from a low priority thread.

Parameters
textText string to write to console.
Returns
False if the maximum number of pending writes is exceeded, true otherwise.
bool writeToConsole ( NSFString  text)

Writes text to the console from a low priority thread.

Parameters
textText string to write to console.
Returns
False if the maximum number of pending writes is exceeded, true otherwise.

Property Documentation

int MaxPendingWrites
getset

Gets and sets the maximum number of pending writes.

Requests to write to console will be dropped if the maximum number of pending writes is exceeded.

NSFDebugUtility PrimaryDebugUtility
staticget

Gets the primary framework debug utility




Copyright 2004-2014, North State Software, LLC. All rights reserved.