HLAinteger64Interval.h

Go to the documentation of this file.

#pragma once
/***********************************************************************
   The IEEE hereby grants a general, royalty-free license to copy, distribute,
   display and make derivative works from this material, for all purposes,
   provided that any use of the material contains the following
   attribution: "Reprinted with permission from IEEE 1516.1(TM)-2025".
   Should you require additional information, contact the Manager, Standards
   Intellectual Property, IEEE Standards Association (stds-ipr@ieee.org).
***********************************************************************/

#include <RTI/time/LogicalTimeInterval.h>
#include <RTI/encoding/EncodingConfig.h>

// Defines interface for HLAinteger64Time which presents an integer-based
// interval representation in the range 0 - 2^63-1. The encoded representation
// is HLAinteger64BE (signed, 64-bit, big-endian).

namespace rti1516_2025
{
   class HLAinteger64IntervalImpl;

   class RTI_EXPORT HLAinteger64Interval : public rti1516_2025::LogicalTimeInterval
   {
   public:

      // Constructors
      HLAinteger64Interval ();

      HLAinteger64Interval (
         HLAinteger64Interval const & rhs);

      HLAinteger64Interval (
         rti1516_2025::LogicalTimeInterval const & rhs);

      HLAinteger64Interval (
         Integer64);

      // Destructor
      ~HLAinteger64Interval()
         noexcept override;

      // Basic accessors/mutators

      void setZero () override;

      bool isZero () const override;

      void setEpsilon () override;

      bool isEpsilon () const override;

      // Operators

      rti1516_2025::HLAinteger64Interval& operator= (
         rti1516_2025::LogicalTimeInterval const & value) override;

      rti1516_2025::LogicalTimeInterval& operator+= (
          rti1516_2025::LogicalTimeInterval const & addend) override;

      rti1516_2025::LogicalTimeInterval& operator-= (
          rti1516_2025::LogicalTimeInterval const & subtrahend) override;

      bool operator> (
          rti1516_2025::LogicalTimeInterval const & value) const override;

      bool operator< (
          rti1516_2025::LogicalTimeInterval const & value) const override;

      bool operator== (
          rti1516_2025::LogicalTimeInterval const & value) const override;

      bool operator>= (
          rti1516_2025::LogicalTimeInterval const & value) const override;

      bool operator<= (
         rti1516_2025::LogicalTimeInterval const & value) const override;

      // Set self to the difference between two LogicalTimes
      void setToDifference (
         rti1516_2025::LogicalTime const & minuend,
         rti1516_2025::LogicalTime const& subtrahend) override;

      // Generates an encoded value that can be used to send
      // LogicalTimeIntervals to other federates in updates or interactions
      rti1516_2025::VariableLengthData encode () const override;

      // Alternate encode for directly filling a buffer
      // Return the length of encoded data
      size_t encode (
         void* buffer,
         size_t bufferSize) const override;

      // The length of the encoded data
      size_t encodedLength () const override;

      // Decode encodedValue into self
      void decode (
         rti1516_2025::VariableLengthData const & encodedValue) override;

      // Decode encodedValue into self
      // Alternate decode that reads directly from a buffer
      void decode (
         const void* buffer,
         size_t bufferSize) override;

      // Diagnostic string representation of time
      std::wstring toString () const override;

      // Return the name of the Implementation, as needed by
      // createFederationExecution.
      std::wstring implementationName () const override;

   public:

      //-----------------------------------------------------------------
      // Implementation functions
      //-----------------------------------------------------------------

      virtual Integer64 getInterval () const;

      virtual void setInterval (
         Integer64 value);

      //-----------------------------------------------------------------
      // Implementation operators
      //-----------------------------------------------------------------
      virtual HLAinteger64Interval& operator= (
         const HLAinteger64Interval& value);

      operator Integer64 () const;

   private:

      //-----------------------------------------------------------------
      // Pointer to internal Implementation
      //-----------------------------------------------------------------
      HLAinteger64IntervalImpl* _impl;
   };
}