lob::Builder Class Reference

Builder class for constructing Input objects with a friendly interface. More...

#include <lob.hpp>

Public Member Functions
	Builder ()
	~Builder ()
	Default constructor.
	Builder (const Builder &other)
	Default destructor.
	Builder (Builder &&other) noexcept
	Copy constructor.
Builder &	operator= (const Builder &rhs)
	Move constructor.
Builder &	operator= (Builder &&rhs) noexcept
	Copy assignment constructor.
Builder &	BallisticCoefficientPsi (double value)
	Move assignment constructor.
Builder &	BCAtmosphere (AtmosphereReferenceT type)
	Sets the atmosphere reference associated with ballistic coefficient.
Builder &	BCDragFunction (DragFunctionT type)
	Sets the drag function associated with ballistic coefficient.
Builder &	DiameterInch (double value)
	Sets the projectile diameter (caliber) in inches.
Builder &	MeplatDiameterInch (double value)
	Sets the projectile meplat diameter in inches.
Builder &	BaseDiameterInch (double value)
	Sets the projectile base diameter in inches.
Builder &	LengthInch (double value)
	Sets the projectile length in inches.
Builder &	NoseLengthInch (double value)
	Sets the projectile nose length in inches.
Builder &	TailLengthInch (double value)
	Sets the projectile tail length in inches.
Builder &	OgiveRtR (double value)
	Sets the Rt/R ratio of the projectile ogive.
Builder &	MachVsDragTable (const float *pmachs, const float *pdrags, size_t size)
	Loads a custom Mach vs Drag table for the projectile.
template<size_t N>
Builder &	MachVsDragTable (const std::array< float, N > &machs, const std::array< float, N > &drags)
	Loads a custom Mach vs Drag table for the projectile.
Builder &	MassGrains (double value)
	Sets the projectile mass in grains.
Builder &	InitialVelocityFps (uint16_t value)
	Sets the initial velocity of the projectile in feet per second.
Builder &	OpticHeightInches (double value)
	Sets the height of the optic above the bore in inches.
Builder &	TwistInchesPerTurn (double value)
	Sets the twist rate of the barrel in inches per turn.
Builder &	ZeroAngleMOA (double value)
	Sets the angle between the sight and launch angle used to achieve zero.
Builder &	ZeroDistanceYds (double value)
	Sets the zero distance in yards.
Builder &	ZeroImpactHeightInches (double value)
	Sets the zero impact height in inches.
Builder &	AltitudeOfFiringSiteFt (double value)
	Sets the altitude of the firing site in feet.
Builder &	AirPressureInHg (double value)
	Sets the air pressure in inches of mercury (inHg).
Builder &	AltitudeOfBarometerFt (double value)
	Sets the altitude of the location where air pressure was taken in feet.
Builder &	TemperatureDegF (double value)
	Sets the temperature in degrees Fahrenheit.
Builder &	AltitudeOfThermometerFt (double value)
	Sets the altitude of the location where temperature was taken in feet.
Builder &	RelativeHumidityPercent (double value)
	Sets the relative humidity at the firing site in percent.
Builder &	WindHeading (ClockAngleT value)
	Sets the wind heading using a clock angle.
Builder &	WindHeadingDeg (double value)
	Sets the wind heading in degrees.
Builder &	WindSpeedFps (double value)
	Sets the wind speed in feet per second.
Builder &	WindSpeedMph (double value)
	Sets the wind speed in miles per hour.
Builder &	AzimuthDeg (double value)
	Sets the azimuth (bearing) of the target in degrees.
Builder &	LatitudeDeg (double value)
	Sets the latitude of the firing location in degrees.
Builder &	RangeAngleDeg (double value)
	Sets the range angle (inclination) to the target in degrees.
Builder &	MinimumSpeed (uint16_t value)
	Sets the minimum speed threshold for the solver.
Builder &	MinimumEnergy (uint16_t value)
	Sets the minimum energy threshold for the solver.
Builder &	MaximumTime (double value)
	Sets the maximum time of flight for the solver.
Builder &	StepSize (uint16_t value)
	Sets the step size for the numerical solver.
Input	Build ()
	Builds the Input object with the configured parameters.

Detailed Description

Builder class for constructing Input objects with a friendly interface.

Constructor & Destructor Documentation

Builder() [1/3]

lob::Builder::Builder

(

)

~Builder()

lob::Builder::~Builder

(

)

Default constructor.

Builder() [2/3]

lob::Builder::Builder

(

const Builder &

other

)

Default destructor.

Builder() [3/3]

lob::Builder::Builder ( Builder && other )

noexcept

Copy constructor.

Member Function Documentation

AirPressureInHg()

Builder & lob::Builder::AirPressureInHg

(

double

value

)

Sets the air pressure in inches of mercury (inHg).

Parameters

value

The air pressure in inHg.

Returns

A reference to the Builder object.

AltitudeOfBarometerFt()

