PLCAddressBlock (ErgoTech VIB/TransSECS Scripting API)

java.lang.Object
- com.ergotech.vib.servers.plc.PLCAddressBlock

Direct Known Subclasses:

ControlLogixAddressBlock
```
public class PLCAddressBlock
extends java.lang.Object
```
This is the address block for the PLC protocol. It maintains an image from the PLC that it refreshes on a periodic basis. It compares the new image with an existing image and will update any servers that are watching an address that has changed. The address is zero based so that the address commonly known as 40001 will be 0 and so on.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`debugLevel` The debug level.
`int`	`errorCount` The error count for the block.
`static int`	`executorThreadCount` The number of thread to exec to splitting the values read.
`static int`	`FULL`
`static int`	`globalUniqueID`
`static int`	`HIGHER`
`int`	`imageSize` The number of bytes to read/write.
`static int`	`LOWER`
`static int`	`MUCH_HIGHER`
`static int`	`MUCH_LOWER`
`static int`	`NOT_APPROPRIATE`
`int`	`packetCount` The number of packets that have been read or written, or a useful unique packet ID, depends on how you look at it.
`DirtyVector<? super PLCServer>`	`readServers` The tables of read and write servers.
`int`	`startAddress` The starting address of this block expressed as an integer.
`int`	`uniqueID`
`static int`	`WITHIN`
`DirtyVector<? super PLCServer>`	`writeServers`

Constructor Summary

Constructors
Constructor and Description

PLCAddressBlock(PLCServer server)
Constructor.

Constructors
Constructor and Description
`PLCAddressBlock(PLCServer server)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PLCDataBlock`	`_refreshImage()` Refresh the data in the block.
`int`	`add(PLCServer server, boolean refresh)` Add the address.
`int`	`addressLocation(int address, int size)` Ask if the address could be added to this address block.
`int`	`canBeAdded(PLCServer server)` Ask if the address could be added to this address block.
`boolean`	`canBeAdded(PLCServer server, int maxOffset)` Ask if the address could be added to this address block.
`java.lang.String`	`getBlockType()` Returns the type of this block.
`int`	`getDirty()` This method returns the value of the dirty flag.
`int`	`getImageSize()` Returns the number of bytes in the current block.
`int`	`getMaximumBlockSize()` Returns the maximum allowable block size in bytes.
`Timer`	`getTimer()`
`boolean`	`isAppropriateAddress(PLCServer server)` Determines if this address points to the same type of address in the same PLC as the rest of the block.
`boolean`	`isDirty()` This method returns true if the block has been marked as dirty.
`boolean`	`isStarted()`
`PLCDataBlock`	`refreshImage()` Refresh the data in the block.
`void`	`remove(PLCServer server)` Remove the server from the read servers array.
`void`	`requestRefresh()` Force an untimely refresh of the address block.
`void`	`setDirty(boolean flag)` Dirty tracking.
`void`	`setMaximumBlockSize(int maximumBlockSize)` Set the maximum allowable block size in bytes.
`void`	`start()` Start the timer.
`void`	`tick(Timer timer)` Refresh the image on the timer tick.
`java.lang.String`	`toString()` Return an intelligent description.

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

- Field Detail
  - debugLevel
```
public static int debugLevel
```
    The debug level.
  - errorCount
```
public int errorCount
```
    The error count for the block.
  - executorThreadCount
```
public static int executorThreadCount
```
    The number of thread to exec to splitting the values read.
  - FULL
```
public static final int FULL
```
    See Also:
    
    Constant Field Values
  - globalUniqueID
```
public static int globalUniqueID
```
  - HIGHER
```
public static final int HIGHER
```
    See Also:
    
    Constant Field Values
  - imageSize
```
public int imageSize
```
    The number of bytes to read/write.
  - LOWER
```
public static final int LOWER
```
    See Also:
    
    Constant Field Values
  - MUCH_HIGHER
```
public static final int MUCH_HIGHER
```
    See Also:
    
    Constant Field Values
  - MUCH_LOWER
```
public static final int MUCH_LOWER
```
    See Also:
    
    Constant Field Values
  - NOT_APPROPRIATE
```
public static final int NOT_APPROPRIATE
```
    See Also:
    
    Constant Field Values
  - packetCount
```
public int packetCount
```
    The number of packets that have been read or written, or a useful unique packet ID, depends on how you look at it.
  - readServers
```
public DirtyVector<? super PLCServer> readServers
```
    The tables of read and write servers.
  - startAddress
```
public int startAddress
```
    The starting address of this block expressed as an integer.
  - uniqueID
```
public transient int uniqueID
```
  - WITHIN
```
public static final int WITHIN
```
    See Also:
    
    Constant Field Values
  - writeServers
```
public DirtyVector<? super PLCServer> writeServers
```
- Constructor Detail
  - PLCAddressBlock
