ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
mx.olap 

OLAPTrace  - AS3 Flex

Packagemx.olap
Classpublic class OLAPTrace
InheritanceOLAPTrace Inheritance Object

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The OLAPTrace class controls the generation of trace information generated by the OLAP classes and written to the log file. This class uses the trace() method internally to write out the log information.

You must set TraceOutputFileEnable=1 in mm.cfg, and use the Debug Flash Player or AIR Debug Launcher to generate trace output.

Related API Elements

trace()


Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  traceLevel : int = 1
[static] The current trace level, which determines the amount of trace information written to the log file, TRACE_LEVEL_1 writes the least amount of information to the log file, and TRACE_LEVEL_3 writes the most.
OLAPTrace
  traceOn : Boolean = true
[static] Set to true to enable trace output.
OLAPTrace
Public Methods
 MethodDefined By
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
  
traceMsg(msg:String, level:int = 1):void
[static] Writes trace information to the log file You must set TraceOutputFileEnable=1 in mm.cfg, and use the Debug Flash Player or AIR Debug Launcher to generate trace output by calling this method.
OLAPTrace
 Inherited
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  TRACE_LEVEL_1 : int = 1
[static] Specifies to write minimal trace information to the log file.
OLAPTrace
  TRACE_LEVEL_2 : int = 2
[static] Specifies to write more trace information to the log file than TRACE_LEVEL_1.
OLAPTrace
  TRACE_LEVEL_3 : int = 3
[static] Specifies to write the most trace information to the log file.
OLAPTrace
Property Detail

traceLevel

property
public static var traceLevel:int = 1

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The current trace level, which determines the amount of trace information written to the log file, TRACE_LEVEL_1 writes the least amount of information to the log file, and TRACE_LEVEL_3 writes the most.

All trace information output by a call to the traceMsg() method with a level argument less than traceLevel is sent to the log file.

The default value is TRACE_LEVEL_1.

traceOn

property 
public static var traceOn:Boolean = true

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Set to true to enable trace output.

The default value is true.

Method Detail

traceMsg

()method
public static function traceMsg(msg:String, level:int = 1):void

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Writes trace information to the log file

You must set TraceOutputFileEnable=1 in mm.cfg, and use the Debug Flash Player or AIR Debug Launcher to generate trace output by calling this method.

Parameters

msg:String — The trace message.
 
level:int (default = 1) — The trace level of the message. Only trace messages with a level argument less than traceLevel are sent to the log file.
Constant Detail

TRACE_LEVEL_1

Constant
public static const TRACE_LEVEL_1:int = 1

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Specifies to write minimal trace information to the log file.

TRACE_LEVEL_2

Constant 
public static const TRACE_LEVEL_2:int = 2

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Specifies to write more trace information to the log file than TRACE_LEVEL_1.

TRACE_LEVEL_3

Constant 
public static const TRACE_LEVEL_3:int = 3

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Specifies to write the most trace information to the log file.