ldas-tools-diskcacheAPI  2.5.6
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Classes | Functions
diskCache::Commands Namespace Reference

Classes

class  Timer
 Debug utility to track down execution time. More...
 

Functions

const
Cache::SDGTx::file_extension_container_type
FileExtList ()
 usage: set ext_list [ getFileExtList ] More...
 
void getDirCache (diskCache::Cache::QueryAnswer &Answer, const char *Ifo="all", const char *Type="all")
 Get ASCII representation of the current frame hash. More...
 
void getFileNames (diskCache::Cache::QueryAnswer &Answer, const char *ifo_type_str, const INT_4U query_start, const INT_4U query_stop, const std::string &Extension)
 
void getFrameFiles (diskCache::Cache::QueryAnswer &Answer, const char *Ifo, const char *Type, const INT_4U StartTime, const INT_4U StopTime, const std::string &Extension, const bool GapsAllowed)
 
void getIntervalsList (diskCache::Cache::QueryAnswer &Answer, const char *ifo_type_str, const INT_4U query_start, const INT_4U query_stop, const std::string &Extension)
 Get TCL formatted lists of intervals for data matching the specified and Type within the bounds of the query. More...
 
void getRDSFrameFiles (diskCache::Cache::QueryAnswer &Answer, const char *ifo, const char *type, const unsigned int start_time, const unsigned int stop_time, const std::string &Extension, const bool will_resample)
 RDS frame query. More...
 
void updateFileExtList (const diskCache::Cache::SDGTx::file_extension_container_type &Extensions)
 usage: updateFileExtList [ list ] More...
 
void updateMountPtList (MountPointManagerSingleton::UpdateResults &Status, const MountPointManagerSingleton::mount_point_name_container_type &Paths, const bool enable_global_check=false)
 usage: set dir_list [ updateMountPtList known_mount_pt_dirs optional_global_check ] More...
 
void getFileNames (diskCache::Cache::QueryAnswer &Answer, const char *ifo_type_str, const unsigned int query_start, const unsigned int query_stop, const std::string &Extension)
 Get filename based on search criteria. More...
 
void getFrameFiles (diskCache::Cache::QueryAnswer &Answer, const char *Ifo, const char *Type, const unsigned int StartTime, const unsigned int StopTime, const std::string &Extension, const bool GapsAllowed)
 Frame query. More...
 

Function Documentation

const Cache::SDGTx::file_extension_container_type & diskCache::Commands::FileExtList ( )

usage: set ext_list [ getFileExtList ]

param: none return: std::string

void diskCache::Commands::getDirCache ( diskCache::Cache::QueryAnswer Answer,
const char *  Ifo = "all",
const char *  Type = "all" 
)

Get ASCII representation of the current frame hash.

Parameters
[out]AnswerA collection of files that match the criteria.
[in]IfoAn ifo to look up. Default is "all".
[in]TypeA type to look up. Default is "all".
void diskCache::Commands::getFileNames ( diskCache::Cache::QueryAnswer Answer,
const char *  ifo_type_str,
const INT_4U  query_start,
const INT_4U  query_stop,
const std::string &  Extension 
)
void diskCache::Commands::getFileNames ( diskCache::Cache::QueryAnswer Answer,
const char *  ifo_type_str,
const unsigned int  query_start,
const unsigned int  query_stop,
const std::string &  Extension 
)

Get filename based on search criteria.

Parameters
[out]AnswerA collection of filenames that reflect the search criteria.
[in]ifo_type_strA space delimited list of IFO-Type strings
[in]query_startQuery start time.
[in]query_stopQuery stop time.
[in]ExtensionQuery file extension
void diskCache::Commands::getFrameFiles ( diskCache::Cache::QueryAnswer Answer,
const char *  Ifo,
const char *  Type,
const INT_4U  StartTime,
const INT_4U  StopTime,
const std::string &  Extension,
const bool  GapsAllowed 
)

This function is used to search global frame data hash for a specific data.

Todo:
Need to handle is_first_scan_complete exception
void diskCache::Commands::getFrameFiles ( diskCache::Cache::QueryAnswer Answer,
const char *  Ifo,
const char *  Type,
const unsigned int  StartTime,
const unsigned int  StopTime,
const std::string &  Extension,
const bool  GapsAllowed 
)

Frame query.

Parameters
[out]AnswerA collection of filenames that reflect the search criteria.
IfoData IFO.
TypeData Type.
StartTimeData start time.
StopTimeData stop time.
[in]ExtensionQuery file extension
GapsAllowedFlag to indicate if data gaps are allowed. Set to true (1) if allowed, to false (0) if not.
Todo:
Tcl formated string: {frame files} {errors if any}.
void diskCache::Commands::getIntervalsList ( diskCache::Cache::QueryAnswer Answer,
const char *  ifo_type_str,
const INT_4U  query_start,
const INT_4U  query_stop,
const std::string &  Extension 
)

Get TCL formatted lists of intervals for data matching the specified and Type within the bounds of the query.

Parameters
[out]AnswerList of intervals resulting from the given query.
[in]ifo_type_strA space delimited list of IFO-Type strings
[in]query_startQuery start time.
[in]query_stopQuery stop time.
[in]ExtensionFilename extension
Returns
A list for each IFO-Type with data intervals: IFO-Type1 { i1_start i1_stop ... iN_start iN_stop } ... IFO-TypeN { ... }
void diskCache::Commands::getRDSFrameFiles ( diskCache::Cache::QueryAnswer Answer,
const char *  ifo,
const char *  type,
const unsigned int  start_time,
const unsigned int  stop_time,
const std::string &  Extension,
const bool  will_resample 
)

RDS frame query.

This command finds frame files that satisfy createRDS user request. If "will_resample" flag is set to TRUE, requested time range will be automatically expanded by frame dt at the beginning and at the end.

This command finds frame files that satisfy createRDS user request. If "will_resample" flag is set to TRUE, requested time range will be automatically expanded by frame dt at the beginning and at the end.

Parameters
[out]AnswerA collection of filenames that reflect the search criteria.
[in]ifoData IFO.
[in]typeData Type.
[in]start_timeData start time.
[in]stop_timeData stop time.
[in]ExtensionQuery file extension
[in]will_resampleFlag to indicate if requested data will be resampled. Set to TRUE (1) if will be resampled, to FALSE (0) if not.
void diskCache::Commands::updateFileExtList ( const diskCache::Cache::SDGTx::file_extension_container_type Extensions)

usage: updateFileExtList [ list ]

param: const CHAR* ext_list - A list of file extensions return: nothing

void diskCache::Commands::updateMountPtList ( MountPointManagerSingleton::UpdateResults &  Status,
const MountPointManagerSingleton::mount_point_name_container_type &  Paths,
const bool  enable_global_check = false 
)

usage: set dir_list [ updateMountPtList known_mount_pt_dirs optional_global_check ]

param: const CHAR* dir_list - A list of directories as they appear param: const bool enable_global_check - A flag to indicate if API should return: string - Sorted Tcl list of all removed subdirectories, followed