FACT++  1.0
FitsLoader Class Reference

Load a given Fits file and table, and dump selected columns if requested. More...

+ Inheritance diagram for FitsLoader:
+ Collaboration diagram for FitsLoader:

Public Types

enum  { kSM_FileLoaded = 20 }
 
- Public Types inherited from StateMachineImp
enum  DefaultStates_t {
  kSM_KeepState = -42, kSM_NotAvailable = -2, kSM_NotReady = -1, kSM_Ready = 0,
  kSM_UserMode = 1, kSM_Error = 0x100, kSM_FatalError = 0xffff
}
 
- Public Types inherited from MessageImp
enum  Severity {
  kMessage = 10, kInfo = 20, kWarn = 30, kError = 40,
  kAlarm = 45, kFatal = 50, kComment = 90, kDebug = 99
}
 Severity of a message. More...
 

Public Member Functions

 FitsLoader (ostream &out)
 
 ~FitsLoader ()
 Destructor. More...
 
void SetupConfig (Configuration &conf)
 Configures the fitsLoader from the config file and/or command arguments. More...
 
- Public Member Functions inherited from StateMachineDim
 StateMachineDim (std::ostream &out=std::cout, const std::string &name="DEFAULT")
 
int Write (const Time &time, const std::string &txt, int qos=kMessage)
 Redirect our own logging to fLog. More...
 
bool AddStateName (const int state, const std::string &name, const std::string &doc="")
 
bool MessageQueueEmpty () const
 
- Public Member Functions inherited from DimCommandHandler
DimCommandgetCommand ()
 
virtual ~DimCommandHandler ()
 
- Public Member Functions inherited from DimInfoHandler
DimInfogetInfo ()
 
virtual ~DimInfoHandler ()
 
- Public Member Functions inherited from DimErrorRedirecter
 DimErrorRedirecter (MessageImp &imp)
 
 ~DimErrorRedirecter ()
 
- Public Member Functions inherited from DimErrorHandler
virtual ~DimErrorHandler ()
 
- Public Member Functions inherited from DimExitHandler
virtual ~DimExitHandler ()
 
- Public Member Functions inherited from StateMachineImp
 StateMachineImp (std::ostream &out=std::cout, const std::string &name="")
 
 ~StateMachineImp ()
 delete all object stored in fListOfEvent and in fEventQueue More...
 
std::function< int(const EventImp &)> Wrap (const std::function< int(const EventImp &)> &func)
 
const std::string & GetName () const
 
EventImpSubscribe (const std::string &name)
 
void Unsubscribe (EventImp *evt)
 
int GetCurrentState () const
 return the current state of the machine More...
 
void SetReady ()
 
void SetNotReady ()
 
virtual int Run (bool dummy)
 Start the mainloop. More...
 
int Run ()
 
virtual void Stop (int code=0)
 Request to stop the mainloop. More...
 
bool IsRunning () const
 Used to check if the main loop is already running or still running. More...
 
void EnableBuffer (bool b=true)
 Used to enable or disable buffering of events outside of the main loop. More...
 
bool PostEvent (std::ostream &lout, const std::string &str)
 Post an event to the event queue. More...
 
bool PostEvent (const std::string &evt)
 
bool PostEvent (const EventImp &evt)
 
bool PostEvent (const EventImp &evt, const char *ptr, size_t siz)
 
bool HasEvent (const EventImp *cmd)
 
EventImpFindEvent (const std::string &evt)
 
bool IsQueueEmpty () const
 
const std::vector< std::string > GetEventNames ()
 
void PrintListOfEvents (std::ostream &out, const std::string &evt="")
 
void PrintListOfEvents (const std::string &str="")
 
void PrintListOfAllowedEvents (std::ostream &out)
 
void PrintListOfAllowedEvents ()
 
void PrintListOfStates (std::ostream &out) const
 
void PrintListOfStates () const
 Print a list of all states with descriptions. More...
 
int GetStateIndex (const std::string &name) const
 
bool HasState (int index) const
 
const std::string GetStateName (int state) const
 
const std::string GetStateName () const
 
const std::string GetStateDesc (int state) const
 
const std::string GetStateDesc () const
 
const std::string GetStateDescription (int state) const
 
const std::string GetStateDescription () const
 
- Public Member Functions inherited from MainImp
virtual ~MainImp ()
 
- Public Member Functions inherited from MessageImp
 MessageImp (std::ostream &out=std::cout)
 
virtual ~MessageImp ()
 
virtual void IndicateStateChange (const Time &, const std::string &)
 
void StateChanged (const Time &time, const std::string &server, const std::string &msg, int state)
 
int Update (const std::string &txt, int severity=kMessage)
 
int Update (const char *txt, int severity=kMessage)
 
int Update (const std::ostringstream &str, int severity=kMessage)
 
int Debug (const std::string &str)
 
int Message (const std::string &str)
 
int Info (const std::string &str)
 
int Warn (const std::string &str)
 
int Error (const std::string &str)
 
int Alarm (const std::string &str)
 
int Fatal (const std::string &str)
 
int Comment (const std::string &str)
 
