NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | Properties | List of all members
NXOpen.Report.AutomationLogger Class Reference

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

Inheritance diagram for NXOpen.Report.AutomationLogger:
NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  MessageType { Empty, Information, Debug, Exception }
 Represents the automation logger message type. More...
 

Public Member Functions

unsafe void Clear ()
 Clears the messages in the logger. More...
 
unsafe bool IsEmpty ()
 Has messages in the logger. More...
 
unsafe void LogMessage (string message)
 Adds debug message to the logger. More...
 
unsafe void LogMessage (string message, NXOpen.Report.AutomationLogger.MessageType messageType)
 Adds required type of message to the logger. More...
 
unsafe void SaveLog (string logFileName)
 Saves the messages in the logger to a file. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Properties

Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.Utilities.NXRemotableObject
void initialize ()
 <exclude> 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

Represents the automation logger message type.

Enumerator
Empty 

None

Information 

Information message

Debug 

Debug message

Exception 

Exception message

Member Function Documentation

unsafe void NXOpen.Report.AutomationLogger.Clear ( )
inline

Clears the messages in the logger.

Created in NX11.0.0

License requirements: None.

unsafe bool NXOpen.Report.AutomationLogger.IsEmpty ( )
inline

Has messages in the logger.

Created in NX11.0.0

License requirements: None.

Returns
unsafe void NXOpen.Report.AutomationLogger.LogMessage ( string  message)
inline

Adds debug message to the logger.

Created in NX11.0.0

License requirements: None.

Parameters
message
unsafe void NXOpen.Report.AutomationLogger.LogMessage ( string  message,
NXOpen.Report.AutomationLogger.MessageType  messageType 
)
inline

Adds required type of message to the logger.

Created in NX11.0.0

License requirements: None.

Parameters
message
messageType
unsafe void NXOpen.Report.AutomationLogger.SaveLog ( string  logFileName)
inline

Saves the messages in the logger to a file.

Created in NX11.0.0

License requirements: None.

Parameters
logFileName

Property Documentation

Tag NXOpen.Report.AutomationLogger.Tag
get

Returns the tag of this object.


The documentation for this class was generated from the following file:
Copyright 2019 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.