BufferInfo

java.lang.Object
- diagapplet.CodeGen.BufferInfo

```
public class BufferInfo
extends java.lang.Object
```
Stores referencees to all of the information needed by the Design or Diagnostics tools related to a single NML Buffer.

Field Summary

Fields
Modifier and Type	Field and Description
`boolean`	`bufferline_headers_checked`
`java.util.Hashtable`	`channelsHashtable` Hashtable matching module Names to ChannelInfo objects associated with this buffer.
`java.lang.String`	`configFile` NML Configuration file associated with this buffer.
`boolean`	`has_been_plotted` Has the diagnosics tool already plotted this buffer since reading it?
`int`	`id` Integer Id used only by Design Tool.
`int`	`last_selected_msg_index`
`int`	`max_plot_var_number` The hightest variable number needed for plotting.
`java.lang.String`	`message_data` Message data after conversion to a comma delimited string.
`ModuleInfoInterface`	`mi` ModuleInfo associated with this buffer.
`java.lang.String`	`Name` Name of buffer used in NML constructor and config file.
`int`	`new_data_count` How many times have we read new data from this buffer? Can be used to determine if plotting/redisplay etc is necessary.
`DiagNMLMsgDictInterface`	`read_msg_dict` NMLMessageDictionary associated with the read channel.
`NMLConnectionInterface`	`read_nml` Connection used by Diagnostics tool for reading from this buffer.
`java.util.List<java.lang.String>`	`readerNames` List of all the names of all processes known to read from this buffer.
`ServerInfo`	`si` ServerInfo associated with this buffer.
`DiagNMLMsgDictInterface`	`write_msg_dict` NMLMessageDictionary associated with the write channel.
`NMLConnectionInterface`	`write_nml` Connection used by Diagnostics tool for writing to this buffer.
`java.util.List<java.lang.String>`	`writerNames` List of all the names of all processes known to write to this buffer.

Constructor Summary

Constructors
Constructor and Description

BufferInfo()

