NCBI C++ ToolKit
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes
Messenger Class Reference

Search Toolkit Book for Messenger

#include <messenger.hpp>

+ Collaboration diagram for Messenger:

List of all members.

Public Types

typedef std::map< const
MoleculeIdentifier
*, std::vector< bool > > 
MoleculeHighlightMap

Public Member Functions

void PostRedrawSequenceViewer (ViewerBase *viewer)
void PostRedrawAllSequenceViewers (void)
void PostRedrawMolecule (const Molecule *molecule)
void PostRedrawAllStructures (void)
void UnPostRedrawAllSequenceViewers (void)
void UnPostRedrawSequenceViewer (ViewerBase *viewer)
void UnPostStructureRedraws (void)
void ProcessRedraws (void)
void SequenceWindowsSave (bool prompt)
void NewSequenceViewerFont (void)
bool IsHighlighted (const Molecule *molecule, int residueID) const
bool IsHighlighted (const Sequence *sequence, unsigned int seqIndex) const
bool IsHighlightedAnywhere (const MoleculeIdentifier *identifier) const
bool IsHighlightedAnywhere (const Molecule *molecule) const
bool RemoveAllHighlights (bool postRedraws)
void AddHighlights (const Sequence *sequence, unsigned int seqIndexFrom, unsigned int seqIndexTo)
void RemoveHighlights (const Sequence *sequence, unsigned int seqIndexFrom, unsigned int seqIndexTo)
void ToggleHighlights (const Sequence *sequence, unsigned int seqIndexFrom, unsigned int seqIndexTo)
void AddHighlights (const Molecule *molecule, int residueIDFrom, int residueIDTo, bool scrollViewersTo=false)
void ToggleHighlight (const Molecule *molecule, int residueID, bool scrollViewersTo=false)
void GetHighlights (MoleculeHighlightMap *copyHighlights)
void SetHighlights (const MoleculeHighlightMap &newHighlights)
void HighlightAndShowSequence (const Sequence *sequence)
void KeepHighlightsOnlyOnSequence (const Sequence *sequence)
void SuspendHighlighting (bool suspend)
void CacheHighlights (void)
void RestoreCachedHighlights (void)
 Messenger (void)
bool IsAnythingHighlighted (void) const
bool GetHighlightedResiduesWithStructure (MoleculeHighlightMap *residues) const
ncbi::objects::CBiostruc_annot_set * CreateBiostrucAnnotSetForHighlightsOnSingleObject (void) const
bool GetHighlightsForSelectionMessage (std::string *data) const
void AddSequenceViewer (ViewerBase *sequenceViewer)
void AddStructureWindow (StructureWindow *window)
void RemoveStructureWindow (const StructureWindow *structureWindow)
void RemoveSequenceViewer (const ViewerBase *sequenceViewer)
void SetAllWindowTitles (void) const
bool IsFileMessengerActive (void) const
void FileMessengerSend (const std::string &toApp, const std::string &command, const std::string &data)

Private Types

typedef std::list< ViewerBase * > SequenceViewerList
typedef std::map< const
Molecule *, bool
RedrawMoleculeList
typedef std::map< ViewerBase
*, bool
RedrawSequenceViewerList

Private Member Functions

bool IsHighlighted (const MoleculeIdentifier *identifier, int index) const
void ToggleHighlights (const MoleculeIdentifier *identifier, unsigned int indexFrom, unsigned int indexTo, const StructureSet *set)
void RedrawMoleculesWithIdentifier (const MoleculeIdentifier *identifier, const StructureSet *set)

Private Attributes

SequenceViewerList sequenceViewers
StructureWindowstructureWindow
RedrawMoleculeList redrawMolecules
RedrawSequenceViewerList redrawSequenceViewers
bool redrawAllStructures
bool redrawAllSequenceViewers
bool highlightingSuspended
MoleculeHighlightMap highlights
MoleculeHighlightMap highlightCache

Detailed Description

Definition at line 64 of file messenger.hpp.


Member Typedef Documentation

typedef std::map< const MoleculeIdentifier *, std::vector < bool > > Messenger::MoleculeHighlightMap

Definition at line 99 of file messenger.hpp.

typedef std::map< const Molecule *, bool > Messenger::RedrawMoleculeList [private]

Definition at line 148 of file messenger.hpp.

typedef std::map< ViewerBase *, bool > Messenger::RedrawSequenceViewerList [private]

Definition at line 150 of file messenger.hpp.

typedef std::list< ViewerBase * > Messenger::SequenceViewerList [private]

Definition at line 142 of file messenger.hpp.


Constructor & Destructor Documentation

Messenger::Messenger ( void  ) [inline]

Definition at line 166 of file messenger.hpp.


Member Function Documentation

void Messenger::AddHighlights ( const Sequence sequence,
unsigned int  seqIndexFrom,
unsigned int  seqIndexTo 
)
void Messenger::AddHighlights ( const Molecule molecule,
int  residueIDFrom,
int  residueIDTo,
bool  scrollViewersTo = false 
)
void Messenger::AddSequenceViewer ( ViewerBase sequenceViewer) [inline]

Definition at line 182 of file messenger.hpp.

Referenced by AlignmentManager::Init().

void Messenger::AddStructureWindow ( StructureWindow window) [inline]

