Loading...
Searching...
No Matches
OFT.Core.BaseConnectorSettings< T, TSelf > Class Template Referenceabstract
Inheritance diagram for OFT.Core.BaseConnectorSettings< T, TSelf >:
[legend]
Collaboration diagram for OFT.Core.BaseConnectorSettings< T, TSelf >:
[legend]

Public Member Functions

IDataFeedConnector CreateConnector (string dataPath)
 
void ApplySettings (IDataFeedConnector connector)
 
virtual bool CheckSupported (out string? errorMessage)
 Checks if connector is supported on this machine.
Parameters
errorMessageNull if supported otherwise contains error text
Returns
true if no problems detected, false if not supported

 
bool HasSameCredentials (IConnectorSettings other)
 Checks if this connector has the same credentials as another connector. Also verifies that the connector types match.
 
override string ToString ()
 
IDataFeedConnector CreateConnector (string dataPath)
 
void ApplySettings (IDataFeedConnector connector)
 
bool CheckSupported (out string? errorMessage)
 Checks if connector is supported on this machine.
 
bool HasSameCredentials (IConnectorSettings other)
 Checks if this connector has the same credentials as another connector. Also verifies that the connector types match.
 

Protected Member Functions

 BaseConnectorSettings ()
 
string? GetCategory ()
 Category of this settings type: the class-level CategoryAttribute, or the group name of a DisplayAttribute. Null when the type declares neither.
 
abstract bool CompareCredentials (IConnectorSettings other)
 Compares credentials with another connector of the same type. The caller (HasSameCredentials) already guarantees that other is the same Type.
 
abstract IDataFeedConnector OnCreateConnector (string dataPath)
 
abstract void OnApplySettings (IDataFeedConnector connector)
 
void RaisePropertyChanged (string propertyName)
 
bool SetProperty< TValue > (ref TValue storage, TValue newValue, string propertyName, Action< TValue, TValue >? onChanged=null)
 
override IDataFeedConnector OnCreateConnector (string dataPath)
 
override void OnApplySettings (IDataFeedConnector connector)
 
sealed override bool CompareCredentials (IConnectorSettings other)
 
abstract void OnApplySettings (T connector)
 
abstract bool CompareCredentials (TSelf other)
 

Properties

string Type [get, set]
 
string Description [get]
 
Uri Logo [get]
 
Guid Id [get, set]
 
virtual string DisplayName [get, set]
 User-facing connection name: Name when set, otherwise a connector-specific fallback (e.g. the login).
 
string Name [get, set]
 
bool IsMarketDataEnabled [get, set]
 
bool IsAutoConnectEnabled [get, set]
 
bool IsFavorite [get, set]
 
bool AllowUpdatePositionsPnL [get, set]
 
TimeOnly? RefreshSecuritiesTime [get, set]
 
abstract ConnectorFeatures Features [get]
 
virtual ConnectorSettingsTypes SettingsTypes [get]
 
virtual bool IsDemo [get]
 Indicates that connector uses TestNet environment.
 
virtual AccountKind AccountKind [get]
 Derived from the connector category: simulators and prop connections are kinds of their own, the rest is live or demo by IsDemo.
 
virtual MarketDataDelayPeriods MarketDataDelayPeriod [get]
 
virtual ? string ConnectorServer [get]
 Selected server/endpoint name for telemetry. Null when the connector has no server selection.
 
virtual ? string ConnectionMode [get]
 Connection mode for telemetry when the connector offers a choice, e.g. connecting without market data. Null when the connector has a single mode.
 
- Properties inherited from OFT.Core.IConnectorSettings
string Type [get]
 
string Description [get]
 
Uri Logo [get]
 
Guid Id [get, set]
 
string Name [get, set]
 
string DisplayName [get, set]
 User-facing connection name: Name when set, otherwise a connector-specific fallback (e.g. the login).
 
bool IsMarketDataEnabled [get, set]
 
