Table of Contents

Class UserGroup

Namespace
ATAS.DataFeedsCore
Assembly
ATAS.DataFeedsCore.dll

Group of users of the ATAS emulation (simulated trading) server. Defines the prefix of new account numbers, the exchanges whose market data the users may subscribe to and the default TradingOptions of their portfolios. Groups form a hierarchy through Parent.

public class UserGroup : IEntity
Inheritance
object
UserGroup
Implements
Extension Methods

Constructors

UserGroup()

Initializes a new group with no exchanges and default trading options.

public UserGroup()

Properties

AllowLogonWithWrongPassword

Gets or sets whether users of the group are logged on even with a wrong password; the server then stores the new password for the user.

public bool AllowLogonWithWrongPassword { get; set; }

Property Value

bool

Code

Gets or sets the group code, used as the prefix of the account IDs of new portfolios.

public string Code { get; set; }

Property Value

string

DefaultExpiration

Gets or sets the period by which the expiration of a user of the group is extended by default; null when there is no default.

public TimeSpan? DefaultExpiration { get; set; }

Property Value

TimeSpan?

Description

Gets or sets an optional description of the group.

public string? Description { get; set; }

Property Value

string

EntityType

Gets the type of the entity.

[Browsable(false)]
public EntityType EntityType { get; }

Property Value

EntityType

Exchanges

Gets or sets the exchanges whose market data users of the group may subscribe to.

public List<Exchange> Exchanges { get; set; }

Property Value

List<Exchange>

Id

Gets or sets the database identifier of the group.

[Browsable(false)]
public long Id { get; set; }

Property Value

long

LastPortfolioNumber

Gets or sets the number of the last account created in the group; it is incremented for each new account and written, as five hexadecimal digits after Code, into the new account ID.

public int LastPortfolioNumber { get; set; }

Property Value

int

Name

Gets or sets the display name of the group.

public string Name { get; set; }

Property Value

string

Parent

Gets or sets the parent group; setting it also updates ParentId.

public UserGroup? Parent { get; set; }

Property Value

UserGroup

ParentId

Gets or sets the identifier of Parent; null for a top-level group.

[Browsable(false)]
public long? ParentId { get; set; }

Property Value

long?

StatisticsServerUrl

Gets or sets the URL template of the trading statistics page, with {0} replaced by the encrypted account ID. null means that the value of the parent group is used; see GetStatisticsServerUrl(Portfolio).

public string? StatisticsServerUrl { get; set; }

Property Value

string

TradingOptions

Gets or sets the trading and risk rules of the group's portfolios, used for portfolios that have no options of their own; setting it also updates TradingOptionsId.

public TradingOptions TradingOptions { get; set; }

Property Value

TradingOptions

TradingOptionsId

Gets or sets the identifier of TradingOptions.

[Browsable(false)]
public long? TradingOptionsId { get; set; }

Property Value

long?

Methods

OnPropertyChanged(string)

Raises the PropertyChanged event.

protected virtual void OnPropertyChanged(string propertyName)

Parameters

propertyName string

The name of the changed property.

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.

Events

PropertyChanged

Occurs when a property value changes.

Added in ATAS 8.0.15.

public event PropertyChangedEventHandler? PropertyChanged

Event Type

PropertyChangedEventHandler