QuantConnect.Orders.Serialization.OrderEventJsonConverter Class Reference
Defines how OrderEvents should be serialized to json More...
Inheritance diagram for QuantConnect.Orders.Serialization.OrderEventJsonConverter:
Public Member Functions | |
| OrderEventJsonConverter (string algorithmId=null) | |
| Creates a new instance More... | |
 Public Member Functions inherited from QuantConnect.Util.TypeChangeJsonConverter< OrderEvent, SerializedOrderEvent > | |
| override object | ReadJson (JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer) |
| Reads the JSON representation of the object. More... | |
| override void | WriteJson (JsonWriter writer, object value, JsonSerializer serializer) |
| Writes the JSON representation of the object. More... | |
| override bool | CanConvert (Type objectType) |
| Determines whether this instance can convert the specified object type. More... | |
Protected Member Functions | |
| override SerializedOrderEvent | Convert (OrderEvent value) |
| Convert the input value to a value to be serialzied More... | |
| override OrderEvent | Convert (SerializedOrderEvent value) |
| Converts the input value to be deserialized More... | |
| Protected Member Functions inherited from QuantConnect.Util.TypeChangeJsonConverter< OrderEvent, SerializedOrderEvent > | |
| virtual T | Create (Type type, JToken token) |
| Creates an instance of the un-projected type to be deserialized More... | |
| abstract TResult | Convert (T value) |
| Convert the input value to a value to be serialized More... | |
| abstract T | Convert (TResult value) |
| Converts the input value to be deserialized More... | |
Protected Attributes | |
| override bool | PopulateProperties => false |
| True will populate TResult object returned by Convert(SerializedOrderEvent) with json properties More... | |
| Protected Attributes inherited from QuantConnect.Util.TypeChangeJsonConverter< OrderEvent, SerializedOrderEvent > | |
| virtual bool | PopulateProperties |
| True will populate TResult object returned by Convert(TResult) with json properties More... | |
Detailed Description
Defines how OrderEvents should be serialized to json
Definition at line 24 of file OrderEventJsonConverter.cs.
Constructor & Destructor Documentation
◆ OrderEventJsonConverter()
| QuantConnect.Orders.Serialization.OrderEventJsonConverter.OrderEventJsonConverter | ( | string | algorithmId = null | ) |
Creates a new instance
- Parameters
-
algorithmId The associated algorithm id, required when serializing
Definition at line 37 of file OrderEventJsonConverter.cs.
Member Function Documentation
◆ Convert() [1/2]
|
protected |
Convert the input value to a value to be serialzied
- Parameters
-
value The input value to be converted before serialziation
- Returns
- A new instance of TResult that is to be serialzied
Definition at line 47 of file OrderEventJsonConverter.cs.
◆ Convert() [2/2]
|
protected |
Converts the input value to be deserialized
- Parameters
-
value The deserialized value that needs to be converted to OrderEvent
- Returns
- The converted value
Definition at line 57 of file OrderEventJsonConverter.cs.
Here is the call graph for this function:
Member Data Documentation
◆ PopulateProperties
|
protected |
True will populate TResult object returned by Convert(SerializedOrderEvent) with json properties
Definition at line 31 of file OrderEventJsonConverter.cs.
The documentation for this class was generated from the following file:
- Common/Orders/Serialization/OrderEventJsonConverter.cs
