RlCgfVrf::DtVreRlStateRepository Class Reference

Detailed Description

This class maintains the state information for rotary-wing aircraft within the VREngage simulation, including position, orientation, velocity, and other aircraft state variables. It provides methods for initializing, updating, and querying this state information.

#include <vreRlStateRepository.h>

Inheritance diagram for RlCgfVrf::DtVreRlStateRepository:

Public Member Functions
	DtVreRlStateRepository (DtLocalObject *vrfObject, const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtVreRlStateRepository () override
virtual bool	init () override
virtual DtString	type () const override
virtual void	initializeFromParameters () override
const DtVreRlParameters *	getParameters () const
virtual void	place (const DtVector &location, const DtReal heading, bool clampToGroundFlag=true, bool *dataAvailable=0, bool requireAllData=false) override

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

Private Member Functions
	DtVreRlStateRepository (const DtVreRlStateRepository &orig)
const DtVreRlStateRepository &	operator= (const DtVreRlStateRepository &orig)

Friends
class	Controller

Constructor & Destructor Documentation

DtVreRlStateRepository() [1/2]

RlCgfVrf::DtVreRlStateRepository::DtVreRlStateRepository ( const DtVreRlStateRepository & orig )

private

Copy constructor (not implemented)

Parameters

orig	The source object

References DtVreRlStateRepository().

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

DtVreRlStateRepository() [2/2]

RlCgfVrf::DtVreRlStateRepository::DtVreRlStateRepository	(	DtLocalObject *	vrfObject,
		const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = 0 )

Constructor.

Parameters

vrfObject	The local object this repository belongs to
name	The name of the repository
parentRegistry	Parent registry for reader/writer functionality

Initializes a new rotary-wing state repository for VREngage control.

~DtVreRlStateRepository()

virtual RlCgfVrf::DtVreRlStateRepository::~DtVreRlStateRepository ( )

overridevirtual

Virtual destructor.

Cleans up resources used by the state repository.

Member Function Documentation

operator=()

const DtVreRlStateRepository & RlCgfVrf::DtVreRlStateRepository::operator= ( const DtVreRlStateRepository & orig )

private

Assignment operator (not implemented)

Parameters

orig	The source object

Returns

Reference to this object

References DtVreRlStateRepository().

init()

virtual bool RlCgfVrf::DtVreRlStateRepository::init ( )

overridevirtual

Initializes the state repository.

Returns

True if initialization was successful

Performs initial setup of the state repository, including configuration loading and state initialization.

type()

virtual DtString RlCgfVrf::DtVreRlStateRepository::type ( ) const

overridevirtual

Gets the component type.

Returns

The type string for this component

Returns TS_VREngageStateRepository as the component type identifier.

initializeFromParameters()

virtual void RlCgfVrf::DtVreRlStateRepository::initializeFromParameters ( )

overridevirtual

Initializes state from parameters.

Sets up the initial state values based on the parameters defined in the component's descriptor.

creator()

static DtVrfObjectStateRepository * RlCgfVrf::DtVreRlStateRepository::creator ( const DtString & name, DtLocalObject * vrfObject, DtReaderWriterRegistry * parentRegistry )

static

Component factory function.

Parameters

name	The name for the new repository
vrfObject	The local object the repository will belong to
parentRegistry	Parent registry for reader/writer functionality

Returns

Pointer to the newly created repository

Static factory function used for component creation through the component registry.

getParameters()

const DtVreRlParameters * RlCgfVrf::DtVreRlStateRepository::getParameters

(

)

const

Gets the rotary-wing parameters.

Returns

Pointer to the rotary-wing parameters

Returns the parameters used to configure this rotary-wing aircraft.

place()

virtual void RlCgfVrf::DtVreRlStateRepository::place ( const DtVector & location, const DtReal heading, bool clampToGroundFlag = true, bool * dataAvailable = 0, bool requireAllData = false )

overridevirtual

Places the aircraft at a specified location and heading.

Parameters

location	The position vector where the aircraft should be placed
heading	The heading (in radians) the aircraft should face
clampToGroundFlag	If true, adjusts the aircraft altitude to ground level
dataAvailable	Optional output parameter indicating if terrain data is available
requireAllData	If true, requires complete terrain data to be available

Moves the aircraft to the specified location and orientation, optionally adjusting its altitude to maintain proper ground clearance.

Friends And Related Symbol Documentation

Controller

friend class Controller

friend

Friend class that needs direct access to state repository internals.

References Controller.

Referenced by Controller.

---

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

• include/vrfExtensions/vreVrfRtd/vreRlStateRepository.h