telemeter.hpp File Reference

Configuration and control of a telemetry logger. More...

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	MagAOX::app::dev::telemeter< derivedT >
	A device base class which saves telemetry. More...

Namespaces
namespace	MagAOX
namespace	MagAOX::app
namespace	MagAOX::app::dev

Macros
#define	TELEMETER_SETUP_CONFIG(cfig)
	Call telemeter::setupConfig with error checking.
#define	TELEMETER_LOAD_CONFIG(cfig)
	Call telemeter::loadConfig with error checking.
#define	TELEMETER_APP_STARTUP
	Call telemeter::appStartup with error checking.
#define	TELEMETER_APP_LOGIC
	Call telemeter::appLogic with error checking.
#define	TELEMETER_APP_SHUTDOWN
	Call telemeter::appShutdown with error checking.

Detailed Description

Configuration and control of a telemetry logger.

Author

Jared R. Males

Definition in file telemeter.hpp.

Macro Definition Documentation

TELEMETER_APP_LOGIC

#define TELEMETER_APP_LOGIC

Value:

    if (telemeterT::appLogic() < 0)                           \
    {                                                         \
        return log<software_error, -1>({__FILE__, __LINE__}); \
    }

Call telemeter::appLogic with error checking.

Definition at line 372 of file telemeter.hpp.

TELEMETER_APP_SHUTDOWN

#define TELEMETER_APP_SHUTDOWN

Value:

    if (telemeterT::appShutdown() < 0)                                                   \
    {                                                                                    \
        log<software_error>({__FILE__, __LINE__, "error from telemeterT::appShutdown"}); \
    }

Call telemeter::appShutdown with error checking.

Definition at line 379 of file telemeter.hpp.

TELEMETER_APP_STARTUP

#define TELEMETER_APP_STARTUP

Value:

    if (telemeterT::appStartup() < 0)                         \
    {                                                         \
        return log<software_error, -1>({__FILE__, __LINE__}); \
    }

Call telemeter::appStartup with error checking.

Definition at line 365 of file telemeter.hpp.

TELEMETER_LOAD_CONFIG

#define TELEMETER_LOAD_CONFIG

(

cfig

)

Value:

    if (telemeterT::loadConfig(cfig) < 0)                                                          \
    {                                                                                              \
        return log<software_error, -1>({__FILE__, __LINE__, "Error from telemeterT::loadConfig"}); \
    }

Call telemeter::loadConfig with error checking.

This must be inside a function that returns int, e.g. the standard loadConfigImpl.

Parameters

cfig	the application configurator

Definition at line 358 of file telemeter.hpp.

TELEMETER_SETUP_CONFIG

#define TELEMETER_SETUP_CONFIG

(

cfig

)

Value:

    if (telemeterT::setupConfig( cfig) < 0)                                              \
    {                                                                                    \
        log<software_error>({__FILE__, __LINE__, "Error from telemeterT::setupConfig"}); \
        m_shutdown = true;                                                               \
    }

Call telemeter::setupConfig with error checking.

Parameters

cfig	the application configurator

Definition at line 347 of file telemeter.hpp.