LUSID C# SDK
Public Member Functions | Protected Member Functions | Properties | List of all members
Lusid.Sdk.Model.AllocationGroupDefinition Class Reference

AllocationGroupDefinition More...

Inheritance diagram for Lusid.Sdk.Model.AllocationGroupDefinition:
Inheritance graph
[legend]

Public Member Functions

 AllocationGroupDefinition (List< AllocationGroupClassDefinition > classes=default(List< AllocationGroupClassDefinition >), string code=default(string), string name=default(string), string description=default(string), string shareClassShortCode=default(string), ApportionmentMethodProperty apportionmentMethodProperty=default(ApportionmentMethodProperty), string formula=default(string))
 Initializes a new instance of the AllocationGroupDefinition 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 (AllocationGroupDefinition input)
 Returns true if AllocationGroupDefinition instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

 AllocationGroupDefinition ()
 Initializes a new instance of the AllocationGroupDefinition class. More...
 

Properties

List< AllocationGroupClassDefinitionClasses [get, set]
 An optional list of share classes that belong to this group. Each entry must reference a ShareClass already present on the Fund. You can provide this or the Formula, but not both. More...
 
string Code [get, set]
 The unique code for the Allocation Group. Must be unique within the Fund. More...
 
string Name [get, set]
 The display name of the Allocation Group. More...
 
string Description [get, set]
 An optional description for the Allocation Group. More...
 
string ShareClassShortCode [get, set]
 The short code that identifies the Allocation Group. More...
 
ApportionmentMethodProperty ApportionmentMethodProperty [get, set]
 Gets or Sets ApportionmentMethodProperty More...
 
string Formula [get, set]
 An optional filter expression used to define which classes belong to this group, based on fund grouping criteria. You can provide this or the Classes, but not both. More...
 

Detailed Description

AllocationGroupDefinition

Constructor & Destructor Documentation

◆ AllocationGroupDefinition() [1/2]

Lusid.Sdk.Model.AllocationGroupDefinition.AllocationGroupDefinition ( )
inlineprotected

Initializes a new instance of the AllocationGroupDefinition class.

◆ AllocationGroupDefinition() [2/2]

Lusid.Sdk.Model.AllocationGroupDefinition.AllocationGroupDefinition ( List< AllocationGroupClassDefinition classes = default(List<AllocationGroupClassDefinition>),
string  code = default(string),
string  name = default(string),
string  description = default(string),
string  shareClassShortCode = default(string),
ApportionmentMethodProperty  apportionmentMethodProperty = default(ApportionmentMethodProperty),
string  formula = default(string) 
)
inline

Initializes a new instance of the AllocationGroupDefinition class.

Parameters
classesAn optional list of share classes that belong to this group. Each entry must reference a ShareClass already present on the Fund. You can provide this or the Formula, but not both..
codeThe unique code for the Allocation Group. Must be unique within the Fund. (required).
nameThe display name of the Allocation Group. (required).
descriptionAn optional description for the Allocation Group..
shareClassShortCodeThe short code that identifies the Allocation Group. (required).
apportionmentMethodPropertyapportionmentMethodProperty.
formulaAn optional filter expression used to define which classes belong to this group, based on fund grouping criteria. You can provide this or the Classes, but not both..

Member Function Documentation

◆ Equals() [1/2]

bool Lusid.Sdk.Model.AllocationGroupDefinition.Equals ( AllocationGroupDefinition  input)
inline

Returns true if AllocationGroupDefinition instances are equal

Parameters
inputInstance of AllocationGroupDefinition to be compared
Returns
Boolean

◆ Equals() [2/2]

override bool Lusid.Sdk.Model.AllocationGroupDefinition.Equals ( object  input)
inline

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ GetHashCode()

override int Lusid.Sdk.Model.AllocationGroupDefinition.GetHashCode ( )
inline

Gets the hash code

Returns
Hash code

◆ ToJson()

virtual string Lusid.Sdk.Model.AllocationGroupDefinition.ToJson ( )
inlinevirtual

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

override string Lusid.Sdk.Model.AllocationGroupDefinition.ToString ( )
inline

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ ApportionmentMethodProperty

ApportionmentMethodProperty Lusid.Sdk.Model.AllocationGroupDefinition.ApportionmentMethodProperty
getset

◆ Classes

List<AllocationGroupClassDefinition> Lusid.Sdk.Model.AllocationGroupDefinition.Classes
getset

An optional list of share classes that belong to this group. Each entry must reference a ShareClass already present on the Fund. You can provide this or the Formula, but not both.

An optional list of share classes that belong to this group. Each entry must reference a ShareClass already present on the Fund. You can provide this or the Formula, but not both.

◆ Code

string Lusid.Sdk.Model.AllocationGroupDefinition.Code
getset

The unique code for the Allocation Group. Must be unique within the Fund.

The unique code for the Allocation Group. Must be unique within the Fund.

◆ Description

string Lusid.Sdk.Model.AllocationGroupDefinition.Description
getset

An optional description for the Allocation Group.

An optional description for the Allocation Group.

◆ Formula

string Lusid.Sdk.Model.AllocationGroupDefinition.Formula
getset

An optional filter expression used to define which classes belong to this group, based on fund grouping criteria. You can provide this or the Classes, but not both.

An optional filter expression used to define which classes belong to this group, based on fund grouping criteria. You can provide this or the Classes, but not both.

◆ Name

string Lusid.Sdk.Model.AllocationGroupDefinition.Name
getset

The display name of the Allocation Group.

The display name of the Allocation Group.

◆ ShareClassShortCode

string Lusid.Sdk.Model.AllocationGroupDefinition.ShareClassShortCode
getset

The short code that identifies the Allocation Group.

The short code that identifies the Allocation Group.


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