Class WriteAccessParams


  • public class WriteAccessParams
    extends java.lang.Object
    • Constructor Summary

      Constructors 
      Constructor Description
      WriteAccessParams()
      Constructor
      WriteAccessParams​(MEMORY_BANK m_eMemoryBank, int m_nByteOffset, int m_nWriteDataLength, long m_nAccessPassword, byte[] m_WriteData)  
    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      long getAccessPassword()
      Password to be used for the Access operation.
      int getByteOffset()
      Deprecated.
      Address of the first short to be written to the chosen memory bank.
      MEMORY_BANK getMemoryBank()
      Memory bank on which data is to be written to.
      int getOffset()
      Address of the first word to be written to the chosen memory bank.
      java.lang.String getStringWriteData()
      Returns data to be written in string format.
      byte[] getWriteData()
      Pointer to a short array which contains the data to be written.
      int getWriteDataLength()
      Length of the WriteData in words to be considered for write access operation.
      int getWriteRetries()
      Get the number of retries to be performed for write access operation
      void setAccessPassword​(long accessPassword)
      Password to be used for the Access operation.
      void setByteOffset​(int byteOffset)
      Deprecated.
      Address of the first short to be written to the chosen memory bank.
      void setMemoryBank​(MEMORY_BANK memoryBank)
      Memory bank on which data is to be written to.
      void setOffset​(int Offset)
      Address of the first word to be written to the chosen memory bank.
      void setWriteData​(byte[] writeData)
      Deprecated.
      - use same API with string as parameter Pointer to a short array which contains the data to be written.
      void setWriteData​(java.lang.String writeDataInStringFormat)
      Pointer to a string which contains the data to be written.
      void setWriteDataLength​(int writeDataLength)
      Length of the WriteData in words to be considered for write access operation.
      void setWriteRetries​(int writeRetries)
      Number of retries to be performed for write access operation.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • WriteAccessParams

        public WriteAccessParams​(MEMORY_BANK m_eMemoryBank,
                                 int m_nByteOffset,
                                 int m_nWriteDataLength,
                                 long m_nAccessPassword,
                                 byte[] m_WriteData)
      • WriteAccessParams

        public WriteAccessParams()
        Constructor
    • Method Detail

      • getWriteData

        public byte[] getWriteData()
        Pointer to a short array which contains the data to be written. Write operation occurs only on word boundaries, hence it is required to input this field accordingly. For e.g The word 0x1122 will be short writeData[2] = {0x11,0x22}
      • setWriteData

        public void setWriteData​(java.lang.String writeDataInStringFormat)
        Pointer to a string which contains the data to be written. Write operation occurs only on word boundaries, hence it is required to input this field accordingly. For e.g The word 0x1122 will be short writeData[4] = {"1122"}
      • getStringWriteData

        public java.lang.String getStringWriteData()
        Returns data to be written in string format.
      • setWriteData

        public void setWriteData​(byte[] writeData)
        Deprecated.
        - use same API with string as parameter Pointer to a short array which contains the data to be written. Write operation occurs only on word boundaries, hence it is required to input this field accordingly. For e.g The word 0x1122 will be short writeData[4] = {0x1,0x1,0x2,0x2}
      • getMemoryBank

        public MEMORY_BANK getMemoryBank()
        Memory bank on which data is to be written to.
      • setMemoryBank

        public void setMemoryBank​(MEMORY_BANK memoryBank)
        Memory bank on which data is to be written to.
      • getAccessPassword

        public long getAccessPassword()
        Password to be used for the Access operation.
      • setAccessPassword

        public void setAccessPassword​(long accessPassword)
        Password to be used for the Access operation.
      • getOffset

        public int getOffset()
        Address of the first word to be written to the chosen memory bank. Since Access operation is WORD aligned, offset be in double bytes.
      • setOffset

        public void setOffset​(int Offset)
        Address of the first word to be written to the chosen memory bank. Since Access operation is WORD aligned, offset be in double bytes.
      • getByteOffset

        public int getByteOffset()
        Deprecated.
        Address of the first short to be written to the chosen memory bank. Since Access operation is WORD aligned, offset be in double bytes.
      • setByteOffset

        public void setByteOffset​(int byteOffset)
        Deprecated.
        Address of the first short to be written to the chosen memory bank. Since Access operation is WORD aligned, offset be in double bytes.
      • getWriteDataLength

        public int getWriteDataLength()
        Length of the WriteData in words to be considered for write access operation.
      • setWriteDataLength

        public void setWriteDataLength​(int writeDataLength)
        Length of the WriteData in words to be considered for write access operation.
      • getWriteRetries

        public int getWriteRetries()
        Get the number of retries to be performed for write access operation
      • setWriteRetries

        public void setWriteRetries​(int writeRetries)
        Number of retries to be performed for write access operation.