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

Search Toolkit Book for CTempTrackProxy

File Description: More...

#include <gui/widgets/seq_graphic/layout_track_proxy.hpp>

+ Inheritance diagram for CTempTrackProxy:
+ Collaboration diagram for CTempTrackProxy:

Public Types

enum  EAction { eNone , eMakeVisible , eHide }
 
typedef list< CRef< CTempTrackProxy > > TTrackProxies
 
typedef vector< stringTSubTracks
 
typedef vector< stringTAnnots
 
- Public Types inherited from CObject
enum  EAllocFillMode { eAllocFillNone = 1 , eAllocFillZero , eAllocFillPattern }
 Control filling of newly allocated memory. More...
 
typedef CObjectCounterLocker TLockerType
 Default locker type for CRef. More...
 
typedef atomic< Uint8TCounter
 Counter type is CAtomiCounter. More...
 
typedef Uint8 TCount
 Alias for value type of counter. More...
 

Public Member Functions

 CTempTrackProxy ()
 
 CTempTrackProxy (int order, const string &name, bool shown, const string &key=NcbiEmptyString, const string &sub_key=NcbiEmptyString)
 
 CTempTrackProxy (const CTempTrackProxy &param)
 copy constructor. More...
 
CTempTrackProxyoperator= (const CTempTrackProxy &param)
 assignment operator. More...
 
virtual bool IsTempTrack () const
 check if this is a temporary track. More...
 
virtual CRef< CTempTrackProxyClone () const
 
void SetOrder (int order)
 CTempTrackProxy class implementation. More...
 
int GetOrder () const
 
const stringGetName () const
 
void SetName (const string &name)
 
const stringGetId () const
 
void SetId (const string &id)
 
const stringGetDisplayName () const
 
void SetDisplayName (const string &name)
 
void SetShown (bool shown)
 
bool GetShown () const
 
const stringGetHelp () const
 
void SetHelp (const string &help)
 
void SetExpanded (bool f)
 
bool GetExpanded () const
 
void SetTrack (CLayoutTrack *track)
 Associated any track already?. More...
 
bool TrackNotSet () const
 
const CLayoutTrackGetTrack () const
 
CLayoutTrackGetTrack ()
 
void SetTrackProfile (const string &profile)
 
const stringGetTrackProfile () const
 
void SetSource (const string &src)
 
const stringGetSource () const
 
void SetCategory (const string &cat)
 
const stringGetCategory () const
 
void SetSubcategory (const string &scat)
 
const stringGetSubcategory () const
 
void SetSettingGroup (const string &name)
 
const stringGetSettingGroup () const
 
void SetRemoteData (const string &remote_data)
 
const stringGetRemoteData () const
 
void SetRemoteId (const string &remote_id)
 
const stringGetRemoteId () const
 
void SetSeqDataKey (const string &seq_data_key)
 
const stringGetSeqDataKey () const
 
void SetUseGroupDefault (bool flag)
 
bool GetUseGroupDefault () const
 
const stringGetFilter () const
 
void SetFilter (const string &filter)
 
const stringGetSortBy () const
 
void SetSortBy (const string &sort_by)
 
void SetRealized (bool f)
 
bool IsRealized () const
 
void SetEmpty (bool f)
 
bool IsEmpty () const
 
const TTrackProxiesGetChildren () const
 
TTrackProxiesGetChildren ()
 
void SetVisitedRange (const TSeqRange &range)
 
const TSeqRangeGetVisitedRange () const
 
CRef< CTempTrackProxyAddTempTrack (const string &name, const string &title)
 add a new template track params. More...
 
CRef< CTempTrackProxyAddTempTrack (const string &name, const string &filter, const string &title)
 add a new template track params with a filter set More...
 
CConstRef< CTempTrackProxyGetChildTempTrack (const string &name) const
 Get track params for child temporary track. More...
 
CRef< CTempTrackProxyGetChildTempTrack (const string &name)
 
bool operator< (const CTempTrackProxy &item) const
 compare operator used by sorting algorithms. More...
 
void SetComments (const string &comment_str)
 
const stringGetComments () const
 
void SetHighlights (const string &hl_str)
 
const stringGetHighlights () const
 
void SetHighlightsColor (const string &hl_str)
 
const stringGetHighlightsColor () const
 
void SetShowTitle (bool flag)
 
bool GetShowTitle () const
 
const TTrackErrorStatusGetErrorStatus () const
 
void SetErrorStatus (const TTrackErrorStatus &ErrorStatus)
 
void SetIsPrivate (bool flag)
 
bool GetIsPrivate () const
 
void SetStoredScale (const string &stored_scale)
 
const stringGetStoredScale () const
 
void SetUId (const string &uid)
 
const stringGetUId () const
 
void SetBatch (const string &batch)
 
const stringGetBatch () const
 
void SetExtraInfo (const string &sExtraInfo)
 
const stringGetExtraInfo () const
 
void SetRemotePath (const string &remote_path)
 
const stringGetRemotePath () const
 
const TSubTracksGetSubTracks () const
 
TSubTracksSetSubTracks ()
 
void SetAction (EAction action)
 
EAction GetAction () const
 
void SetTimeStamp (time_t timeStamp)
 
time_t GetTimeStamp () const
 
const stringGetKey () const
 
void SetKey (const string &key)
 
const stringGetSubkey () const
 
void SetSubkey (const string &sub_key)
 
const TAnnotsGetAnnots () const
 
void SetAnnots (const TAnnots &annots)
 
bool IsNA () const
 
bool IsExtendedNA () const
 check for an extended NA (named annotation::number, as used in e.g. SNP2) More...
 
void SetNAdata (CAnnotMetaData &na)
 
const CAnnotMetaDataGetNAdata () const
 
void SetBigDataIndex (const string &big_data_index)
 
const stringGetBigDataIndex () const
 
void SetHubId (const string &hub_id)
 
const stringGetHubId () const
 
void SetOptions2Hide (const set< string > &options2hide)
 
