setVreEmbarkedRole.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file setVreEmbarkedRole.h
//! \ingroup vreVrfMessages
//! \brief Defines a request message for setting entity embarked roles
//!
//! This file contains the DtSetVreEmbarkedRoleRequest class which is used to
//! save information about the role (gunner, driver, commander, etc.) that a
//! VREngage station has embarked an entity as. This information is used to select
//! the appropriate role when an Engage station (re)attaches to this entity.
 
#pragma once
 
#include "vreVrfMessages/export.h"
#include <vrftasks/setDataRequest.h>
#include <readerWriter/rwString.h>
#include <vrftasks/radioMessageTypes.h>
 
namespace makVre
{
//! \brief Class for storing entity embarked role information
//!
//! This class is used to save the role (gunner, driver, commander, passenger, etc.)
//! which the VREngage station embarked the entity as. This information is used to select
//! the correct role when a VREngage station (re)attaches to this entity and ensures
//! consistent role assignment between sessions.
 
//! \brief Message type identifier for embarked role settings
//!
//! DtSetPlayerStationControlledString must be a unique string representing the message type.
//! Existing string types are defined in msgTypes.h.
const DtSetMessageType DtSetVreEmbarkedRoleType("set-vre-embarked-role");
 
//! \brief Request message for setting entity embarked roles
//!
//! This class provides a mechanism for setting and persisting information about
//! the role a user has selected when embarking an entity. This ensures consistent
//! role allocation when the same user reconnects to the simulation.
class VRFMESSAGES_DLL DtSetVreEmbarkedRoleRequest : public DtSetDataRequest
{
public:
   //! \brief Default constructor
   //!
   //! Initializes an empty embarked role request message.
   DtSetVreEmbarkedRoleRequest();
 
   //! \brief Constructor with write name
   //! \param writeName The name to identify this request
   //! \param parentRegistry Optional reader-writer registry for serialization
   //!
   //! If you have a request 'put' itself, the writeName will preface it.
   DtSetVreEmbarkedRoleRequest(const DtString& writeName, DtReaderWriterRegistry* parentRegistry = 0);
 
   //! \brief Copy constructor with new name
   //! \param writeName The name to identify this request
   //! \param orig The embarked role request to copy from
   //! \param parentRegistry Optional reader-writer registry for serialization
   //!
   //! Creates a new embarked role request by copying an existing one.
   DtSetVreEmbarkedRoleRequest(
      const DtString& writeName, const DtSetVreEmbarkedRoleRequest& orig, DtReaderWriterRegistry* parentRegistry = 0);
 
   //! \brief Assignment operator
   //! \param orig The embarked role request to copy from
   //! \return Reference to this object after assignment
   //!
   //! Copies the contents of another embarked role request into this one.
   const DtSetVreEmbarkedRoleRequest& operator=(const DtSetVreEmbarkedRoleRequest& orig);
 
   //! \brief Virtual destructor
   virtual ~DtSetVreEmbarkedRoleRequest() override;
 
   //! \brief Gets the request message type
   //! \return The message type identifier
   //!
   //! Returns DtSetVreEmbarkedRoleType as defined in this file.
   virtual const DtSetMessageType& type() const override;
 
   //! \brief Creates a copy of this request
   //! \param name The name to assign to the new request
   //! \param parentRegistry Optional reader-writer registry for serialization
   //! \return Pointer to the newly created request
   //!
   //! Creates a dynamically allocated copy of this request with a new name.
   virtual DtSetDataRequest* clone(const DtString& name, DtReaderWriterRegistry* parentRegistry = 0) const override;
 
   //! \brief Gets a readable string representation of this request
   //! \return String representation of the request
   //!
   //! Returns a human-readable representation of the request contents.
   virtual DtString stringRep() const override;
 
   //! \brief Gets the role in which the entity was embarked
   //! \return The embarked station/role name
   //!
   //! Returns the name of the role (e.g., "gunner", "driver", "commander") that
   //! was used when embarking the entity.
   virtual DtString engageEmbarkedStation() const;
 
   //! \brief Sets the role in which the entity was embarked
   //! \param station The embarked station/role name to set
   //!
   //! Sets the name of the role (e.g., "gunner", "driver", "commander") that
   //! was used when embarking the entity.
   virtual void setEngageEmbarkedStation(const DtString& station);
 
   //! \brief Gets the network representation size
   //! \return Size in bytes of the network representation
   //!
   //! Returns the size of the full network representation padded to an 8-byte boundary.
   virtual int netRepSize() const override;
 
   //! \brief Deserializes the request from a network buffer
   //! \param contentBuffer Pointer to the network buffer
   //! \param contentSize Size of the buffer in bytes
   //! \return True if deserialization was successful
   //!
   //! Fills in the request from the provided network buffer.
   virtual bool setFromNet(const char* contentBuffer, unsigned contentSize) override;
 
   //! \brief Serializes the request for network transmission
   //! \return True if serialization was successful
   //!
   //! Fills in the network buffer (created by base class setDataRequest) with
   //! the set data request contents.
   virtual bool setToNet() override;
 
   //! \brief Static creator function for factory registration
   //! \return Pointer to a new instance of DtSetVreEmbarkedRoleRequest
   //!
   //! This static function is used for registration with the message factory.
   static DtSetDataRequest* creator();
 
protected:
   //! \brief The embarked station/role name
   //!
   //! Stores the name of the role (e.g., "gunner", "driver", "commander")
   //! that was used when embarking the entity.
   DtRwString myStation;
};
} // namespace makVre