Changeset f2efcf for molecuilder/src/Parser/ChangeTracker.cpp

Timestamp:

Mar 5, 2010, 12:53:13 PM (15 years ago)

Author:

Saskia Metzler <metzler@…>

Children:

5aefaa

Parents:

4938aa

Message:

the XYZ parser

File:

• molecuilder/src/Parser/ChangeTracker.cpp (moved) (moved from molecuilder/src/ChangeTracker.cpp ) (4 diffs)

molecuilder/src/Parser/ChangeTracker.cpp

@@ -10 +10 @@
 ChangeTracker* ChangeTracker::instance = NULL;
 
+/**
+ * Constructor. Signs on as an observer for the World.
+ */
 ChangeTracker::ChangeTracker() {
   isConsistent = true;
@@ -15 +18 @@
 }
 
+/**
+ * Destructor. Signs off from the World.
+ */
 ChangeTracker::~ChangeTracker() {
   World::get()->signOff(this);
 }
 
+/**
+ * Returns the change tracker instance.
+ *
+ * \return this
+ */
 ChangeTracker* ChangeTracker::get() {
   if (instance == NULL) {
@@ -27 +38 @@
 }
 
+/**
+ * Destroys the change tracker instance. Be careful, the change tracker is a
+ * singleton and destruction might lead to a loss of consistency.
+ */
 void ChangeTracker::destroy() {
   delete instance;
@@ -32 +47 @@
 }
 
+/**
+ * With this, the World can update the change tracker's state.
+ */
 void ChangeTracker::update(Observable *publisher) {
   isConsistent = false;
 }
 
+/**
+ * Gets whether there are non-saved changes.
+ *
+ * \param true if there are any changes, false otherwise
+ */
 bool ChangeTracker::hasChanged() {
   return !isConsistent;
 }
 
+/**
+ * Tells all observers (which are the different parsers) that they are supposed
+ * to save the current state.
+ */
 void ChangeTracker::saveStatus() {
   if (hasChanged()) {