const set< string > & GetOptions2Hide () const
 
void SetOptions2Show (const set< string > &options2show)
 
const set< string > & GetOptions2Show () const
 
void UpdateNA_ChildVisibility (CTempTrackProxy &child) const
 
- Public Member Functions inherited from CObjectEx
 CObjectEx (void)
 
virtual ~CObjectEx (void)
 
- Public Member Functions inherited from CObject
 CObject (void)
 Constructor. More...
 
 CObject (const CObject &src)
 Copy constructor. More...
 
virtual ~CObject (void)
 Destructor. More...
 
CObjectoperator= (const CObject &src) THROWS_NONE
 Assignment operator. More...
 
bool CanBeDeleted (void) const THROWS_NONE
 Check if object can be deleted. More...
 
bool IsAllocatedInPool (void) const THROWS_NONE
 Check if object is allocated in memory pool (not system heap) More...
 
bool Referenced (void) const THROWS_NONE
 Check if object is referenced. More...
 
bool ReferencedOnlyOnce (void) const THROWS_NONE
 Check if object is referenced only once. More...
 
void AddReference (void) const
 Add reference to object. More...
 
void RemoveReference (void) const
 Remove reference to object. More...
 
void ReleaseReference (void) const
 Remove reference without deleting object. More...
 
virtual void DoNotDeleteThisObject (void)
 Mark this object as not allocated in heap – do not delete this object. More...
 
virtual void DoDeleteThisObject (void)
 Mark this object as allocated in heap – object can be deleted. More...
 
void * operator new (size_t size)
 Define new operator for memory allocation. More...
 
void * operator new[] (size_t size)
 Define new[] operator for 'array' memory allocation. More...
 
void operator delete (void *ptr)
 Define delete operator for memory deallocation. More...
 
void operator delete[] (void *ptr)
 Define delete[] operator for memory deallocation. More...
 
void * operator new (size_t size, void *place)
 Define new operator. More...
 
void operator delete (void *ptr, void *place)
 Define delete operator. More...
 
void * operator new (size_t size, CObjectMemoryPool *place)
 Define new operator using memory pool. More...
 
void operator delete (void *ptr, CObjectMemoryPool *place)
 Define delete operator. More...
 
virtual void DebugDump (CDebugDumpContext ddc, unsigned int depth) const
 Define method for dumping debug information. More...
 
- Public Member Functions inherited from CDebugDumpable
 CDebugDumpable (void)
 
virtual ~CDebugDumpable (void)
 
void DebugDumpText (ostream &out, const string &bundle, unsigned int depth) const
 
void DebugDumpFormat (CDebugDumpFormatter &ddf, const string &bundle, unsigned int depth) const
 
void DumpToConsole (void) const
 
- Public Member Functions inherited from CWeakObject
 CWeakObject (void)
 
virtual ~CWeakObject (void)
 
CPtrToObjectProxyGetPtrProxy (void) const
 Get pointer to proxy object containing pointer to this object. More...
 

Static Public Member Functions

static void LoadFromRegistry (TTrackProxies &proxies, const string &path, bool isMergeWithExisting=false)
 if isMergeWithExisting is true, then load should skip all registry tracks that have keys as in the already existing proxies More...
 
static void SaveToRegistry (const TTrackProxies &proxies, const string &path)
 
static void ParseSubtracks (const string &subtracks_str, TSubTracks &subtracks)
 convert a string with a list of subtracks to a list of subtracks More...
 
- Static Public Member Functions inherited from CObject
static NCBI_XNCBI_EXPORT void ThrowNullPointerException (void)
 Define method to throw null pointer exception. More...
 
static NCBI_XNCBI_EXPORT void ThrowNullPointerException (const type_info &type)
 
static EAllocFillMode GetAllocFillMode (void)
 
static void SetAllocFillMode (EAllocFillMode mode)
 
static void SetAllocFillMode (const string &value)
 Set mode from configuration parameter value. More...
 
- Static Public Member Functions inherited from CDebugDumpable
static void EnableDebugDump (bool on)
 

Static Public Attributes

static const string kAnonTrackName = "SV-Anon"
 CTempTrackProxy class implementation. More...
 
- Static Public Attributes inherited from CObject
static const TCount eCounterBitsCanBeDeleted = 1 << 0
 Define possible object states. More...
 
static const TCount eCounterBitsInPlainHeap = 1 << 1
 Heap signature was found. More...
 
static const TCount eCounterBitsPlaceMask
 Mask for 'in heap' state flags. More...
 
static const int eCounterStep = 1 << 2
 Skip over the "in heap" bits. More...
 
static const TCount eCounterValid = TCount(1) << (sizeof(TCount) * 8 - 2)
 Minimal value for valid objects (reference counter is zero) Must be a single bit value. More...
 
static const TCount eCounterStateMask
 Valid object, and object in heap. More...
 

Private Attributes

int m_Order = -1
 track order for vertical ordering in its parent scope. More...
 
string m_Name
 track name, may serve as track title. More...
 
string m_Id
 unique track identifier. More...
 
string m_DispName
 track display name. More...
 
string m_Profile
 track profile (setting style or list of settings). More...
 
string m_Source
 data source. More...
 
string m_Category
 track category. More...
 
string m_Subcategory
 track sub-category. More...
 
string m_SettingGroup
 setting group name. More...
 
bool m_UseGroupDefault = false
 flag indicating if group default setting applies. More...
 
string m_Filter
 track-specific filter More...
 
string m_SortBy
 track-specific sortby More...
 
TTrackProxies m_Children
 settings for children tracks. More...
 
CRef< CLayoutTrackm_Track
 the delegated layout track object. More...
 
bool m_Shown = true
 track on/off state. More...
 
string m_Help
 track help string More...
 
bool m_Expanded = true
 track expanded/collapsed. More...
 
bool m_Realized = true
 Has this been connected to any real track before. More...
 
bool m_Empty = false
 The track proxy is empty. More...
 
TSeqRange m_VisitedRange
 The sequence range visited so far. More...
 