int Debug (const char *txt)
 
int Message (const char *txt)
 
int Info (const char *txt)
 
int Warn (const char *txt)
 
int Error (const char *txt)
 
int Alarm (const char *txt)
 
int Fatal (const char *txt)
 
int Comment (const char *txt)
 
int Debug (const std::ostringstream &str)
 
int Message (const std::ostringstream &str)
 
int Info (const std::ostringstream &str)
 
int Warn (const std::ostringstream &str)
 
int Alarm (const std::ostringstream &str)
 
int Error (const std::ostringstream &str)
 
int Fatal (const std::ostringstream &str)
 
int Comment (const std::ostringstream &str)
 
std::ostream & operator() () const
 
std::ostream & Out () const
 

Public Attributes

enum FitsLoader:: { ... }  localstates_t
 
- Public Attributes inherited from DimCommandHandler
DimCommanditsCommand
 
- Public Attributes inherited from DimInfoHandler
DimInfoitsService
 

Static Public Attributes

static const char * fLoadFits = "load"
 Define command names. More...
 
static const char * fUnloadFits = "unload"
 
static const char * fListColumns = "list_columns"
 
static const char * fDumpColumns = "add_dump"
 
static const char * fClearDumpList = "clear_dump"
 
static const char * fDoDump = "dump"
 
static const char * fConfigFileName = "set_file"
 
static const char * fConfigTableName = "set_table"
 
static const char * fConfigPrecName = "set_prec"
 
static const char * fConfigFileOutName = "set_outfile"
 

Private Member Functions

int LoadPlease ()
 Transition from ready to fileLoaded. More...
 
int UnloadPlease ()
 Transition from fileLoaded to ready. More...
 
int ListColumnsPlease (const Event &)
 Lists the loaded column names. More...
 
int AddDumpColumnsPlease (const Event &)
 Add a column name to the dump list. More...
 
int ClearDumpListPlease (const Event &)
 Clear the dump list. More...
 
int DoDumpPlease (const Event &)
 Perform the dumping, based on the current dump list. More...
 
int ConfigFileNamePlease (const Event &)
 Set the name of the Fits file to be loaded. More...
 
int ConfigTableNamePlease (const Event &)
 Set the name of the table to be loaded. More...
 
int SetOFStreamPrecisionPlease (const Event &)
 Set the ofstream precision. More...
 
int SetFileOutPlease (const Event &)
 Set the name of the output file. More...
 
vector< int > CalculateBufferSize ()
 Calculate the buffer size required to read a row of the fits table, as well as the offsets to each column. More...
 
void writeValuesFromFits (vector< int > &offsets, ofstream &targetFile, unsigned char *fitsBuffer)
 Write a single row of the selected data. More...
 

Private Attributes

string fFileName
 Name of the fits file to load. More...
 
string fTableName
 Name of the table to load from the file. More...
 
CCfits::FITS * fFile
 FITS pointer. More...
 
CCfits::Table * fTable
 Table pointer. More...
 
int fStreamPrecision
 Precision of the ofstream. Used to output a given number of significant digits for floats or doubles. More...
 
string fFileOut
 Name of the output file. More...
 
map< string, CCfits::Column * > fColMap
 map between the column names and their CCfits objects More...
 
vector< string > fDumpList
 List of the column names to be dumped. More...
 

Additional Inherited Members

- Protected Member Functions inherited from StateMachineDim
std::string SetCurrentState (int state, const char *txt="", const std::string &cmd="")
 
void Lock ()
 
void UnLock ()
 
- Protected Member Functions inherited from DimStart
 DimStart (const std::string &name, MessageImp &imp)
 
 ~DimStart ()
 
- Protected Member Functions inherited from StateMachineImp
virtual void PushEvent (Event *cmd)
 This is a flag which is set true if the main loop should stop. More...
 
std::shared_ptr< EventPopEvent ()
 Pop a command from the fifo. More...
 
bool HandleNewState (int newstate, const EventImp *evt, const char *txt)
 
virtual int Execute ()
 Is called continously to execute actions in the current state. More...
 
bool HandleEvent (const EventImp &evt)
 
EventImpAddEvent (const std::string &name, const std::string &states, const std::string &fmt)
 
EventImpAddEvent (const std::string &name, int s1=-1, int s2=-1, int s3=-1, int s4=-1, int s5=-1)
 
EventImpAddEvent (const std::string &name, const std::string &fmt, int s1=-1, int s2=-1, int s3=-1, int s4=-1, int s5=-1)
 
void SetDefaultStateNames ()
 
- Protected Attributes inherited from StateMachineImp
StateNames fStateNames
 Human readable names associated with the states. More...
 
bool fRunning
 Flag if events should be buffered outside the event loop. More...
 
int fExitRequested
 Machine is in main-loop. More...
 

Detailed Description

Load a given Fits file and table, and dump selected columns if requested.

It derives from StateMachineDim. the first parent is here to enforce a state machine behaviour The possible states and transitions of the machine are:

dot_inline_dotgraph_2.png

Definition at line 44 of file fitsloader.cc.


The documentation for this class was generated from the following file: