The MagAO-X generic shared memory monitor. More...

#include <ImageStreamIO/ImageStruct.h>
#include <ImageStreamIO/ImageStreamIO.h>
#include "../../libMagAOX/common/paths.hpp"

Include dependency graph for shmimMonitor.hpp:

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

Go to the source code of this file.

Classes
struct	MagAOX::app::dev::shmimT

class	MagAOX::app::dev::shmimMonitor< derivedT, specificT >

Namespaces
namespace	MagAOX

namespace	MagAOX::app

namespace	MagAOX::app::dev

Macros
#define	SHMIMMONITOR_SETUP_CONFIG(cfig)
	Call shmimMonitorT::setupConfig with error checking for shmimMonitor.

#define	SHMIMMONITORT_SETUP_CONFIG(SHMIMMONITORT, cfig)
	Call shmimMonitorT::setupConfig with error checking for a typedef-ed shmimMonitor.

#define	SHMIMMONITOR_LOAD_CONFIG(cfig)
	Call shmimMonitorT::loadConfig with error checking for shmimMonitor.

#define	SHMIMMONITORT_LOAD_CONFIG(SHMIMMONITORT, cfig)
	Call shmimMonitorT::loadConfig with error checking for a typedef-ed shmimMonitor.

#define	SHMIMMONITOR_APP_STARTUP
	Call shmimMonitorT::appStartup with error checking for shmimMonitor.

#define	SHMIMMONITORT_APP_STARTUP(SHMIMMONITORT)
	Call shmimMonitorT::appStartup with error checking for a typedef-ed shmimMonitor.

#define	SHMIMMONITOR_APP_LOGIC
	Call shmimMonitorT::appLogic with error checking for shmimMonitor.

#define	SHMIMMONITORT_APP_LOGIC(SHMIMMONITORT)
	Call shmimMonitorT::appLogic with error checking for a typedef-ed shmimMonitor.

#define	SHMIMMONITOR_UPDATE_INDI
	Call shmimMonitorT::updateINDI with error checking for shmimMonitor.

#define	SHMIMMONITORT_UPDATE_INDI(SHMIMMONITORT)
	Call shmimMonitorT::updateINDI with error checking for a typedef-ed shmimMonitor.

#define	SHMIMMONITOR_APP_SHUTDOWN
	Call shmimMonitorT::appShutdown with error checking for shmimMonitor.

#define	SHMIMMONITORT_APP_SHUTDOWN(SHMIMMONITORT)
	Call shmimMonitorT::appShutodwn with error checking for a typedef-ed shmimMonitor.

Enumerations
enum class	MagAOX::app::dev::shmimMonitorState { MagAOX::app::dev::init , MagAOX::app::dev::notfound , MagAOX::app::dev::connected }

Detailed Description

The MagAO-X generic shared memory monitor.

Author: Jared R. Males (jared.nosp@m.male.nosp@m.s@gma.nosp@m.il.c.nosp@m.om)

Definition in file shmimMonitor.hpp.

Macro Definition Documentation

◆ SHMIMMONITOR_APP_LOGIC

#define SHMIMMONITOR_APP_LOGIC

Value:

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

Call shmimMonitorT::appLogic with error checking for shmimMonitor.

Definition at line 999 of file shmimMonitor.hpp.

◆ SHMIMMONITOR_APP_SHUTDOWN

#define SHMIMMONITOR_APP_SHUTDOWN

Value:

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

Call shmimMonitorT::appShutdown with error checking for shmimMonitor.

Definition at line 1033 of file shmimMonitor.hpp.

◆ SHMIMMONITOR_APP_STARTUP

#define SHMIMMONITOR_APP_STARTUP

Value:

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

Call shmimMonitorT::appStartup with error checking for shmimMonitor.

Definition at line 982 of file shmimMonitor.hpp.

◆ SHMIMMONITOR_LOAD_CONFIG

#define SHMIMMONITOR_LOAD_CONFIG ( cfig )

Value:

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

Call shmimMonitorT::loadConfig with error checking for shmimMonitor.

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

Parameters

cfig	the application configurator

Definition at line 964 of file shmimMonitor.hpp.

◆ SHMIMMONITOR_SETUP_CONFIG

#define SHMIMMONITOR_SETUP_CONFIG ( cfig )

Value:

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

Call shmimMonitorT::setupConfig with error checking for shmimMonitor.

Parameters

cfig	the application configurator

Definition at line 939 of file shmimMonitor.hpp.

◆ SHMIMMONITOR_UPDATE_INDI

#define SHMIMMONITOR_UPDATE_INDI

Value:

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

Call shmimMonitorT::updateINDI with error checking for shmimMonitor.

