/// <summary>
/// Creates an EagerLoad object. Only the specified flags will be set to eager load.
/// </summary>
/// <param name="et">EagerLoadType</param>
/// <example>
/// The following example sets CelestialInfo and Cartesian properties to eager load. Other conversions will be lazy loaded.
/// <code>
/// //Create an EagerLoading object with only CelestialInfo and Cartesian properties set to eager load.
/// EagerLoad el = new EagerLoad(EagerLoadType.Celestial | EagerLoadType.Cartesian);
///
/// //Create coordinate with defined eagerloading settings.
/// Coordinate coord = new Coordinate(25, 25, new DateTime(2018, 3, 2), el);
///
/// //Display UTC sunset time at the location.
/// Console.WriteLine(coord.CelestialInfo.SunSet); //3/2/2018 4:23:46 PM
/// Console.WriteLine(coord.Cartesian); //0.8213938 0.38302222 0.42261826
///
/// //Load UTM_MGRS when ready.
/// coord.LoadUTM_MGRS_Info();
/// Console.WriteLine(coord.UTM); //35R 298154mE 2766437mN
/// </code>
/// </example>
public EagerLoad(EagerLoadType et)
{
Extensions = new EagerLoad_Extensions();
Cartesian = false;
Celestial = false;
UTM_MGRS = false;
ECEF = false;
if (et.HasFlag(EagerLoadType.Cartesian))
{
Cartesian = true;
}
if (et.HasFlag(EagerLoadType.Celestial))
{
Celestial = true;
}
if (et.HasFlag(EagerLoadType.UTM_MGRS))
{
UTM_MGRS = true;
}
if (et.HasFlag(EagerLoadType.ECEF))
{
ECEF = true;
}
}
/// <summary>
/// Creates a default EagerLoad object.
/// </summary>
/// <remarks>
/// All properties are set with eager loading turned on.
/// </remarks>
/// <example>
/// The following example turns off eager loading for a Coordinate objects CelestialInfo property.
/// <code>
/// //Create a default EagerLoading object.
/// EagerLoad el = new EagerLoad();
///
/// //Turn of eagerloading of celestial information.
/// el.Celestial = false;
///
/// //Create coordinate with defined eager loading settings.
/// Coordinate coord = new Coordinate(25, 25, new DateTime(2018, 3, 2), el);
///
/// //Load celestial information when ready.
/// //Failure to do this will cause NullReference Exceptions in the Coordinate objects CelestialInfo Property.
/// coord.LoadCelestialInfo();
///
/// //Display UTC sunset time at the location.
/// Console.WriteLine(coord.CelestialInfo.SunSet); //3/2/2018 4:23:46 PM
/// </code>
/// </example>
public EagerLoad()
{
Extensions = new EagerLoad_Extensions();
Celestial = true;
UTM_MGRS = true;
Cartesian = true;
ECEF = true;
}
/// <summary>
/// Create an EagerLoad object with all options on or off
/// </summary>
/// <param name="isOn">Turns EagerLoad on or off</param>
/// <example>
/// The following example turns off eagerloading for a Coordinate objects UTM/MGRS, Cartesian/ECEF and CelestialInfo properties.
/// <code>
/// //Create an EagerLoading object with all properties turned off.
/// //(All properties will now be set to lazy load).
/// EagerLoad el = new EagerLoad(false);
///
/// //Create coordinate with defined eager loading settings.
/// Coordinate coord = new Coordinate(25, 25, new DateTime(2018, 3, 2), el);
///
/// //Load celestial information when ready.
/// //Failure to do this will cause NullReference Exceptions in the Coordinate objects CelestialInfo Property.
/// coord.LoadCelestialInfo();
///
/// //Display UTC sunset time at the location.
/// Console.WriteLine(coord.CelestialInfo.SunSet); //3/2/2018 4:23:46 PM
/// </code>
/// </example>
public EagerLoad(bool isOn)
{
Extensions = new EagerLoad_Extensions();
Celestial = isOn;
UTM_MGRS = isOn;
Cartesian = isOn;
ECEF = isOn;
}