```
public PLCAddressBlock(PLCServer server)
```
    Constructor.
    
    Parameters:
    
    startAddress - the starting address of the block.
- Method Detail
  - _refreshImage
```
public PLCDataBlock _refreshImage()
```
    Refresh the data in the block. Update any servers that are waiting for the data.
  - add
```
public int add(PLCServer server,
               boolean refresh)
```
    Add the address. This first checks if the address could be added to this address block. If the address is NOT_APPROPRIATE or the block is FULL then it will not be added, and these values will be returned.
    
    Parameters:
    
    server - the address to add
    
    refresh - whether to update the block after adding the address
    
    Returns:
    
    an integer that is the distance from the block of the new address
  - addressLocation
```
public int addressLocation(int address,
                           int size)
```
    Ask if the address could be added to this address block.
    
    Parameters:
    
    address - the address to add
    
    Returns:
    
    the offset from the block. This can be negative if the address is below the current address block.
  - canBeAdded
```
public int canBeAdded(PLCServer server)
```
    Ask if the address could be added to this address block. This returns an integer that is the distance from the block of the new address this will be NOT_APPROPRIATE if the server can never be added to this block. FULL indicates that the block has reached it's maximum size. A return of zero indicates that the address is within the existing block. for comparison. This is just a pass through to "add(server, false, true)".
    
    Parameters:
    
    server - the address to add
    
    Returns:
    
    an integer that is the distance from the block of the new address
  - canBeAdded
```
public boolean canBeAdded(PLCServer server,
                          int maxOffset)
```
    Ask if the address could be added to this address block. Returns true if the address is within the block or within the offset either above or below the existing block.
    
    Parameters:
    
    server - the address to add
    
    maxOffset - the maximum permitted number of byte above or below the block
    
    Returns:
    
    an integer that is the distance from the block of the new address
  - getBlockType
```
public java.lang.String getBlockType()
```
    Returns the type of this block. For example "1x", "0x", "3x", "4x", "V", "Q", etc.
  - getDirty
```
public int getDirty()
```
    This method returns the value of the dirty flag.
  - getImageSize
```
public int getImageSize()
```
    Returns the number of bytes in the current block. This is imageSize.
  - getMaximumBlockSize
```
public int getMaximumBlockSize()
```
    Returns the maximum allowable block size in bytes.
  - getTimer
```
public Timer getTimer()
```
    Returns:
    
    the timer
  - isAppropriateAddress
```
public boolean isAppropriateAddress(PLCServer server)
```
    Determines if this address points to the same type of address in the same PLC as the rest of the block.
  - isDirty
```
public boolean isDirty()
```
    This method returns true if the block has been marked as dirty.
  - isStarted
```
public boolean isStarted()
```
    Returns:
    
    Returns the started.
  - refreshImage
```
public PLCDataBlock refreshImage()
```
    Refresh the data in the block. Update any servers that are waiting for the data.
  - remove
```
public void remove(PLCServer server)
```
    Remove the server from the read servers array. If the block then has no elements, remove the block. The block will not be shrunk even if the amount of data being read is now larger than the required amount.
  - requestRefresh
```
public void requestRefresh()
```
    Force an untimely refresh of the address block. This is used when servers are added to the address block or when servers are unsuspended or similar. It does not cause a refresh of the block, but requests a special tick from the timer one second in the future. Adding many servers will not cause more updates if they are added in that one second spacing as the tick will occur one second after the last call to this method.
  - setDirty
```
public void setDirty(boolean flag)
```
    Dirty tracking. This is not (currently) used be all the PLC implementations. The flag is an integer and is incremented by each call to "setDirty(true)", it is reset to zero by a call to "setDirty(false)". This allows logic that can quickly determine how many servers in the block are dirty and so can decide whether to send the entire block or just particular servers.
  - setMaximumBlockSize
```
public void setMaximumBlockSize(int maximumBlockSize)
```
    Set the maximum allowable block size in bytes.
  - start
```
public void start()
```
    Start the timer. This will be called by any one of the components when they are unsuspended.
  - tick
```
public void tick(Timer timer)
```
    Refresh the image on the timer tick.
  - toString
```
public java.lang.String toString()
```
    Return an intelligent description.
    
    Overrides:
    
    toString in class java.lang.Object

Class PLCAddressBlock

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

debugLevel

errorCount

executorThreadCount

FULL

globalUniqueID

HIGHER

imageSize

LOWER

MUCH_HIGHER

MUCH_LOWER

NOT_APPROPRIATE

packetCount

readServers

startAddress

uniqueID

WITHIN

writeServers

Constructor Detail

PLCAddressBlock

Method Detail

_refreshImage

add

addressLocation

canBeAdded

canBeAdded

getBlockType

getDirty

getImageSize

getMaximumBlockSize

getTimer

isAppropriateAddress

isDirty

isStarted

refreshImage

remove

requestRefresh

setDirty

setMaximumBlockSize

start

tick

toString