Store Class

See the Store Entity for generic information.

class StoreClass : public Acroname::BrainStem::EntityClass

StoreClass: The store provides a flat file system on modules that have storage capacity. Files are referred to as slots and they have simple zero-based numbers for access. Store slots can be used for generalized storage and commonly contain compiled reflex code (files ending in .map) or templates used by the system. Slots simply contain bytes with no expected organization but the code or use of the slot may impose a structure. Stores have fixed indices based on type. Not every module contains a store of each type. Consult the module datasheet for details on which specific stores are implemented, if any, and the capacities of implemented stores.

Public Functions

StoreClass(void)

Constructor.

virtual ~StoreClass(void)

Destructor.

void init(Module *pModule, const uint8_t index)

Initialize the Store Class.

Parameters:

  • pModule – The module to which this entity belongs.

  • index – The index of the Store entity to be addressed.

aErr getSlotState(const uint8_t slot, uint8_t *state)

Get slot state.

Parameters:

  • slot – The slot number.

  • state – true: enabled, false: disabled.

Returns:

Returns common entity return values

aErr loadSlot(const uint8_t slot, const uint8_t *buffer, const uint16_t bufferLength)

Load the slot.

Parameters:

  • slot – The slot number.

  • buffer – The data.

  • bufferLength – The data length.

Returns:

Returns common entity return values

aErr unloadSlot(const uint8_t slot, const size_t bufferLength, uint8_t *buffer, size_t *unloadedLength)

Unload the slot data.

Parameters:

  • slot – The slot number.

  • bufferLength – The length of buffer buffer in bytes. This is the maximum number of bytes that should be unloaded.

  • buffer – Byte array that the unloaded data will be placed into.

  • unloadedLength – Length of data that was unloaded. Unloaded length will never be larger than dataLength.

Returns:

Returns common entity return values

aErr slotEnable(const uint8_t slot)

Enable slot.

Parameters:

slot – The slot number.

Returns:

Returns common entity return values

aErr slotDisable(const uint8_t slot)

Disable slot.

Parameters:

slot – The slot number.

Returns:

Returns common entity return values

aErr getSlotCapacity(const uint8_t slot, size_t *capacity)

Get the slot capacity. Returns the Capacity of the slot, i.e. The number of bytes it can hold.

Parameters:

  • slot – The slot number.

  • capacity – The slot capacity.

Returns:

Returns common entity return values

aErr getSlotSize(const uint8_t slot, size_t *size)

Get the slot size. The slot size represents the size of the data currently filling the slot in bytes.

Parameters:

  • slot – The slot number.

  • size – The slot size.

Returns:

Returns common entity return values

aErr getSlotLocked(const uint8_t slot, uint8_t *lock)

Gets the current lock state of the slot Allows for write protection on a slot.

Parameters:

  • slot – The slot number

  • lock – Variable to be filed with the locked state.

Returns:

Returns common entity return values

aErr setSlotLocked(const uint8_t slot, const uint8_t lock)

Sets the locked state of the slot Allows for write protection on a slot.

Parameters:

  • slot – The slot number

  • lock – state to be set.

Returns:

Returns common entity return values