Base class for representing schedules in LUSID. This base class should not be directly instantiated; each supported ScheduleType has a corresponding inherited class. More...
Public Types | |
| enum class | ScheduleTypeEnum { FixedSchedule = 1 , FloatSchedule = 2 , OptionalitySchedule = 3 , StepSchedule = 4 , Exercise = 5 , FxRateSchedule = 6 , Invalid = 7 } |
| The available values are: FixedSchedule, FloatSchedule, OptionalitySchedule, StepSchedule, Exercise, FxRateSchedule, Invalid More... | |
Public Member Functions | |
| Schedule (ScheduleTypeEnum scheduleType=default(ScheduleTypeEnum)) | |
| Initializes a new instance of the Schedule 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 (Schedule input) |
| Returns true if Schedule instances are equal More... | |
| override int | GetHashCode () |
| Gets the hash code More... | |
Protected Member Functions | |
| Schedule () | |
| Initializes a new instance of the Schedule class. More... | |
| IEnumerable< System.ComponentModel.DataAnnotations.ValidationResult > | BaseValidate (ValidationContext validationContext) |
| To validate all properties of the instance More... | |
Properties | |
| ScheduleTypeEnum | ScheduleType [get, set] |
| The available values are: FixedSchedule, FloatSchedule, OptionalitySchedule, StepSchedule, Exercise, FxRateSchedule, Invalid More... | |
Detailed Description
Base class for representing schedules in LUSID. This base class should not be directly instantiated; each supported ScheduleType has a corresponding inherited class.
Member Enumeration Documentation
◆ ScheduleTypeEnum
|
strong |
The available values are: FixedSchedule, FloatSchedule, OptionalitySchedule, StepSchedule, Exercise, FxRateSchedule, Invalid
The available values are: FixedSchedule, FloatSchedule, OptionalitySchedule, StepSchedule, Exercise, FxRateSchedule, Invalid
| Enumerator | |
|---|---|
| FixedSchedule | Enum FixedSchedule for value: FixedSchedule |
| FloatSchedule | Enum FloatSchedule for value: FloatSchedule |
| OptionalitySchedule | Enum OptionalitySchedule for value: OptionalitySchedule |
| StepSchedule | Enum StepSchedule for value: StepSchedule |
| Exercise | Enum Exercise for value: Exercise |
| FxRateSchedule | Enum FxRateSchedule for value: FxRateSchedule |
| Invalid | Enum Invalid for value: Invalid |
Constructor & Destructor Documentation
◆ Schedule() [1/2]
|
inlineprotected |
Initializes a new instance of the Schedule class.
◆ Schedule() [2/2]
|
inline |
Initializes a new instance of the Schedule class.
- Parameters
-
scheduleType The available values are: FixedSchedule, FloatSchedule, OptionalitySchedule, StepSchedule, Exercise, FxRateSchedule, Invalid (required).
Member Function Documentation
◆ BaseValidate()
|
inlineprotected |
To validate all properties of the instance
- Parameters
-
validationContext Validation context
- Returns
- Validation Result
◆ Equals() [1/2]
|
inline |
Returns true if objects are equal
- Parameters
-
input Object to be compared
- Returns
- Boolean
◆ Equals() [2/2]
|
inline |
◆ GetHashCode()
|
inline |
Gets the hash code
- Returns
- Hash code
◆ ToJson()
|
inlinevirtual |
Returns the JSON string presentation of the object
- Returns
- JSON string presentation of the object
Reimplemented in Lusid.Sdk.Model.StepSchedule, Lusid.Sdk.Model.OptionalitySchedule, Lusid.Sdk.Model.FxRateSchedule, Lusid.Sdk.Model.FloatSchedule, and Lusid.Sdk.Model.FixedSchedule.
◆ ToString()
|
inline |
Returns the string presentation of the object
- Returns
- String presentation of the object
Property Documentation
◆ ScheduleType
|
getset |
The available values are: FixedSchedule, FloatSchedule, OptionalitySchedule, StepSchedule, Exercise, FxRateSchedule, Invalid
The available values are: FixedSchedule, FloatSchedule, OptionalitySchedule, StepSchedule, Exercise, FxRateSchedule, Invalid
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/Schedule.cs
