Add ContractMultiplier setter to Cfd via CfdSymbolProperties

Author: JosueNina

Common/Securities/Cfd/Cfd.cs

@@ -62,6 +62,8 @@ public Cfd(SecurityExchangeHours exchangeHours,
                 Securities.MarginInterestRateModel.Null
                 )
         {
+            _symbolProperties = new CfdSymbolProperties(symbolProperties);
+            SymbolProperties = _symbolProperties;
             Holdings = new CfdHolding(this, currencyConverter);
         }
 
@@ -102,15 +104,20 @@ public Cfd(Symbol symbol,
                 Securities.MarginInterestRateModel.Null
                 )
         {
+            _symbolProperties = new CfdSymbolProperties(symbolProperties);
+            SymbolProperties = _symbolProperties;
             Holdings = new CfdHolding(this, currencyConverter);
         }
 
+        private readonly CfdSymbolProperties _symbolProperties;
+
         /// <summary>
-        /// Gets the contract multiplier for this CFD security
+        /// Gets or sets the contract multiplier for this CFD security
         /// </summary>
         public decimal ContractMultiplier
         {
-            get { return SymbolProperties.ContractMultiplier; }
+            get { return _symbolProperties.ContractMultiplier; }
+            set { _symbolProperties.SetContractMultiplier(value); }
         }
 
         /// <summary>

Common/Securities/Cfd/CfdSymbolProperties.cs

@@ -0,0 +1,51 @@
+/*
+ * QUANTCONNECT.COM - Democratizing Finance, Empowering Individuals.
+ * Lean Algorithmic Trading Engine v2.0. Copyright 2014 QuantConnect Corporation.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+*/
+
+namespace QuantConnect.Securities.Cfd
+{
+    /// <summary>
+    /// Represents common properties for a specific CFD contract
+    /// </summary>
+    public class CfdSymbolProperties : SymbolProperties
+    {
+        /// <summary>
+        /// The contract multiplier for the security.
+        /// </summary>
+        /// <remarks>
+        /// If manually set by a consumer, this value will be used instead of the
+        /// <see cref="SymbolProperties.ContractMultiplier"/> and also allows to make
+        /// sure it is not overridden when the symbol properties database gets updated.
+        /// </remarks>
+        private decimal? _contractMultiplier;
+
+        /// <summary>
+        /// The contract multiplier for the security
+        /// </summary>
+        public override decimal ContractMultiplier => _contractMultiplier ?? base.ContractMultiplier;
+
+        /// <summary>
+        /// Creates an instance of the <see cref="CfdSymbolProperties"/> class from <see cref="SymbolProperties"/>
+        /// </summary>
+        public CfdSymbolProperties(SymbolProperties properties)
+            : base(properties)
+        {
+        }
+
+        internal void SetContractMultiplier(decimal multiplier)
+        {
+            _contractMultiplier = multiplier;
+        }
+    }
+}

Tests/Common/Securities/Cfd/CfdTests.cs

@@ -13,7 +13,6 @@
  * limitations under the License.
 */
 
-using System;
 using NUnit.Framework;
 using QuantConnect.Data;
 using QuantConnect.Data.Market;
@@ -27,12 +26,24 @@ public class CfdTests
         [Test]
         public void ConstructorExtractsQuoteCurrency()
         {
-            var symbol = Symbol.Create("DE30EUR", SecurityType.Cfd, Market.Oanda);
-            var config = new SubscriptionDataConfig(typeof(TradeBar), symbol, Resolution.Minute, TimeZones.Utc, TimeZones.NewYork, true, true, true);
-            var symbolProperties = new SymbolProperties("Dax German index", "EUR", 1, 1, 1, string.Empty);
-            var cfd = new QuantConnect.Securities.Cfd.Cfd(SecurityExchangeHours.AlwaysOpen(config.DataTimeZone), new Cash("EUR", 0, 0), config, symbolProperties, ErrorCurrencyConverter.Instance, RegisteredSecurityDataTypesProvider.Null);
+            var cfd = CreateCfd(contractMultiplier: 1m);
             Assert.AreEqual("EUR", cfd.QuoteCurrency.Symbol);
         }
 
+        [Test]
+        public void ContractMultiplierCanBeSetByUser()
+        {
+            var cfd = CreateCfd(contractMultiplier: 1m);
+            cfd.ContractMultiplier = 5m;
+            Assert.AreEqual(5m, cfd.ContractMultiplier);
+        }
+
+        private static QuantConnect.Securities.Cfd.Cfd CreateCfd(decimal contractMultiplier)
+        {
+            var symbol = Symbol.Create("DE30EUR", SecurityType.Cfd, Market.Oanda);
+            var config = new SubscriptionDataConfig(typeof(TradeBar), symbol, Resolution.Minute, TimeZones.Utc, TimeZones.NewYork, true, true, true);
+            var symbolProperties = new SymbolProperties("Dax German index", "EUR", contractMultiplier, 1, 1, string.Empty);
+            return new QuantConnect.Securities.Cfd.Cfd(SecurityExchangeHours.AlwaysOpen(config.DataTimeZone), new Cash("EUR", 0, 0), config, symbolProperties, ErrorCurrencyConverter.Instance, RegisteredSecurityDataTypesProvider.Null);
+        }
     }
 }