Definition at line 1016 of file shmimMonitor.hpp.

◆ SHMIMMONITORT_APP_LOGIC

#define SHMIMMONITORT_APP_LOGIC ( SHMIMMONITORT )

Value:

    if( SHMIMMONITORT::appLogic() < 0 )                                                                                \
    {                                                                                                                  \
        return log<software_error, -1>( { __FILE__, __LINE__, "Error from " #SHMIMMONITORT "::appLogic" } );           \
    }

Call shmimMonitorT::appLogic with error checking for a typedef-ed shmimMonitor.

Parameters

SHMIMMONITORT is the typedef-ed name of the shmimMonitor class, e.g. darkShmimMonitorT.

Definition at line 1009 of file shmimMonitor.hpp.

◆ SHMIMMONITORT_APP_SHUTDOWN

#define SHMIMMONITORT_APP_SHUTDOWN ( SHMIMMONITORT )

Value:

    if( SHMIMMONITORT::appShutdown() < 0 )                                                                             \
    {                                                                                                                  \
        return log<software_error, -1>( { __FILE__, __LINE__, "Error from " #SHMIMMONITORT "::appShutdown" } );        \
    }

Call shmimMonitorT::appShutodwn with error checking for a typedef-ed shmimMonitor.

Parameters

SHMIMMONITORT is the typedef-ed name of the shmimMonitor class, e.g. darkShmimMonitorT.

Definition at line 1043 of file shmimMonitor.hpp.

◆ SHMIMMONITORT_APP_STARTUP

#define SHMIMMONITORT_APP_STARTUP ( SHMIMMONITORT )

Value:

    if( SHMIMMONITORT::appStartup() < 0 )                                                                              \
    {                                                                                                                  \
        return log<software_error, -1>( { __FILE__, __LINE__, "Error from " #SHMIMMONITORT "::appStartup" } );         \
    }

Call shmimMonitorT::appStartup with error checking for a typedef-ed shmimMonitor.

Parameters

SHMIMMONITORT is the typedef-ed name of the shmimMonitor class, e.g. darkShmimMonitorT.

Definition at line 992 of file shmimMonitor.hpp.

◆ SHMIMMONITORT_LOAD_CONFIG

#define SHMIMMONITORT_LOAD_CONFIG	(	SHMIMMONITORT,
		cfig
	)

Value:

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

Call shmimMonitorT::loadConfig with error checking for a typedef-ed shmimMonitor.

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

Parameters

SHMIMMONITORT	is the typedef-ed name of the shmimMonitor class, e.g. darkShmimMonitorT.
cfig	the application configurator

Definition at line 975 of file shmimMonitor.hpp.

◆ SHMIMMONITORT_SETUP_CONFIG

#define SHMIMMONITORT_SETUP_CONFIG	(	SHMIMMONITORT,
		cfig
	)

Value:

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

Call shmimMonitorT::setupConfig with error checking for a typedef-ed shmimMonitor.

Parameters

SHMIMMONITORT	is the typedef-ed name of the shmimMonitor class, e.g. darkShmimMonitorT.
cfig	the application configurator

Definition at line 952 of file shmimMonitor.hpp.

◆ SHMIMMONITORT_UPDATE_INDI

#define SHMIMMONITORT_UPDATE_INDI ( SHMIMMONITORT )

Value:

    if( SHMIMMONITORT::updateINDI() < 0 )                                                                              \
    {                                                                                                                  \
        return log<software_error, -1>( { __FILE__, __LINE__, "Error from " #SHMIMMONITORT "::updateINDI" } );         \
    }

Call shmimMonitorT::updateINDI with error checking for a typedef-ed shmimMonitor.

Parameters

SHMIMMONITORT is the typedef-ed name of the shmimMonitor class, e.g. darkShmimMonitorT.

Definition at line 1026 of file shmimMonitor.hpp.

Classes

Namespaces

Macros

Enumerations

Detailed Description

Macro Definition Documentation

◆ SHMIMMONITOR_APP_LOGIC

◆ SHMIMMONITOR_APP_SHUTDOWN

◆ SHMIMMONITOR_APP_STARTUP

◆ SHMIMMONITOR_LOAD_CONFIG

◆ SHMIMMONITOR_SETUP_CONFIG

◆ SHMIMMONITOR_UPDATE_INDI

◆ SHMIMMONITORT_APP_LOGIC

◆ SHMIMMONITORT_APP_SHUTDOWN

◆ SHMIMMONITORT_APP_STARTUP

◆ SHMIMMONITORT_LOAD_CONFIG

◆ SHMIMMONITORT_SETUP_CONFIG

◆ SHMIMMONITORT_UPDATE_INDI