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

A pre-simulated representation of a Simulation (SimGrid). More...

Public Member Functions

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...
 
LargeDataSubResource data
 An endpoint for accessing or modifying the data file attached to this resource. 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 = "simulations"
 The collection endpoint at which resources of this type reside on the server. More...
 

Protected Member Functions

override void AfterMembersCloned (APIType _)
 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...
 
IReference< DataFiledata_file [get, set]
 A reference to the data attached to this resource. This field will automatically be created if you initiate an upload using the data property, or this can be set to reference an existing file on the server to immediately initiate the commit phase of this resource. More...
 
string description [get, set]
 A user-friendly description of the resource. More...
 
List< IReference< EventCatalog > > event_catalogs [get, set]
 The list of references to EventCatalog objects that represent the event catalogs for which this Simulation is valid for. 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...
 
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...
 
string name [get, set]
 Name of the simulation. More...
 
Dictionary< string, object > notes [get, set]
 Notes about the simulation. More...
 
DateTime start_date [get, set]
 The date and time represented by a sequence value of 0 in the simulation. More...
 
TaskStatus status [get, set]
 Status of the data file associated with this resource. More...
 
string status_message [get, set]
 Status message of the data file associated with this resource. More...
 
int trial_count [get, set]
 Number of trials in this simulation. More...
 

Detailed Description

A pre-simulated representation of a Simulation (SimGrid).

Definition at line 12 of file StaticSimulation.cs.

Inheritance diagram for AnalyzeRe.StaticSimulation:
AnalyzeRe.Simulation AnalyzeRe.APITypes.IAPIResource_WithDataEndpoint AnalyzeRe.APITypes.StoredAPIResource_Polymorphic AnalyzeRe.APITypes.IStoredAPIResource_WithStatus AnalyzeRe.APITypes.StoredAPIResource AnalyzeRe.APITypes.IAPI_Polymorphic AnalyzeRe.APITypes.IStoredAPIResource AnalyzeRe.APIResource AnalyzeRe.APITypes.IStoredAPIResource AnalyzeRe.IAPIResource AnalyzeRe.APIType AnalyzeRe.IAPIResource AnalyzeRe.IAPIResource AnalyzeRe.IAPIType AnalyzeRe.IAPIType AnalyzeRe.IAPIType AnalyzeRe.IAPIType

Member Function Documentation

override void AnalyzeRe.StaticSimulation.AfterMembersCloned ( APIType  _)
inlineprotectedvirtual

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.

Reimplemented from AnalyzeRe.APIType.

Definition at line 57 of file StaticSimulation.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 16 of file StoredAPIResource_Polymorphic.cs.

readonly string AnalyzeRe.Simulation.CLASS_COLLECTION_NAME = "simulations"
staticinherited

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

Definition at line 17 of file Simulation.cs.

override string AnalyzeRe.Simulation.collection_name => CLASS_COLLECTION_NAME
inherited

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

Definition at line 20 of file Simulation.cs.

LargeDataSubResource AnalyzeRe.StaticSimulation.data
Initial value:
=> _dataEndpoint ??
(_dataEndpoint = new LargeDataSubResource(this, "data"))

An endpoint for accessing or modifying the data file attached to this resource.

Definition at line 35 of file StaticSimulation.cs.

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

The server name for this type of resource.

Definition at line 12 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.

IReference<DataFile> AnalyzeRe.StaticSimulation.data_file
getset

A reference to the data attached to this resource. This field will automatically be created if you initiate an upload using the data property, or this can be set to reference an existing file on the server to immediately initiate the commit phase of this resource.

Definition at line 44 of file StaticSimulation.cs.

string AnalyzeRe.APITypes.StoredAPIResource.description
getsetinherited

A user-friendly description of the resource.

Definition at line 14 of file StoredAPIResource.cs.

List<IReference<EventCatalog> > AnalyzeRe.Simulation.event_catalogs
getsetinherited

The list of references to EventCatalog objects that represent the event catalogs for which this Simulation is valid for.

Definition at line 40 of file Simulation.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.

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.

string AnalyzeRe.Simulation.name
getsetinherited

Name of the simulation.

Definition at line 28 of file Simulation.cs.

Dictionary<string, object> AnalyzeRe.StaticSimulation.notes
getset

Notes about the simulation.

Definition at line 24 of file StaticSimulation.cs.

DateTime AnalyzeRe.Simulation.start_date
getsetinherited

The date and time represented by a sequence value of 0 in the simulation.

Definition at line 33 of file Simulation.cs.

TaskStatus AnalyzeRe.StaticSimulation.status
getset

Status of the data file associated with this resource.

Definition at line 49 of file StaticSimulation.cs.

string AnalyzeRe.StaticSimulation.status_message
getset

Status message of the data file associated with this resource.

Definition at line 54 of file StaticSimulation.cs.

int AnalyzeRe.StaticSimulation.trial_count
getset

Number of trials in this simulation.

Definition at line 17 of file StaticSimulation.cs.


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