vreTableModel.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file vreTableModel.h
//! \ingroup vreManager
//! \brief Table model for VREngage application status data
//!
//! This file defines the DtVreTableModel class, which provides a Qt table model
//! for displaying and manipulating VREngage application status information.
 
#pragma once
 
#include "vreManager/export.h"
 
#include <vlpi/simulationAddress.h>
 
#include <QAbstractTableModel>
#include <QStringList>
 
namespace makVrv
{
class DtDe;
}
 
//! \brief Table model for VREngage application information
//!
//! This class implements a Qt table model for displaying and editing VREngage
//! application information, including application names, assigned entities,
//! station roles, and spectator mode settings.
class VREMANAGER_DLL DtVreTableModel : public QAbstractTableModel
{
   Q_OBJECT
public:
   //! \brief Structure containing VREngage application status information
   //!
   //! Contains all the information about a VREngage application's identity and
   //! current configuration settings displayed in the manager table.
   using VreRecord = struct VreRecord
   {
      //! \brief Unique identifier for the VREngage application
      unsigned long myId;
 
      //! \brief Name of the VREngage application
      std::string myName;
 
      //! \brief UUID of the entity being controlled
      std::string myEntityUUID;
 
      //! \brief Marking text for the entity
      std::string myMarkingText;
 
      //! \brief Currently assigned station/role name
      std::string myStationName;
 
      //! \brief Flag indicating whether player is in spectator mode
      bool mySpectator;
 
      //! \brief Flag indicating whether the record has unsaved changes
      bool myDirty;
 
      //! \brief List of available station names for the entity
      QStringList myStationNameList;
   };
 
   //! \brief Constructor
   //! \param parent The parent QObject
   //!
   //! Initializes a new table model for VREngage application data.
   DtVreTableModel(QObject* parent);
 
   //! \brief Destructor
   //!
   //! Cleans up resources used by the table model.
   virtual ~DtVreTableModel() override;
   //! \brief Gets the number of rows in the model
   //! \param parent The parent model index
   //! \return The number of VREngage applications in the table
   //!
   //! Returns the number of rows (VREngage applications) in the table model.
   virtual int rowCount(const QModelIndex& parent = QModelIndex()) const override;
   //! \brief Gets the number of columns in the model
   //! \param parent The parent model index
   //! \return The number of data columns in the table
   //!
   //! Returns the number of columns (data fields) in the table model.
   virtual int columnCount(const QModelIndex& parent = QModelIndex()) const override;
   //! \brief Gets data for a cell in the table
   //! \param index The model index of the cell
   //! \param role The data role (display, edit, etc.)
   //! \return The requested data as a QVariant
   //!
   //! Returns the data for the specified cell and role. Handles display formatting,
   //! editor setup, and other data presentation aspects.
   virtual QVariant data(const QModelIndex& index, int role = Qt::DisplayRole) const override;
   //! \brief Sets data for a cell in the table
   //! \param index The model index of the cell to modify
   //! \param value The new value to set
   //! \param role The data role (usually Qt::EditRole)
   //! \return True if successful, false otherwise
   //!
   //! Updates the data for the specified cell and marks the record as dirty to
   //! indicate that changes need to be saved.
   virtual bool setData(const QModelIndex& index, const QVariant& value, int role = Qt::EditRole) override;
   //! \brief Gets header data for the table
   //! \param section The row or column number
   //! \param orientation The header orientation (horizontal or vertical)
   //! \param role The data role
   //! \return The header data as a QVariant
   //!
   //! Returns header labels for the table columns.
   virtual QVariant headerData(int section, Qt::Orientation orientation, int role) const override;
   //! \brief Gets flags for an item in the table
   //! \param index The model index of the item
   //! \return The item flags
   //!
   //! Returns the flags for the specified item, including whether it's editable,
   //! selectable, enabled, etc.
   virtual Qt::ItemFlags flags(const QModelIndex& index) const override;
   //! \brief Adds a new VREngage application entry to the table
   //! \param vreRecord The record to add
   //!
   //! Adds a new VREngage application record to the table model and notifies
   //! views that the model has changed.
   virtual void addEntry(const VreRecord& vreRecord);
   //! \brief Removes a VREngage application entry from the table
   //! \param id The unique identifier of the application to remove
   //!
   //! Removes the VREngage application with the specified ID from the table model
   //! and notifies views that the model has changed.
   virtual void removeEntry(unsigned long id);
   //! \brief Updates an existing VREngage application entry
   //! \param id The unique identifier of the application to update
   //! \param vreRecord The new record data
   //!
   //! Updates the data for the VREngage application with the specified ID and
   //! notifies views that the model has changed.
   virtual void updateEntry(unsigned long id, const VreRecord& vreRecord);
 
   //! \brief Gets the ID of a VREngage application by row
   //! \param row The row index
   //! \return The unique identifier of the application
   //!
   //! Returns the unique identifier of the VREngage application at the specified row.
   //! TODO -- make these official columns and hide them
   virtual unsigned long id(int row) const;
   //! \brief Gets the entity UUID for a row
   //! \param row The row index
   //! \return The UUID of the entity assigned to the application
   //!
   //! Returns the UUID of the entity assigned to the VREngage application at the specified row.
   virtual std::string entityUUID(int row) const;
   //! \brief Checks if a row has unsaved changes
   //! \param row The row index
   //! \return True if the row has unsaved changes, false otherwise
   //!
   //! Returns whether the VREngage application record at the specified row has unsaved changes.
   virtual bool isDirty(int row) const;
   //! \brief Sets the dirty flag for a row
   //! \param row The row index
   //! \param flag The new dirty state
   //!
   //! Sets whether the VREngage application record at the specified row has unsaved changes.
   virtual void setDirty(int row, bool flag);
   //! \brief Checks if any rows in the table have unsaved changes
   //! \return True if any row has unsaved changes, false otherwise
   //!
   //! Returns whether any VREngage application records in the table have unsaved changes.
   virtual bool tableIsDirty() const;
   //! \brief Clears all dirty flags in the table
   //!
   //! Marks all VREngage application records in the table as clean (no unsaved changes).
   //! Called after changes have been saved or reverted.
   virtual void clearDirtyFlags();
 
   //! \brief Type definition for the table data container
   //!
   //! Vector of VREngage application records that makes up the table data.
   using VreTable = std::vector<VreRecord>;
 
protected:
   //! \brief The table data
   //!
   //! Container for all VREngage application records in the table.
   VreTable myData;
};