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

This is a process state repository for the DtAggregatePatrolAlongController that stores the list of the names of currently tasked entities. More...

Inheritance diagram for DtAggregatePatrolAlongPSR:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 DtAggregatePatrolAlongPSR (DtVrfObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
 constructor
 DtAggregatePatrolAlongPSR (const DtAggregatePatrolAlongPSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
 copy constructor
virtual ~DtAggregatePatrolAlongPSR ()
 destructor
DtAggregatePatrolAlongPSRoperator= (const DtAggregatePatrolAlongPSR &orig)
 assignment operator
virtual
DtVrfProcessStateRepository
clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const
 returns a newly created copy of this object
virtual DtString type () const
 Returns the string type of this process state repository, defined in procSRTypes.h.
virtual void setReverseDirection (bool trueFalse)
 Indicates which direction we should head.
virtual bool reverseDirection () const
virtual void setMovingAlongRoute (bool trueFalse)
 Indicates if we are currently moving along route (versus reversing direction).
virtual bool movingAlongRoute ()

Static Public Member Functions

static
DtVrfProcessStateRepository
creator (const DtString &rwName, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry)
 Returns a newly created instance of this class.

Protected Attributes

DtRwBoolean myReverseDirection
DtRwBoolean myMovingAlongRoute

Detailed Description

This is a process state repository for the DtAggregatePatrolAlongController that stores the list of the names of currently tasked entities.


Constructor & Destructor Documentation

DtAggregatePatrolAlongPSR::DtAggregatePatrolAlongPSR ( DtVrfObject vrfObject,
const DtString rwName = DtString::nullString(),
DtReaderWriterRegistry parentRegistry = 0 
)

constructor

DtAggregatePatrolAlongPSR::DtAggregatePatrolAlongPSR ( const DtAggregatePatrolAlongPSR orig,
const DtString rwName = DtString::nullString(),
DtReaderWriterRegistry parentRegistry = 0 
)

copy constructor

destructor


Member Function Documentation

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

assignment operator

virtual DtVrfProcessStateRepository* DtAggregatePatrolAlongPSR::clone ( const DtString rwName = DtString::nullString(),
DtReaderWriterRegistry parentRegistry = 0 
) const [virtual]

returns a newly created copy of this object

Implements DtVrfProcessStateRepository.

virtual DtString DtAggregatePatrolAlongPSR::type ( ) const [virtual]

Returns the string type of this process state repository, defined in procSRTypes.h.

Returns "vrf-aggregate-patrol-along-process-state-repository".

Implements DtVrfProcessStateRepository.

virtual void DtAggregatePatrolAlongPSR::setReverseDirection ( bool  trueFalse) [virtual]

Indicates which direction we should head.

If true, move along route in forward direciton. If false, move along route in reverse direction.

virtual void DtAggregatePatrolAlongPSR::setMovingAlongRoute ( bool  trueFalse) [virtual]

Indicates if we are currently moving along route (versus reversing direction).

static DtVrfProcessStateRepository* DtAggregatePatrolAlongPSR::creator ( const DtString rwName,
DtVrfObject vrfObject,
DtReaderWriterRegistry parentRegistry 
) [static]

Returns a newly created instance of this class.


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)