Constructors
Constructor and Description
`BufferInfo()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`NMLConnectionInterface`	`createExtraChannel()` Create an extra channel cloning the options in the read channel.
`static NMLFormatConvertErrCallbackInterface`	`get_nml_format_err_callback()`
`java.lang.String[]`	`getBufferLineHeaders()`
`java.lang.String`	`getMessageData(int read_id)` Read data from the buffer and convert to a comma delimited string.
`java.util.Vector`	`getMsgsAvailable()` Get the list of messages that can be sent and received from this buffer.
`java.lang.String`	`GetPreviousMessage(java.lang.Long l)`
`java.util.Hashtable`	`getPreviousMessagesHashtable()`
`boolean`	`isConnected()` Getter for property connected.
`void`	`setConnected(boolean connected)` Setter for property connected.
`void`	`SetNMLConfigFile(java.lang.String new_config_file)` Change to a new configuration file.
`void`	`SetPreviousMessage(java.lang.String s)`
`void`	`setPreviousMessagesHashtable(java.util.Hashtable _ht)`
`java.lang.String`	`toString()`
`int`	`writeDataString(java.lang.String s)`

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

- Field Detail
  - bufferline_headers_checked
```
public boolean bufferline_headers_checked
```
  - Name
```
public java.lang.String Name
```
    Name of buffer used in NML constructor and config file.
  - si
```
public ServerInfo si
```
    ServerInfo associated with this buffer. Used only by Design tool.
  - id
```
public int id
```
    Integer Id used only by Design Tool.
  - readerNames
```
public java.util.List<java.lang.String> readerNames
```
    List of all the names of all processes known to read from this buffer. Used only by Design tool.
  - writerNames
```
public java.util.List<java.lang.String> writerNames
```
    List of all the names of all processes known to write to this buffer. Used only by Design tool.
  - channelsHashtable
```
public java.util.Hashtable channelsHashtable
```
    Hashtable matching module Names to ChannelInfo objects associated with this buffer. Used only by Design tool.
  - configFile
```
public java.lang.String configFile
```
    NML Configuration file associated with this buffer.
  - last_selected_msg_index
```
public int last_selected_msg_index
```
  - write_nml
```
public NMLConnectionInterface write_nml
```
    Connection used by Diagnostics tool for writing to this buffer.
  - read_nml
```
public NMLConnectionInterface read_nml
```
    Connection used by Diagnostics tool for reading from this buffer.
  - max_plot_var_number
```
public int max_plot_var_number
```
    The hightest variable number needed for plotting. Messages only needed for plotting can stop being parsed after this number.
  - has_been_plotted
```
public boolean has_been_plotted
```
    Has the diagnosics tool already plotted this buffer since reading it?
  - message_data
```
public java.lang.String message_data
```
    Message data after conversion to a comma delimited string. Same as last string returned by getMessageData()
  - new_data_count
```
public int new_data_count
```
    How many times have we read new data from this buffer? Can be used to determine if plotting/redisplay etc is necessary.
  - read_msg_dict
```
public DiagNMLMsgDictInterface read_msg_dict
```
    NMLMessageDictionary associated with the read channel.
  - write_msg_dict
```
public DiagNMLMsgDictInterface write_msg_dict
```
    NMLMessageDictionary associated with the write channel.
  - mi
```
public ModuleInfoInterface mi
```
    ModuleInfo associated with this buffer.
- Constructor Detail
  - BufferInfo
```
public BufferInfo()
```
- Method Detail
  - getBufferLineHeaders
```
public java.lang.String[] getBufferLineHeaders()
```
  - getPreviousMessagesHashtable
```
public java.util.Hashtable getPreviousMessagesHashtable()
```
  - setPreviousMessagesHashtable
```
public void setPreviousMessagesHashtable(java.util.Hashtable _ht)
```
  - get_nml_format_err_callback
```
public static NMLFormatConvertErrCallbackInterface get_nml_format_err_callback()
```
  - SetPreviousMessage
```
public void SetPreviousMessage(java.lang.String s)
```
  - GetPreviousMessage
```
public java.lang.String GetPreviousMessage(java.lang.Long l)
```
  - writeDataString
```
public int writeDataString(java.lang.String s)
                    throws NMLException
```
    Throws:
    
    NMLException
  - SetNMLConfigFile
```
public void SetNMLConfigFile(java.lang.String new_config_file)
```
    Change to a new configuration file. Disconnecting and reconnecting with new parameters each of the NML Connections as necessary.
    
    Parameters:
    
    new_config_file - new value of configuration file name
  - getMsgsAvailable
```
public java.util.Vector getMsgsAvailable()
```
    Get the list of messages that can be sent and received from this buffer.
    
    Returns:
    
    Vector of messages available.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getMessageData
```
public java.lang.String getMessageData(int read_id)
```
    Read data from the buffer and convert to a comma delimited string.
    
    Parameters:
    
    read_id - used to determine if this data is new if data has been written into the buffer but still has the same id as read_id then the data will be considered old.
    
    Returns:
    
    comma delimeted string
  - createExtraChannel
```
public NMLConnectionInterface createExtraChannel()
```
    Create an extra channel cloning the options in the read channel.
    
    Returns:
    
    extra nml channel
  - isConnected
```
public boolean isConnected()
```
    Getter for property connected.
    
    Returns:
    
    Value of property connected.
  - setConnected
```
public void setConnected(boolean connected)
```
    Setter for property connected.
    
    Parameters:
    
    connected - New value of property connected.

Class BufferInfo

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

bufferline_headers_checked

Name

si

id

readerNames

writerNames

channelsHashtable

configFile

last_selected_msg_index

write_nml

read_nml

max_plot_var_number

has_been_plotted

message_data

new_data_count

read_msg_dict

write_msg_dict

mi

Constructor Detail

BufferInfo

Method Detail

getBufferLineHeaders

getPreviousMessagesHashtable

setPreviousMessagesHashtable

get_nml_format_err_callback

SetPreviousMessage

GetPreviousMessage

writeDataString

SetNMLConfigFile

getMsgsAvailable

toString

getMessageData

createExtraChannel

isConnected

setConnected