makVre::DtBullseyePSR Class Reference

Detailed Description

This class provides storage and management for bullseye reference entity data, which is used by the bullseye controller component in VREngage simulations. A bullseye reference point is a tactical position reference commonly used in military simulations for communicating relative positions.

#include <bullseyePSR.h>

Inheritance diagram for makVre::DtBullseyePSR:

Public Member Functions
	DtBullseyePSR (DtLocalObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	DtBullseyePSR (const DtBullseyePSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtBullseyePSR () override
DtBullseyePSR &	operator= (const DtBullseyePSR &orig)
virtual DtVrfProcessStateRepository *	clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const override
virtual DtString	type () const override
virtual DtSimObjectReference	bullseyeEntity () const
virtual void	setBullseyeEntity (const DtUUID &uuid)
virtual void	removeBullseyeEntity ()

Static Public Member Functions
static DtVrfProcessStateRepository *	creator (const DtString &rwName, DtLocalObject *vrfObject, DtReaderWriterRegistry *parentRegistry)

Protected Attributes
DtRwSimObjectReference	myBullseyeEntity

Constructor & Destructor Documentation

DtBullseyePSR() [1/2]

makVre::DtBullseyePSR::DtBullseyePSR	(	DtLocalObject *	vrfObject,
		const DtString &	rwName = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = 0 )

Constructor with VRF object and optional name.

Parameters

vrfObject	Pointer to the local object this PSR is associated with
rwName	Optional reader/writer name
parentRegistry	Optional parent registry for reader/writer functionality

Creates a new bullseye PSR for the specified VRF object.

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

DtBullseyePSR() [2/2]

makVre::DtBullseyePSR::DtBullseyePSR	(	const DtBullseyePSR &	orig,
		const DtString &	rwName = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = 0 )

Copy constructor.

Parameters

orig	The source PSR to copy from
rwName	Optional reader/writer name
parentRegistry	Optional parent registry for reader/writer functionality

Creates a new bullseye PSR as a copy of the provided original.

References DtBullseyePSR().

~DtBullseyePSR()

virtual makVre::DtBullseyePSR::~DtBullseyePSR ( )

overridevirtual

Virtual destructor.

Cleans up resources used by the PSR.

Member Function Documentation

operator=()

DtBullseyePSR & makVre::DtBullseyePSR::operator=

(

const DtBullseyePSR &

orig

)

Assignment operator (not implemented)

Parameters

orig	The source PSR to copy from

Returns

Reference to this PSR after assignment

Assignment operator is declared but not implemented to prevent assignment.

References DtBullseyePSR().

clone()

virtual DtVrfProcessStateRepository * makVre::DtBullseyePSR::clone ( const DtString & rwName = DtString::nullString(), DtReaderWriterRegistry * parentRegistry = 0 ) const

overridevirtual

Creates a clone of this PSR.

Parameters

rwName	Optional reader/writer name for the clone
parentRegistry	Optional parent registry for reader/writer functionality

Returns

Pointer to a new PSR that is a clone of this one

Creates a new bullseye PSR as a deep copy of this one.

type()

virtual DtString makVre::DtBullseyePSR::type ( ) const

overridevirtual

Gets the type identifier for this PSR.

Returns

String identifying this PSR type

Returns a unique type identifier string for this PSR type. Will return DtBullseyePSRType.

bullseyeEntity()

virtual DtSimObjectReference makVre::DtBullseyePSR::bullseyeEntity ( ) const

virtual

Gets the currently selected bullseye entity.

Returns

Reference to the bullseye entity, or an invalid reference if none is set

Returns a reference to the entity currently designated as the bullseye reference point.

setBullseyeEntity()

virtual void makVre::DtBullseyePSR::setBullseyeEntity ( const DtUUID & uuid )

virtual

Sets the bullseye entity.

Parameters

uuid	The UUID of the entity to set as the bullseye reference

Designates the specified entity as the bullseye reference point.

removeBullseyeEntity()

virtual void makVre::DtBullseyePSR::removeBullseyeEntity ( )

virtual

Removes the bullseye entity designation.

Clears the current bullseye reference point, if any.

creator()

static DtVrfProcessStateRepository * makVre::DtBullseyePSR::creator ( const DtString & rwName, DtLocalObject * vrfObject, DtReaderWriterRegistry * parentRegistry )

static

Factory function to create a new instance of this PSR.

Parameters

rwName	The reader/writer name for the new instance
vrfObject	Pointer to the local object this PSR will be associated with
parentRegistry	Parent registry for reader/writer functionality

Returns

Pointer to a newly created PSR instance

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

Member Data Documentation

myBullseyeEntity

DtRwSimObjectReference makVre::DtBullseyePSR::myBullseyeEntity

protected

Reference to the selected bullseye entity.

Stores a reference to the entity designated as the bullseye reference point. This entity serves as a tactical position reference for communicating relative positions in military simulations.

---

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

• include/vrfExtensions/vreVrfobjcore/bullseyePSR.h