Builder & lob::Builder::AltitudeOfBarometerFt

(

double

value

)

Sets the altitude of the location where air pressure was taken in feet.

Note

This only has an effect if the airpressure was taken from a site other than the firing site with a different altitude such as a nearby weather station.

Parameters

value

The altitude in feet.

Returns

A reference to the Builder object.

AltitudeOfFiringSiteFt()

Builder & lob::Builder::AltitudeOfFiringSiteFt

(

double

value

)

Sets the altitude of the firing site in feet.

Parameters

value

The altitude in feet.

Returns

A reference to the Builder object.

AltitudeOfThermometerFt()

Builder & lob::Builder::AltitudeOfThermometerFt

(

double

value

)

Sets the altitude of the location where temperature was taken in feet.

Note

This only has an effect if the temperature was taken from a site other than the firing site with a different altitude such as a nearby weather station.

Parameters

value

The altitude in feet.

Returns

A reference to the Builder object.

AzimuthDeg()

Builder & lob::Builder::AzimuthDeg

(

double

value

)

Sets the azimuth (bearing) of the target in degrees.

Note

Used for making coriolis effect corrections.

Parameters

value

The azimuth in degrees.

Returns

A reference to the Builder object.

BallisticCoefficientPsi()

Builder & lob::Builder::BallisticCoefficientPsi

(

double

value

)

Move assignment constructor.

Sets the ballistic coefficient (Psi).

Parameters

value

The ballistic coefficient value.

Returns

A reference to the Builder object.

BaseDiameterInch()

Builder & lob::Builder::BaseDiameterInch

(

double

value

)

Sets the projectile base diameter in inches.

Parameters

value

The base diameter in inches.

Returns

A reference to the Builder object.

BCAtmosphere()

Builder & lob::Builder::BCAtmosphere

(

AtmosphereReferenceT

type

)

Sets the atmosphere reference associated with ballistic coefficient.

Parameters

type	The atmosphere reference type.

Returns

A reference to the Builder object.

BCDragFunction()

Builder & lob::Builder::BCDragFunction

(

DragFunctionT

type

)

Sets the drag function associated with ballistic coefficient.

Parameters

type	The drag function type.

Returns

A reference to the Builder object.

Build()

Input lob::Builder::Build

(

)

Builds the Input object with the configured parameters.

Returns

The constructed Input object.

DiameterInch()

Builder & lob::Builder::DiameterInch

(

double

value

)

Sets the projectile diameter (caliber) in inches.

Parameters

value

The diameter in inches.

Returns

A reference to the Builder object.

InitialVelocityFps()

Builder & lob::Builder::InitialVelocityFps

(

uint16_t

value

)

Sets the initial velocity of the projectile in feet per second.

Parameters

value

The initial velocity in fps.

Returns

A reference to the Builder object.

LatitudeDeg()

Builder & lob::Builder::LatitudeDeg

(

double

value

)

Sets the latitude of the firing location in degrees.

Note

Used for making coriolis effect corrections.

Parameters

value

The latitude in degrees.

Returns

A reference to the Builder object.

LengthInch()

Builder & lob::Builder::LengthInch

(

double

value

)

Sets the projectile length in inches.

Parameters

value

The length in inches.

Returns

A reference to the Builder object.

MachVsDragTable() [1/2]

Builder & lob::Builder::MachVsDragTable	(	const float *	pmachs,
		const float *	pdrags,
		size_t	size )

Loads a custom Mach vs Drag table for the projectile.

Note

This is a direct alternative to using a ballistic coefficient and a reference drag function.

Template Parameters

N	The number of mach-drag pairs in the table.

Parameters

pmachs	Pointer to an array of mach values.
pdrags	Pointer to an array of associated drag values.
size	The number of mach-drag pairs in the table.

Returns

A reference to the Builder object.

MachVsDragTable() [2/2]

template<size_t N>

Builder & lob::Builder::MachVsDragTable ( const std::array< float, N > & machs, const std::array< float, N > & drags )

inline

Loads a custom Mach vs Drag table for the projectile.

Note

This is a direct alternative to using a ballistic coefficient and a reference drag function.

Template Parameters

N	The number of mach-drag pairs in the table.

Parameters

machs	Reference to an array of mach values.
drags	Reference to an array of associated drag values.

Returns

A reference to the Builder object.

MassGrains()

Builder & lob::Builder::MassGrains

(

double

value

)

Sets the projectile mass in grains.

Parameters

value

The mass in grains.

Returns

A reference to the Builder object.

MaximumTime()

Builder & lob::Builder::MaximumTime

(

double

value

)

Sets the maximum time of flight for the solver.

Parameters

value

The maximum time in seconds after which the solver will stop calculations.

Returns

A reference to the Builder object.

MeplatDiameterInch()

Builder & lob::Builder::MeplatDiameterInch

(

double

value

)

Sets the projectile meplat diameter in inches.

Parameters

