SFBLogger

Wrapper Class for the ILogger interface.

#include <SFBLogger.h.hpp>

class SFBLogger : public SFBBase;

SFMTYPEDEFWRAPPER(SFBLogger)

Inheritance diagram

Version

BREW 2.0	BREW 2.1	BREW 3.1	BREW 4.0
X	O	O	O

Reference

BREW API ILogger

Member

Public Functions
`SFCError`	GetParam( `AEELogParamType` type , `VoidConstPtr` param ) Get the configuration of the SFBLogger interface.
`SFCError`	GetParam( `AEELogParamType` type , `SFXBufferConstRef` param ) Get the configuration of the SFBLogger interface.
static `SFBLoggerSmp`	NewInstance( `AEECLSID` clsid = AEECLSID_LOGGER_WIN , `SFCErrorPtr` exception = null ) Create a new SFBLogger instance.
`SFCError`	Printf( `AEELogBucketType` bucket , `ACharConstPtr` fileName , `UInt16` lineNum , `ACharConstPtr` format , `...` ) Send a formatted ASCII text message.
`SFCError`	PutItem( `AEELogBucketType` bucket , `AEELogItemType` type , `UInt16` size , `UInt08Ptr` item ) Send a prioritized user-defined binary message.
`SFCError`	PutMsg( `AEELogBucketType` bucket , `ACharConstPtr` fileName , `UInt16` lineNum , `ACharConstPtr` msg , `UInt08` numArgs , `UInt32` args[] ) Send a predefined binary message and allows fast logging due to the limited formatting required and the fixed size of the outgoing log message.
`SFCError`	PutRecord( `AEELogBucketType` bucket , `AEELogRecord*` record ) Send a binary message.
`SFCError`	SetParam( `AEELogParamType` type , `UInt32` param , `VoidConstPtr` paramPtr ) Configure the performance and behavior of the SFBLogger interface. Supported Parameters depend on the current implementation's support.
`SFCError`	SetParam( `AEELogParamType` type , `UInt32` param , `SFXBufferConstRef` paramPtr ) Configure the performance and behavior of the SFBLogger interface. Supported Parameters depend on the current implementation's support.

Protected Functions
static `SFBBaseSmp`	FactoryByCreate( `AEECLSID` id , `SFCErrorPtr` exception = null ) (inherits from SFBBase) Create the instance for the specified ClassID's interface.
static `SFBBaseSmp`	FactoryByQuery( `SFBQuerySmpConstRef` query , `AEECLSID` id , `SFCErrorPtr` exception = null ) (inherits from SFBBase) Create the instance for the specified ClassID's interface using the SFBQuery instance.

SFBLogger::GetParam

Get the configuration of the SFBLogger interface.

[ public ]
SFCError GetParam(
    AEELogParamType type   // parameter to modify 
    VoidConstPtr param     // pointer to be filled with settings parameter 
);

[ public ]
SFCError GetParam(
    AEELogParamType type      // parameter to modify 
    SFXBufferConstRef param   // pointer to be filled with settings parameter 
);

Description

Supported Parameters: Depends on the current implementations support, see AEELoggerTypes.h for more information

See details in : AEELoggerTypes.h

Reference

BREW API ILOGGER_GetParam

SFBLogger::NewInstance

Create a new SFBLogger instance.

[ public, static ]
SFBLoggerSmp NewInstance(
    AEECLSID clsid = AEECLSID_LOGGER_WIN   // Class ID
    SFCErrorPtr exception = null           // Error
);

Description

The implemented ClassID of SFBLogger as below can be used.

AEECLSID_LOGGER_FILE: Write log in files

AEECLSID_LOGGER_ WIN: Send log to simulator window

SFBLogger::Printf

Send a formatted ASCII text message.

[ public ]
SFCError Printf(
    AEELogBucketType bucket   // bucket to place item 
    ACharConstPtr fileName    // name of file calling this function
    UInt16 lineNum            // line number in file where it was called 
    ACharConstPtr format      // ASCII text similar to a printf format string 
    ...                       // format string arguments 
);

Reference

BREW API ILOGGER_Printf

SFBLogger::PutItem

Send a prioritized user-defined binary message.

[ public ]
SFCError PutItem(
    AEELogBucketType bucket   // bucket to place item 
    AEELogItemType type       // user defined item type 
    UInt16 size               // size of type in bytes 
    UInt08Ptr item            // pointer to instance of type 
);

Reference

BREW API ILOGGER_PutItem

SFBLogger::PutMsg

Send a predefined binary message and allows fast logging due to the limited formatting required and the fixed size of the outgoing log message.

[ public ]
SFCError PutMsg(
    AEELogBucketType bucket   // bucket to place item 
    ACharConstPtr fileName    // ASCII null terminated name of file calling this function 
    UInt16 lineNum            // line number in file where it was called 
    ACharConstPtr msg         // ASCII null terminated text message
    UInt08 numArgs            // length of the args array 
    UInt32 args[]             // array containing UInt32 arguments 
);

Description

The outgoing binary message's data of type structure AEELogBinMsgType, which is defined in AEELoggerTypes.h.

Reference

BREW API ILOGGER_PutMsg

SFBLogger::PutRecord

Send a binary message.

[ public ]
SFCError PutRecord(
    AEELogBucketType bucket   // bucket to place item
    AEELogRecord* record      // pointer to AEELogRecord structure
);

Reference

BREW API ILOGGER_PutRecord

SFBLogger::SetParam

Configure the performance and behavior of the SFBLogger interface. Supported Parameters depend on the current implementation's support.

[ public ]
SFCError SetParam(
    AEELogParamType type    // parameter to modify 
    UInt32 param            // new settings parameter 
    VoidConstPtr paramPtr   // pointer to new settings parameter 
);

[ public ]
SFCError SetParam(
    AEELogParamType type         // parameter to modify 
    UInt32 param                 // new settings parameter 
    SFXBufferConstRef paramPtr   // pointer to new settings parameter 
);

Reference

BREW API ILOGGER_SetParam