A block of orders for the same instrument, intended to record for example a trader's aggregation of outstanding orders at a given time. More...

Inheritance diagram for Lusid.Sdk.Model.Block:

[legend]

Public Member Functions
	Block (ResourceId id=default(ResourceId), List< ResourceId > orderIds=default(List< ResourceId >), Dictionary< string, PerpetualProperty > properties=default(Dictionary< string, PerpetualProperty >), Dictionary< string, string > instrumentIdentifiers=default(Dictionary< string, string >), string lusidInstrumentId=default(string), decimal quantity=default(decimal), string side=default(string), string type=default(string), string timeInForce=default(string), DateTimeOffset createdDate=default(DateTimeOffset), CurrencyAndAmount limitPrice=default(CurrencyAndAmount), CurrencyAndAmount stopPrice=default(CurrencyAndAmount), bool isSwept=default(bool), ModelVersion varVersion=default(ModelVersion), DataModelMembership dataModelMembership=default(DataModelMembership), List< Link > links=default(List< Link >))
	Initializes a new instance of the Block class. More...

override string	ToString ()
	Returns the string presentation of the object More...

virtual string	ToJson ()
	Returns the JSON string presentation of the object More...

override bool	Equals (object input)
	Returns true if objects are equal More...

bool	Equals (Block input)
	Returns true if Block instances are equal More...

override int	GetHashCode ()
	Gets the hash code More...

Protected Member Functions
	Block ()
	Initializes a new instance of the Block class. More...

Properties
ResourceId	Id `[get, set]`
	Gets or Sets Id More...

List< ResourceId >	OrderIds `[get, set]`
	The related order ids. More...

Dictionary< string, PerpetualProperty >	Properties `[get, set]`
	Client-defined properties associated with this block. More...

Dictionary< string, string >	InstrumentIdentifiers `[get, set]`
	The instrument ordered. More...

string	LusidInstrumentId `[get, set]`
	The LUSID instrument id for the instrument ordered. More...

decimal	Quantity `[get, set]`
	The total quantity of given instrument ordered. More...

string	Side `[get, set]`
	The client's representation of the block's side (buy, sell, short, etc) More...

string	Type `[get, set]`
	The block order's type (examples: Limit, Market, ...) More...

string	TimeInForce `[get, set]`
	The block orders' time in force (examples: Day, GoodTilCancel, ...) More...

DateTimeOffset	CreatedDate `[get, set]`
	The date on which the block was made More...

CurrencyAndAmount	LimitPrice `[get, set]`
	Gets or Sets LimitPrice More...

CurrencyAndAmount	StopPrice `[get, set]`
	Gets or Sets StopPrice More...

bool	IsSwept `[get, set]`
	Swept blocks are considered no longer of active interest, and no longer take part in various order management processes More...

ModelVersion	VarVersion `[get, set]`
	Gets or Sets VarVersion More...

DataModelMembership	DataModelMembership `[get, set]`
	Gets or Sets DataModelMembership More...

List< Link >	Links `[get, set]`
	Gets or Sets Links More...

Detailed Description

A block of orders for the same instrument, intended to record for example a trader's aggregation of outstanding orders at a given time.

Constructor & Destructor Documentation

◆ Block() [1/2]

Lusid.Sdk.Model.Block.Block ( )

inlineprotected

Initializes a new instance of the Block class.

◆ Block() [2/2]

Lusid.Sdk.Model.Block.Block	(	ResourceId	id = `default(ResourceId)`,
		List< ResourceId >	orderIds = `default(List<ResourceId>)`,
		Dictionary< string, PerpetualProperty >	properties = `default(Dictionary<string, PerpetualProperty>)`,
		Dictionary< string, string >	instrumentIdentifiers = `default(Dictionary<string, string>)`,
		string	lusidInstrumentId = `default(string)`,
		decimal	quantity = `default(decimal)`,
		string	side = `default(string)`,
		string	type = `default(string)`,
		string	timeInForce = `default(string)`,
		DateTimeOffset	createdDate = `default(DateTimeOffset)`,
		CurrencyAndAmount	limitPrice = `default(CurrencyAndAmount)`,
		CurrencyAndAmount	stopPrice = `default(CurrencyAndAmount)`,
		bool	isSwept = `default(bool)`,
		ModelVersion	varVersion = `default(ModelVersion)`,
		DataModelMembership	dataModelMembership = `default(DataModelMembership)`,
		List< Link >	links = `default(List<Link>)`
	)