value

The meplat in inches.

Returns

A reference to the Builder object.

MinimumEnergy()

Builder & lob::Builder::MinimumEnergy

(

uint16_t

value

)

Sets the minimum energy threshold for the solver.

Parameters

value

The minimum energy in foot-pounds (ft·lbf) at which the solver will stop calculations.

Returns

A reference to the Builder object.

MinimumSpeed()

Builder & lob::Builder::MinimumSpeed

(

uint16_t

value

)

Sets the minimum speed threshold for the solver.

Parameters

value

The minimum speed in feet per second (fps) at which the solver will stop calculations.

Returns

A reference to the Builder object.

NoseLengthInch()

Builder & lob::Builder::NoseLengthInch

(

double

value

)

Sets the projectile nose length in inches.

Parameters

value

The nose length in inches.

Returns

A reference to the Builder object.

OgiveRtR()

Builder & lob::Builder::OgiveRtR

(

double

value

)

Sets the Rt/R ratio of the projectile ogive.

Parameters

value

The Rt/R ratio.

Returns

A reference to the Builder object.

operator=() [1/2]

Builder & lob::Builder::operator= ( Builder && rhs )

noexcept

Copy assignment constructor.

operator=() [2/2]

Builder & lob::Builder::operator=

(

const Builder &

rhs

)

Move constructor.

OpticHeightInches()

Builder & lob::Builder::OpticHeightInches

(

double

value

)

Sets the height of the optic above the bore in inches.

Parameters

value

The optic height in inches.

Returns

A reference to the Builder object.

RangeAngleDeg()

Builder & lob::Builder::RangeAngleDeg

(

double

value

)

Sets the range angle (inclination) to the target in degrees.

Parameters

value

The range angle in degrees.

Returns

A reference to the Builder object.

RelativeHumidityPercent()

Builder & lob::Builder::RelativeHumidityPercent

(

double

value

)

Sets the relative humidity at the firing site in percent.

Parameters

value

The relative humidity in percent.

Returns

A reference to the Builder object.

StepSize()

Builder & lob::Builder::StepSize

(

uint16_t

value

)

Sets the step size for the numerical solver.

Parameters

value

The time step size in microseconds (µs) used by the solver.

Returns

A reference to the Builder object.

TailLengthInch()

Builder & lob::Builder::TailLengthInch

(

double

value

)

Sets the projectile tail length in inches.

Parameters

value

The tail length in inches.

Returns

A reference to the Builder object.

TemperatureDegF()

Builder & lob::Builder::TemperatureDegF

(

double

value

)

Sets the temperature in degrees Fahrenheit.

Parameters

value

The temperature in degrees F.

Returns

A reference to the Builder object.

TwistInchesPerTurn()

Builder & lob::Builder::TwistInchesPerTurn

(

double

value

)

Sets the twist rate of the barrel in inches per turn.

Note

Used to calculate adjustments for spin drift and aerodynamic jump.

Parameters

value

The twist rate in inches per turn.

Returns

A reference to the Builder object.

WindHeading()

Builder & lob::Builder::WindHeading

(

ClockAngleT

value

)

Sets the wind heading using a clock angle.

Note

Twelve O'Clock is pure tailwind, Six O'Clock is a pure headwind.

Parameters

value

The wind heading as a clock angle.

Returns

A reference to the Builder object.

WindHeadingDeg()

Builder & lob::Builder::WindHeadingDeg

(

double

value

)

Sets the wind heading in degrees.

Note

0 is pure tailwind, 180 is pure headwind.

Parameters

value

The wind heading in degrees.

Returns

A reference to the Builder object.

WindSpeedFps()

Builder & lob::Builder::WindSpeedFps

(

double

value

)

Sets the wind speed in feet per second.

Parameters

value

The wind speed in fps.

Returns

A reference to the Builder object.

WindSpeedMph()

Builder & lob::Builder::WindSpeedMph

(

double

value

)

Sets the wind speed in miles per hour.

Parameters

value

The wind speed in mph.

Returns

A reference to the Builder object.

ZeroAngleMOA()

Builder & lob::Builder::ZeroAngleMOA

(

double

value

)

Sets the angle between the sight and launch angle used to achieve zero.

Note

This is a portable zero value useful when firing conditions differ from zeroing conditions.

Parameters

value

The zero angle in MOA.

Returns

A reference to the Builder object.

ZeroDistanceYds()

Builder & lob::Builder::ZeroDistanceYds

(

double

value

)

Sets the zero distance in yards.

Parameters

value

The zero distance in yards.

Returns

A reference to the Builder object.

ZeroImpactHeightInches()

Builder & lob::Builder::ZeroImpactHeightInches

(

double

value

)

Sets the zero impact height in inches.

Note

This would be used if zeroing three inches high at 100 yards for example.

Parameters

value

The zero impact height in inches.

Returns

A reference to the Builder object.

---

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

• lob/lob.hpp