VIBLogger (ErgoTech VIB/TransSECS Scripting API)

java.lang.Object
- com.ergotech.transsecs.secs.VIBLogger

All Implemented Interfaces:

LoggerInterface, SecsEventListener, java.util.EventListener
```
public class VIBLogger
extends java.lang.Object
implements LoggerInterface
```
This logger provides access to the messages,bytestreams and events from within MIStudio. However, the organization needs to be changed so that either this is a real bean that goes on the screen, or it is part of the ConnectionConfig. In this form it is not usable.

Field Summary
- Fields inherited from interface com.ergotech.secs.SecsEventListener
  cvsRev

Constructor Summary

Constructors
Constructor and Description

VIBLogger(java.lang.String loggerName, OutPortConnectionInterface parent)
This should only be called once.

Constructors
Constructor and Description
`VIBLogger(java.lang.String loggerName, OutPortConnectionInterface parent)` This should only be called once.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`getDisplayBytes()`
`boolean`	`getDisplayMessages()`
`DataSource.Writable`	`getEvents()`
`static VIBLogger`	`getLogger(java.lang.String loggerName)` Returns a logger for the given equipment name.
`java.lang.String`	`getLoggerName()`
`DataSource.Writable`	`getReceivedBytes()`
`DataSource.Writable`	`getReceivedMsg()`
`DataSource.Writable`	`getSentBytes()`
`DataSource.Writable`	`getSentMsg()`
`void`	`received(byte[] msg)` Called to display the byte stream received.
`void`	`received(SecsMsg msg)` Called to display the SML of the messages received.
`void`	`register()`
`void`	`register(SecsEventHandler theHandler)`
`void`	`registerForId(int id)`
`void`	`registerForId(SecsEventHandler theHandler, int id)`
`static VIBLogger`	`removeLogger(java.lang.String loggerName)` Remove the named logger.
`void`	`secsEvent(SecsEvent theEvent)` Called to display the SECS events.
`void`	`sent(byte[] msg)` Called to display the byte stream sent.
`void`	`sent(SecsMsg msg)` Called to display the SML of the sent message.
`void`	`setDisplayBytes(boolean newValue)` This allows the logger to control the display of byte data.
`void`	`setDisplayEvents(boolean newValue)` This method will turn on the display of all events.
`void`	`setDisplayMessages(boolean newValue)` This allows the logger to control the display of message data.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - VIBLogger
```
public VIBLogger(java.lang.String loggerName,
                 OutPortConnectionInterface parent)
```
    This should only be called once.
- Method Detail
  - getDisplayBytes
```
public boolean getDisplayBytes()
```
  - getDisplayMessages
```
public boolean getDisplayMessages()
```
  - getEvents
```
public DataSource.Writable getEvents()
```
    Returns:
    
    Returns the events.
  - getLogger
```
public static VIBLogger getLogger(java.lang.String loggerName)
```
    Returns a logger for the given equipment name. This method will not create a logger and so may return null.
    
    Parameters:
    
    loggerName - The name of the desired logger
    
    Returns:
  - getLoggerName
```
public java.lang.String getLoggerName()
```
    Returns:
    
    Returns the loggerName.
  - getReceivedBytes
```
public DataSource.Writable getReceivedBytes()
```
    Returns:
    
    Returns the receivedBytes.
  - getReceivedMsg
```
public DataSource.Writable getReceivedMsg()
```
    Returns:
    
    Returns the receivedMsg.
  - getSentBytes
```
public DataSource.Writable getSentBytes()
```
    Returns:
    
    Returns the sentBytes.
  - getSentMsg
```
public DataSource.Writable getSentMsg()
```
    Returns:
    
    Returns the sentMsg.
  - received
```
public void received(byte[] msg)
```
    Called to display the byte stream received.
    
    Specified by:
    
    received in interface LoggerInterface
  - received
```
public void received(SecsMsg msg)
```
    Called to display the SML of the messages received.
    
    Specified by:
    
    received in interface LoggerInterface
  - register
```
public void register()
```
  - register
```
public void register(SecsEventHandler theHandler)
```
  - registerForId
```
public void registerForId(int id)
```
  - registerForId
```
public void registerForId(SecsEventHandler theHandler,
                          int id)
```
  - removeLogger
```
public static VIBLogger removeLogger(java.lang.String loggerName)
```
    Remove the named logger.
  - secsEvent
```
public void secsEvent(SecsEvent theEvent)
```
    Called to display the SECS events.
    
    Specified by:
    
    secsEvent in interface SecsEventListener
  - sent
```
public void sent(byte[] msg)
```
    Called to display the byte stream sent.
    
    Specified by:
    
    sent in interface LoggerInterface
  - sent
```
public void sent(SecsMsg msg)
```
    Called to display the SML of the sent message.
    
    Specified by:
    
    sent in interface LoggerInterface
  - setDisplayBytes
```
public void setDisplayBytes(boolean newValue)
```
    Description copied from interface: LoggerInterface
    
    This allows the logger to control the display of byte data. This will be called whenever the user wishes to enable or disable the display of byte data. Note that this has no impact on whether the methods are called. The SECS system will always call the logger methods, it is the task of the logger to decide what to do with the information, this method is here just to help with that task.
    
    Specified by:
    
    setDisplayBytes in interface LoggerInterface
  - setDisplayEvents
```
public void setDisplayEvents(boolean newValue)
```
    This method will turn on the display of all events. It will do this regardless of the value of the boolean.
    
    Specified by:
    
    setDisplayEvents in interface LoggerInterface
  - setDisplayMessages
```
public void setDisplayMessages(boolean newValue)
```
    Description copied from interface: LoggerInterface
    
    This allows the logger to control the display of message data. This will be called whenever the user wishes to enable or disable the display of message data. Note that this has no impact on whether the methods are called. The SECS system will always call the logger methods, it is the task of the logger to decide what to do with the information, this method is here just to help with that task.
    
    Specified by:
    
    setDisplayMessages in interface LoggerInterface
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class VIBLogger

Field Summary

Fields inherited from interface com.ergotech.secs.SecsEventListener

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

VIBLogger

Method Detail

getDisplayBytes

getDisplayMessages

getEvents

getLogger

getLoggerName

getReceivedBytes

getReceivedMsg

getSentBytes

getSentMsg

received

received

register

register

registerForId

registerForId

removeLogger

secsEvent

sent

sent

setDisplayBytes

setDisplayEvents

setDisplayMessages

toString