string m_Comments
 
string m_Highlights
 
string m_HighlightsColor
 Color to use for highlighting. More...
 
bool m_ShowTitle = true
 
TTrackErrorStatus m_ErrorStatus
 
bool m_isPrivate = false
 
string m_StoredScale
 
string m_UId
 
TSubTracks m_SubTracks
 
string m_Key
 may be used for creating a track More...
 
string m_Subkey
 may be used for creating DataSource More...
 
TAnnots m_Annots
 can be 'Unnamed', 'Named', or annot names More...
 
EAction m_Action = eNone
 
time_t m_TimeStamp = -1
 
CRef< CAnnotMetaDatam_NAdata
 
string m_Batch
 AlignDb batch. More...
 
string m_RemotePath
 Track remote path. More...
 
string m_sExtraInfo
 extra information potentially needed to create the track More...
 
string m_RemoteData
 
string m_RemoteId
 
string m_SeqDataKey
 
string m_BigDataIndex
 The location of a remote data file containing the index. More...
 
string m_HubId
 
set< stringm_Options2Hide
 
set< stringm_Options2Show
 

Additional Inherited Members

- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 
- Protected Member Functions inherited from CWeakObject
void CleanWeakRefs (void) const
 Method cleaning all CWeakRefs referencing at this moment to the object After calling to this method all existing CWeakRefs referencing to the object will return NULL, so it effectively will be equal to deleting the object. More...
 

Detailed Description

File Description:

CTempTrackProxy data structure for storing information about tracks status and the layout of the tracks (both position and hierarchy). The stored status includes track order and a flag indicating weather a track is shown. For a given track type, there might be more than one data track get created after loading the data. So, the track status for those data source dependent temporary tracks will also be stored.

Definition at line 53 of file layout_track_proxy.hpp.

Member Typedef Documentation

◆ TAnnots

Definition at line 228 of file layout_track_proxy.hpp.

◆ TSubTracks

Definition at line 58 of file layout_track_proxy.hpp.

◆ TTrackProxies

Definition at line 57 of file layout_track_proxy.hpp.

Member Enumeration Documentation

◆ EAction

Enumerator
eNone 
eMakeVisible 
eHide 

Definition at line 209 of file layout_track_proxy.hpp.

Constructor & Destructor Documentation

◆ CTempTrackProxy() [1/3]

CTempTrackProxy::CTempTrackProxy ( )
inline

Definition at line 61 of file layout_track_proxy.hpp.

Referenced by AddTempTrack(), and Clone().

◆ CTempTrackProxy() [2/3]

CTempTrackProxy::CTempTrackProxy ( int  order,
const string name,
bool  shown,
const string key = NcbiEmptyString,
const string sub_key = NcbiEmptyString 
)
inline

Definition at line 63 of file layout_track_proxy.hpp.

◆ CTempTrackProxy() [3/3]

CTempTrackProxy::CTempTrackProxy ( const CTempTrackProxy param)

copy constructor.

Definition at line 50 of file layout_track_proxy.cpp.

References GetChildren(), ITERATE, and m_Children.

Member Function Documentation

◆ AddTempTrack() [1/2]

CRef< CTempTrackProxy > CTempTrackProxy::AddTempTrack ( const string name,
const string filter,
const string title 
)

add a new template track params with a filter set

Definition at line 171 of file layout_track_proxy.cpp.

References AddTempTrack(), and SetFilter().

◆ AddTempTrack() [2/2]

CRef< CTempTrackProxy > CTempTrackProxy::AddTempTrack ( const string name,
const string title 
)

add a new template track params.

The order will be initialized based on maximal track order used

Returns
the newly added track params.

Definition at line 152 of file layout_track_proxy.cpp.

References CTempTrackProxy(), GetCategory(), GetErrorStatus(), GetFilter(), GetSortBy(), GetSubcategory(), GetTrackProfile(), m_Children, SetCategory(), SetDisplayName(), SetErrorStatus(), SetFilter(), SetOrder(), SetRealized(), SetSortBy(), SetSubcategory(), and SetTrackProfile().

Referenced by AddTempTrack(), GetChildTempTrack(), and CTrackContainer::x_ReinitNATrack().

◆ Clone()

CRef< CTempTrackProxy > CTempTrackProxy::Clone ( void  ) const
virtual

Reimplemented in CTrackProxy.

Definition at line 145 of file layout_track_proxy.cpp.

References CTempTrackProxy().

Referenced by CTrackContainer::CloneTrack(), and CGraphOverlay::Drop().

◆ GetAction()

EAction CTempTrackProxy::GetAction ( void  ) const
inline

Definition at line 217 of file layout_track_proxy.hpp.

References m_Action.

◆ GetAnnots()

const TAnnots& CTempTrackProxy::GetAnnots ( void  ) const
inline

◆ GetBatch()

const string & CTempTrackProxy::GetBatch ( void  ) const
inline

Definition at line 707 of file layout_track_proxy.hpp.

References m_Batch.

Referenced by CTrackConfigManager::CreateTrackConfig().

◆ GetBigDataIndex()

const string & CTempTrackProxy::GetBigDataIndex ( ) const
inline

Definition at line 769 of file layout_track_proxy.hpp.

References m_BigDataIndex.

Referenced by CTrackConfigManager::CreateTrackConfig().

◆ GetCategory()

const string & CTempTrackProxy::GetCategory ( void  ) const
inline

◆ GetChildren() [1/2]

TTrackProxies& CTempTrackProxy::GetChildren ( void  )
inline

Definition at line 149 of file layout_track_proxy.hpp.

References m_Children.

◆ GetChildren() [2/2]

const TTrackProxies& CTempTrackProxy::GetChildren ( void  ) const
inline

◆ GetChildTempTrack() [1/2]

CRef< CTempTrackProxy > CTempTrackProxy::GetChildTempTrack ( const string name)
Returns
an existing track params or newly created if not available

Definition at line 200 of file layout_track_proxy.cpp.

