VR-Engage  2.2
Loading...
Searching...
No Matches
makVre::DtVreWeaponControllerDescriptor Class Reference

Detailed Description

This class extends the base weapon controller descriptor to add configuration for equipment resource types and ammunition selection capabilities. It provides parameters for direct fire weapon controllers, allowing them to choose appropriate ammunition based on target types and maintain resource tracking.

#include <vreWeaponControllerDescriptor.h>

Inheritance diagram for makVre::DtVreWeaponControllerDescriptor:
[legend]

Public Member Functions

 DtVreWeaponControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
 
 DtVreWeaponControllerDescriptor (const DtVreWeaponControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
 
DtVreWeaponControllerDescriptoroperator= (const DtVreWeaponControllerDescriptor &orig)
 
virtual ~DtVreWeaponControllerDescriptor () override
 
 DtVreWeaponControllerDescriptor ()=delete
 
virtual DtString type () const override
 
virtual DtComponentDescriptor * clone (DtReaderWriterRegistry *parentRegistry=0) const override
 
virtual const DtEntityType & equipmentResourceType () const
 
virtual void setEquipmentResourceType (const DtEntityType &equipmentResourceType)
 

Static Public Member Functions

static DtComponentDescriptor * creator ()
 

Protected Attributes

DtRwResource myEquipmentResourceType
 

Constructor & Destructor Documentation

◆ DtVreWeaponControllerDescriptor() [1/3]

makVre::DtVreWeaponControllerDescriptor::DtVreWeaponControllerDescriptor ( const DtString & name,
DtReaderWriterRegistry * parentRegistry = 0 )

Constructor with component name.

Parameters
nameThe name of this component
parentRegistryParent registry for reader/writer functionality (optional)

Creates a new weapon controller descriptor with the specified name.

Referenced by DtVreWeaponControllerDescriptor(), and operator=().

◆ DtVreWeaponControllerDescriptor() [2/3]

makVre::DtVreWeaponControllerDescriptor::DtVreWeaponControllerDescriptor ( const DtVreWeaponControllerDescriptor & orig,
DtReaderWriterRegistry * parentRegistry = 0 )

Copy constructor.

Parameters
origThe source descriptor to copy from
parentRegistryParent registry for reader/writer functionality (optional)

Creates a new weapon controller descriptor as a copy of the provided original.

References DtVreWeaponControllerDescriptor().

◆ ~DtVreWeaponControllerDescriptor()

virtual makVre::DtVreWeaponControllerDescriptor::~DtVreWeaponControllerDescriptor ( )
overridevirtual

Virtual destructor.

Cleans up resources used by the descriptor.

◆ DtVreWeaponControllerDescriptor() [3/3]

makVre::DtVreWeaponControllerDescriptor::DtVreWeaponControllerDescriptor ( )
delete

Default constructor (deleted)

Default constructor is explicitly deleted to prevent creation of instances without proper initialization.

Member Function Documentation

◆ operator=()

DtVreWeaponControllerDescriptor & makVre::DtVreWeaponControllerDescriptor::operator= ( const DtVreWeaponControllerDescriptor & orig)

Assignment operator.

Parameters
origThe source descriptor to copy from
Returns
Reference to this descriptor after assignment

Assigns the contents of the provided descriptor to this one.

References DtVreWeaponControllerDescriptor().

◆ type()

virtual DtString makVre::DtVreWeaponControllerDescriptor::type ( ) const
overridevirtual

Gets the type identifier for this descriptor.

Returns
String identifying this descriptor type

Returns a unique type identifier string for this descriptor type. Will return DtVreWeaponControllerDescriptorType.

◆ clone()

virtual DtComponentDescriptor * makVre::DtVreWeaponControllerDescriptor::clone ( DtReaderWriterRegistry * parentRegistry = 0) const
overridevirtual

Creates a clone of this descriptor.

Parameters
parentRegistryParent registry for reader/writer functionality (optional)
Returns
Pointer to a new descriptor that is a clone of this one

Creates a new weapon controller descriptor as a deep copy of this one.

◆ equipmentResourceType()

virtual const DtEntityType & makVre::DtVreWeaponControllerDescriptor::equipmentResourceType ( ) const
virtual

Gets the equipment resource type.

Returns
Reference to the equipment resource entity type

Returns the type of equipment resource used by this weapon controller. This is used for resource tracking and management in the simulation.

Referenced by setEquipmentResourceType().

◆ setEquipmentResourceType()

virtual void makVre::DtVreWeaponControllerDescriptor::setEquipmentResourceType ( const DtEntityType & equipmentResourceType)
virtual

Sets the equipment resource type.

Parameters
equipmentResourceTypeThe equipment resource entity type

Sets the type of equipment resource used by this weapon controller. This is used for resource tracking and management in the simulation.

References equipmentResourceType().

◆ creator()

static DtComponentDescriptor * makVre::DtVreWeaponControllerDescriptor::creator ( )
static

Factory function to create a new instance of this descriptor.

Returns
Pointer to a newly created descriptor

Static factory function used by the descriptor creation system to instantiate new instances of this descriptor type.

Member Data Documentation

◆ myEquipmentResourceType

DtRwResource makVre::DtVreWeaponControllerDescriptor::myEquipmentResourceType
protected

Equipment resource entity type.

The type of equipment resource used by this weapon controller. This is used for resource tracking and management in the simulation. Parameter name: "equipment-resource"


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