NDEVR
API Documentation
VehicleRecord

A read-only accessor for a single vehicle record within a VehicleDatabase, providing make, model, year, weight, dimensions, and associated 3D model file. More...

Collaboration diagram for VehicleRecord:
[legend]

Public Member Functions

 VehicleRecord (uint04 index, const VehicleDatabase *database)
 Constructs a record accessor for the given index in a database.
const fltp08curbWeight () const
 Returns the vehicle curb weight.
const Vector< 3, fltp08dimensions () const
 Returns the vehicle overall dimensions (length, width, height).
const Stringmake () const
 Returns the vehicle manufacturer name.
const Stringmodel () const
 Returns the vehicle model name.
File modelFile () const
 Returns the file path to the associated 3D model.
const uint04year () const
 Returns the vehicle model year.

Protected Attributes

const VehicleDatabase *const m_database
 The owning database providing field data.
const uint04 m_index
 Index of this record within the database buffers.

Detailed Description

A read-only accessor for a single vehicle record within a VehicleDatabase, providing make, model, year, weight, dimensions, and associated 3D model file.


Definition at line 14 of file VehicleDatabase.h.

Constructor & Destructor Documentation

◆ VehicleRecord()

VehicleRecord::VehicleRecord ( uint04 index,
const VehicleDatabase * database )

Constructs a record accessor for the given index in a database.

Parameters
[in]indexThe zero-based record index.
[in]databaseThe owning database.

Member Function Documentation

◆ curbWeight()

const fltp08 & VehicleRecord::curbWeight ( ) const

Returns the vehicle curb weight.

Returns
Reference to the curb weight in appropriate units.

◆ dimensions()

const Vector< 3, fltp08 > VehicleRecord::dimensions ( ) const

Returns the vehicle overall dimensions (length, width, height).

Returns
A 3D vector of dimensions.

◆ make()

const String & VehicleRecord::make ( ) const

Returns the vehicle manufacturer name.

Returns
Reference to the make string.

◆ model()

const String & VehicleRecord::model ( ) const

Returns the vehicle model name.

Returns
Reference to the model string.

◆ modelFile()

File VehicleRecord::modelFile ( ) const

Returns the file path to the associated 3D model.

Returns
The model file path.

◆ year()

const uint04 & VehicleRecord::year ( ) const

Returns the vehicle model year.

Returns
Reference to the year value.

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