VR-Link API Documentation for DIS
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Attributes
DtAttachedPart Class Reference

A representation of a single attached part, which contains an entity type. More...

+ Collaboration diagram for DtAttachedPart:

Public Member Functions

 DtAttachedPart ()
 Constructor.
virtual ~DtAttachedPart ()
 Destructor.
 DtAttachedPart (const DtAttachedPart &orig)
 Copy constructor.
DtAttachedPartoperator= (const DtAttachedPart &orig)
 Assignment operator.
bool operator== (const DtAttachedPart &other) const
 Equality/inequality operators.
bool operator!= (const DtAttachedPart &other) const
 Equality/inequality operators.
virtual const DtEntityTypeentityType () const
 Get/Set the entity type.
virtual void setEntityType (const DtEntityType &entType)
 Get/Set the entity type.
virtual bool detached () const
 Get/Set the detached value.
virtual void setDetached (bool det)
 Get/Set the detached value.
virtual unsigned int attachedTo () const
 Get/Set where this part is attached to the host.
virtual void setAttachedTo (unsigned int where)
 Get/Set where this part is attached to the host.

Protected Attributes

DtEntityType myEntityType
bool myDetached
unsigned short myAttachedTo

Detailed Description

A representation of a single attached part, which contains an entity type.

The station number of the attached part is held in the DtAttachedPartCollection to which each DtAttachedPart belongs. The creation/destruction of a DtAttachedPart should be done through the DtAttachedPartColleciton.

Constructor & Destructor Documentation

DtAttachedPart::DtAttachedPart ( )

Constructor.

Creates a new attached part with a null entity type.

virtual DtAttachedPart::~DtAttachedPart ( )
virtual

Destructor.

DtAttachedPart::DtAttachedPart ( const DtAttachedPart orig)

Copy constructor.

Member Function Documentation

virtual unsigned int DtAttachedPart::attachedTo ( ) const
virtual

Get/Set where this part is attached to the host.

This is only relevant in DIS 7 and later. If the detached value is set to true, the attached part should be deleted after an update.

virtual bool DtAttachedPart::detached ( ) const
virtual

Get/Set the detached value.

This is only relevant in DIS 7 and later. If the detached value is set to true, the attached part should be deleted after an update.

virtual const DtEntityType& DtAttachedPart::entityType ( ) const
virtual

Get/Set the entity type.

bool DtAttachedPart::operator!= ( const DtAttachedPart other) const

Equality/inequality operators.

A DtAttachedPart is considered equal to another if the entity type is the same. The station number is not taken into consideration in this class, as that information is stored in the DtAttachedPartCollection. These operators are meant to be primarily used by DtAttachedPartCollection's equality/inequality operators.

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

Assignment operator.

bool DtAttachedPart::operator== ( const DtAttachedPart other) const

Equality/inequality operators.

A DtAttachedPart is considered equal to another if the entity type is the same. The station number is not taken into consideration in this class, as that information is stored in the DtAttachedPartCollection. These operators are meant to be primarily used by DtAttachedPartCollection's equality/inequality operators.

virtual void DtAttachedPart::setAttachedTo ( unsigned int  where)
virtual

Get/Set where this part is attached to the host.

This is only relevant in DIS 7 and later. If the detached value is set to true, the attached part should be deleted after an update.

virtual void DtAttachedPart::setDetached ( bool  det)
virtual

Get/Set the detached value.

This is only relevant in DIS 7 and later. If the detached value is set to true, the attached part should be deleted after an update.

virtual void DtAttachedPart::setEntityType ( const DtEntityType entType)
virtual

Get/Set the entity type.

Member Data Documentation

unsigned short DtAttachedPart::myAttachedTo
protected
bool DtAttachedPart::myDetached
protected
DtEntityType DtAttachedPart::myEntityType
protected

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

Document ID: Generated on Thu Feb 22 04:26:36 EST 2018 from SVN revision 186468
Copyright © 2005-2016 VT MÄK. All Rights Reserved (www.mak.com)