References AddTempTrack(), GetTrackProfile(), m_Children, m_Filter, m_SortBy, NON_CONST_ITERATE, NStr::ReplaceInPlace(), and SetSource().

◆ GetChildTempTrack() [2/2]

CConstRef< CTempTrackProxy > CTempTrackProxy::GetChildTempTrack ( const string name) const

Get track params for child temporary track.

Returns
an existing track params or newly created if not available

Definition at line 186 of file layout_track_proxy.cpp.

References ITERATE, m_Children, and NStr::ReplaceInPlace().

Referenced by CTrackContainer::AddTracks(), SaveToRegistry(), CTrackContainer::SyncSettings(), and CTrackContainer::x_ConvertToContainer().

◆ GetComments()

const string & CTempTrackProxy::GetComments ( void  ) const
inline

◆ GetDisplayName()

const string & CTempTrackProxy::GetDisplayName ( ) const
inline

◆ GetErrorStatus()

const TTrackErrorStatus & CTempTrackProxy::GetErrorStatus ( void  ) const
inline

Definition at line 660 of file layout_track_proxy.hpp.

References m_ErrorStatus.

Referenced by AddTempTrack().

◆ GetExpanded()

bool CTempTrackProxy::GetExpanded ( ) const
inline

Definition at line 510 of file layout_track_proxy.hpp.

References CLayoutTrack::IsExpanded(), m_Expanded, and m_Track.

Referenced by operator=(), and SaveToRegistry().

◆ GetExtraInfo()

const string & CTempTrackProxy::GetExtraInfo ( ) const
inline

Definition at line 715 of file layout_track_proxy.hpp.

References m_sExtraInfo.

Referenced by CTrackConfigManager::CreateTrackConfig().

◆ GetFilter()

const string & CTempTrackProxy::GetFilter ( void  ) const
inline

◆ GetHelp()

const string & CTempTrackProxy::GetHelp ( void  ) const
inline

Definition at line 494 of file layout_track_proxy.hpp.

References m_Help.

Referenced by CTrackConfigManager::CreateTrackConfig(), and SaveToRegistry().

◆ GetHighlights()

const string & CTempTrackProxy::GetHighlights ( void  ) const
inline

◆ GetHighlightsColor()

const string & CTempTrackProxy::GetHighlightsColor ( ) const
inline

◆ GetHubId()

const string & CTempTrackProxy::GetHubId ( ) const
inline

Definition at line 781 of file layout_track_proxy.hpp.

References m_HubId.

Referenced by CTrackConfigManager::CreateTrackConfig().

◆ GetId()

const string & CTempTrackProxy::GetId ( void  ) const
inline

◆ GetIsPrivate()

bool CTempTrackProxy::GetIsPrivate ( ) const
inline

Definition at line 670 of file layout_track_proxy.hpp.

References m_isPrivate.

Referenced by CTrackConfigManager::CreateTrackConfig().

◆ GetKey()

const string& CTempTrackProxy::GetKey ( void  ) const
inline

◆ GetNAdata()

const CAnnotMetaData* CTempTrackProxy::GetNAdata ( ) const
inline

Definition at line 237 of file layout_track_proxy.hpp.

References CRef< C, Locker >::GetPointerOrNull(), and m_NAdata.

Referenced by UpdateNA_ChildVisibility().

◆ GetName()

const string& CTempTrackProxy::GetName ( void  ) const
inline

◆ GetOptions2Hide()

const set< string > & CTempTrackProxy::GetOptions2Hide ( ) const
inline

Definition at line 793 of file layout_track_proxy.hpp.

References m_Options2Hide.

Referenced by s_ProcessOptionalSettings().

◆ GetOptions2Show()

const set< string > & CTempTrackProxy::GetOptions2Show ( ) const
inline

Definition at line 805 of file layout_track_proxy.hpp.

References m_Options2Show.

Referenced by s_ProcessOptionalSettings().

◆ GetOrder()

int CTempTrackProxy::GetOrder ( void  ) const
inline

◆ GetRemoteData()

const string & CTempTrackProxy::GetRemoteData ( ) const
inline

Definition at line 678 of file layout_track_proxy.hpp.

References m_RemoteData.

Referenced by CTrackConfigManager::CreateTrackConfig().

◆ GetRemoteId()

const string & CTempTrackProxy::GetRemoteId ( ) const
inline

Definition at line 688 of file layout_track_proxy.hpp.

References m_RemoteId.

Referenced by CTrackConfigManager::CreateTrackConfig().

◆ GetRemotePath()

const string & CTempTrackProxy::GetRemotePath ( ) const
inline

◆ GetSeqDataKey()

const string & CTempTrackProxy::GetSeqDataKey ( ) const
inline

Definition at line 699 of file layout_track_proxy.hpp.

References m_SeqDataKey.

Referenced by CTrackConfigManager::CreateTrackConfig().

◆ GetSettingGroup()

const string & CTempTrackProxy::GetSettingGroup ( ) const
inline

◆ GetShown()

bool CTempTrackProxy::GetShown ( void  ) const
inline

◆ GetShowTitle()

bool CTempTrackProxy::GetShowTitle ( ) const
inline

◆ GetSortBy()

const string & CTempTrackProxy::GetSortBy ( ) const
inline

◆ GetSource()

const string & CTempTrackProxy::GetSource ( void  ) const
inline

◆ GetStoredScale()

const string & CTempTrackProxy::GetStoredScale ( ) const
inline

◆ GetSubcategory()

const string & CTempTrackProxy::GetSubcategory ( void  ) const
inline

◆ GetSubkey()

const string& CTempTrackProxy::GetSubkey ( void  ) const
inline

◆ GetSubTracks()

const CTempTrackProxy::TSubTracks & CTempTrackProxy::GetSubTracks ( void  ) const
inline

◆ GetTimeStamp()

time_t CTempTrackProxy::GetTimeStamp ( ) const
inline

Definition at line 220 of file layout_track_proxy.hpp.

References m_TimeStamp.

