NCBI C++ ToolKit
Public Types | Static Public Member Functions | Static Public Attributes | List of all members
CTrackUtils Class Reference

Search Toolkit Book for CTrackUtils

#include <gui/utils/track_info.hpp>

Public Types

typedef vector< stringTDataKeys
 
typedef map< string, stringTTrackSettings
 key-value pair for track settings More...
 
typedef list< TTrackSettingsTTrackSettingsSet
 
typedef list< TTrackSettingsSet::iterator > TTrackSettingsSetSelection
 

Static Public Member Functions

static void ExtractTrackConfig (const string &track_str, TTrackSettingsSet &settings_set, list< string > *warning_messages=nullptr)
 Extract the track settings from a setting string. More...
 
static bool HasTrack (const string &track_key, const TTrackSettingsSet &settings_set)
 Check if track settings contain the track of a given track key. More...
 
static bool HasTrack (const string &track_key, const string &track_name, const TTrackSettingsSet &settings_set)
 Check if track settings contain the track of the given track key and name. More...
 
static bool isTMSId (const TTrackSettings &TrackSettings)
 returns true if the track id in settings looks like a TMS track id (i.e. More...
 
static bool isRemoteData (const TTrackSettings &TrackSettings)
 Returns true if the track uses remote (non NCBI hosted) data. More...
 
static TDataKeys GetAllDataKeys (const TTrackSettingsSet &settings_set)
 Collect all data key values stored in 'data_key'. More...
 
static void GetTrackSettingsSetSelection (TTrackSettingsSet &TrackSettingsSet, const string &key, const string &value, TTrackSettingsSetSelection &TrackSettingsSetSelection)
 get all tracks that have a given value in a given key the entries in TrackSettingsSetSelection are valid while no operations that invalidate iterators in TrackSettingsSet take place More...
 
static bool GetKey (const TTrackSettings &TrackSettings, const string &key, string &value)
 returns a specified key; if it does not exist, returns false More...
 
static void SetKey (TTrackSettings &TrackSettings, const string &key, const string &value)
 
static void SetError (TTrackSettings &TrackSettings, TTrackErrorStatus::TErrorSeverity severity, TTrackErrorStatus::TErrorCode code, const string &short_msg, const string &msg)
 set error information in the track configuration error codes and such should correspond to ones in CHTMLActiveArea More...
 
static bool isInErrorStatus (const TTrackSettings &TrackSettings)
 check that the track is currently marked as having an error More...
 
static string RemoveEscape (const string &str)
 remove escape characters ('\') used for escaping special characters in track settings values More...
 
static void TokenizeWithEscape (const string &str, const string &delim, vector< string > &tokens, bool remove_escape=false)
 Tokenize a string using the delim. More...
 

Static Public Attributes

static const string cTrackSettingKey_PrivatePrefix = "###"
 some internal reserved track setting keys that are used for internal communication always start with ### More...
 
static const string cTrackSettingKey_ErrorSeverity = "###severity"
 if present and set to anything, but CHTMLActiveArea::eErrorSeverity_NoError, do not attempt to load the track and render it empty More...
 
static const string cTrackSettingKey_ErrorCode = "###code"
 if present contains the error code More...
 
static const string cTrackSettingKey_ErrorShortMsg = "###short_msg"
 if present contains the short error message More...
 
static const string cTrackSettingKey_ErrorMsg = "###msg"
 if present contains the error message More...
 
static const string kStdTrackId = "STD"
 prefix for STD (as opposed to TMS) tracks More...
 
static const string kRStdTrackId = "R" + kStdTrackId
 prefix for Remote STD (as opposed to TMS) tracks More...
 

Detailed Description

Definition at line 116 of file track_info.hpp.


The documentation for this class was generated from the following files:
Modified on Fri Jul 12 16:19:47 2024 by modify_doxy.py rev. 669887