NXOpen::Report::AutomationLogger Class Reference

Represents the automation logger to log information for report automation program. More...

Public Types
enum	MessageType { MessageTypeEmpty, MessageTypeInformation, MessageTypeDebug, MessageTypeException }
	Represents the automation logger message type. More...

Public Member Functions
void	Clear ()
	Clears the messages in the logger. More...
bool	IsEmpty ()
	Has messages in the logger. More...
void	LogMessage (const NXString &message)
	Adds debug message to the logger. More...
void	LogMessage (const char *message)
	Adds debug message to the logger. More...
void	LogMessage (const NXString &message, NXOpen::Report::AutomationLogger::MessageType messageType)
	Adds required type of message to the logger. More...
void	LogMessage (const char *message, NXOpen::Report::AutomationLogger::MessageType messageType)
	Adds required type of message to the logger. More...
void	SaveLog (const NXString &logFileName)
	Saves the messages in the logger to a file. More...
void	SaveLog (const char *logFileName)
	Saves the messages in the logger to a file. More...
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

Represents the automation logger to log information for report automation program.

No support KF.

Created in NX11.0.0.

Member Enumeration Documentation

enum NXOpen::Report::AutomationLogger::MessageType

Represents the automation logger message type.

Enumerator
MessageTypeEmpty	None.
MessageTypeInformation	Information message.
MessageTypeDebug	Debug message.
MessageTypeException	Exception message.

Member Function Documentation

void NXOpen::Report::AutomationLogger::Clear

(

)

Clears the messages in the logger.

Created in NX11.0.0.

License requirements : None

bool NXOpen::Report::AutomationLogger::IsEmpty

(

)

Has messages in the logger.

Returns

Created in NX11.0.0.

License requirements : None

void NXOpen::Report::AutomationLogger::LogMessage

(

const NXString &

message

)

Adds debug message to the logger.

Created in NX11.0.0.

License requirements : None

Parameters

message

message

void NXOpen::Report::AutomationLogger::LogMessage

(

const char *

message

)

Adds debug message to the logger.

Created in NX11.0.0.

License requirements : None

Parameters

message

message

void NXOpen::Report::AutomationLogger::LogMessage	(	const NXString &	message,
		NXOpen::Report::AutomationLogger::MessageType	messageType
	)

Adds required type of message to the logger.

Created in NX11.0.0.

License requirements : None

Parameters

message	message
messageType	messagetype

void NXOpen::Report::AutomationLogger::LogMessage	(	const char *	message,
		NXOpen::Report::AutomationLogger::MessageType	messageType
	)

Adds required type of message to the logger.

Created in NX11.0.0.

License requirements : None

Parameters

message	message
messageType	messagetype

void NXOpen::Report::AutomationLogger::SaveLog

(

const NXString &

logFileName

)

Saves the messages in the logger to a file.

Created in NX11.0.0.

License requirements : None

Parameters

logFileName

logfilename

void NXOpen::Report::AutomationLogger::SaveLog

(

const char *

logFileName

)

Saves the messages in the logger to a file.

Created in NX11.0.0.

License requirements : None

Parameters

logFileName

logfilename

tag_t NXOpen::Report::AutomationLogger::Tag

(

)

const

Returns the tag of this object.

---

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

• Report_AutomationLogger.hxx