inline

Initializes a new instance of the Block class.

Parameters

id	id (required).
orderIds	The related order ids. (required).
properties	Client-defined properties associated with this block..
instrumentIdentifiers	The instrument ordered. (required).
lusidInstrumentId	The LUSID instrument id for the instrument ordered. (required).
quantity	The total quantity of given instrument ordered. (required).
side	The client's representation of the block's side (buy, sell, short, etc) (required).
type	The block order's type (examples: Limit, Market, ...).
timeInForce	The block orders' time in force (examples: Day, GoodTilCancel, ...).
createdDate	The date on which the block was made (required).
limitPrice	limitPrice.
stopPrice	stopPrice.
isSwept	Swept blocks are considered no longer of active interest, and no longer take part in various order management processes (required).
varVersion	varVersion.
dataModelMembership	dataModelMembership.
links	links.

Member Function Documentation

◆ Equals() [1/2]

bool Lusid.Sdk.Model.Block.Equals ( Block input )

inline

Returns true if Block instances are equal

Parameters

input Instance of Block to be compared

Returns: Boolean

◆ Equals() [2/2]

override bool Lusid.Sdk.Model.Block.Equals ( object input )

inline

Returns true if objects are equal

Parameters

input Object to be compared

Returns: Boolean

◆ GetHashCode()

override int Lusid.Sdk.Model.Block.GetHashCode ( )

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

virtual string Lusid.Sdk.Model.Block.ToJson ( )

inlinevirtual

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

◆ ToString()

override string Lusid.Sdk.Model.Block.ToString ( )

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ CreatedDate

DateTimeOffset Lusid.Sdk.Model.Block.CreatedDate

getset

The date on which the block was made

◆ DataModelMembership

DataModelMembership Lusid.Sdk.Model.Block.DataModelMembership

getset

Gets or Sets DataModelMembership

◆ Id

ResourceId Lusid.Sdk.Model.Block.Id

getset

Gets or Sets Id

◆ InstrumentIdentifiers

Dictionary<string, string> Lusid.Sdk.Model.Block.InstrumentIdentifiers

getset

The instrument ordered.

◆ IsSwept

bool Lusid.Sdk.Model.Block.IsSwept

getset

Swept blocks are considered no longer of active interest, and no longer take part in various order management processes

◆ LimitPrice

CurrencyAndAmount Lusid.Sdk.Model.Block.LimitPrice

getset

Gets or Sets LimitPrice

◆ Links

List<Link> Lusid.Sdk.Model.Block.Links

getset

Gets or Sets Links

◆ LusidInstrumentId

string Lusid.Sdk.Model.Block.LusidInstrumentId

getset

The LUSID instrument id for the instrument ordered.

◆ OrderIds

List<ResourceId> Lusid.Sdk.Model.Block.OrderIds

getset

The related order ids.

◆ Properties

Dictionary<string, PerpetualProperty> Lusid.Sdk.Model.Block.Properties

getset

Client-defined properties associated with this block.

◆ Quantity

decimal Lusid.Sdk.Model.Block.Quantity

getset

The total quantity of given instrument ordered.

◆ Side

string Lusid.Sdk.Model.Block.Side

getset

The client's representation of the block's side (buy, sell, short, etc)

◆ StopPrice

CurrencyAndAmount Lusid.Sdk.Model.Block.StopPrice

getset

Gets or Sets StopPrice

◆ TimeInForce

string Lusid.Sdk.Model.Block.TimeInForce

getset

The block orders' time in force (examples: Day, GoodTilCancel, ...)

◆ Type

string Lusid.Sdk.Model.Block.Type

getset

The block order's type (examples: Limit, Market, ...)

◆ VarVersion

ModelVersion Lusid.Sdk.Model.Block.VarVersion

getset

Gets or Sets VarVersion

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

/home/docs/checkouts/readthedocs.org/user_builds/lusid-sdk-csharp/checkouts/latest/sdk/Lusid.Sdk/Model/Block.cs

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ Block() [1/2]

◆ Block() [2/2]

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ CreatedDate

◆ DataModelMembership

◆ Id

◆ InstrumentIdentifiers

◆ IsSwept

◆ LimitPrice

◆ Links

◆ LusidInstrumentId

◆ OrderIds

◆ Properties

◆ Quantity

◆ Side

◆ StopPrice

◆ TimeInForce

◆ Type

◆ VarVersion