KDIS/KDIS/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 "./GED_BasicGroundCombatVehicle.h"
  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 {
  49     for( KINT8 i = 0; i < 3; ++i )
  50     {
  51         m_i16Offsets[i] = 0;
  52         m_i8Ori[i] = 0;
  53     }
  54 }
  55
  56 //////////////////////////////////////////////////////////////////////////
  57
  58 GED_BasicGroundCombatVehicle::GED_BasicGroundCombatVehicle( KDataStream & stream )
  59 {
  60     Decode( stream );
  61 }
  62
  63 //////////////////////////////////////////////////////////////////////////
  64
  65 GED_BasicGroundCombatVehicle::GED_BasicGroundCombatVehicle( KUINT16 ID, KINT16 XOffset, KINT16 YOffset, KINT16 ZOffset, const EntityAppearance & EA,
  66         KINT8 Psi, KINT8 Theta, KINT8 Phi, KINT8 Speed, KINT8 TurretAzimuth, KINT8 GunElevation,
  67         KINT8 TurretSlewRate, 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 {
  76     m_i16Offsets[0] = XOffset;
  77     m_i16Offsets[1] = YOffset;
  78     m_i16Offsets[2] = ZOffset;
  79     m_i8Ori[0] = Psi;
  80     m_i8Ori[1] = Theta;
  81     m_i8Ori[2] = Phi;
  82 }
  83
  84 //////////////////////////////////////////////////////////////////////////
  85
  86 GED_BasicGroundCombatVehicle::~GED_BasicGroundCombatVehicle()
  87 {
  88 }
  89
  90 //////////////////////////////////////////////////////////////////////////
  91
  92 GroupedEntityCategory GED_BasicGroundCombatVehicle::GetGroupedEntityCategory() const
  93 {
  94     return BasicGroundCombatVehicleGEC;
  95 }
  96
  97 //////////////////////////////////////////////////////////////////////////
  98
  99 KUINT8 GED_BasicGroundCombatVehicle::GetLength() const
 100 {
 101     return GED_BASIC_GROUND_COMBAT_VEHICLE_SIZE;
 102 }
 103
 104 //////////////////////////////////////////////////////////////////////////
 105
 106 void GED_BasicGroundCombatVehicle::SetEntityID( KUINT16 ID )
 107 {
 108     m_ui16EntityID = ID;
 109 }
 110
 111 //////////////////////////////////////////////////////////////////////////
 112
 113 KUINT16 GED_BasicGroundCombatVehicle::GetEntityID() const
 114 {
 115     return m_ui16EntityID;
 116 }
 117
 118 //////////////////////////////////////////////////////////////////////////
 119
 120 void GED_BasicGroundCombatVehicle::SetEntityLocation( KINT16 XOffset, KINT16 YOffset, KINT16 ZOffset )
 121 {
 122     m_i16Offsets[0] = XOffset;
 123     m_i16Offsets[1] = YOffset;
 124     m_i16Offsets[2] = ZOffset;
 125 }
 126
 127 //////////////////////////////////////////////////////////////////////////
 128
 129 void GED_BasicGroundCombatVehicle::SetEntityLocation( KINT16 Offsets[3] )
 130 {
 131     for( KUINT8 i = 0; i < 3; ++i )
 132     {
 133         m_i16Offsets[i] = Offsets[i];
 134     }
 135 }
 136
 137 //////////////////////////////////////////////////////////////////////////
 138
 139 void GED_BasicGroundCombatVehicle::SetEntityLocationXOffset( KINT16 X )
 140 {
 141     m_i16Offsets[0] = X;
 142 }
 143
 144 //////////////////////////////////////////////////////////////////////////
 145
 146 void GED_BasicGroundCombatVehicle::SetEntityLocationYOffset( KINT16 Y )
 147 {
 148     m_i16Offsets[1] = Y;
 149 }
 150
 151 //////////////////////////////////////////////////////////////////////////
 152
 153 void GED_BasicGroundCombatVehicle::SetEntityLocationZOffset( KINT16 Z )
 154 {
 155     m_i16Offsets[2] = Z;
 156 }
 157
 158 //////////////////////////////////////////////////////////////////////////
 159
 160 KINT16 GED_BasicGroundCombatVehicle::GetEntityLocationXOffset() const
 161 {
 162     return m_i16Offsets[0];
 163 }
 164
 165 //////////////////////////////////////////////////////////////////////////
 166
 167 KINT16 GED_BasicGroundCombatVehicle::GetEntityLocationYOffset() const
 168 {
 169     return m_i16Offsets[1];
 170 }
 171
 172 //////////////////////////////////////////////////////////////////////////
 173
 174 KINT16 GED_BasicGroundCombatVehicle::GetEntityLocationZOffset() const
 175 {
 176     return m_i16Offsets[2];
 177 }
 178
 179 //////////////////////////////////////////////////////////////////////////
 180
 181 void GED_BasicGroundCombatVehicle::SetEntityAppearance( const EntityAppearance & EA )
 182 {
 183     m_EA = EA;
 184 }
 185
 186 //////////////////////////////////////////////////////////////////////////
 187
 188 const EntityAppearance & GED_BasicGroundCombatVehicle::GetEntityAppearance() const
 189 {
 190     return m_EA;
 191 }
 192
 193 //////////////////////////////////////////////////////////////////////////
 194
 195 EntityAppearance & GED_BasicGroundCombatVehicle::GetEntityAppearance()
 196 {
 197     return m_EA;
 198 }
 199
 200 //////////////////////////////////////////////////////////////////////////
 201
 202 void GED_BasicGroundCombatVehicle::SetEntityOrientation( KINT8 Psi, KINT8 Theta, KINT8 Phi )
 203 {
 204     m_i8Ori[0] = Psi;
 205     m_i8Ori[1] = Theta;
 206     m_i8Ori[2] = Phi;
 207 }
 208
 209 //////////////////////////////////////////////////////////////////////////
 210
 211 void GED_BasicGroundCombatVehicle::SetEntityOrientation( KINT8 Ori[3] )
 212 {
 213     for( KINT8 i = 0; i < 3; ++i )
 214     {
 215         m_i8Ori[i] = Ori[i];
 216     }
 217 }
 218
 219 //////////////////////////////////////////////////////////////////////////
 220
 221 void GED_BasicGroundCombatVehicle::SetEntityOrientationPsi( KINT8 P )
 222 {
 223     m_i8Ori[0] = P;
 224 }
 225
 226 //////////////////////////////////////////////////////////////////////////
 227
 228 void GED_BasicGroundCombatVehicle::SetEntityOrientationTheta( KINT8 T )
 229 {
 230     m_i8Ori[1] = T;
 231 }
 232
 233 //////////////////////////////////////////////////////////////////////////
 234
 235 void GED_BasicGroundCombatVehicle::SetEntityOrientationPhi( KINT8 P )
 236 {
 237     m_i8Ori[2] = P;
 238 }
 239
 240 //////////////////////////////////////////////////////////////////////////
 241
 242 KINT8 GED_BasicGroundCombatVehicle::GetEntityOrientationPsi() const
 243 {
 244     return m_i8Ori[0];
 245 }
 246
 247 //////////////////////////////////////////////////////////////////////////
 248
 249 KINT8 GED_BasicGroundCombatVehicle::GetEntityOrientationTheta() const
 250 {
 251     return m_i8Ori[1];
 252 }
 253
 254 //////////////////////////////////////////////////////////////////////////
 255
 256 KINT8 GED_BasicGroundCombatVehicle::GetEntityOrientationPhi() const
 257 {
 258     return m_i8Ori[2];
 259 }
 260
 261 //////////////////////////////////////////////////////////////////////////
 262
 263 void GED_BasicGroundCombatVehicle::SetSpeed( KINT8 S )
 264 {
 265     m_i8Spd = S;
 266 }
 267
 268 //////////////////////////////////////////////////////////////////////////
 269
 270 KINT8 GED_BasicGroundCombatVehicle::GetSpeed() const
 271 {
 272     return m_i8Spd;
 273 }
 274
 275 //////////////////////////////////////////////////////////////////////////
 276
 277 void GED_BasicGroundCombatVehicle::SetTurretAzimuth( KINT8 T )
 278 {
 279     m_i8TrrtAz = T;
 280 }
 281
 282 //////////////////////////////////////////////////////////////////////////
 283
 284 KINT8 GED_BasicGroundCombatVehicle::GetTurretAzimuth() const
 285 {
 286     return m_i8TrrtAz;
 287 }
 288
 289 //////////////////////////////////////////////////////////////////////////
 290
 291 void GED_BasicGroundCombatVehicle::SetGunElevation( KINT8 G )
 292 {
 293     m_i8GnElv = G;
 294 }
 295
 296 //////////////////////////////////////////////////////////////////////////
 297
 298 KINT8 GED_BasicGroundCombatVehicle::GetGunElevation() const
 299 {
 300     return m_i8GnElv;
 301 }
 302
 303 //////////////////////////////////////////////////////////////////////////
 304
 305 void GED_BasicGroundCombatVehicle::SetTurretSlewRate( KINT8 T )
 306 {
 307     m_i8TrrtSlwRt = T;
 308 }
 309
 310 //////////////////////////////////////////////////////////////////////////
 311
 312 KINT8 GED_BasicGroundCombatVehicle::GetTurretSlewRate() const
 313 {
 314     return m_i8TrrtSlwRt;
 315 }
 316
 317 //////////////////////////////////////////////////////////////////////////
 318
 319 void GED_BasicGroundCombatVehicle::SetGunElevationRate( KINT8 G )
 320 {
 321     m_i8GnElvRt = G;
 322 }
 323
 324 //////////////////////////////////////////////////////////////////////////
 325
 326 KINT8 GED_BasicGroundCombatVehicle::GetGunElevationRate() const
 327 {
 328     return m_i8GnElvRt;
 329 }
 330
 331 //////////////////////////////////////////////////////////////////////////
 332
 333 KString GED_BasicGroundCombatVehicle::GetAsString() const
 334 {
 335     KStringStream ss;
 336
 337     ss << "GED Basic Ground Combat Vehicle\n"
 338        << "\tEntity ID:                  " << m_ui16EntityID  << "\n"
 339        << "\tLocation Offsets(x,y,z):    " << m_i16Offsets[0] << " " << m_i16Offsets[1] << " " << m_i16Offsets[2] << "\n"
 340        << IndentString( m_EA.GetAsString( EntityType( Platform, Land, 0, 0, 0, 0, 0 ) ), 1 )
 341        << "\tOrientation(Psi,Theta,Phi): " << ( KINT16 )m_i8Ori[0]    << " " << ( KINT16 )m_i8Ori[1] << " " << ( KINT16 )m_i8Ori[2] << "\n"
 342        << "\tSpeed:                      " << ( KINT16 )m_i8Spd       << "m/s\n"
 343        << "\tTurret Azimuth:             " << ( KINT16 )m_i8TrrtAz    << "\n"
 344        << "\tGun Elevation:              " << ( KINT16 )m_i8GnElv     << "\n"
 345        << "\tTurret Slew Rate:           " << ( KINT16 )m_i8TrrtSlwRt << "\n"
 346        << "\tGun Elevation Rate:         " << ( KINT16 )m_i8GnElvRt   << "\n";
 347
 348     return ss.str();
 349 }
 350
 351 //////////////////////////////////////////////////////////////////////////
 352
 353 void GED_BasicGroundCombatVehicle::Decode( KDataStream & stream )
 354 {
 355     if( stream.GetBufferSize() < GED_BASIC_GROUND_COMBAT_VEHICLE_SIZE )throw KException( __FUNCTION__, NOT_ENOUGH_DATA_IN_BUFFER );
 356
 357     stream >> m_ui16EntityID
 358            >> m_i16Offsets[0]
 359            >> m_i16Offsets[1]
 360            >> m_i16Offsets[2]
 361            >> KDIS_STREAM m_EA
 362            >> m_i8Ori[0]
 363            >> m_i8Ori[1]
 364            >> m_i8Ori[2]
 365            >> m_i8Spd
 366            >> m_i8TrrtAz
 367            >> m_i8GnElv
 368            >> m_i8TrrtSlwRt
 369            >> m_i8GnElvRt;
 370 }
 371
 372 //////////////////////////////////////////////////////////////////////////
 373
 374 KDataStream GED_BasicGroundCombatVehicle::Encode() const
 375 {
 376     KDataStream stream;
 377
 378     GED_BasicGroundCombatVehicle::Encode( stream );
 379
 380     return stream;
 381 }
 382
 383 //////////////////////////////////////////////////////////////////////////
 384
 385 void GED_BasicGroundCombatVehicle::Encode( KDataStream & stream ) const
 386 {
 387     stream << m_ui16EntityID
 388            << m_i16Offsets[0]
 389            << m_i16Offsets[1]
 390            << m_i16Offsets[2]
 391            << KDIS_STREAM m_EA
 392            << m_i8Ori[0]
 393            << m_i8Ori[1]
 394            << m_i8Ori[2]
 395            << m_i8Spd
 396            << m_i8TrrtAz
 397            << m_i8GnElv
 398            << m_i8TrrtSlwRt
 399            << m_i8GnElvRt;
 400 }
 401
 402 //////////////////////////////////////////////////////////////////////////
 403
 404 KBOOL GED_BasicGroundCombatVehicle::operator == ( const GED_BasicGroundCombatVehicle & Value ) const
 405 {
 406     if( m_ui16EntityID      != Value.m_ui16EntityID )   return false;
 407     if( m_i16Offsets[0]     != Value.m_i16Offsets[0] )  return false;
 408     if( m_i16Offsets[1]     != Value.m_i16Offsets[1] )  return false;
 409     if( m_i16Offsets[2]     != Value.m_i16Offsets[2] )  return false;
 410     if( m_EA                != Value.m_EA )             return false;
 411     if( m_i8Ori[0]          != Value.m_i8Ori[0] )       return false;
 412     if( m_i8Ori[1]          != Value.m_i8Ori[1] )       return false;
 413     if( m_i8Ori[2]          != Value.m_i8Ori[2] )       return false;
 414     if( m_i8Spd             != Value.m_i8Spd )          return false;
 415     if( m_i8TrrtAz          != Value.m_i8TrrtAz )       return false;
 416     if( m_i8GnElv           != Value.m_i8GnElv  )       return false;
 417     if( m_i8TrrtSlwRt       != Value.m_i8TrrtSlwRt )    return false;
 418     if( m_i8GnElvRt         != Value.m_i8GnElvRt )      return false;
 419     return true;
 420 }
 421
 422 //////////////////////////////////////////////////////////////////////////
 423
 424 KBOOL GED_BasicGroundCombatVehicle::operator != ( const GED_BasicGroundCombatVehicle & Value ) const
 425 {
 426     return !( *this == Value );
 427 }
 428
 429 //////////////////////////////////////////////////////////////////////////