[ROOT] doc DocFrag SELECT Assembly, DocFragType, Description.FirstLine() < SKIP 277 > < TAKE 256 >
256 items
DocFragId | Assembly | DocFragType | Description.FirstLine() |
---|---|---|---|
ARCCore.PKTypeAttribute.IsObligatory | ARCCore | ClassMember | See -IsObligatory-. |
ARCQuery.ValueComparerDateTime.Steps | ARCQuery | ClassMember | Value 0 would mean 'This', like ThisHour, Today, ThisMonth and so on. |
ARCCore.PKTypeAttribute.IsDefault | ARCCore | ClassMember | Does not have a corresponding -BaseAttributeP- since all attributes relevant for querying (for instance in the documentation) will be IsDefault = FALSE anyway. (if we had included it in -BaseAttributeP- it would just have led to a lot of confusing IsDefault = FALSE key-values showing up.) |
ARCQuery.ValueComparerDateTime.IsGliding | ARCQuery | ClassMember | The modifier 'Gliding' (or just 'G') can be appended in order to mean continous gliding periode, so for instance |
ARCCore.IP | ARCCore | Class | IP = IProperty. |
ARCQuery.ValueComparerDateTime.IsBefore | ARCQuery | ClassMember | The modifier 'Before' can be prepended in order to mean from any time before the specified time. |
ARCCore.IP.TryGetV Overload2 | ARCCore | ClassMember | The actual value of the property. Mostly relevant for single-value properties like -PValue-. |
ARCQuery.ValueComparerDateTime.IsAfter | ARCQuery | ClassMember | The modifier 'After' can be prepended in order to mean any time after the specified time. |
ARCCore.IP.Inc | ARCCore | ClassMember | Increments given property key by 1. Sets to 1 if not found. Uses long, not integer. |
ARCQuery.ValueComparerDateTime.IsInterval | ARCQuery | ClassMember | Normally the interval which is compared against is the timespan corresponding to -Resolution-. |
ARCCore.IP.Dec | ARCCore | ClassMember | Decrements given property key by 1. Sets to -1 if not found. Uses long, not integer. |
ARCQuery.ValueComparerDateTime.InitValue | ARCQuery | ClassMember | For debugging purposes. The initial 'now' value used before calculating -StartPeriod- and -EndPeriod-. |
ARCCore.IP.Log | ARCCore | ClassMember | The 'final' overload of -Log- that is called by the other overloads. |
ARCQuery.ValueComparerDateTime.StartPeriod | ARCQuery | ClassMember | The start of the interval which this instance compares against. |
ARCCore.IP.LogExecuteTime | ARCCore | ClassMember | Times the execution of the given function and logs details about elapsed time. |
ARCQuery.ValueComparerDateTime.EndPeriod | ARCQuery | ClassMember | The end of the interval which this instance compares against. |
ARCCore.IP.HandleException | ARCCore | ClassMember | Note that most relevant to use for -PConcurrent-. |
ARCQuery.ValueComparerDateTime.ToDebugProperties | ARCQuery | ClassMember | Exposes all members of this class. |
ARCCore.IP.TryParseDtr | ARCCore | ClassMember | Parses a PropertyStreamLine- beginning with -dtr-. |
ARCQuery.ForeignKey+IKIPEqualityComparer | ARCQuery | Class | Used by -TryGetPInternal- when it needs distinct list of foreign entities, based on their keys |
ARCCore.IP.Initialize | ARCCore | ClassMember | Note that has a default implementation (doing nothing). |
ARCQuery.ForeignKey+EntityTypeAndKey | ARCQuery | Class | Describes an entity type and a key. |
ARCCore.IP.AssertIntegrity | ARCCore | ClassMember | See -TryAssertIntegrity-. |
ARCQuery.ForeignKey+EntityTypeAndKey.EntityType | ARCQuery | ClassMember | For -IPRelationsKeysPointingTo-, corresponds to foreign entity type. |
ARCCore.IP.TryAssertIntegrity | ARCCore | ClassMember | Asserts the integrity of this entity. |
ARCQuery.ForeignKey+EntityTypeAndKey.Key | ARCQuery | ClassMember | NOTE: Key in EntityTypeAndKey was relaxed from PK to IK 25 Feb 2022 in order for experiment in -ForeignKey- to work. |
ARCCore.IP.ToString | ARCCore | ClassMember | The ToString()-implementation in the classes implementing this interface is supposed to give a short concise representation of the object for debugging and logging purposes, that is, intended for human consumption. The most 'important' implementation is probably the one in -PRich- (-ToString-) because that one is often the basis for your entity classes like 'Customer', 'Order' and so on |
ARCQuery.ForeignKey+EntityTypeAndKey.OppositeTerm | ARCQuery | ClassMember | Corresponds to -PKRelAttributeP-.- OppositeTerm-. |
ARCCore.IP.TrySetPP | ARCCore | ClassMember | SetPP = set property of property. Sets property of entity contained within this class. |
ARCQuery.ForeignKey+ForeignKeySingleStep | ARCQuery | Class | Describes how to traverse between related entities. |
ARCCore.IP.GetKeysEqualToValue | ARCCore | ClassMember | Returns properties which themselves again have key and value equal to the given key and value. |
ARCQuery.ForeignKey+ForeignKeySingleStep.ForeignEntitiesCollection | ARCQuery | ClassMember | The collection containing all the (foreign) entities for the type that this step leads to |
ARCCore.IP.OnTrySetP | ARCCore | ClassMember | Event handler to be called by -TrySetP- before it changes a property value (but AFTER it has done any validity checks, that is, after it has 'decided' to return TRUE, in other words, event handler should be called when change is guaranteed to go through, but before it actually has been done). |
ARCQuery.QueryExpressionSelfCreate+ISelfCreateCollection | ARCQuery | Class | Provides a standardized mechanism for describing classes that are able to autogenerate collection of themeselves. |
ARCCore.IP.TryGetP | ARCCore | ClassMember | Gets a single property for this object |
ARCQuery.ForeignKeyDirection | ARCQuery | Enum | Describes the type of traversing to a foreign entity possible. |
ARCCore.IP.ToPropertyStream | ARCCore | ClassMember | Turns object into a -PropertyStream- |
ARCQuery.ForeignKeyDirection.ToOne | ARCQuery | EnumMember | Traverse to one entity, like traversing from OrderLine to Order (based on OrderLine containing foreign key OrderId) or Order to Customer (based on Order containing foreign key CustomerId). |
ARCCore.IP.ToJSONSerializeable | ARCCore | ClassMember | Prepares the data into a format acceptable for System.Text.Json.JsonSerializer.Serialize. |
ARCQuery.ForeignKeyDirection.ToMany | ARCQuery | EnumMember | Traverse to many entities, like traversing from Customer to Order (based on Order containing foreign key CustomerId) or Order to OrderLine (based on OrderLine containing foreign key OrderId). |
ARCCore.IP.GetValueForJSONSerializer | ARCCore | ClassMember | Practical approach to serializing of -IP- based values to JSON. |
ARCQuery.AggregationType | ARCQuery | Enum | Used by -QueryExpressionPivot- and -QueryExpressionAggregate-. |
ARCCore.IP.TrySetP | ARCCore | ClassMember | Set property regardless of whether exists or not. |
ARCQuery.AggregationType.Count | ARCQuery | EnumMember | |
ARCCore.IP.TryGetV Overload1 | ARCCore | ClassMember | The actual 'unpacking' of the object. |
ARCQuery.AggregationType.Sum | ARCQuery | EnumMember | |
ARCCore.IP.DeepCopy | ARCCore | ClassMember | Creates a deep copy of this object instance, that is, a copy with all new object instances (except for immutable objects). |
ARCQuery.RelationalOperator | ARCQuery | Enum | Relational / comparision operators. |
ARCCore.IP.AddPV Overload2 | ARCCore | ClassMember | NOTE: The different AddPV / AddP overloads should only be used if you want an assertion against the |
ARCQuery.RelationalOperator.EQ | ARCQuery | EnumMember | |
ARCCore.IP.AddPV Overload1 | ARCCore | ClassMember | Adds a property value (as a -PValue-) for this objectThrows -KeyAlreadyExistsException- when relevant. |
ARCQuery.RelationalOperator.CONTAINS | ARCQuery | EnumMember | |
ARCCore.IP.AddP | ARCCore | ClassMember | Adds a property for this object. |
ARCQuery.RelationalOperator.NEQ | ARCQuery | EnumMember | |
ARCCore.IP.AddOrUpdateP | ARCCore | ClassMember | Duplicates functionality of SetP. |
ARCQuery.RelationalOperator.NOTCONTAINS | ARCQuery | EnumMember | |
ARCCore.IP.GetOrAddPV | ARCCore | ClassMember | Gets value. If not set then value will be added |
ARCQuery.RelationalOperator.GT | ARCQuery | EnumMember | |
ARCCore.IP.GetPV | ARCCore | ClassMember | Gets a single property's value for this object. Returns default value if not successful. |
ARCQuery.RelationalOperator.LT | ARCQuery | EnumMember | |
ARCCore.IP.TryGetPV | ARCCore | ClassMember | Gets a single property's value for the given property key. |
ARCQuery.RelationalOperator.GEQ | ARCQuery | EnumMember | |
ARCCore.IP.IsValid | ARCCore | ClassMember | Note that by default all properties are 'valid' but because of -NoRealDeletion-, we must have a mechanism for invalidating properties. This property returns FALSE if property has been invalidated and timestamp for invalidation is not '0001-01-01'. |
ARCQuery.RelationalOperator.LEQ | ARCQuery | EnumMember | |
ARCCore.IP.Item | ARCCore | ClassMember | Offers string-based direct indexing. |
ARCQuery.RelationalOperator.LIKE | ARCQuery | EnumMember | Case sensitive string wildcard comparision. |
ARCCore.IP.Keys | ARCCore | ClassMember | Returns all the keys for this instance. |
ARCQuery.RelationalOperator.ILIKE | ARCQuery | EnumMember | Case insensitive string wildcard comparision. |
ARCCore.IP.Values | ARCCore | ClassMember | Returns all the values (all the properties) for this instance. |
ARCQuery.RelationalOperator.NOTLIKE | ARCQuery | EnumMember | Case sensitive string wildcard comparision. |
ARCCore.IP.Logger | ARCCore | ClassMember | Describes a logger. |
ARCQuery.RelationalOperator.NOTILIKE | ARCQuery | EnumMember | Case insensitive string wildcard comparision. |
ARCCore.IP.AllIPDerivedTypes | ARCCore | ClassMember | All relevant -IP--derived types for the whole application. |
ARCQuery.Strictness | ARCQuery | Enum | Describes level of -Strictness- when executing query. |
ARCCore.IP.AllIPDerivedTypesWithPKEnum | ARCCore | ClassMember | All relevant -IP--derived types for the whole application for which the also is defined a -PropertyKeyEnum-. |
ARCQuery.Strictness.ON | ARCQuery | EnumMember | |
ARCCore.IP.AllIPDerivedTypesWithPKEnumApplicationSpecific | ARCCore | ClassMember | All relevant -IP--derived types for the -ApplicationSpecificCode- part of the application for which also is defined a -PropertyKeyEnum-. |
ARCQuery.Strictness.OFF | ARCQuery | EnumMember | |
ARCCore.IP.AllIPDerivedEntityCollectionClassesDict | ARCCore | ClassMember | All -IP--derived types for which is found a corresponding class with name like '{EntityType}Collection' |
ARCQuery.Quantile | ARCQuery | Enum | Describes quantiles like -TERTILE- and -QUARTILE-. |
ARCCore.IP.AllIPDerivedTypesInludingGenericAndAbstract | ARCCore | ClassMember | All relevant -IP--derived types (except the interface -IP- itself) known to the application. |
ARCQuery.Quantile.MEDIAN | ARCQuery | EnumMember | Divide into two parts |
ARCCore.IP.AllIPDerivedTypesDict | ARCCore | ClassMember | Provides lookup of a type in -AllIPDerivedTypes- given its string representation. |
ARCQuery.Quantile.TERTILE | ARCQuery | EnumMember | Divide into three parts |
ARCCore.IP.AllIPDerivedTypesDictIKType | ARCCore | ClassMember | Same as -AllIPDerivedTypesDict- except that value is -IKType-, not string. |
ARCQuery.Quantile.QUARTILE | ARCQuery | EnumMember | Divide into four parts |
ARCCore.P | ARCCore | Class | 'Dummy'-class, not necessarily in use. See -PP- for more information. Created because of the concept of CorrespondingClass which is strictly enforced |
ARCQuery.Quantile.QUINTILE | ARCQuery | EnumMember | Divide into five parts |
ARCCore.P.TryGetP | ARCCore | ClassMember | Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway. |
ARCQuery.Quantile.SEXTILE | ARCQuery | EnumMember | Divide into 6 parts |
ARCCore.P.TryGetV | ARCCore | ClassMember | Note that 'normally' this method would be irrelevant for a -PRich- object because we will usually be an entity object (like 'Customer') not having an intrinsic value ourselves per se (because we will instead be containing a list of values). |
ARCQuery.Quantile.SEPTILE | ARCQuery | EnumMember | Divide into 7 parts |
ARCCore.P.ToString | ARCCore | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCQuery.Quantile.OCTILE | ARCQuery | EnumMember | Divide into 8 parts |
ARCCore.ICreated | ARCCore | Class | A dummy interface signifying that implementing class has the ability to store (in-memory) metadata -Created- |
ARCQuery.Quantile.DECILE | ARCQuery | EnumMember | Divide into 10 parts |
ARCCore.PCollection | ARCCore | Class | A class useful for storing a collection of entities (a table in RDBMS-terms) because it implements -Indexing-. |
ARCQuery.Quantile.DUODECILE | ARCQuery | EnumMember | Divide into 12 parts |
ARCCore.PCollection.TrySetPP | ARCCore | ClassMember | Replaces default interface method -TrySetPP-. |
ARCQuery.Quantile.HEXADECILE | ARCQuery | EnumMember | Divide into 16 parts |
ARCCore.PCollection.GetKeysEqualToValue | ARCCore | ClassMember | Returns properties which themselves again have key and value equal to the given key and value. |
ARCQuery.Quantile.VENTILE | ARCQuery | EnumMember | Divide into 20 parts |
ARCCore.PCollection.TryGetP | ARCCore | ClassMember | Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway. |
ARCQuery.Quantile.PERCENTILE | ARCQuery | EnumMember | Divide into 100 parts |
ARCCore.PCollection.TryGetV | ARCCore | ClassMember | Note that 'normally' this method would be irrelevant for a -PRich- object because we will usually be an entity object (like 'Customer') not having an intrinsic value ourselves per se (because we will instead be containing a list of values). |
ARCQuery.Quantile.PERMILLE | ARCQuery | EnumMember | Divide into 1000 parts |
ARCCore.PCollection.ToString | ARCCore | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCQuery.QueryProgressP | ARCQuery | Enum | Describes class -QueryProgress-. |
ARCCore.IGetKeysEqualToValue | ARCCore | Class | Interface stating that implementing class does not use the default implementation of -GetKeysEqualToValue- (which does not use -Indexing-) but has replaced it with a more efficient implementation assumed to utilize -Indexing-. |
ARCQuery.QueryProgressP.Title | ARCQuery | EnumMember | The title to be used in the final presentation of the query result. |
ARCCore.PConcurrent | ARCCore | Class | A (somewhat) thread-safe alternative to -PRich- which also supports -ExposingApplicationState- (through -Logger-). |
ARCQuery.QueryProgressP.Queries | ARCQuery | EnumMember | |
ARCCore.PConcurrent.ToString | ARCCore | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCQuery.QueryProgressP.StrCurrentType | ARCQuery | EnumMember | Normally the -ToStringVeryShort- representation of the type of objects in the -Result- collection. |
ARCCore.PExact<TEnumType> | ARCCore | Class | Very -MemoryConsumption- efficient alternative to -PRich-. |
ARCQuery.QueryProgressP.CurrentStrictness | ARCQuery | EnumMember | Describes -Strictness- ON / OFF when executing query. |
ARCCore.PExact<TEnumType>.SetPVDirect | ARCCore | ClassMember | High performance alternative to -TrySetP-, accessing -Storage- more direct. |
ARCQuery.QueryProgressP.CreateHints | ARCQuery | EnumMember | Describes if hints are to be generated (as query progresses) for new queries. |
ARCCore.PExact<TEnumType>.GetPVDirect | ARCCore | ClassMember | High performance alternative to -TryGetP-, accessing -Storage- more direct. |
ARCQuery.QueryProgressP.UseCache | ARCQuery | EnumMember | Describes if cache is to be used or not. |
ARCCore.PExact<TEnumType>.TryGetPVDirect | ARCCore | ClassMember | High performance alternative to -TryGetP-, accessing -Storage- more direct. |
ARCQuery.QueryProgressP.LinkAdjustment | ARCQuery | EnumMember | Experimental: Adjustment to be done by -QueryProgress-.- ToHTMLSimpleSingle- (when it ascertains how to go back to root level). |
ARCCore.PExact<TEnumType>.ToString | ARCCore | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCQuery.QueryProgressP.Limit | ARCQuery | EnumMember | Limits the final HTML presentation of results (limits the number of elements being presented). Does not affect the query in itself. Used in order to avoid building huge HTML pages which will not be consumed anyway. |
ARCCore.PExact<TEnumType>..ctor | ARCCore | ClassMember | Set capacity to the number of members in the -PropertyKeyEnum- for this class (minus the __invalid-value) |
ARCQuery.QueryProgressP.TerminateReason | ARCQuery | EnumMember | The reason for a query being terminated. This property should contain a user friendly message about the problem and how to fix it. |
ARCCore.PExact<TEnumType>.Storage | ARCCore | ClassMember | Uses int-value of -__enum- minus 1 as index. |
ARCQuery.QueryProgressP.AllLogEntriesForThisQuery | ARCQuery | EnumMember | |
ARCCore.PII | ARCCore | Class | PII = property for storing individual items. |
ARCQuery.TranslationsP | ARCQuery | Enum | This enum has no values because the keys are the actual string to be translated. |
ARCCore.PII.TryGetV | ARCCore | ClassMember | Since value is stored in keys, we need to override this method. |
ARCQuery.TranslationSingleP | ARCQuery | Enum | Describes class -TranslationSingle-. |
ARCCore.PII.TryGetP | ARCCore | ClassMember | Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway. |
ARCQuery.TranslationSingleP.Text | ARCQuery | EnumMember | |
ARCCore.PII.ToString | ARCCore | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCQuery.TranslationSingleP.IsMissing | ARCQuery | EnumMember | Value TRUE indicates that the Text given is simply the original key, in other words, the translation for the key is actually missing. |
ARCCore.IPII | ARCCore | Class | Future expansion, using different classes for storing, not only -PII-. |
ARCQuery.EntityMethodKey+MethodType | ARCQuery | Enum | Explains type of method signature found (trough reflection) for corresponding entity class. |
ARCCore.IIKII | ARCCore | Class | Related to -PII-, property for storing individual items |
ARCQuery.EntityMethodKey+MethodType.Simple | ARCQuery | EnumMember | Signature like 'bool TryGet{KeyName}(out IP retval, out string errorResponse)' |
ARCCore.IIKII.PackParseResultForStorageInIKII | ARCCore | ClassMember | This method corresponds to -PackParseResultForStorageInEntityObject-. |
ARCQuery.EntityMethodKey+MethodType.Complex | ARCQuery | EnumMember | Signature like 'bool TryGet{KeyName}(IP dataStorage, IK thisKey, out IP retval, out string errorResponse)' |
ARCCore.IIKII.PackObjectForStorageInIKII | ARCCore | ClassMember | This method corresponds to -PackObjectForStorageInEntityObject-. |
ARCQuery.QueryExpressionWhere+WildcardPositionType | ARCQuery | Enum | Position of wildcard in value, like '*ABC' (-AtStart-), 'ABC*' (-AtEnd-) and |
ARCCore.PReadOnly | ARCCore | Class | Experimental (from Feb 2022) class suitable for classes that do not need to be deserialized, or to accept write requests through -PropertyAccess-. |
ARCQuery.QueryExpressionWhere+WildcardPositionType.AtStart | ARCQuery | EnumMember | Example: '*ABC'. |
ARCCore.PRich | ARCCore | Class | Fully flexible storage. Can store anything. Typical inherited for entity representations like 'Customer' or 'Order'. |
ARCQuery.QueryExpressionWhere+WildcardPositionType.AtEnd | ARCQuery | EnumMember | Example: 'ABC*'. |
ARCCore.PRich.TryGetP | ARCCore | ClassMember | Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway. |
ARCQuery.QueryExpressionWhere+WildcardPositionType.AtStartAndEnd | ARCQuery | EnumMember | Example: '*ABC*'. |
ARCCore.PRich.TryGetV | ARCCore | ClassMember | Note that 'normally' this method would be irrelevant for a -PRich- object because we will usually be an entity object (like 'Customer') not having an intrinsic value ourselves per se (because we will instead be containing a list of values). |
ARCQuery.QueryExpressionWhere+ValueEnum | ARCQuery | Enum | Helper enum used internally by -QueryExpressionWhere- in order to represent queries like WHERE Name = NULL, WHERE Name = NOTNULL and WHERE Name = * (ALL). |
ARCCore.PRich.ToString | ARCCore | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCQuery.QueryExpressionWhere+ValueEnum.NULL | ARCQuery | EnumMember | |
ARCCore.PValue<T> | ARCCore | Class | Single value storage. |
ARCQuery.QueryExpressionWhere+ValueEnum.NOTNULL | ARCQuery | EnumMember | Practical value enabling suggestions from -GetPrevious- and -GetNext-. |
ARCCore.PValue<T>.TrySetP | ARCCore | ClassMember | NOTE: -TryStore- is explicit aware that -PValue- and -PValueEmpty- |
ARCQuery.QueryExpressionWhere+ValueEnum.ALL | ARCQuery | EnumMember | Equivalent to query like WHERE Name = * |
ARCCore.PValue<T>.TryGetV | ARCCore | ClassMember | Supports duck typing. |
ARCQuery.ValueComparerDateTime+ResolutionEnum | ARCQuery | Enum | |
ARCCore.PValue<T>.ConvertObjectToString | ARCCore | ClassMember | Converts object to string. |
ARCQuery.ValueComparerDateTime+ResolutionEnum.Second | ARCQuery | EnumMember | |
ARCCore.PValue<T>.ToString | ARCCore | ClassMember | Do no cache this value, because memory consumption would then increase significantly in your applicationj |
ARCQuery.ValueComparerDateTime+ResolutionEnum.Minute | ARCQuery | EnumMember | |
ARCCore.PValue<T>.DeepCopy | ARCCore | ClassMember | Note that if the generic type (T) is not immutable, then what we return will not be a truly deep copy. |
ARCQuery.ValueComparerDateTime+ResolutionEnum.Hour | ARCQuery | EnumMember | |
ARCCore.PValue<T>..ctor | ARCCore | ClassMember | Note how this class does not have a parameter-less constructor (unlike all other -IP--derived classes in AgoRapide) |
ARCQuery.ValueComparerDateTime+ResolutionEnum.Day | ARCQuery | EnumMember | |
ARCCore.PValueEmpty | ARCCore | Class | Represents the 'no value'. |
ARCQuery.ValueComparerDateTime+ResolutionEnum.Week | ARCQuery | EnumMember | |
ARCCore.PValueEmpty.TrySetP | ARCCore | ClassMember | NOTE: -TryStore- is explicit aware that -PValue- and -PValueEmpty- |
ARCQuery.ValueComparerDateTime+ResolutionEnum.Month | ARCQuery | EnumMember | |
ARCCore.PValueEmpty.ToPropertyStream | ARCCore | ClassMember | Typicall return value could be something like |
ARCQuery.ValueComparerDateTime+ResolutionEnum.Quarter | ARCQuery | EnumMember | |
ARCCore.ActualConnection | ARCCore | Class | The actual connection, its internal state, queue for sending and so on. |
ARCQuery.ValueComparerDateTime+ResolutionEnum.Year | ARCQuery | EnumMember | |
ARCCore.ActualConnection.SetMyUpdatePositionGenerator | ARCCore | ClassMember | Set by -StreamProcessor-. |
Assembly ARCAPI | Assembly | A library providing an API on top of the -PropertyStream-. | |
ARCCore.ActualConnection.SetSinglePropertyStreamReceiver | ARCCore | ClassMember | Set by -StreamProcessor-. |
ARCAPI.ContentResult | ARCAPI | Class | Mimicks Microsoft.AspNetCore.Mvc.ContentResult. |
ARCCore.ActualConnection.SetUpToDatePositionGenerator | ARCCore | ClassMember | Set by -StreamProcessor-. Not used by -Client-. |
ARCAPI.ContentResult.CreateHTMLOK | ARCAPI | ClassMember | NOTE: Parameter must be a complete HTML page. |
ARCCore.ActualConnection.InitializeOutgoingConnection | ARCCore | ClassMember | Relevant for -Outgoing-. |
ARCAPI.ContentResult.CreateError | ARCAPI | ClassMember | TODO: Add a key / value format for error messages, like done for -Log-. |
ARCCore.ActualConnection.Communicate | ARCCore | ClassMember | Common for both -Incoming- and -Outgoing-. |
ARCAPI.AddController | ARCAPI | Class | Parses and stores a -PropertyStreamLine-. |
ARCCore.ActualConnection.LogAndSendErrorConditionData | ARCCore | ClassMember | Called when a serious error condition has been discovered and connection should be terminated. |
ARCAPI.AddController.APIMethod | ARCAPI | ClassMember | The (only) API method that this controller supports. |
ARCCore.ActualConnection.Send | ARCCore | ClassMember | Sends all messages in queue. |
ARCAPI.AddController.ToString | ARCAPI | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCCore.ActualConnection.ToString | ARCCore | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCAPI.AddController.AllowFilter | ARCAPI | ClassMember | Describes what data is allowed to change through a list of -Subscription- instances. |
ARCCore.ActualConnection..ctor | ARCCore | ClassMember | Note parameter-less constructor as desired for all classes inheriting -IP-. |
ARCAPI.BaseController | ARCAPI | Class | Contains basic functionality for serving API methods. |
ARCCore.MonkeyWrench | ARCCore | Class | Describes level of 'spanner-throwing' this connection shall contibute with |
ARCAPI.BaseController.BuildControllerStorage | ARCAPI | ClassMember | Builds a collection of 'std' (standard) controller instances to use for serving API requests. |
ARCCore.ClientUpdatePosition | ARCCore | Class | Describes from WHERE (from WHEN) in the historic -PropertyStream- new data is to be returned. |
ARCAPI.BaseController.APIMethod | ARCAPI | ClassMember | The (only) API method that this controller supports. |
ARCCore.ClientUpdatePosition.Filename | ARCCore | ClassMember | Filename like '2020-04-03 08:42:22_R001' |
ARCAPI.BaseController.CatchAll | ARCAPI | ClassMember | Serves the typical single generic API method in an AgoRapide API. |
ARCCore.ClientUpdatePosition.Index | ARCCore | ClassMember | Index (zero-based) into file. Value of -1 means blank update status / no data received at all (or no data received for this specific filename) |
ARCAPI.BaseController.TryNavigateToLevelInDataStorage | ARCAPI | ClassMember | Navigates to the specified level (usually within -Storage-). |
ARCCore.ClientUpdatePosition.ClientDatastoreIsEmpty | ARCCore | ClassMember | Used by the subscribing client to signify that it has no data stored locally, and it therefore needs an update from the beginning of the -PropertyStream-, that is, 'from the beginning of time'. |
ARCAPI.BaseController.GetFormatAndAdjustRequest | ARCAPI | ClassMember | Decides -ResponseFormat- (like HTML, JSON, CSV, PDF and so on). |
ARCCore.ClientUpdatePosition.OnlyNewDataIsRequested | ARCCore | ClassMember | Used by the subscribing client to signify that it does not care about historical data, the server may start with sending only new data. |
ARCAPI.BaseController.GetTimestampIsOldWarningHTML | ARCAPI | ClassMember | If -TimestampIsOld- is found in the rootStorage-parameter, returns warning message in HTML format. |
ARCCore.ClientUpdatePosition.IsGoBack | ARCCore | ClassMember | Has to be translated by -StreamProcessor- into a concrete filename / index. |
ARCAPI.BaseController.ToString | ARCAPI | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCCore.ClientUpdatePosition.IsAtEndOfStream | ARCCore | ClassMember | Necessary in order to implement -AdHocQuery-. |
ARCAPI.EditController | ARCAPI | Class | Offers a simple HTML editing environment of the raw -PropertyStream- from the given key. |
ARCCore.ClientUpdatePosition.ClientDatastoreIsEmptyInstance | ARCCore | ClassMember | See also -ClientDatastoreIsEmpty. |
ARCAPI.EditController.APIMethod | ARCAPI | ClassMember | The (only) API method that this controller supports. |
ARCCore.ClientUpdatePosition.OnlyNewDataIsRequestedInstance | ARCCore | ClassMember | See also -OnlyNewDataIsRequested. |
ARCAPI.EditController.ToString | ARCAPI | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCCore.ConnectionInstruction | ARCCore | Class | The instruction about what connections to make (host, portnr, data transfer direction and so on). |
ARCAPI.GQController | ARCAPI | Class | Offers GraphQL queries. |
ARCCore.ConnectionInstruction.Initialize | ARCCore | ClassMember | Initializes to sane values. |
ARCAPI.GQController.APIMethod | ARCAPI | ClassMember | The (only) API method that this controller supports. |
ARCCore.ConnectionInstruction.TryGetP | ARCCore | ClassMember | Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway. |
ARCAPI.GQController.ToString | ARCAPI | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCCore.ConnectionInstruction.TryGetV | ARCCore | ClassMember | Note that 'normally' this method would be irrelevant for a -PRich- object because we will usually be an entity object (like 'Customer') not having an intrinsic value ourselves per se (because we will instead be containing a list of values). |
ARCAPI.RQController | ARCAPI | Class | RQ = REST Query. Executes a REST like query request against the given -DataStorage-. |
ARCCore.ConnectionInstruction.ToString | ARCCore | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCAPI.RQController.APIMethod | ARCAPI | ClassMember | The (only) API method that this controller supports. |
ARCCore.Sharding | ARCCore | Class | Enables load-balancing by describing what data should be sent over a given connection. |
ARCAPI.RQController.ToString | ARCAPI | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCCore.PropertyStreamLine | ARCCore | Class | Has two main functions: |
ARCAPI.DataStorage | ARCAPI | Class | The all-in-memory global application data storage. |
ARCCore.PropertyStreamLine.EncodeKeys | ARCCore | ClassMember | Encodes the key part of a -PropertyStreamLine-. |
ARCAPI.DataStorage.Create | ARCAPI | ClassMember | Creates a -DataStorage- instance with default parameters. |
ARCCore.PropertyStreamLine.EncodeValues | ARCCore | ClassMember | Typically used when turning -WholeCollection- into a value part of a -PropertyStreamLine-. |
ARCAPI.DataStorage..ctor | ARCAPI | ClassMember | This method will: |
ARCCore.PropertyStreamLine.EncodeKeyPart | ARCCore | ClassMember | Converts a single key part of a -PropertyStreamLine- to a format suitable for sending over a -PropertyStream-. |
ARCAPI.DataStorage.Storage | ARCAPI | ClassMember | The actual storage. |
ARCCore.PropertyStreamLine.EncodeValuePart | ARCCore | ClassMember | Converts a single value part of a -PropertyStreamLine- to a format suitable for sending over a -PropertyStream-. |
ARCAPI.DataStorage.ControllerStorage | ARCAPI | ClassMember | Usually (but not always) a branch of -Storage- (like Storage["log"]["{nodeId}"]["Controller"]). |
ARCCore.PropertyStreamLine.Decode | ARCCore | ClassMember | Decodes string as encoded by -EncodeKeyPart- or -EncodeValuePart-. |
ARCAPI.DataStorage.DocLinks | ARCAPI | ClassMember | Note that may be null. |
ARCCore.PropertyStreamLine.TryParseDirectToIP | ARCCore | ClassMember | Parses a series of -PropertyStreamLine- directly to the given type of -IP-. |
ARCAPI.DataStorage.Lock | ARCAPI | ClassMember | Locking object for thread-safe access from simultaneous API requests. |
ARCCore.PropertyStreamLine.TryParseDirectToProperty | ARCCore | ClassMember | Parses direct to a given property value. |
ARCAPI.DataStorage.ExternalReceiver | ARCAPI | ClassMember | Typically used by -AddController-. |
ARCCore.PropertyStreamLine.ParseAndStore | ARCCore | ClassMember | Note that throws exception if -TryParseAndStore- fails. |
ARCAPI.DataStorage.DoNotStoreInternally | ARCAPI | ClassMember | Typically used by -AddController-. |
ARCCore.PropertyStreamLine.ParseAndStoreFailSafe | ARCCore | ClassMember | If either parsing or storing fails then this method will call -StoreFailure- in order to keep some track of why parsing or storing failed. |
ARCAPI.BaseControllerP | ARCAPI | Enum | Describes class -BaseController-. |
ARCCore.PropertyStreamLine.StoreFailSafe | ARCCore | ClassMember | Stores if possible and fails silently. |
ARCAPI.BaseControllerP.CountRequest | ARCAPI | EnumMember | Number of calls to -APIMethod- since application initialization |
ARCCore.PropertyStreamLine.StoreFailure | ARCCore | ClassMember | Stores a 'ParseOrStoreFailure'-object. |
ARCAPI.BaseControllerP.CountException | ARCAPI | EnumMember | Number of exceptions at call to -APIMethod- since application initialization |
ARCCore.PropertyStreamLine.TryStore | ARCCore | ClassMember | Stores the given -PropertyStreamLineParsed- in the given storage object. |
ARCAPI.BaseControllerP.LogLevel | ARCAPI | EnumMember | |
ARCCore.PropertyStreamLine.AllowedKeyChars | ARCCore | ClassMember | Allowed characters in the Key-part of a -PropertyStreamLine-. |
ARCAPI.ResponseFormat | ARCAPI | Enum | The response format, HTML or JSON, for an API request. |
ARCCore.PropertyStreamLine.AllowedValueChars | ARCCore | ClassMember | Allowed characters in the Value-part of a -PropertyStreamLine-. |
ARCAPI.ResponseFormat.JSON | ARCAPI | EnumMember |
Generated 2025-07-12 05:09:26.065 UTC