Referenced by SaveToRegistry().

◆ GetTrack() [1/2]

CLayoutTrack * CTempTrackProxy::GetTrack ( )
inline

Definition at line 533 of file layout_track_proxy.hpp.

References m_Track.

◆ GetTrack() [2/2]

const CLayoutTrack * CTempTrackProxy::GetTrack ( ) const
inline

◆ GetTrackProfile()

const string & CTempTrackProxy::GetTrackProfile ( ) const
inline

◆ GetUId()

const string & CTempTrackProxy::GetUId ( void  ) const
inline

◆ GetUseGroupDefault()

bool CTempTrackProxy::GetUseGroupDefault ( ) const
inline

Definition at line 589 of file layout_track_proxy.hpp.

References m_UseGroupDefault.

Referenced by operator=().

◆ GetVisitedRange()

const TSeqRange & CTempTrackProxy::GetVisitedRange ( ) const
inline

◆ IsEmpty()

bool CTempTrackProxy::IsEmpty ( void  ) const
inline

Definition at line 146 of file layout_track_proxy.hpp.

References m_Empty.

◆ IsExtendedNA()

bool CTempTrackProxy::IsExtendedNA ( ) const

check for an extended NA (named annotation::number, as used in e.g. SNP2)

Definition at line 238 of file layout_track_proxy.cpp.

References CSeqUtils::IsExtendedNAA(), and m_Source.

◆ IsNA()

bool CTempTrackProxy::IsNA ( ) const

◆ IsRealized()

bool CTempTrackProxy::IsRealized ( ) const
inline

Definition at line 143 of file layout_track_proxy.hpp.

References m_Realized.

Referenced by operator=(), and SaveToRegistry().

◆ IsTempTrack()

virtual bool CTempTrackProxy::IsTempTrack ( ) const
inlinevirtual

check if this is a temporary track.

Reimplemented in CTrackProxy.

Definition at line 79 of file layout_track_proxy.hpp.

Referenced by CTrackContainer::CloneTrack().

◆ LoadFromRegistry()

void CTempTrackProxy::LoadFromRegistry ( TTrackProxies proxies,
const string path,
bool  isMergeWithExisting = false 
)
static

◆ operator<()

bool CTempTrackProxy::operator< ( const CTempTrackProxy item) const
inline

compare operator used by sorting algorithms.

Definition at line 549 of file layout_track_proxy.hpp.

References GetOrder(), and m_Order.

◆ operator=()

CTempTrackProxy & CTempTrackProxy::operator= ( const CTempTrackProxy param)

◆ ParseSubtracks()

void CTempTrackProxy::ParseSubtracks ( const string subtracks_str,
TSubTracks subtracks 
)
static

convert a string with a list of subtracks to a list of subtracks

Definition at line 583 of file layout_track_proxy.cpp.

References NStr::Split().

Referenced by LoadFromRegistry().

◆ SaveToRegistry()

void CTempTrackProxy::SaveToRegistry ( const TTrackProxies proxies,
const string path 
)
static

◆ SetAction()

void CTempTrackProxy::SetAction ( EAction  action)
inline

Definition at line 216 of file layout_track_proxy.hpp.

References m_Action.

Referenced by CConfigureTracksDlg::OnOkClick().

◆ SetAnnots()

void CTempTrackProxy::SetAnnots ( const TAnnots annots)
inline

◆ SetBatch()

void CTempTrackProxy::SetBatch ( const string batch)
inline

Definition at line 703 of file layout_track_proxy.hpp.

References m_Batch.

Referenced by s_InitTrackFromSettings().

◆ SetBigDataIndex()

void CTempTrackProxy::SetBigDataIndex ( const string big_data_index)
inline

Definition at line 763 of file layout_track_proxy.hpp.

References m_BigDataIndex.

Referenced by s_InitTrackFromSettings().

◆ SetCategory()

void CTempTrackProxy::SetCategory ( const string cat)
inline

◆ SetComments()

void CTempTrackProxy::SetComments ( const string comment_str)
inline

Definition at line 617 of file layout_track_proxy.hpp.

References m_Comments.

Referenced by s_InitTrackFromSettings().

◆ SetDisplayName()

void CTempTrackProxy::SetDisplayName ( const string name)
inline

◆ SetEmpty()

void CTempTrackProxy::SetEmpty ( bool  f)
inline

Definition at line 145 of file layout_track_proxy.hpp.

References f(), and m_Empty.

Referenced by CTrackContainer::x_ConvertToContainer().

◆ SetErrorStatus()

void CTempTrackProxy::SetErrorStatus ( const TTrackErrorStatus ErrorStatus)
inline

◆ SetExpanded()

void CTempTrackProxy::SetExpanded ( bool  f)
inline

Definition at line 506 of file layout_track_proxy.hpp.

References f(), and m_Expanded.

Referenced by CTrackContainer::CloneTrack(), and s_LoadTempTrackRecursive().

◆ SetExtraInfo()

void CTempTrackProxy::SetExtraInfo ( const string sExtraInfo)
inline

Definition at line 711 of file layout_track_proxy.hpp.

References m_sExtraInfo.

Referenced by s_InitTrackFromSettings().

◆ SetFilter()

void CTempTrackProxy::SetFilter ( const string filter)
inline

◆ SetHelp()

void CTempTrackProxy::SetHelp ( const string help)
inline

Definition at line 500 of file layout_track_proxy.hpp.

References help(), and m_Help.

Referenced by s_InitTrackFromSettings(), and s_LoadTempTrackRecursive().

◆ SetHighlights()

void CTempTrackProxy::SetHighlights ( const string hl_str)
inline

Definition at line 625 of file layout_track_proxy.hpp.

References m_Highlights.

Referenced by s_InitTrackFromSettings().

◆ SetHighlightsColor()

void CTempTrackProxy::SetHighlightsColor ( const string hl_str)
inline

Definition at line 633 of file layout_track_proxy.hpp.

References m_HighlightsColor.

