KerbalData Namespace KerbalData - KSP Data Unlocked!

[Missing <summary> documentation for "N:KerbalData"]

Classes

  Class Description
Public class ActionGroups
ActionGroups assigned to the Vessel
Public class ConfigFile
Represents a KSP configuration file.
Public class CraftFile
Represents a loaded craft file
Public class CraftPart
Data model for part object in a craft file
Public class Crew
Crew data
Public class EditorGameParameters
TODO: Class Summary
Public class FlightGameParameters
TODO: Class Summary
Public class FlightState
Container for flights, crew and key universe variables
Public class Game
Game data model
Public class GameParameters
TODO: Class Summary
Public class KerbalData
Top level consumer API class. For easiest access use this class to edit and manage KSP data.
Public class KerbalDataException
Base Exception used any time an error with the underlying cache API is surfaced.
Public class KerbalDataExtension
Extensions used and provided by KebralData
Public class KerbalDataObject
TODO: Class Summary
Public class KspData
Top level data conversion/access class. This core class is used by higher level clasess to load and convert data as needed. KspData and the underlying converters are netural to context and only deal with data format conversion. Any vaild JSON or KSP data file can be converted even if the fields in the data do not match a particular game or even are used at all. Note that when adding data and fields not supported by KSP you may have unpredictable behavior up to and including deletion of your save file on attempted load.
Public class KspDataContext
Model object provided to de-serializer/serilaizer classes for defining the basic structure of the KSP data prior to conversion to JSON
Public class KspDataField
Model class used by KspDataObject as a key component in data serilaization/de-serialization.
Public class KspDataObject
Core data context object used for data serilization/de-serilaization. Only inplmentations build on IKspDataConverter or IKspFileConverter
Public class KspToJson
Primarey converter class, holds core references to file and data conveter. 1-to-1 mapping between a single file/data converter pair and a KspToJson instance. TODO: Additional constructors to facilitate configuration injection
Public class Module
TODO: Class Summary
Public class Orbit
Orbit data model
Public class Part
Part data model
Public class PartFile
Represents a loaded part file
Public class PartModule
Data model for a module found in a part file
Public class PartPropellant
Data model for propellent data found in part file.
Public class PartResource
Data model for resource data found in part
Public class PlanetConfig
Data model for planets found in KSP configuration.
Public class PresetConfig
Data model for presets found in KSP configuration.
Public class RepoFactory
Basic reposiotry placeholder
Public class Resource
Resource model class
Public class SaveFile
TODO: Class Summary
Public class SpaceCenterGameParameters
TODO: Class Summary
Public class StorableItemMetadata T 
Meta-data wrapper for storable data. Used for lazy loading.
Public class StorableObject
base class for top level consumer models. Contains functionality for saving/updating data store model is loaded from.
Public class StorableObjects T 
Maintains the top level collection of Kerbal data objects. Works similar to a dictionary however it does not implment IDictionary in order to restrict usage. It is important to note that unlike an IDictionary implmentation this class will accept a call to the Add method even if another value with the same name already exists. The previous value will be overwritten by the latest addition to the list.
Public class TerrainConfig
Data model for terrain found in KSP configuration.
Public class TrackingStationGameParameters
TODO: Class Summary
Public class UnMappedPropertiesConverter T 
JSON.NET implmentation class for de-serializing to classes while storing unmapped properties to the the IKerbalDataObject implmentation.
Public class Vessel
Vessel data model
Public class VesselActions
TODO: Class Summary
Public class VesselEvents
TODO: Class Summary
Interfaces

  Interface Description
Public interface IKerbalDataObject
Base data object. Included dictionary requirment to provide storage for root level values not mapped to strongly typed properties.
Public interface IKerbalDataRepo T 
Requirements for data loading repository. Additonal implmentations may be provided to store/load KSP data from any desired store.
Public interface IKspDataConverter
Instances of IKspDataConverter provide intenral KSP>JSON parsing. The interface will be used to swap out converters as the KSP data format evolves. Converter pattern may be made more general to provide support for any type of data format. As long as KSP uses the ASCII format they have JSON will be hard-wired as a base "gateway" converter for all other converters. TODO: POC converter stack processor (publish to multiple endpoints/formats)
Public interface IKspFileConverter
Instances of this class are responsible for de-serialzing KSP data.
Public interface IStorable
Reperesents a data element that can be saved as a unit.
Enumerations

  Enumeration Description
Public enumeration Body
Provides list of bodies in the Kerbol system.