Class SecurityInterfaceObject

Inheritance Relationships

Base Type

Class Documentation

class SecurityInterfaceObject : public InterfaceObject

Public Functions

SecurityInterfaceObject()
virtual void masterReset(EraseCode eraseCode, uint8_t channel) override
bool isSecurityModeEnabled()
bool isLoaded()
const uint8_t *toolKey()
const uint8_t *p2pKey(uint16_t addressIndex)
const uint8_t *groupKey(uint16_t addressIndex)
uint16_t indAddressIndex(uint16_t indAddr)
void setSequenceNumber(bool toolAccess, uint64_t seqNum)
uint64_t getLastValidSequenceNumber(uint16_t deviceAddr)
void setLastValidSequenceNumber(uint16_t deviceAddr, uint64_t seqNum)
DataSecurity getGroupObjectSecurity(uint16_t index)
LoadState loadState()
virtual uint8_t *save(uint8_t *buffer) override

This method is called when the object should save its state to the buffer.

Parameters:

buffer – The buffer the object should save its state to.

Returns:

The buffer plus the size of the object state. The next object will use this value as the start of its buffer.

virtual const uint8_t *restore(const uint8_t *buffer) override

This method is called when the object should restore its state from the buffer.

Parameters:

buffer – The buffer the object should restore its state from.

Returns:

The buffer plus the size of the object state. The next object will use this value as the start of its buffer.

virtual uint16_t saveSize() override
Returns:

The maximum number of bytes the object needs to save its state.