Referenced by s_InitTrackFromSettings().

◆ SetHubId()

void CTempTrackProxy::SetHubId ( const string hub_id)
inline

Definition at line 775 of file layout_track_proxy.hpp.

References m_HubId.

Referenced by s_InitTrackFromSettings().

◆ SetId()

void CTempTrackProxy::SetId ( const string id)
inline

Definition at line 467 of file layout_track_proxy.hpp.

References m_Id, m_Track, and CLayoutTrack::SetId().

Referenced by s_InitTrackFromSettings().

◆ SetIsPrivate()

void CTempTrackProxy::SetIsPrivate ( bool  flag)
inline

Definition at line 666 of file layout_track_proxy.hpp.

References m_isPrivate.

Referenced by s_InitTrackFromSettings().

◆ SetKey()

void CTempTrackProxy::SetKey ( const string key)
inline

◆ SetNAdata()

void CTempTrackProxy::SetNAdata ( CAnnotMetaData na)

◆ SetName()

void CTempTrackProxy::SetName ( const string name)
inline

◆ SetOptions2Hide()

void CTempTrackProxy::SetOptions2Hide ( const set< string > &  options2hide)
inline

Definition at line 787 of file layout_track_proxy.hpp.

References m_Options2Hide.

Referenced by s_InitTrackFromSettings().

◆ SetOptions2Show()

void CTempTrackProxy::SetOptions2Show ( const set< string > &  options2show)
inline

Definition at line 799 of file layout_track_proxy.hpp.

References m_Options2Show.

Referenced by s_InitTrackFromSettings().

◆ SetOrder()

void CTempTrackProxy::SetOrder ( int  order)
inline

◆ SetRealized()

void CTempTrackProxy::SetRealized ( bool  f)
inline

Definition at line 142 of file layout_track_proxy.hpp.

References f(), and m_Realized.

Referenced by AddTempTrack(), and CTrackContainer::x_OnJobCompleted().

◆ SetRemoteData()

void CTempTrackProxy::SetRemoteData ( const string remote_data)
inline

Definition at line 674 of file layout_track_proxy.hpp.

References m_RemoteData.

Referenced by s_InitTrackFromSettings().

◆ SetRemoteId()

void CTempTrackProxy::SetRemoteId ( const string remote_id)
inline

Definition at line 682 of file layout_track_proxy.hpp.

References m_RemoteId.

Referenced by s_InitTrackFromSettings().

◆ SetRemotePath()

void CTempTrackProxy::SetRemotePath ( const string remote_path)
inline

Definition at line 719 of file layout_track_proxy.hpp.

References m_RemotePath.

Referenced by s_InitTrackFromSettings().

◆ SetSeqDataKey()

void CTempTrackProxy::SetSeqDataKey ( const string seq_data_key)
inline

Definition at line 695 of file layout_track_proxy.hpp.

References m_SeqDataKey.

Referenced by s_InitTrackFromSettings().

◆ SetSettingGroup()

void CTempTrackProxy::SetSettingGroup ( const string name)
inline

Definition at line 577 of file layout_track_proxy.hpp.

References m_SettingGroup.

Referenced by s_InitTrackFromSettings(), and s_LoadTempTrackRecursive().

◆ SetShown()

void CTempTrackProxy::SetShown ( bool  shown)
inline

◆ SetShowTitle()

void CTempTrackProxy::SetShowTitle ( bool  flag)
inline

Definition at line 645 of file layout_track_proxy.hpp.

References m_ShowTitle.

Referenced by s_InitTrackFromSettings().

◆ SetSortBy()

void CTempTrackProxy::SetSortBy ( const string sort_by)
inline

Definition at line 605 of file layout_track_proxy.hpp.

References m_SortBy.

Referenced by AddTempTrack(), and s_InitTrackFromSettings().

◆ SetSource()

void CTempTrackProxy::SetSource ( const string src)
inline

◆ SetStoredScale()

void CTempTrackProxy::SetStoredScale ( const string stored_scale)
inline

Definition at line 731 of file layout_track_proxy.hpp.

References m_StoredScale.

Referenced by s_InitTrackFromSettings().

◆ SetSubcategory()

void CTempTrackProxy::SetSubcategory ( const string scat)
inline

◆ SetSubkey()

void CTempTrackProxy::SetSubkey ( const string sub_key)
inline

◆ SetSubTracks()

CTempTrackProxy::TSubTracks & CTempTrackProxy::SetSubTracks ( void  )
inline

Definition at line 757 of file layout_track_proxy.hpp.

References m_SubTracks.

Referenced by CGraphTrack::CreateOverlay(), and s_InitTrackFromSettings().

◆ SetTimeStamp()

void CTempTrackProxy::SetTimeStamp ( time_t  timeStamp)
inline

Definition at line 219 of file layout_track_proxy.hpp.

References m_TimeStamp.

Referenced by s_LoadTempTrackRecursive().

◆ SetTrack()

void CTempTrackProxy::SetTrack ( CLayoutTrack track)
inline

◆ SetTrackProfile()

void CTempTrackProxy::SetTrackProfile ( const string profile)
inline

◆ SetUId()

void CTempTrackProxy::SetUId ( const string uid)
inline

Definition at line 739 of file layout_track_proxy.hpp.

References m_UId.

Referenced by s_InitTrackFromSettings(), and s_ResolveSubTracks().

◆ SetUseGroupDefault()

void CTempTrackProxy::SetUseGroupDefault ( bool  flag)
inline

Definition at line 585 of file layout_track_proxy.hpp.

References m_UseGroupDefault.

Referenced by s_InitTrackFromSettings(), and s_LoadTempTrackRecursive().

◆ SetVisitedRange()

void CTempTrackProxy::SetVisitedRange ( const TSeqRange range)
inline

◆ TrackNotSet()

bool CTempTrackProxy::TrackNotSet ( ) const
inline

Definition at line 537 of file layout_track_proxy.hpp.

References CRef< C, Locker >::IsNull(), and m_Track.

