VR-Link API Documentation for DIS
List of all members | Public Member Functions | Protected Attributes
DtBreachableSegmentRecord Class Reference

Instances of DtBreachableSegment record implement the BreachableSegmentStruct used to implement the Breachable Linear Object. More...

+ Collaboration diagram for DtBreachableSegmentRecord:

Public Member Functions

 DtBreachableSegmentRecord ()
 Default Constructor.
 DtBreachableSegmentRecord (const DtBreachableSegmentRecord &orig)
 Copy constructor.
DtBreachableSegmentRecordoperator= (const DtBreachableSegmentRecord &orig)
 Assignment Operator.
DtBreachableSegmentRecordoperator= (const DtNetBreachableSegmentRecord &orig)
int operator== (const DtBreachableSegmentRecord &rec)
int operator!= (const DtBreachableSegmentRecord &rec)
virtual ~DtBreachableSegmentRecord ()
 Destructor.
virtual void setSegmentParameters (const DtLinearSegmentRecord &seg)
 Get/Set Segment Parameters.
virtual const
DtLinearSegmentRecord
segmentParameters () const
virtual void setBreachLength (const DtU32 length)
 Get/Set Breach Length.
virtual DtU32 breachLength () const
virtual void setBreachedState (const DtBreachedStatus state)
 Get/Set Breached State.
virtual DtBreachedStatus breachedState () const
virtual bool setSegmentBreached (int index, const DtBreachedStatus state)
 Get/Set Segment Breached Returns false if the index is out of bounds.
virtual bool segmentBreached (int index, DtBreachedStatus &state) const
virtual void unloadNetRecord (const DtNetBreachableSegmentRecord &record)
virtual void loadNetRecord (DtNetBreachableSegmentRecord &record) const
virtual void printData () const
 Print the record to DtInfo.
virtual void printDataToStream (std::ostream &stream) const
 Print the record to a stream.

Protected Attributes

DtLinearSegmentRecord mySegmentParameters
DtU32 myBreachLength
DtBreachedStatus myBreachedState
DtBreachedStatus mySegmentBreached [8]

Detailed Description

Instances of DtBreachableSegment record implement the BreachableSegmentStruct used to implement the Breachable Linear Object.

Constructor & Destructor Documentation

DtBreachableSegmentRecord::DtBreachableSegmentRecord ( )

Default Constructor.

DtBreachableSegmentRecord::DtBreachableSegmentRecord ( const DtBreachableSegmentRecord orig)

Copy constructor.

virtual DtBreachableSegmentRecord::~DtBreachableSegmentRecord ( )
virtual

Destructor.

Member Function Documentation

virtual DtBreachedStatus DtBreachableSegmentRecord::breachedState ( ) const
virtual
virtual DtU32 DtBreachableSegmentRecord::breachLength ( ) const
virtual
virtual void DtBreachableSegmentRecord::loadNetRecord ( DtNetBreachableSegmentRecord record) const
virtual
int DtBreachableSegmentRecord::operator!= ( const DtBreachableSegmentRecord rec)
DtBreachableSegmentRecord& DtBreachableSegmentRecord::operator= ( const DtBreachableSegmentRecord orig)

Assignment Operator.

DtBreachableSegmentRecord& DtBreachableSegmentRecord::operator= ( const DtNetBreachableSegmentRecord orig)
int DtBreachableSegmentRecord::operator== ( const DtBreachableSegmentRecord rec)
virtual void DtBreachableSegmentRecord::printData ( ) const
virtual

Print the record to DtInfo.

virtual void DtBreachableSegmentRecord::printDataToStream ( std::ostream &  stream) const
virtual

Print the record to a stream.

virtual bool DtBreachableSegmentRecord::segmentBreached ( int  index,
DtBreachedStatus state 
) const
virtual
virtual const DtLinearSegmentRecord& DtBreachableSegmentRecord::segmentParameters ( ) const
virtual
virtual void DtBreachableSegmentRecord::setBreachedState ( const DtBreachedStatus  state)
virtual

Get/Set Breached State.

virtual void DtBreachableSegmentRecord::setBreachLength ( const DtU32  length)
virtual

Get/Set Breach Length.

virtual bool DtBreachableSegmentRecord::setSegmentBreached ( int  index,
const DtBreachedStatus  state 
)
virtual

Get/Set Segment Breached Returns false if the index is out of bounds.

There are 8 SegmentBreached records, so a valid index is >= 0 and <=7

virtual void DtBreachableSegmentRecord::setSegmentParameters ( const DtLinearSegmentRecord seg)
virtual

Get/Set Segment Parameters.

virtual void DtBreachableSegmentRecord::unloadNetRecord ( const DtNetBreachableSegmentRecord record)
virtual

Member Data Documentation

DtBreachedStatus DtBreachableSegmentRecord::myBreachedState
protected
DtU32 DtBreachableSegmentRecord::myBreachLength
protected
DtBreachedStatus DtBreachableSegmentRecord::mySegmentBreached[8]
protected
DtLinearSegmentRecord DtBreachableSegmentRecord::mySegmentParameters
protected

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

Document ID: Generated on Wed Aug 14 15:35:11 EDT 2013 from SVN revision 130445
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)