log.hpp File Reference

Defines an event/data logging system for swarm. More...

#include "../common.hpp"
#include "gpulog/gpulog.h"
#include "gpulog/lprintf.h"
#include "../types/ensemble.hpp"
#include "types.hpp"

Go to the source code of this file.

Namespaces
	swarm
	Swarm-NG library.
	swarm::log
	The event/data logging system for swarm

Constant Groups
	swarm
	Swarm-NG library.
	swarm::log
	The event/data logging system for swarm

Functions
int	swarm::log::num_ints_for_event (const int code)
	Helper function to decide how many integers are expected.
int	swarm::log::num_doubles_for_event (const int code)
	Helper function to decide how many doubles are expected.
template<typename L >
GENERIC void	swarm::log::system (L &l, ensemble::SystemRefConst sys)
	Store a snapshot of the entire system (EVT_SNAPSHOT).
template<typename L >
GENERIC void	swarm::log::system (L &l, const ensemble &ens, const int sys)
	Store a snapshot of the entire system (EVT_SNAPSHOT).
template<typename L >
GENERIC void	swarm::log::ensemble (L &l, const swarm::ensemble &ens)
	Store a snapshot of the entire ensemble (convenience).
template<typename L >
GENERIC void	swarm::log::ensemble_enabled (L &l, const swarm::ensemble &ens)
	Store a snapshot of all non-disabled systems within the ensemble (convenience).

Variables
static const int	swarm::log::EVT_SNAPSHOT = 1
	marks a snapshot of a system. see swarm::log::system() down below
static const int	swarm::log::EVT_EJECTION = 2
	marks a body has been ejected
static const int	swarm::log::EVT_ENCOUNTER = 3
	marks near a close encounter event
static const int	swarm::log::EVT_COLLISION = 4
	marks near a physical collision
static const int	swarm::log::EVT_COLLISION_CENTRAL = 5
	marks near a collision with central body
static const int	swarm::log::EVT_RV_OBS = 11
	marks near a transit of planet in front of star
static const int	swarm::log::EVT_ASTROM_OBS = 12
	marks near a transit of planet in front of star
static const int	swarm::log::EVT_TIMING_OBS = 13
	marks near a transit of planet in front of star
static const int	swarm::log::EVT_DIRECT_IMAGE_OBS = 14
	marks near a transit of planet in front of star
static const int	swarm::log::EVT_TRANSIT = 15
	marks near a transit of planet in front of star
static const int	swarm::log::EVT_OCCULTATION = 16
	marks near an occultation of star in front of planet
static const int	swarm::log::EVT_MUTUAL_EVENT = 17
	marks near a mutual event, planet in front of planet
static const int	swarm::log::EVT_FIRST_OBS_CODE = EVT_RV_OBS
	marks begining of event codes used for observations
static const int	swarm::log::EVT_LAST_OBS_CODE = EVT_MUTUAL_EVENT
	marks end of event codes used for observations

Detailed Description

Defines an event/data logging system for swarm.

Definition in file log.hpp.