C# Client Library
A C# Client Library for the AnalyzeRe REST API
AnalyzeRe.Layers.Filter Class Reference

Filter is like a layer whose 'terms' are to filter events out of the loss sources. By referencing some loss sets filters, the result is that only the losses that meet the criteria of the filters are emitted. More...

Public Member Functions

 Filter ()
 Construct a new Filter with an empty list of filters. More...
 
virtual T ShallowCopy< T > ()
 Create a shallow copy of this object.

See also
ExtensionMethods.DeepCopy<T>

for a serializer-based copy method. More...

 

Public Attributes

override string collection_name => CLASS_COLLECTION_NAME
 The collection endpoint at which resources of this type reside on the server. More...
 
string Path => API.GetResourcePath(this)
 The relative path to this endpoint from the root URL. More...
 
string type => TypeResolver.GetTypeNameForAPIType(GetType())
 The server name for this type of resource. More...
 

Static Public Attributes

static string APITypeName
 Can be used to get the API type name in a static context. More...
 
static readonly string CLASS_COLLECTION_NAME = "layers"
 The collection endpoint at which resources of this type reside on the server. More...
 

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. More...
 

Properties

DateTime created [get, set]
 The date and time when the resource was created on the system. More...
 
string description [get, set]
 A user-friendly description of the resource. More...
 
List< IReference< LossFilter > > filters [get, set]
 A list of filters, any of whose criteria must be met. (i.e. The filters are OR'd together). More...
 
string id [get, set]
 The resource's unique identifier. It will be used in the request URL when requesting the resource from the server. More...
 
bool invert [get, set]
 A Boolean flag determining how the filters are used. If invert is FALSE (default), the events that pass through are only those events that meet any of the filter criteria. If invert is TRUE, then only events that DO NOT meet any of the criteria are passed through. In summary, set invert to FALSE to INCLUDE events that match the filters, set invert to TRUE to EXCLUDE events that match the filters. More...
 
List< IReference< LossSet > > loss_sets [get, set]
 The list of LossSet references that is associated with the specific layer. More...
 
Dictionary< string, object > meta_data [get, set]
 Any user-defined metadata for this layer. More...
 
DateTime modified [get, set]
 The date and time when the resource was last modified on the system. More...
 
Policy policy [get, set]
 The Policy that overrides the default layer behaviour for forwarding and transforming loss records. More...
 

Detailed Description

Filter is like a layer whose 'terms' are to filter events out of the loss sources. By referencing some loss sets filters, the result is that only the losses that meet the criteria of the filters are emitted.

Definition at line 12 of file Filter.cs.

Inheritance diagram for AnalyzeRe.Layers.Filter:
AnalyzeRe.Layers.Layer_WithLossSets AnalyzeRe.Layer AnalyzeRe.Layers.ILayer_WithLossSets AnalyzeRe.APITypes.StoredAPIResource_Polymorphic AnalyzeRe.ILayer AnalyzeRe.ILayer AnalyzeRe.APITypes.IAPI_Polymorphic AnalyzeRe.APITypes.IStoredAPIResource AnalyzeRe.ILayerSource AnalyzeRe.APITypes.IAPI_Polymorphic AnalyzeRe.APITypes.IStoredAPIResource AnalyzeRe.ILayerSource AnalyzeRe.APITypes.IAPI_Polymorphic AnalyzeRe.APITypes.StoredAPIResource

Constructor & Destructor Documentation

AnalyzeRe.Layers.Filter.Filter ( )
inline

Construct a new Filter with an empty list of filters.

Definition at line 33 of file Filter.cs.

Member Function Documentation

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.APIResourceView.BaseAPIResourceView, AnalyzeRe.Optimization.OptimizationView, AnalyzeRe.Optimization.Candidate, AnalyzeRe.StaticSimulation, AnalyzeRe.Distributions.CustomDistribution, AnalyzeRe.LossSets.LossSet_WithData, and AnalyzeRe.APITypes.APIResource_WithDataEndpoint.

Definition at line 37 of file APIType.cs.

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.

Member Data Documentation

string AnalyzeRe.APITypes.StoredAPIResource_Polymorphic.APITypeName
staticinherited
Initial value:
=> TypeResolver.GetTypeNameForAPIType(
MethodBase.GetCurrentMethod().DeclaringType)

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

Definition at line 17 of file StoredAPIResource_Polymorphic.cs.

readonly string AnalyzeRe.Layer.CLASS_COLLECTION_NAME = "layers"
staticinherited

The collection endpoint at which resources of this type reside on the server.

Definition at line 15 of file Layer.cs.

override string AnalyzeRe.Layer.collection_name => CLASS_COLLECTION_NAME
inherited

The collection endpoint at which resources of this type reside on the server.

Definition at line 18 of file Layer.cs.

string AnalyzeRe.APIResource.Path => API.GetResourcePath(this)
inherited

The relative path to this endpoint from the root URL.

Exceptions
System.ArgumentExceptionIf this resource does not have an id.

Definition at line 27 of file APIResource.cs.

string AnalyzeRe.APITypes.StoredAPIResource_Polymorphic.type => TypeResolver.GetTypeNameForAPIType(GetType())
inherited

The server name for this type of resource.

Definition at line 13 of file StoredAPIResource_Polymorphic.cs.

Property Documentation

DateTime AnalyzeRe.APITypes.StoredAPIResource.created
getsetinherited

The date and time when the resource was created on the system.

Definition at line 19 of file StoredAPIResource.cs.

string AnalyzeRe.APITypes.StoredAPIResource.description
getsetinherited

A user-friendly description of the resource.

Definition at line 14 of file StoredAPIResource.cs.

List<IReference<LossFilter> > AnalyzeRe.Layers.Filter.filters
getset

A list of filters, any of whose criteria must be met. (i.e. The filters are OR'd together).

Definition at line 29 of file Filter.cs.

string AnalyzeRe.APIResource.id
getsetinherited

The resource's unique identifier. It will be used in the request URL when requesting the resource from the server.

Definition at line 16 of file APIResource.cs.

bool AnalyzeRe.Layers.Filter.invert
getset

A Boolean flag determining how the filters are used. If invert is FALSE (default), the events that pass through are only those events that meet any of the filter criteria. If invert is TRUE, then only events that DO NOT meet any of the criteria are passed through. In summary, set invert to FALSE to INCLUDE events that match the filters, set invert to TRUE to EXCLUDE events that match the filters.

Definition at line 23 of file Filter.cs.

List<IReference<LossSet> > AnalyzeRe.Layers.Layer_WithLossSets.loss_sets
getsetinherited

The list of LossSet references that is associated with the specific layer.

Definition at line 15 of file Layer_WithLossSets.cs.

Dictionary<string, object> AnalyzeRe.APITypes.StoredAPIResource.meta_data
getsetinherited

Any user-defined metadata for this layer.

Definition at line 30 of file StoredAPIResource.cs.

DateTime AnalyzeRe.APITypes.StoredAPIResource.modified
getsetinherited

The date and time when the resource was last modified on the system.

Definition at line 24 of file StoredAPIResource.cs.

Policy AnalyzeRe.Layers.Layer_WithLossSets.policy
getsetinherited

The Policy that overrides the default layer behaviour for forwarding and transforming loss records.

Definition at line 20 of file Layer_WithLossSets.cs.


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