◆ UpdateNA_ChildVisibility()

void CTempTrackProxy::UpdateNA_ChildVisibility ( CTempTrackProxy child) const

Definition at line 254 of file layout_track_proxy.cpp.

References GetNAdata(), m_Annots, CAnnotMetaData::m_Name, and SetShown().

Referenced by CTrackContainer::AddTracks().

Member Data Documentation

◆ kAnonTrackName

const string CTempTrackProxy::kAnonTrackName = "SV-Anon"
static

CTempTrackProxy class implementation.

Definition at line 59 of file layout_track_proxy.hpp.

Referenced by CTrackConfigManager::CreateDisplayName().

◆ m_Action

EAction CTempTrackProxy::m_Action = eNone
private

Definition at line 360 of file layout_track_proxy.hpp.

Referenced by GetAction(), operator=(), and SetAction().

◆ m_Annots

TAnnots CTempTrackProxy::m_Annots
private

can be 'Unnamed', 'Named', or annot names

Definition at line 358 of file layout_track_proxy.hpp.

Referenced by GetAnnots(), operator=(), SetAnnots(), and UpdateNA_ChildVisibility().

◆ m_Batch

string CTempTrackProxy::m_Batch
private

AlignDb batch.

Definition at line 363 of file layout_track_proxy.hpp.

Referenced by GetBatch(), operator=(), and SetBatch().

◆ m_BigDataIndex

string CTempTrackProxy::m_BigDataIndex
private

The location of a remote data file containing the index.

Definition at line 371 of file layout_track_proxy.hpp.

Referenced by GetBigDataIndex(), operator=(), and SetBigDataIndex().

◆ m_Category

string CTempTrackProxy::m_Category
private

track category.

Definition at line 289 of file layout_track_proxy.hpp.

Referenced by GetCategory(), operator=(), and SetCategory().

◆ m_Children

TTrackProxies CTempTrackProxy::m_Children
private

settings for children tracks.

Each created track may correspond to one data source, or data type (feature type/subtype). For example, the gene model may have gene model track created based on NCBI gene model, ENSEMBL gene model, other RNAs and Exons. optional, only for group-type track

Definition at line 316 of file layout_track_proxy.hpp.

Referenced by AddTempTrack(), CTempTrackProxy(), GetChildren(), GetChildTempTrack(), and operator=().

◆ m_Comments

string CTempTrackProxy::m_Comments
private

Definition at line 343 of file layout_track_proxy.hpp.

Referenced by GetComments(), operator=(), and SetComments().

◆ m_DispName

string CTempTrackProxy::m_DispName
private

track display name.

If empty, use track name

Definition at line 276 of file layout_track_proxy.hpp.

Referenced by GetDisplayName(), operator=(), and SetDisplayName().

◆ m_Empty

bool CTempTrackProxy::m_Empty = false
private

The track proxy is empty.

It can be removed and will be removed.

Definition at line 338 of file layout_track_proxy.hpp.

Referenced by IsEmpty(), operator=(), and SetEmpty().

◆ m_ErrorStatus

TTrackErrorStatus CTempTrackProxy::m_ErrorStatus
private

Definition at line 349 of file layout_track_proxy.hpp.

Referenced by GetErrorStatus(), operator=(), SetErrorStatus(), and SetTrack().

◆ m_Expanded

bool CTempTrackProxy::m_Expanded = true
private

track expanded/collapsed.

Definition at line 328 of file layout_track_proxy.hpp.

Referenced by GetExpanded(), operator=(), SetExpanded(), and SetTrack().

◆ m_Filter

string CTempTrackProxy::m_Filter
private

track-specific filter

Definition at line 305 of file layout_track_proxy.hpp.

Referenced by GetChildTempTrack(), GetFilter(), operator=(), and SetFilter().

◆ m_Help

string CTempTrackProxy::m_Help
private

track help string

Definition at line 325 of file layout_track_proxy.hpp.

Referenced by GetHelp(), operator=(), and SetHelp().

◆ m_Highlights

string CTempTrackProxy::m_Highlights
private

Definition at line 344 of file layout_track_proxy.hpp.

Referenced by GetHighlights(), operator=(), and SetHighlights().

◆ m_HighlightsColor

string CTempTrackProxy::m_HighlightsColor
private

Color to use for highlighting.

Definition at line 346 of file layout_track_proxy.hpp.

Referenced by GetHighlightsColor(), operator=(), and SetHighlightsColor().

◆ m_HubId

string CTempTrackProxy::m_HubId
private

Definition at line 372 of file layout_track_proxy.hpp.

Referenced by GetHubId(), and SetHubId().

◆ m_Id

string CTempTrackProxy::m_Id
private

unique track identifier.

Definition at line 272 of file layout_track_proxy.hpp.

Referenced by GetId(), operator=(), SetId(), and SetTrack().

◆ m_isPrivate

bool CTempTrackProxy::m_isPrivate = false
private

Definition at line 350 of file layout_track_proxy.hpp.

Referenced by GetIsPrivate(), operator=(), and SetIsPrivate().

◆ m_Key

string CTempTrackProxy::m_Key
private

may be used for creating a track

Definition at line 356 of file layout_track_proxy.hpp.

Referenced by GetKey(), operator=(), and SetKey().

◆ m_NAdata

CRef<CAnnotMetaData> CTempTrackProxy::m_NAdata
private

Definition at line 362 of file layout_track_proxy.hpp.

Referenced by GetNAdata(), and SetNAdata().

◆ m_Name

string CTempTrackProxy::m_Name
private

track name, may serve as track title.

Definition at line 269 of file layout_track_proxy.hpp.

Referenced by GetName(), operator=(), and SetName().

◆ m_Options2Hide

set<string> CTempTrackProxy::m_Options2Hide
private

Definition at line 373 of file layout_track_proxy.hpp.

Referenced by GetOptions2Hide(), and SetOptions2Hide().

◆ m_Options2Show

set<string> CTempTrackProxy::m_Options2Show
private