bool IsAutoConnectEnabled [get, set]
 
bool IsFavorite [get, set]
 
ConnectorFeatures Features [get]
 
ConnectorSettingsTypes SettingsTypes [get]
 
bool IsDemo [get]
 Indicates that connector uses TestNet environment.
 
AccountKind AccountKind [get]
 Kind of the accounts of this connection, for telemetry (PLAT-4891). The connection-level default: a connector that tells its accounts apart (IB paper accounts, NinjaTrader Sim, CQG demo brokerages) overrides it per account through Portfolio.AccountKind.
 
MarketDataDelayPeriods MarketDataDelayPeriod [get]
 
string? ConnectorServer [get]
 Selected server/endpoint name for telemetry. Null when the connector has no server selection.
 
string? ConnectionMode [get]
 Connection mode for telemetry when the connector offers a choice, e.g. connecting without market data. Null when the connector has a single mode.
 

Events

PropertyChangedEventHandler? PropertyChanged
 

Constructor & Destructor Documentation

◆ BaseConnectorSettings()

Member Function Documentation

◆ ApplySettings()

void OFT.Core.BaseConnectorSettings< T, TSelf >.ApplySettings ( IDataFeedConnector  connector)

◆ CheckSupported()

virtual bool OFT.Core.BaseConnectorSettings< T, TSelf >.CheckSupported ( out string?  errorMessage)
virtual

Checks if connector is supported on this machine.

Parameters
errorMessageNull if supported otherwise contains error text
Returns
true if no problems detected, false if not supported

Implements OFT.Core.IConnectorSettings.

◆ CompareCredentials() [1/3]

abstract bool OFT.Core.BaseConnectorSettings< T, TSelf >.CompareCredentials ( IConnectorSettings  other)
protectedpure virtual

Compares credentials with another connector of the same type. The caller (HasSameCredentials) already guarantees that other is the same Type.

Override examples:

  • Login-based: => this.HaveSameLogin(other);
  • Key-based: => Key.HaveSameValue(other.Key);
  • No credentials: => false;

Implemented in ATAS.DataFeedsCore.BasketConnectorSettings< TDataFeedSettings, TTradingSettings, TSelf >.

◆ CompareCredentials() [2/3]

sealed override bool OFT.Core.BaseConnectorSettings< T, TSelf >.CompareCredentials ( IConnectorSettings  other)
protected

◆ CompareCredentials() [3/3]

abstract bool OFT.Core.BaseConnectorSettings< T, TSelf >.CompareCredentials ( TSelf  other)
protectedpure virtual

◆ CreateConnector()

IDataFeedConnector OFT.Core.BaseConnectorSettings< T, TSelf >.CreateConnector ( string  dataPath)

◆ GetCategory()

string? OFT.Core.BaseConnectorSettings< T, TSelf >.GetCategory ( )
protected

Category of this settings type: the class-level CategoryAttribute, or the group name of a DisplayAttribute. Null when the type declares neither.

◆ HasSameCredentials()

bool OFT.Core.BaseConnectorSettings< T, TSelf >.HasSameCredentials ( IConnectorSettings  other)

Checks if this connector has the same credentials as another connector. Also verifies that the connector types match.

Implements OFT.Core.IConnectorSettings.

◆ OnApplySettings() [1/3]

abstract void OFT.Core.BaseConnectorSettings< T, TSelf >.OnApplySettings ( IDataFeedConnector  connector)
protectedpure virtual

◆ OnApplySettings() [2/3]

override void OFT.Core.BaseConnectorSettings< T, TSelf >.OnApplySettings ( IDataFeedConnector  connector)
protected

◆ OnApplySettings() [3/3]

abstract void OFT.Core.BaseConnectorSettings< T, TSelf >.OnApplySettings ( T  connector)
protectedpure virtual

◆ OnCreateConnector() [1/2]

