C# Client Library
A C# Client Library for the AnalyzeRe REST API
Loading...
Searching...
No Matches
AnalyzeRe.Fees.Fee Class Referenceabstract

Abstract representation of a fee. This resource type cannot be instantiated instead derived resource types should be used for instantiation. More...

Public Member Functions

bool Equals (Fee other)
 
override bool Equals (object obj)
 Determine if this Fee is equivalent to another.
 
override int GetHashCode ()
 Get the HashCode for this Fee.
 
virtual T ShallowCopy< T > ()
 Create a shallow copy of this object.

See also
ExtensionMethods.DeepCopy<T>

for a serializer-based copy method.

 

Protected Member Functions

virtual void AfterMembersCloned (APIType originalResource)
 Invoked following construction if the current instance has been created using a member-wise clone of some other instance. Override if your derived APIType class contains some members that should not be cloned.
 

Static Protected Member Functions

static int HashReferences (IEnumerable< FeeReference > references)
 Get the HashCode for a collection of Fee References.
 
static bool ReferencesEquivalent (List< FeeReference > first, List< FeeReference > second)
 Used to determine if two lists of fee references are equivalent while ignoring the order in which fee references occur.
 

Properties

static string APITypeName [get]
 Can be used to get the API type name in a static context.
 
string name [get, set]
 A user friendly name for this fee.
 
DateTimepayout_date [get, set]
 The date on which the payout is made.
 
string type [get]
 The server name for this type of resource.
 

Detailed Description

Abstract representation of a fee. This resource type cannot be instantiated instead derived resource types should be used for instantiation.

Definition at line 13 of file Fee.cs.

Inheritance diagram for AnalyzeRe.Fees.Fee:
AnalyzeRe.APITypes.APIType_Polymorphic AnalyzeRe.APIType AnalyzeRe.APITypes.IAPI_Polymorphic AnalyzeRe.IAPIType AnalyzeRe.Fees.FixedExpense AnalyzeRe.Fees.ProfitCommission AnalyzeRe.Fees.ProportionalExpense

Member Function Documentation

◆ AfterMembersCloned()

virtual void AnalyzeRe.APIType.AfterMembersCloned ( APIType  originalResource)
inlineprotectedvirtualinherited

Invoked following construction if the current instance has been created using a member-wise clone of some other instance. Override if your derived APIType class contains some members that should not be cloned.

Overriding implementations should be sure to invoke base.AfterMembersCloned().

A sane question for a code reviewer to ask might be: "Why not avoid copying those members in the first place?" The answer is that there is no framework-supported method of excluding members from a MemberwiseClone. The only officially supported solution is to not use the object.MemberwiseClone method at all and instead have each class implement it's own Copy method. In our case, most objects have no need to specialize their copy implementation (even though they could - the ShallowCopy<T> method is marked virtual). It's simpler to simply "correct" any special-case members after the fact, and requires less error-prone code than if the code were responsible for ensuring no members were missed in a copy. It's also faster than any reflection-based approach, even though such an approach could benefit from custom attributes meant to exclude certain members from copying.

Reimplemented in AnalyzeRe.APITypes.APIResource_WithDataEndpoint, AnalyzeRe.APIResourceView.BaseAPIResourceView, AnalyzeRe.Distributions.CustomDistribution, AnalyzeRe.LossSets.LossSet_WithData, AnalyzeRe.Optimization.Candidate, AnalyzeRe.Optimization.OptimizationView, and AnalyzeRe.StaticSimulation.

Definition at line 37 of file APIType.cs.

◆ Equals() [1/2]

bool AnalyzeRe.Fees.Fee.Equals ( Fee  other)

◆ Equals() [2/2]

override bool AnalyzeRe.Fees.Fee.Equals ( object  obj)

Determine if this Fee is equivalent to another.

Parameters
objObject to compare to this.
Returns
True if the other object is a Fee and it is equivalent to this.

◆ GetHashCode()

override int AnalyzeRe.Fees.Fee.GetHashCode ( )
inline

Get the HashCode for this Fee.

Returns
A unique HashCode for this Fee

Definition at line 41 of file Fee.cs.

◆ HashReferences()

static int AnalyzeRe.Fees.Fee.HashReferences ( IEnumerable< FeeReference references)
inlinestaticprotected

Get the HashCode for a collection of Fee References.

Parameters
referencesA collection of references.
Returns
A HashCode for the collection.

Definition at line 52 of file Fee.cs.

◆ ReferencesEquivalent()

static bool AnalyzeRe.Fees.Fee.ReferencesEquivalent ( List< FeeReference first,
List< FeeReference second 
)
inlinestaticprotected

Used to determine if two lists of fee references are equivalent while ignoring the order in which fee references occur.

Definition at line 63 of file Fee.cs.

◆ ShallowCopy< T >()

virtual T AnalyzeRe.APIType.ShallowCopy< T > ( )
inlinevirtualinherited

Create a shallow copy of this object.

See also
ExtensionMethods.DeepCopy<T>

for a serializer-based copy method.

Returns
A shallow copy of this object.

If this object contains any members that reference the current object (this), the class should override this method to avoid cloning a reference to the old class.

Implements AnalyzeRe.IAPIType.

Type Constraints
T :IAPIType 

Definition at line 14 of file APIType.cs.

Property Documentation

◆ APITypeName

string AnalyzeRe.APITypes.APIType_Polymorphic.APITypeName
staticgetinherited

Can be used to get the API type name in a static context.

Definition at line 22 of file APIType_Polymorphic.cs.

◆ name

string AnalyzeRe.Fees.Fee.name
getset

A user friendly name for this fee.

Definition at line 18 of file Fee.cs.

◆ payout_date

DateTime? AnalyzeRe.Fees.Fee.payout_date
getset

The date on which the payout is made.

Definition at line 23 of file Fee.cs.

◆ type

string AnalyzeRe.APITypes.APIType_Polymorphic.type
getinherited

The server name for this type of resource.

Implements AnalyzeRe.APITypes.IAPI_Polymorphic.

Definition at line 18 of file APIType_Polymorphic.cs.


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