src/DataTypes/GED_BasicGroundCombatVehicle.cpp

   1 /*********************************************************************
   2 Copyright 2013 Karl Jones
   3 All rights reserved.
   4
   5 Redistribution and use in source and binary forms, with or without
   6 modification, are permitted provided that the following conditions are met:
   7
   8 1. Redistributions of source code must retain the above copyright notice, this
   9    list of conditions and the following disclaimer.
  10 2. Redistributions in binary form must reproduce the above copyright notice,
  11    this list of conditions and the following disclaimer in the documentation
  12    and/or other materials provided with the distribution.
  13
  14 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
  15 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  16 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  17 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
  18 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  19 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  20 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  21 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  23 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24
  25 For Further Information Please Contact me at
  26 Karljj1@yahoo.com
  27 http://p.sf.net/kdis/UserGuide
  28 *********************************************************************/
  29
  30 #include "KDIS/DataTypes/GED_BasicGroundCombatVehicle.hpp"
  31
  32 using namespace KDIS;
  33 using namespace DATA_TYPE;
  34 using namespace ENUMS;
  35 using namespace UTILS;
  36
  37 //////////////////////////////////////////////////////////////////////////
  38 // Public:
  39 //////////////////////////////////////////////////////////////////////////
  40
  41 GED_BasicGroundCombatVehicle::GED_BasicGroundCombatVehicle()
  42     : m_ui16EntityID(0),
  43       m_i8Spd(0),
  44       m_i8TrrtAz(0),
  45       m_i8GnElv(0),
  46       m_i8TrrtSlwRt(0),
  47       m_i8GnElvRt(0) {
  48   for (KINT8 i = 0; i < 3; ++i) {
  49     m_i16Offsets[i] = 0;
  50     m_i8Ori[i] = 0;
  51   }
  52 }
  53
  54 //////////////////////////////////////////////////////////////////////////
  55
  56 GED_BasicGroundCombatVehicle::GED_BasicGroundCombatVehicle(
  57     KDataStream& stream) {
  58   Decode(stream);
  59 }
  60
  61 //////////////////////////////////////////////////////////////////////////
  62
  63 GED_BasicGroundCombatVehicle::GED_BasicGroundCombatVehicle(
  64     KUINT16 ID, KINT16 XOffset, KINT16 YOffset, KINT16 ZOffset,
  65     const EntityAppearance& EA, KINT8 Psi, KINT8 Theta, KINT8 Phi, KINT8 Speed,
  66     KINT8 TurretAzimuth, KINT8 GunElevation, KINT8 TurretSlewRate,
  67     KINT8 GunElevationRate)
  68     : m_ui16EntityID(ID),
  69       m_EA(EA),
  70       m_i8Spd(Speed),
  71       m_i8TrrtAz(TurretAzimuth),
  72       m_i8GnElv(GunElevation),
  73       m_i8TrrtSlwRt(TurretSlewRate),
  74       m_i8GnElvRt(GunElevationRate) {
  75   m_i16Offsets[0] = XOffset;
  76   m_i16Offsets[1] = YOffset;
  77   m_i16Offsets[2] = ZOffset;
  78   m_i8Ori[0] = Psi;
  79   m_i8Ori[1] = Theta;
  80   m_i8Ori[2] = Phi;
  81 }
  82
  83 //////////////////////////////////////////////////////////////////////////
  84
  85 GED_BasicGroundCombatVehicle::~GED_BasicGroundCombatVehicle() {}
  86
  87 //////////////////////////////////////////////////////////////////////////
  88
  89 GroupedEntityCategory GED_BasicGroundCombatVehicle::GetGroupedEntityCategory()
  90     const {
  91   return BasicGroundCombatVehicleGEC;
  92 }
  93
  94 //////////////////////////////////////////////////////////////////////////
  95
  96 KUINT8 GED_BasicGroundCombatVehicle::GetLength() const {
  97   return GED_BASIC_GROUND_COMBAT_VEHICLE_SIZE;
  98 }
  99
 100 //////////////////////////////////////////////////////////////////////////
 101
 102 void GED_BasicGroundCombatVehicle::SetEntityID(KUINT16 ID) {
 103   m_ui16EntityID = ID;
 104 }
 105
 106 //////////////////////////////////////////////////////////////////////////
 107
 108 KUINT16 GED_BasicGroundCombatVehicle::GetEntityID() const {
 109   return m_ui16EntityID;
 110 }
 111
 112 //////////////////////////////////////////////////////////////////////////
 113
 114 void GED_BasicGroundCombatVehicle::SetEntityLocation(KINT16 XOffset,
 115                                                      KINT16 YOffset,
 116                                                      KINT16 ZOffset) {
 117   m_i16Offsets[0] = XOffset;
 118   m_i16Offsets[1] = YOffset;
 119   m_i16Offsets[2] = ZOffset;
 120 }
 121
 122 //////////////////////////////////////////////////////////////////////////
 123
 124 void GED_BasicGroundCombatVehicle::SetEntityLocation(KINT16 Offsets[3]) {
 125   for (KUINT8 i = 0; i < 3; ++i) {
 126     m_i16Offsets[i] = Offsets[i];
 127   }
 128 }
 129
 130 //////////////////////////////////////////////////////////////////////////
 131
 132 void GED_BasicGroundCombatVehicle::SetEntityLocationXOffset(KINT16 X) {
 133   m_i16Offsets[0] = X;
 134 }
 135
 136 //////////////////////////////////////////////////////////////////////////
 137
 138 void GED_BasicGroundCombatVehicle::SetEntityLocationYOffset(KINT16 Y) {
 139   m_i16Offsets[1] = Y;
 140 }
 141
 142 //////////////////////////////////////////////////////////////////////////
 143
 144 void GED_BasicGroundCombatVehicle::SetEntityLocationZOffset(KINT16 Z) {
 145   m_i16Offsets[2] = Z;
 146 }
 147
 148 //////////////////////////////////////////////////////////////////////////
 149
 150 KINT16 GED_BasicGroundCombatVehicle::GetEntityLocationXOffset() const {
 151   return m_i16Offsets[0];
 152 }
 153
 154 //////////////////////////////////////////////////////////////////////////
 155
 156 KINT16 GED_BasicGroundCombatVehicle::GetEntityLocationYOffset() const {
 157   return m_i16Offsets[1];
 158 }
 159
 160 //////////////////////////////////////////////////////////////////////////
 161
 162 KINT16 GED_BasicGroundCombatVehicle::GetEntityLocationZOffset() const {
 163   return m_i16Offsets[2];
 164 }
 165
 166 //////////////////////////////////////////////////////////////////////////
 167
 168 void GED_BasicGroundCombatVehicle::SetEntityAppearance(
 169     const EntityAppearance& EA) {
 170   m_EA = EA;
 171 }
 172
 173 //////////////////////////////////////////////////////////////////////////
 174
 175 const EntityAppearance& GED_BasicGroundCombatVehicle::GetEntityAppearance()
 176     const {
 177   return m_EA;
 178 }
 179
 180 //////////////////////////////////////////////////////////////////////////
 181
 182 EntityAppearance& GED_BasicGroundCombatVehicle::GetEntityAppearance() {
 183   return m_EA;
 184 }
 185
 186 //////////////////////////////////////////////////////////////////////////
 187
 188 void GED_BasicGroundCombatVehicle::SetEntityOrientation(KINT8 Psi, KINT8 Theta,
 189                                                         KINT8 Phi) {
 190   m_i8Ori[0] = Psi;
 191   m_i8Ori[1] = Theta;
 192   m_i8Ori[2] = Phi;
 193 }
 194
 195 //////////////////////////////////////////////////////////////////////////
 196
 197 void GED_BasicGroundCombatVehicle::SetEntityOrientation(KINT8 Ori[3]) {
 198   for (KINT8 i = 0; i < 3; ++i) {
 199     m_i8Ori[i] = Ori[i];
 200   }
 201 }
 202
 203 //////////////////////////////////////////////////////////////////////////
 204
 205 void GED_BasicGroundCombatVehicle::SetEntityOrientationPsi(KINT8 P) {
 206   m_i8Ori[0] = P;
 207 }
 208
 209 //////////////////////////////////////////////////////////////////////////
 210
 211 void GED_BasicGroundCombatVehicle::SetEntityOrientationTheta(KINT8 T) {
 212   m_i8Ori[1] = T;
 213 }
 214
 215 //////////////////////////////////////////////////////////////////////////
 216
 217 void GED_BasicGroundCombatVehicle::SetEntityOrientationPhi(KINT8 P) {
 218   m_i8Ori[2] = P;
 219 }
 220
 221 //////////////////////////////////////////////////////////////////////////
 222
 223 KINT8 GED_BasicGroundCombatVehicle::GetEntityOrientationPsi() const {
 224   return m_i8Ori[0];
 225 }
 226
 227 //////////////////////////////////////////////////////////////////////////
 228
 229 KINT8 GED_BasicGroundCombatVehicle::GetEntityOrientationTheta() const {
 230   return m_i8Ori[1];
 231 }
 232
 233 //////////////////////////////////////////////////////////////////////////
 234
 235 KINT8 GED_BasicGroundCombatVehicle::GetEntityOrientationPhi() const {
 236   return m_i8Ori[2];
 237 }
 238
 239 //////////////////////////////////////////////////////////////////////////
 240
 241 void GED_BasicGroundCombatVehicle::SetSpeed(KINT8 S) { m_i8Spd = S; }
 242
 243 //////////////////////////////////////////////////////////////////////////
 244
 245 KINT8 GED_BasicGroundCombatVehicle::GetSpeed() const { return m_i8Spd; }
 246
 247 //////////////////////////////////////////////////////////////////////////
 248
 249 void GED_BasicGroundCombatVehicle::SetTurretAzimuth(KINT8 T) { m_i8TrrtAz = T; }
 250
 251 //////////////////////////////////////////////////////////////////////////
 252
 253 KINT8 GED_BasicGroundCombatVehicle::GetTurretAzimuth() const {
 254   return m_i8TrrtAz;
 255 }
 256
 257 //////////////////////////////////////////////////////////////////////////
 258
 259 void GED_BasicGroundCombatVehicle::SetGunElevation(KINT8 G) { m_i8GnElv = G; }
 260
 261 //////////////////////////////////////////////////////////////////////////
 262
 263 KINT8 GED_BasicGroundCombatVehicle::GetGunElevation() const {
 264   return m_i8GnElv;
 265 }
 266
 267 //////////////////////////////////////////////////////////////////////////
 268
 269 void GED_BasicGroundCombatVehicle::SetTurretSlewRate(KINT8 T) {
 270   m_i8TrrtSlwRt = T;
 271 }
 272
 273 //////////////////////////////////////////////////////////////////////////
 274
 275 KINT8 GED_BasicGroundCombatVehicle::GetTurretSlewRate() const {
 276   return m_i8TrrtSlwRt;
 277 }
 278
 279 //////////////////////////////////////////////////////////////////////////
 280
 281 void GED_BasicGroundCombatVehicle::SetGunElevationRate(KINT8 G) {
 282   m_i8GnElvRt = G;
 283 }
 284
 285 //////////////////////////////////////////////////////////////////////////
 286
 287 KINT8 GED_BasicGroundCombatVehicle::GetGunElevationRate() const {
 288   return m_i8GnElvRt;
 289 }
 290
 291 //////////////////////////////////////////////////////////////////////////
 292
 293 KString GED_BasicGroundCombatVehicle::GetAsString() const {
 294   KStringStream ss;
 295
 296   ss << "GED Basic Ground Combat Vehicle\n"
 297      << "\tEntity ID:                  " << m_ui16EntityID << "\n"
 298      << "\tLocation Offsets(x,y,z):    " << m_i16Offsets[0] << " "
 299      << m_i16Offsets[1] << " " << m_i16Offsets[2] << "\n"
 300      << IndentString(
 301             m_EA.GetAsString(EntityType(Platform, Land, 0, 0, 0, 0, 0)), 1)
 302      << "\tOrientation(Psi,Theta,Phi): " << (KINT16)m_i8Ori[0] << " "
 303      << (KINT16)m_i8Ori[1] << " " << (KINT16)m_i8Ori[2] << "\n"
 304      << "\tSpeed:                      " << (KINT16)m_i8Spd << "m/s\n"
 305      << "\tTurret Azimuth:             " << (KINT16)m_i8TrrtAz << "\n"
 306      << "\tGun Elevation:              " << (KINT16)m_i8GnElv << "\n"
 307      << "\tTurret Slew Rate:           " << (KINT16)m_i8TrrtSlwRt << "\n"
 308      << "\tGun Elevation Rate:         " << (KINT16)m_i8GnElvRt << "\n";
 309
 310   return ss.str();
 311 }
 312
 313 //////////////////////////////////////////////////////////////////////////
 314
 315 void GED_BasicGroundCombatVehicle::Decode(KDataStream& stream) {
 316   if (stream.GetBufferSize() < GED_BASIC_GROUND_COMBAT_VEHICLE_SIZE)
 317     throw KException(__FUNCTION__, NOT_ENOUGH_DATA_IN_BUFFER);
 318
 319   stream >> m_ui16EntityID >> m_i16Offsets[0] >> m_i16Offsets[1] >>
 320       m_i16Offsets[2] >> KDIS_STREAM m_EA >> m_i8Ori[0] >> m_i8Ori[1] >>
 321       m_i8Ori[2] >> m_i8Spd >> m_i8TrrtAz >> m_i8GnElv >> m_i8TrrtSlwRt >>
 322       m_i8GnElvRt;
 323 }
 324
 325 //////////////////////////////////////////////////////////////////////////
 326
 327 KDataStream GED_BasicGroundCombatVehicle::Encode() const {
 328   KDataStream stream;
 329
 330   GED_BasicGroundCombatVehicle::Encode(stream);
 331
 332   return stream;
 333 }
 334
 335 //////////////////////////////////////////////////////////////////////////
 336
 337 void GED_BasicGroundCombatVehicle::Encode(KDataStream& stream) const {
 338   stream << m_ui16EntityID << m_i16Offsets[0] << m_i16Offsets[1]
 339          << m_i16Offsets[2] << KDIS_STREAM m_EA << m_i8Ori[0] << m_i8Ori[1]
 340          << m_i8Ori[2] << m_i8Spd << m_i8TrrtAz << m_i8GnElv << m_i8TrrtSlwRt
 341          << m_i8GnElvRt;
 342 }
 343
 344 //////////////////////////////////////////////////////////////////////////
 345
 346 KBOOL GED_BasicGroundCombatVehicle::operator==(
 347     const GED_BasicGroundCombatVehicle& Value) const {
 348   if (m_ui16EntityID != Value.m_ui16EntityID) return false;
 349   if (m_i16Offsets[0] != Value.m_i16Offsets[0]) return false;
 350   if (m_i16Offsets[1] != Value.m_i16Offsets[1]) return false;
 351   if (m_i16Offsets[2] != Value.m_i16Offsets[2]) return false;
 352   if (m_EA != Value.m_EA) return false;
 353   if (m_i8Ori[0] != Value.m_i8Ori[0]) return false;
 354   if (m_i8Ori[1] != Value.m_i8Ori[1]) return false;
 355   if (m_i8Ori[2] != Value.m_i8Ori[2]) return false;
 356   if (m_i8Spd != Value.m_i8Spd) return false;
 357   if (m_i8TrrtAz != Value.m_i8TrrtAz) return false;
 358   if (m_i8GnElv != Value.m_i8GnElv) return false;
 359   if (m_i8TrrtSlwRt != Value.m_i8TrrtSlwRt) return false;
 360   if (m_i8GnElvRt != Value.m_i8GnElvRt) return false;
 361   return true;
 362 }
 363
 364 //////////////////////////////////////////////////////////////////////////
 365
 366 KBOOL GED_BasicGroundCombatVehicle::operator!=(
 367     const GED_BasicGroundCombatVehicle& Value) const {
 368   return !(*this == Value);
 369 }
 370
 371 //////////////////////////////////////////////////////////////////////////