App Class

class AppClass

The AppClass is used to send a cmAPP packet to the BrainStem network. These commands are used for either host-to-stem or stem-to-stem interactions. BrainStem modules can implement a reflex origin to complete an action when

Public Functions

AppClass(Acroname::BrainStem::AppClass &app)

Constructor.

~AppClass()

Destructor.

Acroname::BrainStem2CLI::AppClass::!AppClass()

Finalizer.

aErr execute(const unsigned int appParam)

Execute the app reflex on the module. Don’t wait for a return value from the execute call; this call returns immediately upon execution of the module’s reflex.

Return

aErrNone - success.

Return

aErrTimeout - The request timed out waiting to start execution.

Return

aErrConnection - No active link connection.

Return

aErrNotFound - the app reflex was not found or not enabled on the module.

Parameters
  • appParam: The app parameter handed to the reflex.

aErr execute(const unsigned int appParam, unsigned int %returnVal)

Execute the app reflex on the module. Wait for a return from the reflex execution for msTimoue milliseconds. This method will block for up to msTimeout.

Return

aErrNone - success.

Return

aErrTimeout - The request timed out waiting for a response.

Return

aErrConnection - No active link connection.

Return

aErrNotFound - the app reflex was not found or not enabled on the module.

Parameters
  • appParam: The app parameter handed to the reflex.

  • returnVal: The return value filled in from the result of executing the reflex routine.

aErr execute(const unsigned int appParam, unsigned int %returnVal, const unsigned int msTimeout)

Execute the app reflex on the module. Wait for a return from the reflex execution for msTimoue milliseconds. This method will block for up to msTimeout.

Return

aErrNone - success.

Return

aErrTimeout - The request timed out waiting for a response.

Return

aErrConnection - No active link connection.

Return

aErrNotFound - the app reflex was not found or not enabled on the module.

Parameters
  • appParam: The app parameter handed to the reflex.

  • returnVal: The return value filled in from the result of executing the reflex routine.

  • msTimeout: The amount of time to wait for the return value from the reflex routine. The default value is 1000 milliseconds if not specified.