abstract IDataFeedConnector OFT.Core.BaseConnectorSettings< T, TSelf >.OnCreateConnector ( string  dataPath)
protectedpure virtual

◆ OnCreateConnector() [2/2]

override IDataFeedConnector OFT.Core.BaseConnectorSettings< T, TSelf >.OnCreateConnector ( string  dataPath)
protected

◆ RaisePropertyChanged()

void OFT.Core.BaseConnectorSettings< T, TSelf >.RaisePropertyChanged ( string  propertyName)
protected

◆ SetProperty< TValue >()

bool OFT.Core.BaseConnectorSettings< T, TSelf >.SetProperty< TValue > ( ref TValue  storage,
TValue  newValue,
string  propertyName,
Action< TValue, TValue >?  onChanged = null 
)
protected

◆ ToString()

override string OFT.Core.BaseConnectorSettings< T, TSelf >.ToString ( )

Property Documentation

◆ AccountKind

Derived from the connector category: simulators and prop connections are kinds of their own, the rest is live or demo by IsDemo.

Implements OFT.Core.IConnectorSettings.

◆ AllowUpdatePositionsPnL

bool OFT.Core.BaseConnectorSettings< T, TSelf >.AllowUpdatePositionsPnL
getset

◆ ConnectionMode

virtual ? string OFT.Core.BaseConnectorSettings< T, TSelf >.ConnectionMode
get

Connection mode for telemetry when the connector offers a choice, e.g. connecting without market data. Null when the connector has a single mode.

Implements OFT.Core.IConnectorSettings.

◆ ConnectorServer

virtual ? string OFT.Core.BaseConnectorSettings< T, TSelf >.ConnectorServer
get

Selected server/endpoint name for telemetry. Null when the connector has no server selection.

Implements OFT.Core.IConnectorSettings.

◆ Description

string OFT.Core.BaseConnectorSettings< T, TSelf >.Description
get

◆ DisplayName

virtual string OFT.Core.BaseConnectorSettings< T, TSelf >.DisplayName
getset

User-facing connection name: Name when set, otherwise a connector-specific fallback (e.g. the login).

Implements OFT.Core.IConnectorSettings.

◆ Features

abstract ConnectorFeatures OFT.Core.BaseConnectorSettings< T, TSelf >.Features
get

◆ Id

Guid OFT.Core.BaseConnectorSettings< T, TSelf >.Id
getset

◆ IsAutoConnectEnabled

bool OFT.Core.BaseConnectorSettings< T, TSelf >.IsAutoConnectEnabled
getset

◆ IsDemo

virtual bool OFT.Core.BaseConnectorSettings< T, TSelf >.IsDemo
get

Indicates that connector uses TestNet environment.

Implements OFT.Core.IConnectorSettings.

◆ IsFavorite

bool OFT.Core.BaseConnectorSettings< T, TSelf >.IsFavorite
getset

◆ IsMarketDataEnabled

bool OFT.Core.BaseConnectorSettings< T, TSelf >.IsMarketDataEnabled
getset

◆ Logo

Uri OFT.Core.BaseConnectorSettings< T, TSelf >.Logo
get

◆ MarketDataDelayPeriod

virtual MarketDataDelayPeriods OFT.Core.BaseConnectorSettings< T, TSelf >.MarketDataDelayPeriod
get

◆ Name

string OFT.Core.BaseConnectorSettings< T, TSelf >.Name
getset

◆ RefreshSecuritiesTime

TimeOnly? OFT.Core.BaseConnectorSettings< T, TSelf >.RefreshSecuritiesTime
getset

◆ SettingsTypes

virtual ConnectorSettingsTypes OFT.Core.BaseConnectorSettings< T, TSelf >.SettingsTypes
get

◆ Type

string OFT.Core.BaseConnectorSettings< T, TSelf >.Type
getset

Event Documentation

◆ PropertyChanged

PropertyChangedEventHandler? OFT.Core.BaseConnectorSettings< T, TSelf >.PropertyChanged

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