Store Class

class StoreClass : public 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()

Constructors.

~StoreClass()

Destructor.

!StoreClass ()

Finalizer.

void init (BrainStem2CLI::ModuleClass^ module, const unsigned char index)

Initializes the class. Should only be called when manually creating classes.

Parameters:

  • pModule – The module.

  • index – The cmdSTORE index to be addressed.

aErr getSlotState(const unsigned char slot, unsigned char %state)

Get slot state.

Parameters:

  • slot – The slot number.

  • state – true: enabled, false: disabled.

Returns:

Returns common entity return values

aErr loadSlot(const unsigned char slot, const unsigned char %pData, const unsigned short length)

Load the slot.

Parameters:

  • slot – The slot number.

  • pData – The data.

  • length – The data length.

Returns:

Returns common entity return values

aErr unloadSlot(const unsigned char slot, const unsigned int dataLength, unsigned char %pData, unsigned int %unloadedLength)

Unload the slot data.

Parameters:

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

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

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

  • slot – The slot number.

Returns:

Returns common entity return values

aErr slotEnable(const unsigned char slot)

Enable slot.

Parameters:

slot – The slot number.

Returns:

Returns common entity return values

aErr slotDisable(const unsigned char slot)

Disable slot.

Parameters:

slot – The slot number.

Returns:

Returns common entity return values

aErr getSlotCapacity(const unsigned char slot, unsigned int %capacity)

Get the slot capacity.

Parameters:

  • slot – The slot number.

  • capacity – The slot capacity.

Returns:

Returns common entity return values

aErr getSlotSize(const unsigned char slot, unsigned int %size)

Get the slot size

Parameters:

  • slot – The slot number.

  • size – The slot size.

Returns:

Returns common entity return values