Definition at line 185 of file messenger.hpp.

Referenced by StructureWindow::StructureWindow().

void Messenger::CacheHighlights ( void  )
CBiostruc_annot_set * Messenger::CreateBiostrucAnnotSetForHighlightsOnSingleObject ( void  ) const
void Messenger::FileMessengerSend ( const std::string &  toApp,
const std::string &  command,
const std::string &  data 
)

Definition at line 599 of file messenger.cpp.

References StructureWindow::SendCommand(), and structureWindow.

bool Messenger::GetHighlightedResiduesWithStructure ( MoleculeHighlightMap residues) const

Definition at line 453 of file messenger.cpp.

References highlights, and IsAnythingHighlighted().

Referenced by AnnotateDialog::AnnotateDialog().

void Messenger::GetHighlights ( MoleculeHighlightMap copyHighlights)
bool Messenger::GetHighlightsForSelectionMessage ( std::string *  data) const

Definition at line 536 of file messenger.cpp.

References highlights, IsAnythingHighlighted(), SeqIdToIdentifier(), and WARNINGMSG.

void Messenger::HighlightAndShowSequence ( const Sequence sequence)
bool Messenger::IsAnythingHighlighted ( void  ) const [inline]
bool Messenger::IsFileMessengerActive ( void  ) const

Definition at line 594 of file messenger.cpp.

References StructureWindow::IsFileMessengerActive(), and structureWindow.

bool Messenger::IsHighlighted ( const Molecule molecule,
int  residueID 
) const
bool Messenger::IsHighlighted ( const Sequence sequence,
unsigned int  seqIndex 
) const

Definition at line 221 of file messenger.cpp.

References Sequence::identifier, and IsHighlighted().

bool Messenger::IsHighlighted ( const MoleculeIdentifier identifier,
int  index 
) const [private]

Definition at line 200 of file messenger.cpp.

References ERRORMSG, highlightingSuspended, and highlights.

bool Messenger::IsHighlightedAnywhere ( const MoleculeIdentifier identifier) const
bool Messenger::IsHighlightedAnywhere ( const Molecule molecule) const

Definition at line 231 of file messenger.cpp.

References Molecule::identifier, and IsHighlighted().

void Messenger::KeepHighlightsOnlyOnSequence ( const Sequence sequence)
void Messenger::NewSequenceViewerFont ( void  )

Definition at line 190 of file messenger.cpp.

References sequenceViewers.

Referenced by StructureWindow::OnSetFont().

void Messenger::PostRedrawAllSequenceViewers ( void  )
void Messenger::PostRedrawAllStructures ( void  )
void Messenger::PostRedrawMolecule ( const Molecule molecule)
void Messenger::PostRedrawSequenceViewer ( ViewerBase viewer)
void Messenger::ProcessRedraws ( void  )
void Messenger::RedrawMoleculesWithIdentifier ( const MoleculeIdentifier identifier,
const StructureSet set 
) [private]
bool Messenger::RemoveAllHighlights ( bool  postRedraws)
void Messenger::RemoveHighlights ( const Sequence sequence,
unsigned int  seqIndexFrom,
unsigned int  seqIndexTo 
)
void Messenger::RemoveSequenceViewer ( const ViewerBase sequenceViewer)

Definition at line 174 of file messenger.cpp.

References sequenceViewers.

Referenced by AlignmentManager::~AlignmentManager().

void Messenger::RemoveStructureWindow ( const StructureWindow structureWindow)

Definition at line 167 of file messenger.cpp.

References ERRORMSG, and structureWindow.

Referenced by StructureWindow::OnExit().

void Messenger::RestoreCachedHighlights ( void  )
void Messenger::SequenceWindowsSave ( bool  prompt)
void Messenger::SetAllWindowTitles ( void  ) const
void Messenger::SetHighlights ( const MoleculeHighlightMap newHighlights)
void Messenger::SuspendHighlighting ( bool  suspend)
void Messenger::ToggleHighlight ( const Molecule molecule,
int  residueID,
bool  scrollViewersTo = false 
)
void Messenger::ToggleHighlights ( const Sequence sequence,
unsigned int  seqIndexFrom,
unsigned int  seqIndexTo 
)
void Messenger::ToggleHighlights ( const MoleculeIdentifier identifier,
unsigned int  indexFrom,
unsigned int  indexTo,
const StructureSet set 
) [private]
void Messenger::UnPostRedrawAllSequenceViewers ( void  )

Definition at line 100 of file messenger.cpp.

References redrawAllSequenceViewers, and redrawSequenceViewers.

void Messenger::UnPostRedrawSequenceViewer ( ViewerBase viewer)
void Messenger::UnPostStructureRedraws ( void  )

Definition at line 117 of file messenger.cpp.

References redrawAllStructures, and redrawMolecules.

Referenced by OpenGLRenderer::Construct().


Member Data Documentation

Definition at line 157 of file messenger.hpp.

Referenced by CacheHighlights(), and RestoreCachedHighlights().

Definition at line 154 of file messenger.hpp.

Referenced by IsHighlighted(), and SuspendHighlighting().


The documentation for this class was generated from the following files:
Modified on Wed May 23 12:51:37 2012 by modify_doxy.py rev. 337098