C# Client Library
A C# Client Library for the AnalyzeRe REST API
Loading...
Searching...
No Matches
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.

 

Static Public Attributes

static readonly string CLASS_COLLECTION_NAME = "simulations"
 The collection endpoint at which resources of this type reside on the server.
 

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.Overriding implementations should be sure to invoke base.AfterMembersCloned().
 

Properties

static string APITypeName [get]
 Can be used to get the API type name in a static context.
 
override string collection_name [get]
 The collection endpoint at which resources of this type reside on the server.
 
DateTime? created [get, set]
 The date and time when the resource was created on the system.
 
LargeDataSubResource data [get]
 An endpoint for accessing or modifying the data file attached to this resource.
 
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.
 
string description [get, set]
 A user-friendly description of the resource.
 
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.
 
string id [get, set]
 The resource's unique identifier. It will be used in the request URL when requesting the resource from the server.
 
Dictionary< string, object > meta_data = new Dictionary<string, object>() [get, set]
 Any user-defined metadata for this layer.
 
DateTime? modified [get, set]
 The date and time when the resource was last modified on the system.
 
string name [get, set]
 Name of the simulation.
 
Dictionary< string, objectnotes [get, set]
 Notes about the simulation.
 
string Path [get]
 The relative path to this endpoint from the root URL.
 
DateTime start_date [get, set]
 The date and time represented by a sequence value of 0 in the simulation.
 
TaskStatus status [get, set]
 Status of the data file associated with this resource.
 
string status_message [get, set]
 Status message of the data file associated with this resource.
 
int trial_count [get, set]
 Number of trials in this simulation.
 
string type [get]
 The server name for this type of resource.
 

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.APITypes.IEndpoint AnalyzeRe.IAPIType AnalyzeRe.IAPIType AnalyzeRe.APITypes.IEndpoint AnalyzeRe.IAPIType AnalyzeRe.APITypes.IEndpoint

Member Function Documentation

◆ AfterMembersCloned()

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.Overriding implementations should be sure to invoke base.AfterMembersCloned().

Reimplemented from AnalyzeRe.APIType.

Definition at line 56 of file StaticSimulation.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.

Member Data Documentation

◆ CLASS_COLLECTION_NAME

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.

Property Documentation

◆ APITypeName

string AnalyzeRe.APITypes.StoredAPIResource_Polymorphic.APITypeName
staticgetinherited

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

Definition at line 17 of file StoredAPIResource_Polymorphic.cs.

◆ collection_name

override string AnalyzeRe.Simulation.collection_name
getinherited

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

Implements AnalyzeRe.IAPIResource.

Definition at line 20 of file Simulation.cs.

◆ created

DateTime? AnalyzeRe.APITypes.StoredAPIResource.created
getsetinherited

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

Implements AnalyzeRe.APITypes.IStoredAPIResource.

Definition at line 19 of file StoredAPIResource.cs.

◆ data

LargeDataSubResource AnalyzeRe.StaticSimulation.data
get

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

Implements AnalyzeRe.APITypes.IAPIResource_WithDataEndpoint.

Definition at line 34 of file StaticSimulation.cs.

◆ data_file

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.

Implements AnalyzeRe.APITypes.IAPIResource_WithDataEndpoint.

Definition at line 43 of file StaticSimulation.cs.

◆ description

string AnalyzeRe.APITypes.StoredAPIResource.description
getsetinherited

A user-friendly description of the resource.

Implements AnalyzeRe.APITypes.IStoredAPIResource.

Definition at line 14 of file StoredAPIResource.cs.

◆ event_catalogs

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.

◆ id

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.

Implements AnalyzeRe.IAPIResource.

Definition at line 16 of file APIResource.cs.

◆ meta_data

Dictionary<string, object> AnalyzeRe.APITypes.StoredAPIResource.meta_data = new Dictionary<string, object>()
getsetinherited

Any user-defined metadata for this layer.

Implements AnalyzeRe.APITypes.IStoredAPIResource.

Definition at line 30 of file StoredAPIResource.cs.

◆ modified

DateTime? AnalyzeRe.APITypes.StoredAPIResource.modified
getsetinherited

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

Implements AnalyzeRe.APITypes.IStoredAPIResource.

Definition at line 24 of file StoredAPIResource.cs.

◆ name

string AnalyzeRe.Simulation.name
getsetinherited

Name of the simulation.

Definition at line 28 of file Simulation.cs.

◆ notes

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

Notes about the simulation.

Definition at line 22 of file StaticSimulation.cs.

◆ Path

string AnalyzeRe.APIResource.Path
getinherited

The relative path to this endpoint from the root URL.

The relative path to this endpoint from the root URL.

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

Implements AnalyzeRe.APITypes.IEndpoint.

Definition at line 27 of file APIResource.cs.

◆ start_date

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.

◆ status

TaskStatus AnalyzeRe.StaticSimulation.status
getset

Status of the data file associated with this resource.

Implements AnalyzeRe.APITypes.IStoredAPIResource_WithStatus.

Definition at line 48 of file StaticSimulation.cs.

◆ status_message

string AnalyzeRe.StaticSimulation.status_message
getset

Status message of the data file associated with this resource.

Implements AnalyzeRe.APITypes.IStoredAPIResource_WithStatus.

Definition at line 53 of file StaticSimulation.cs.

◆ trial_count

int AnalyzeRe.StaticSimulation.trial_count
getset

Number of trials in this simulation.

Definition at line 17 of file StaticSimulation.cs.

◆ type

string AnalyzeRe.APITypes.StoredAPIResource_Polymorphic.type
getinherited

The server name for this type of resource.

Implements AnalyzeRe.APITypes.IAPI_Polymorphic.

Definition at line 13 of file StoredAPIResource_Polymorphic.cs.


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