VR-Forces 4.0.4 Class Documentation
Public Member Functions | Static Public Member Functions | Protected Attributes
DtSetScanSectorRequest Class Reference

DtSetScanSectorRequest is used to specify a scan sector for a (usually turreted) entity. More...

Inheritance diagram for DtSetScanSectorRequest:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 DtSetScanSectorRequest ()
 default constructor
 DtSetScanSectorRequest (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
 constructor If you have a request 'put' itself, the writeName will preface it.
 DtSetScanSectorRequest (const DtString &writeName, const DtSetScanSectorRequest &orig, DtReaderWriterRegistry *parentRegistry=0)
 copy constructor
const DtSetScanSectorRequestoperator= (const DtSetScanSectorRequest &orig)
 assignment operator
virtual ~DtSetScanSectorRequest ()
virtual int type () const
 Returns DtSetScanSectorRequestType.
virtual DtSetDataRequestclone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const
 Creates a copy of the request.
virtual DtString stringRep () const
 Get a readable string representation of this setDataRequest.
virtual DtReal scanCenter () const
 The center of the sector of responsibility, in radians.
virtual void setScanCenter (DtReal scanCenter)
virtual DtReal scanAmount () const
 The size (angular width) of the sector of responsibility, expressed in radians.
virtual void setScanAmount (DtReal scanAmount)
virtual int netRepSize () const
 Returns the size of the full network representation padded to an 8-byte boundary.
virtual bool setFromNet (const char *contentBuffer, unsigned contentSize)
 Fills in the task from the network buffer.
virtual bool setToNet ()
 Fills in the network buffer (created by base class simTask) with the task contents.

Static Public Member Functions

static DtSetDataRequestcreator ()

Protected Attributes

DtRwReal myScanCenter
DtRwReal myScanAmount

Detailed Description

DtSetScanSectorRequest is used to specify a scan sector for a (usually turreted) entity.

The sector of responsibility is used by individual entities when they compute the probability of detection of hostile entities. One detection table is used for detection in-sector, while another is used for out-of-sector detection. Normally, the probability of detection outside an entity’s sector of responsibility is lower. The DtTurretScanController slews the turret within this sector. It inherits read/writableness from DtSetDataRequest, and includes the center of the scan sector (in radians, 0. out the vehicle front, clockwise) and the size of the sector (scan amount, radians).

set-data-request-type: DtSetScanSectorRequestType

parameters: scan center - The center of the sector of responsibility, in radians. The sector of responsibility lies in the entity’s X-Y plane (body coordinates). Angles are measured starting from the front of the vehicle, increasing clockwise.

scan size - The size (angular width) of the sector of responsi- bility, expressed in radians.


Constructor & Destructor Documentation

default constructor

DtSetScanSectorRequest::DtSetScanSectorRequest ( const DtString writeName,
DtReaderWriterRegistry parentRegistry = 0 
)

constructor If you have a request 'put' itself, the writeName will preface it.

DtSetScanSectorRequest::DtSetScanSectorRequest ( const DtString writeName,
const DtSetScanSectorRequest orig,
DtReaderWriterRegistry parentRegistry = 0 
)

copy constructor


Member Function Documentation

const DtSetScanSectorRequest& DtSetScanSectorRequest::operator= ( const DtSetScanSectorRequest orig)

assignment operator

virtual int DtSetScanSectorRequest::type ( ) const [virtual]

Returns DtSetScanSectorRequestType.

Implements DtSetDataRequest.

virtual DtSetDataRequest* DtSetScanSectorRequest::clone ( const DtString name,
DtReaderWriterRegistry parentRegistry = 0 
) const [virtual]

Creates a copy of the request.

Implements DtSetDataRequest.

virtual DtString DtSetScanSectorRequest::stringRep ( ) const [virtual]

Get a readable string representation of this setDataRequest.

Implements DtSetDataRequest.

virtual DtReal DtSetScanSectorRequest::scanCenter ( ) const [virtual]

The center of the sector of responsibility, in radians.

The sector of responsibility lies in the entity’s X-Y plane (body coordinates). Angles are measured starting from the front of the vehicle, increasing clockwise.

virtual void DtSetScanSectorRequest::setScanCenter ( DtReal  scanCenter) [virtual]
virtual DtReal DtSetScanSectorRequest::scanAmount ( ) const [virtual]

The size (angular width) of the sector of responsibility, expressed in radians.

virtual void DtSetScanSectorRequest::setScanAmount ( DtReal  scanAmount) [virtual]
virtual int DtSetScanSectorRequest::netRepSize ( ) const [virtual]

Returns the size of the full network representation padded to an 8-byte boundary.

Reimplemented from DtSetDataRequest.

virtual bool DtSetScanSectorRequest::setFromNet ( const char *  contentBuffer,
unsigned  contentSize 
) [virtual]

Fills in the task from the network buffer.

Reimplemented from DtSetDataRequest.

virtual bool DtSetScanSectorRequest::setToNet ( ) [virtual]

Fills in the network buffer (created by base class simTask) with the task contents.

Reimplemented from DtSetDataRequest.


Member Data Documentation


The documentation for this class was generated from the following file:

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)