Definition at line 374 of file layout_track_proxy.hpp.

Referenced by GetOptions2Show(), and SetOptions2Show().

◆ m_Order

int CTempTrackProxy::m_Order = -1
private

track order for vertical ordering in its parent scope.

Initially, the track order is -1 for a newly created track params before associating it with a real track.

Definition at line 266 of file layout_track_proxy.hpp.

Referenced by GetOrder(), operator<(), operator=(), SetOrder(), and SetTrack().

◆ m_Profile

string CTempTrackProxy::m_Profile
private

track profile (setting style or list of settings).

Definition at line 279 of file layout_track_proxy.hpp.

Referenced by GetTrackProfile(), operator=(), SetTrack(), and SetTrackProfile().

◆ m_Realized

bool CTempTrackProxy::m_Realized = true
private

Has this been connected to any real track before.

A tempory track proxy may be created for a potential track that may not exist. This flag is for indicating if we need to save the proxy.

Definition at line 334 of file layout_track_proxy.hpp.

Referenced by IsRealized(), operator=(), SetRealized(), and SetTrack().

◆ m_RemoteData

string CTempTrackProxy::m_RemoteData
private

Definition at line 368 of file layout_track_proxy.hpp.

Referenced by GetRemoteData(), operator=(), and SetRemoteData().

◆ m_RemoteId

string CTempTrackProxy::m_RemoteId
private

Definition at line 369 of file layout_track_proxy.hpp.

Referenced by GetRemoteId(), and SetRemoteId().

◆ m_RemotePath

string CTempTrackProxy::m_RemotePath
private

Track remote path.

Definition at line 365 of file layout_track_proxy.hpp.

Referenced by GetRemotePath(), operator=(), and SetRemotePath().

◆ m_SeqDataKey

string CTempTrackProxy::m_SeqDataKey
private

Definition at line 370 of file layout_track_proxy.hpp.

Referenced by GetSeqDataKey(), operator=(), and SetSeqDataKey().

◆ m_SettingGroup

string CTempTrackProxy::m_SettingGroup
private

setting group name.

A group name defining a set of similar tracks that have the same properties and potentially can share the same set of settings

Definition at line 298 of file layout_track_proxy.hpp.

Referenced by GetSettingGroup(), operator=(), and SetSettingGroup().

◆ m_sExtraInfo

string CTempTrackProxy::m_sExtraInfo
private

extra information potentially needed to create the track

Definition at line 367 of file layout_track_proxy.hpp.

Referenced by GetExtraInfo(), and SetExtraInfo().

◆ m_Shown

bool CTempTrackProxy::m_Shown = true
private

track on/off state.

Definition at line 322 of file layout_track_proxy.hpp.

Referenced by GetShown(), operator=(), SetShown(), and SetTrack().

◆ m_ShowTitle

bool CTempTrackProxy::m_ShowTitle = true
private

Definition at line 348 of file layout_track_proxy.hpp.

Referenced by GetShowTitle(), operator=(), and SetShowTitle().

◆ m_SortBy

string CTempTrackProxy::m_SortBy
private

track-specific sortby

Definition at line 308 of file layout_track_proxy.hpp.

Referenced by GetChildTempTrack(), GetSortBy(), operator=(), and SetSortBy().

◆ m_Source

string CTempTrackProxy::m_Source
private

data source.

For most of cases, data source is the same as track name. If that is the case, m_Source may be empty. m_Source will be used when a track need data source info which is different from m_Name.

Definition at line 286 of file layout_track_proxy.hpp.

Referenced by GetSource(), IsExtendedNA(), IsNA(), operator=(), and SetSource().

◆ m_StoredScale

string CTempTrackProxy::m_StoredScale
private

Definition at line 351 of file layout_track_proxy.hpp.

Referenced by GetStoredScale(), operator=(), and SetStoredScale().

◆ m_Subcategory

string CTempTrackProxy::m_Subcategory
private

track sub-category.

Definition at line 292 of file layout_track_proxy.hpp.

Referenced by GetSubcategory(), operator=(), and SetSubcategory().

◆ m_Subkey

string CTempTrackProxy::m_Subkey
private

may be used for creating DataSource

Definition at line 357 of file layout_track_proxy.hpp.

Referenced by GetSubkey(), operator=(), and SetSubkey().

◆ m_SubTracks

TSubTracks CTempTrackProxy::m_SubTracks
private

Definition at line 354 of file layout_track_proxy.hpp.

Referenced by GetSubTracks(), operator=(), and SetSubTracks().

◆ m_TimeStamp

time_t CTempTrackProxy::m_TimeStamp = -1
private

Definition at line 361 of file layout_track_proxy.hpp.

Referenced by GetTimeStamp(), operator=(), and SetTimeStamp().

◆ m_Track

CRef<CLayoutTrack> CTempTrackProxy::m_Track
private

the delegated layout track object.

Definition at line 319 of file layout_track_proxy.hpp.

Referenced by GetExpanded(), GetOrder(), GetShown(), GetTrack(), GetTrackProfile(), operator=(), SetErrorStatus(), SetId(), SetOrder(), SetTrack(), and TrackNotSet().

◆ m_UId

string CTempTrackProxy::m_UId
private

Definition at line 353 of file layout_track_proxy.hpp.

Referenced by GetUId(), operator=(), and SetUId().

◆ m_UseGroupDefault

bool CTempTrackProxy::m_UseGroupDefault = false
private

flag indicating if group default setting applies.

default: false

Definition at line 302 of file layout_track_proxy.hpp.

Referenced by GetUseGroupDefault(), operator=(), and SetUseGroupDefault().

◆ m_VisitedRange

TSeqRange CTempTrackProxy::m_VisitedRange
private

The sequence range visited so far.

Definition at line 341 of file layout_track_proxy.hpp.

Referenced by GetVisitedRange(), and SetVisitedRange().


The documentation for this class was generated from the following files:
Modified on Wed Jun 19 17:00:09 2024 by modify_doxy.py rev. 669887