[ROOT] doc DocFrag SELECT Assembly, DocFragType, Description.FirstLine() < SKIP 199 > < TAKE 496 >
496 items
| DocFragId | Assembly | DocFragType | Description.FirstLine() |
|---|---|---|---|
| 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'. |
| ARCCore.PKTypeAttribute.StandardCleaner | ARCCore | ClassMember | Returns a cleaner for well known types like bool |
| ARCCore.StreamProcessor.ReadStorageFile | ARCCore | ClassMember | Reads one storage file from disk |
| ARCCore.PropertyStreamLine.StoreFailSafe | ARCCore | ClassMember | Stores if possible and fails silently. |
| ARCCore.PKTypeAttribute.IsObligatory | ARCCore | ClassMember | See -IsObligatory-. |
| ARCCore.StreamProcessor.ToString | ARCCore | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCCore.PropertyStreamLine.StoreFailure | ARCCore | ClassMember | Stores a 'ParseOrStoreFailure'-object. |
| 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.) |
| ARCCore.StreamProcessor.OutsideLocalReceiver | ARCCore | ClassMember | The outside (in the sense outside of this class) local mechanism which receives all -PropertyStreamLine- registered by this class. |
| ARCCore.PropertyStreamLine.TryStore | ARCCore | ClassMember | Stores the given -PropertyStreamLineParsed- in the given storage object. |
| ARCCore.IP | ARCCore | Class | IP = IProperty. |
| ARCCore.PropertyStreamLineWithOrigin | ARCCore | Class | The rationale for this class is that -ReceiveAndDistribute- needs to distingush origin of data when routing it (in general, in order to avoid sending it back to its source). |
| ARCCore.PropertyStreamLine.AllowedKeyChars | ARCCore | ClassMember | Allowed characters in the Key-part of a -PropertyStreamLine-. |
| ARCCore.IP.TryGetV Overload2 | ARCCore | ClassMember | The actual value of the property. Mostly relevant for single-value properties like -PValue-. |
| ARCCore.PropertyStreamLineWithOrigin.HasLocalOrigin | ARCCore | ClassMember | Locally generated data is not to be sent to -OutsideLocalReceiver-). We instead leave it to the 'outside' to decide if |
| ARCCore.PropertyStreamLine.AllowedValueChars | ARCCore | ClassMember | Allowed characters in the Value-part of a -PropertyStreamLine-. |
| ARCCore.IP.GetKeysEqualToValue | ARCCore | ClassMember | Returns properties which themselves again have key and value equal to the given key and value. |
| ARCCore.PropertyStreamLineWithOrigin.SendToLocalReceiver | ARCCore | ClassMember | Means 'send to local receiver regardless of origin'. |
| ARCCore.PropertyStreamLineParsed | ARCCore | Class | Parses the keys part of a line from -PropertyStream-, like 'Customer/42/FirstName = John. |
| 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). |
| ARCCore.PropertyStreamLineWithOrigin.DoNotAddTimestamp | ARCCore | ClassMember | Normally -StreamProcessor- inserts the required -Timestamp-s in the AgoRapide storage. |
| ARCCore.PropertyStreamLineParsed.ToString | ARCCore | ClassMember | Note relatively complex operation of 'restoring' original property stream line. |
| ARCCore.IP.TryGetP Overload1 | ARCCore | ClassMember | Gets a single property for this object |
| ARCCore.PropertyStreamLineWithOrigin.ReceivedFromOutgoing | ARCCore | ClassMember | Data received from an outgoing connection, that is, data received based on 'this' application's subscription request (as subscribing client). |
| ARCCore.PropertyStreamLineParsed.TryParse | ARCCore | ClassMember | Generate list of <(IK key, Type valueType)> together with value from value part. |
| ARCCore.IP.ToPropertyStream | ARCCore | ClassMember | Turns object into a -PropertyStream- |
| ARCCore.UtilCore.TryGetTypeFromStringFromCache | ARCCore | ClassMember | Corresponding method for creating string-representation of type is -ToStringDB-. |
| ARCCore.StorageFile.ToString | ARCCore | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCCore.IP.TryGetPV | ARCCore | ClassMember | Gets a single property's value for the given property key. |
| ARCCore.UtilCore.GetExceptionChainAsString | ARCCore | ClassMember | Follows the chain of InnerException and returns types as comma-separated string |
| ARCCore.Subscription | ARCCore | Class | A stream -Subscription- is the concept of how nodes (see -ARNodeType-) subscribe to the -PropertyStream- (either the whole stream or just part of it) in a distributed manner. |
| ARCCore.IP.EnumeratorReturnsEmptyCollection | ARCCore | ClassMember | Hint for how to avoid calling enumerator.Count() when all you need is to decide if collection is empty or not. |
| ARCCore.UtilCore.GetExeptionDetails | ARCCore | ClassMember | Gives as much information about exception as possible. |
| ARCCore.Subscription.FromTime | ARCCore | ClassMember | TODO: Implement concept of specifying starting-point in TIME (often for an -AdHocQuery-?). |
| 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'. |
| ARCCore.UtilCore.DateTimeTryParse | ARCCore | ClassMember | Accepts on of the formats specified in -ValidDateTimeFormats-. |
| ARCCore.Subscription.ToTime | ARCCore | ClassMember | TODO: Implement concept of specifying ending-point in TIME (often for an -AdHocQuery-?). |
| ARCCore.IP.Item | ARCCore | ClassMember | Offers string-based direct indexing. |
| ARCCore.UtilCore.TimeSpanTryParse | ARCCore | ClassMember | Accepts on of the formats specified in -ValidDateTimeFormats-. |
| ARCCore.Subscription.IsMatch Overload1 | ARCCore | ClassMember | Evaluates a query consisting of multiple instances of -Subscription- against a single property stream line. |
| ARCCore.PConcurrent | ARCCore | Class | A (somewhat) thread-safe alternative to -PRich- which also supports -ExposingApplicationState- (through -Logger-). |
| ARCCore.UtilCore.UseLocalTimeInsteadOfUTC | ARCCore | ClassMember | By default AgoRapide operates only with UTC time. |
| ARCCore.Subscription.IsMatch Overload2 | ARCCore | ClassMember | Evaluates this instance of -Subscription- against a single property stream line (which has been split up into its constituent elements). |
| ARCCore.PConcurrent.ToString | ARCCore | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCCore.UtilCore.DateTimeNow | ARCCore | ClassMember | Returns DateTime.UtcNow unless -UseLocalTimeInsteadOfUTC- has been set to TRUE in which case DateTime.Now is returned. |
| ARCCore.Subscription.SyntaxHelp | ARCCore | ClassMember | '+*' Subscribe to everything in database. |
| ARCCore.PExact<EnumType> | ARCCore | Class | Very -MemoryConsumption- efficient alternative to -PRich-. |
| ARCCore.UtilCore.CurrentlyStartingUp | ARCCore | ClassMember | Called once at application startup after all Attribute instances in the C# code has been processed. |
| ARCCore.Subscription.IsAdd | ARCCore | ClassMember | Corresponds to whether value starts with a plus sign, '+' or not. |
| ARCCore.PExact<EnumType>..ctor | ARCCore | ClassMember | Set capacity to the number of members in the -PropertyKeyEnum- for this class (minus the __invalid-value) |
| ARCCore.StreamProcessor+StorageFile.Length | ARCCore | ClassMember | Wrongly placed. Belongs to each individual revision file. |
| ARCCore.UtilCore.ValidDateTimeFormats | ARCCore | ClassMember | 'yyyy-MM-dd HH:mm:ss.fff', 'yyyy-MM-dd HH:mm:ss', 'yyyy-MM-dd HH:mm', 'yyyy-MM-dd' |
| ARCCore.PExact<EnumType>.Storage | ARCCore | ClassMember | Uses int-value of -__enum- minus 1 as index. |
| ARCCore.StreamProcessor+StorageFile.Properties | ARCCore | ClassMember | Key = revision number of file (due to compression / -DataRetention-), like R00001, R00002 and so on. |
| ARCCore.UtilCore.ValidTimeSpanFormats | ARCCore | ClassMember | 'hh\:mm', 'hh\:mm\:ss', 'd\.hh\:mm\:ss', 'hh\:mm\:ss\.fff' // Milliseconds,'d\.hh\:mm\:ss\.fff' |
| ARCCore.PII | ARCCore | Class | PII = property for storing individual items. |
| ARCCore.BaseAttributeP | ARCCore | Enum | Describes class -BaseAttribute-. |
| ARCCore.REx | ARCCore | Class | REx = 'TooDeepRecursiveDepthException' |
| ARCCore.PII.TryGetV | ARCCore | ClassMember | Since value is stored in keys, we need to override this method. |
| ARCCore.BaseAttributeP.Description | ARCCore | EnumMember | The description for the attribute, like this description |
| ARCCore.REx.Inc | ARCCore | ClassMember | Increases recursive count. |
| ARCCore.PII.ToString | ARCCore | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCCore.BaseAttributeP.LongDescription | ARCCore | EnumMember | The long (detailed) description for the attribute. |
| ARCCore.REx.Dec | ARCCore | ClassMember | This method should be called from inside a 'finally' block, in order to secure its execution, if not your static recursion depth counter could slowly increase over time due to exceptions ocurring after call to -Inc- but before call to -Dec-. |
| ARCCore.IPII | ARCCore | Class | Future expansion, using different classes for storing, not only -PII-. |
| ARCCore.ClassAttributeP | ARCCore | Enum | Describes class -ClassAttribute-. |
| ARCCore.InvalidTypeException | ARCCore | Class | |
| ARCCore.IIKII | ARCCore | Class | Related to -PII-, property for storing individual items |
| ARCCore.ClassAttributeP.AssemblyName | ARCCore | EnumMember | The assembly in which this class resides. |
| ARCCore.InvalidTypeException.AssertAssignable | ARCCore | ClassMember | Asserts that expectedType.IsAssignableFrom(foundType) |
| ARCCore.IIKII.PackParseResultForStorageInIKII | ARCCore | ClassMember | This method corresponds to -PackParseResultForStorageInEntityObject-. |
| ARCCore.ClassAttributeP.ClassNamespace | ARCCore | EnumMember | The namespace for -ClassType-. |
| ARCCore.InvalidTypeException.AssertEquals | ARCCore | ClassMember | Asserts that expectedType.Equals(foundType) |
| ARCCore.IIKII.PackObjectForStorageInIKII | ARCCore | ClassMember | This method corresponds to -PackObjectForStorageInEntityObject-. |
| ARCCore.EnumAttributeP.AssemblyName | ARCCore | EnumMember | The assembly in which this class resides. |
| ARCCore.ClassAttributeP.ClassType | ARCCore | EnumMember | The actual type that we are a -ClassAttribute- for |
| ARCCore.ActualConnection.SetUpToDatePositionGenerator | ARCCore | ClassMember | Set by -StreamProcessor-. Not used by -Client-. |
| ARCCore.EnumAttributeP.EnumNamespace | ARCCore | EnumMember | The namespace for -EnumType-. |
| ARCCore.ClassAttributeP.BaseTypes | ARCCore | EnumMember | The inheritance hierarchy for this class, starting with base type (excluding 'object').r Not set if class does not inherit any class except 'object' |
| ARCCore.ActualConnection.InitializeOutgoingConnection | ARCCore | ClassMember | Relevant for -Outgoing-. |
| ARCCore.EnumAttributeP.EnumType | ARCCore | EnumMember | The type of the enum (like type of 'CustomerP' in CustomerP.FirstName) that we are an attribute for |
| ARCCore.ClassAttributeP.SubTypes | ARCCore | EnumMember | Direct and indirect sub types of this class. |
| ARCCore.ActualConnection.Communicate | ARCCore | ClassMember | Common for both -Incoming- and -Outgoing-. |
| ARCCore.EnumAttributeP.AREnumType | ARCCore | EnumMember | Note that will default to -__invalid- if not explicit set. |
| ARCCore.ClassAttributeP.Interfaces | ARCCore | EnumMember | All interfaces that this class and its base classes implement |
| ARCCore.ActualConnection.LogAndSendErrorConditionData | ARCCore | ClassMember | Called when a serious error condition has been discovered and connection should be terminated. |
| ARCCore.EnumAttributeP.CorrespondingClass | ARCCore | EnumMember | Only relevant when -PropertyKeyEnum-. |
| ARCCore.ClassAttributeP.InterfacesDirectlyImplemented | ARCCore | EnumMember | All interfaces that this class directly implements. |
| 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. |
| ARCCore.EnumMemberAttributeP | ARCCore | Enum | Describes class -EnumMemberAttribute-. |
| ARCCore.ClassAttributeP.CorrespondingEnumType | ARCCore | EnumMember | Only relevant when implements -IP-. |
| ARCCore.ClientUpdatePosition.IsGoBack | ARCCore | ClassMember | Has to be translated by -StreamProcessor- into a concrete filename / index. |
| ARCCore.EnumMemberAttributeP.EnumType | ARCCore | EnumMember | The type of the enum (like type of 'CustomerP' in CustomerP.FirstName) that we are an attribute for |
| ARCCore.ClassAttributeP.BoilerplateCodePropertiesAndStorage | ARCCore | EnumMember | Only relevant when implements -IP- and when a -CorrespondingEnumType- is found. |
| ARCCore.ClientUpdatePosition.IsAtEndOfStream | ARCCore | ClassMember | Necessary in order to implement -AdHocQuery-. |
| ARCCore.EnumMemberAttributeP.EnumMember | ARCCore | EnumMember | The actual enum member / enum value (like 'Firstname' in CustomerP.FirstName) that we are an attribute for |
| ARCCore.ClassMemberAttributeP | ARCCore | Enum | Describes class -ClassMemberAttribute-. |
| ARCCore.ClientUpdatePosition.ClientDatastoreIsEmptyInstance | ARCCore | ClassMember | See also -ClientDatastoreIsEmpty. |
| ARCCore.ARConcepts.DataRetention | ARCCore | EnumMember | The concept of when to delete old data (if deemed necessary). |
| ARCCore.ARComponents.ARCAPI | ARCCore | EnumMember | A library providing an API on top of the -PropertyStream-. |
| ARCCore.PropertyStreamLine.EncodeValues | ARCCore | ClassMember | Typically used when turning -WholeCollection- into a value part of a -PropertyStreamLine-. |
| ARCCore.ARConcepts.NoRealDeletion | ARCCore | EnumMember | AgoRapide has no real concept for deletion of data (apart from -DataRetention-, which is mostly relevant for 'old' data). |
| ARCCore.ARComponents.ARAAPI | ARCCore | EnumMember | The corresponding template application for -ARCAPI- demonstrating its usage, providing an HTTP / HTTPS interface with the help of Microsoft.AspNetCore.Mvc. |
| ARCCore.PropertyStreamLine.EncodeKeyPart | ARCCore | ClassMember | Converts a single key part of a -PropertyStreamLine- to a format suitable for sending over a -PropertyStream-. |
| ARCCore.ARConcepts.ManyToManyRelations | ARCCore | EnumMember | -ARCQuery- supports many-to-many relations in a simple manner without introducing a third entity type (a third table). |
| ARCCore.ARConcepts | ARCCore | Enum | The overarching concepts upon which AgoRapide is built. |
| ARCCore.PropertyStreamLine.EncodeValuePart | ARCCore | ClassMember | Converts a single value part of a -PropertyStreamLine- to a format suitable for sending over a -PropertyStream-. |
| ARCCore.ARConcepts.Documentation | ARCCore | EnumMember | Thanks to the tagging of enums and classes in AgoRapide (like this description), automatically generation of documentation is possible. |
| ARCCore.ARConcepts.GettingStarted | ARCCore | EnumMember | AgoRapide 2020 is an open source library for building data-oriented backend applications using .NET Standard 2.1. |
| ARCCore.PropertyStreamLine.Decode | ARCCore | ClassMember | Decodes string as encoded by -EncodeKeyPart- or -EncodeValuePart-. |
| ARCCore.ARConcepts.AssertionsAndDetailedExceptionMessages | ARCCore | EnumMember | The abstraction level in AgoRapide is very high. |
| ARCCore.ARConcepts.PropertyStream | ARCCore | EnumMember | AgoRapide, the 'streams-of-water' database". |
| ARCCore.PropertyStreamLine.TryParseDirectToIP | ARCCore | ClassMember | Parses a series of -PropertyStreamLine- directly to the given type of -IP-. |
| ARCCore.ARConcepts.ExposingApplicationState | ARCCore | EnumMember | The traditional debugging process usually entails reading through logs and querying about your application state through a debugging tool. |
| ARCCore.ARConcepts.TaggingOfPropertyKeys | ARCCore | EnumMember | The concept of specifying in a single place all relevant information about a given property (data field). |
| ARCCore.PropertyStreamLine.TryParseDirectToProperty | ARCCore | ClassMember | Parses direct to a given property value. |
| ARCCore.ARConcepts.LinkInsertionInDocumentation | ARCCore | EnumMember | Documentation with links is much easier to read. |
| ARCCore.ARConcepts.PropertyAccess | ARCCore | EnumMember | The general mechanism for accessing properties of objects in AgoRapide. |
| ARCCore.PropertyStreamLine.ParseAndStore | ARCCore | ClassMember | Note that throws exception if -TryParseAndStore- fails. |
| ARCCore.ARConcepts.TryPatternAndNull | ARCCore | EnumMember | AgoRapide uses non-nullable reference types as default throughout the system |
| ARCCore.ARConcepts.AvoidingRepetition | ARCCore | EnumMember | Avoiding repetition, the overarching philosophy that inspired the rest of AgoRapide. |
| 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. |
| ARCCore.EnumAttribute.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.) |
| ARCCore.EnumMemberAttribute.Initialize | ARCCore | ClassMember | To be overridden in sub-classes, but do note that sub-classes are supposed to call base.Initialize() at end of their own initialization. |
| ARCCore.EnumMemberAttribute.TryRemoveP | ARCCore | ClassMember | Should probably never be used. |
| ARCCore.Extensions.ToStringDB | ARCCore | ClassMember | Gives the minimum representation of type as string suitable for later reconstruction by -GetType-. |
| ARCCore.Extensions.Use | ARCCore | ClassMember | Convenience method that shortens down code in cases where an instance of an object must be created first in order to use that same variable multiple times |
| ARCCore.Extensions.GetValue | ARCCore | ClassMember | Gives better error messages when reading value from directory if key does not exist |
| ARCCore.Extensions.Single | ARCCore | ClassMember | Same as inbuilt LINQ's Single except that gives a more friendly exception message |
| ARCCore.IKIP | ARCCore | Class | Container class for key (-IK-), and value (-IP-). |
| 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 |
| ARCCore.IP.TrySetPP | ARCCore | ClassMember | SetPP = set property of property. Sets property of entity contained within this class. |
| ARCCore.StreamProcessor.ReceiveAndDistribute | ARCCore | ClassMember | Process all messages in receive queue. |
| ARCCore.StreamProcessor.AddTimestampAsRequired | ARCCore | ClassMember | Adds -Timestamp- to the property stream (to -_queueReceive-) as specified by -TimestampResolution-. |
| ARCCore.StorageFile | ARCCore | Class | Implemented only in order to store some ideas about -Hash-. |
| ARCCore.StorageFile.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). |
| ARCCore.Subscription.IsRemove | ARCCore | ClassMember | Corresponds to whether value starts with a minus sign, '+' or not. |
| ARCCore.UtilCore | ARCCore | Class | Utility methods for -ARCCore-. |
| ARCCore.UtilCore.AssertCurrentlyStartingUp | ARCCore | ClassMember | Normally called from non-thread safe methods that should be run single-threaded at application startup only. |
| ARCCore.UtilCore.DoubleTryParse | ARCCore | ClassMember | Note that treats ',' (comma) as decimal point (not as thousands separator). |
| ARCCore.UtilCore.EnumTryParse | ARCCore | ClassMember | Same as the inbuilt .NET method -TryParse- but with some additional checks. |
| ARCCore.UtilCore.TryGetTypeFromStringNoCache | ARCCore | ClassMember | See -TryGetTypeFromStringFromCache- for documentation. |
| ARCCore.UtilCore.Assemblies | ARCCore | ClassMember | All relevant assemblies for application. |
| ARCCore.UtilCore.Culture | ARCCore | ClassMember | The general culture used for parsing. |
| ARCCore.UtilCore.Culture_en_US | ARCCore | ClassMember | Used by -DoubleTryParse-. |
| ARCCore.UtilCore.DefaultAgoRapideEncoding | ARCCore | ClassMember | The standard encoding used for text (UTF8). |
| ARCCore.TValue | ARCCore | Class | Placeholder for any class type suitable as generic type parameter -PValue-. |
| ARCCore.BaseAttribute+IncorrectAttributeTypeUsedException | ARCCore | Class | Helps to clean up any confusion about which -BaseAttribute- to use in a given concept. |
| ARCCore.PK+BasePKAttributeNotFoundException<T> | ARCCore | Class | Explains how to implement a given -BasePKAttribute- for an enum |
| ARCCore.PK+PKBoolPair | ARCCore | Class | Used to signify that a given -PK- returned from value factory inside -FromEnum- has not been initialized (has not yet been populated with -PKTypeAttribute- collection). |
| ARCCore.PK+PKBoolPair.TrulyInitialized | ARCCore | ClassMember | Not used currently (May 2020). Useful for debugging purposes |
| ARCCore.StreamProcessor+StorageFile | ARCCore | Class | |
| ARCCore.StreamProcessor+StorageFile.Filepath | ARCCore | ClassMember | Complete path to file |
| ARCCore.StreamProcessor+StorageFile.Filename | ARCCore | ClassMember | Filename: Main file name, like 2020-04-03 08:42 |
| ARCCore.ClassMemberAttributeP.DeclaringType | ARCCore | EnumMember | The actual MemberInfo.DeclaringType. |
| ARCCore.ClassMemberAttributeP.MethodName | ARCCore | EnumMember | The actual MemberInfo.Name. |
| ARCCore.ClassMemberAttributeP.MethodSignature | ARCCore | EnumMember | The actual MemberInfo.ToString. |
| ARCCore.EnumAttributeP | ARCCore | Enum | Describes class -EnumAttribute-. |
| ARCCore.ARComponents | ARCCore | Enum | Contains short descriptions of the different 'official' AgoRapide components. |
| ARCCore.ARComponents.ARCCore | ARCCore | EnumMember | A necessary library (.DLL in Windows terms) that every -ARNodeType- should link to. |
| ARCCore.ARComponents.ARADB | ARCCore | EnumMember | An application constituting the full functionality of a -CoreDB- (linking to -ARCCore-). |
| ARCCore.ARComponents.ARAClient | ARCCore | EnumMember | A template application for a -Client- (linking to -ARCCore-). |
| ARCCore.ARComponents.ARCDoc | ARCCore | EnumMember | A library supporting documentation and demonstrating usage of AgoRapide. |
| ARCCore.ARComponents.ARCQuery | ARCCore | EnumMember | ARCQuery provides a query language that mimicks SQL but is usable through HTTP as GET URLs. |
| ARCCore.ARComponents.ARCSync | ARCCore | EnumMember | (Not implemented as of March 2020) |
| ARCCore.ARComponents.ARCSec | ARCCore | EnumMember | (Not implemented as of March 2020) |
| ARCCore.Cardinality | ARCCore | Enum | Describes how multiple instances of a property is supposed to be handled. |
| ARCCore.Cardinality.HistoryOnly | ARCCore | EnumMember | The default value. |
| ARCCore.Cardinality.WholeCollection | ARCCore | EnumMember | Values are always set as a whole (there is no need or no meaning in setting or deleting individual items) |
| ARCCore.Cardinality.IndividualItems | ARCCore | EnumMember | Values are supposed to be set and 'deleted' individually. |
| ARCCore.PKLogAttributeP.DoNotLogAtAll | ARCCore | EnumMember | Originates from -DoNotLogAtAll-. |
| ARCCore.PKLogAttributeP.CountInterval | ARCCore | EnumMember | For a value of n, log only every n'th time the property is changed. |
| ARCCore.PKLogAttributeP.TimeInterval | ARCCore | EnumMember | Specifies a certain time interval for which the property's value shall be sent over the -PropertyStream-. |
| ARCCore.PKRelAttributeP | ARCCore | Enum | Describes class -PKRelAttribute-. |
| ARCCore.PKRelAttributeP.ForeignEntity | ARCCore | EnumMember | The type of foreign entity that this property points to. |
| ARCCore.PKRelAttributeP.EnforceReferentialIntegrity | ARCCore | EnumMember | If TRUE then referential integrity will be enforced by -TryStore-. |
| ARCCore.PKTypeAttributeP | ARCCore | Enum | Describes class -PKTypeAttribute-. |
| ARCCore.PKTypeAttributeP.Type | ARCCore | EnumMember | The type of this Property. |
| ARCCore.PKTypeAttributeP.DefaultValue | ARCCore | EnumMember | The default value. |
| ARCCore.PKTypeAttributeP.Cardinality | ARCCore | EnumMember | Describes how multiple instances of a property is supposed to be handled. |
| ARCCore.PKTypeAttributeP.IsObligatory | ARCCore | EnumMember | True means value is obligatory. |
| ARCCore.PKTypeAttributeP.BoilerplateCodeProperties | ARCCore | EnumMember | Automatically generated boilerplate code that implements traditional setters and getters for this key. |
| ARCCore.PP | ARCCore | Enum | Describes meta data for any class (property) implementing -IP-. |
| ARCCore.PP.Created | ARCCore | EnumMember | Timestamp when property was created in database. |
| ARCCore.PP.Cid | ARCCore | EnumMember | Creator id (entity which created this property). |
| ARCCore.PP.Value | ARCCore | EnumMember | The actual value. |
| ARCCore.AREnumType | ARCCore | Enum | Categories different types of enum used in AgoRapide. The most important one is -PropertyKeyEnum-. |
| ARCCore.ARConcepts.AgoRapideHistory | ARCCore | EnumMember | AgoRapide has roots back to 2011 when Bjørn Erling Fløtten invented panSL (SL = Schema language). |
| ARCCore.ActualConnectionP.IsErrorCondition | ARCCore | EnumMember | Some kind of error condition has occured regarding data going back and forth, but the TCP/IP connection itself is probably sound. |
| ARCCore.PSPrefix | ARCCore | Enum | Describes some recommended prefixed to use in a -PropertyStreamLine-. |
| ARCCore.AREnumType.PropertyKeyEnum | |||
| ARCCore.ARConcepts.AdHocQuery | ARCCore | EnumMember | The concept of a -Client- doing an ad-hoc query against (normally) a -ArmDB-. |
| ARCCore.ActualConnectionP.ErrorConditionData | ARCCore | EnumMember | Detailed explanation about -IsErrorCondition- |
| ARCCore.PSPrefix.dt | ARCCore | EnumMember | Data, like dt/ |
| ARCCore.AREnumType.OrdinaryEnum | ARCCore | EnumMember | Designates "Ordinary" enums used for indicating range of valid values for a given key |
| ARCCore.ARConcepts.StandardAgoRapideCode | ARCCore | EnumMember | Code originating from the main official AgoRapide distribution (which therefore does not include any end-application specific code) |
| ARCCore.ActualConnectionP.UnderClosure | ARCCore | EnumMember | Set to TRUE if to be closed and reinitialized. |
| ARCCore.PSPrefix.cmd | ARCCore | EnumMember | Command, like cmd/ |
| ARCCore.AREnumType.DocumentationOnlyEnum | ARCCore | EnumMember | Designates enums that provide a central repository of explanation of terms that are not present in the C# code. |
| ARCCore.ARConcepts.ApplicationSpecificCode | ARCCore | EnumMember | Code specific for an end-application. |
| ARCCore.ActualConnectionP.MonkeyWrench | ARCCore | EnumMember | |
| ARCCore.PSPrefix.app | ARCCore | EnumMember | Application state, like app/ |
| ARCCore.ARNodeType | ARCCore | Enum | Describes what function a node in an AgoRapide system serves. A given node may constitute of only -StandardAgoRapideCode- or a combination of -StandardAgoRapideCode- and -ApplicationSpecificCode-. |
| ARCCore.ARConcepts.MemoryConsumption | ARCCore | EnumMember | A naïve implementation of key-value storages like AgoRapide may lead to excessive memory (RAM) consumption. |
| ARCCore.ActualConnectionP.PartnerIPAddress | ARCCore | EnumMember | TODO: Use more strongly typing for this. |
| ARCCore.PSPrefix.doc | ARCCore | EnumMember | Documentation, like doc/. |
| ARCCore.ARNodeType.CoreDB | ARCCore | EnumMember | A node containing the core or central database. |
| ARCCore.ARConcepts.Indexing | ARCCore | EnumMember | In-memory indexing of data is done 'behind-the-scenes' by some classes implementing -IP-. |
| ARCCore.ConnectionInstructionP | ARCCore | Enum | Describes class -ConnectionInstruction-. |
| ARCCore.PKHTMLAttributeP | ARCCore | Enum | Describes class -PKRelAttribute-. |
| ARCCore.ARNodeType.ArmDB | ARCCore | EnumMember | A node with a 'client -Subscription-' towards -CoreDB- to a (usually) subset of the entire database (acting as a cache and filtering mechanism), or with a 'client -Subscription-' towards -CoreDB- to the whole database (acting as a cache mechanism only) |
| ARCCore.ARConcepts.CoreDBSynchronization | ARCCore | EnumMember | The concept of how multiple -CoreDB- instances synchronizes their data. |
| ARCCore.ConnectionInstructionP.ClientId | ARCCore | EnumMember | The AgoRapide node-id for which this connection is relevant. Used for distributing over the -PropertyStream- information to the clients about which possible nodes they can connect to. |
| ARCCore.PKHTMLAttributeP.Encoder | ARCCore | EnumMember | The class doing the HTML-encoding. |
| ARCCore.ARNodeType.Client | ARCCore | EnumMember | An outer node / 'end' node with (usually) -ApplicationSpecificCode- but based on -ARADB-. |
| ARCCore.ARConcepts.SingleThreadedCode | ARCCore | EnumMember | Some practical choices have been made in AgoRapide which requires object access to be done in a single-threaded manner, or within a locking context (using for instance -ReaderWriterLockSlim-). |
| ARCCore.ConnectionInstructionP.ServerHostName | ARCCore | EnumMember | The host (DNS or IP-address) for which to connect. |
| ARCCore.PKLogAttributeP | ARCCore | Enum | Describes class -PKLogAttribute. |
| ARCCore.ConnectionInstructionP.ServerPortNo | ARCCore | EnumMember | The port number for which to connect. |
| ARCCore.PP.Valid | ARCCore | EnumMember | Timestamp when property was last known to be (still) valid |
| ARCCore.StreamProcessorP.IncomingConnectionsPortNo | ARCCore | EnumMember | If not set, then class will not listen for incoming connections (meaning that our application is probably a -Client-). |
| ARCDoc.DocLinkResolution.TryGetV | ARCDoc | 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). |
| ARCCore.ConnectionInstructionP.ConnectionId | ARCCore | EnumMember | Usually a combination of -ClientId-, -ServerHostName- and -ServerPortNo-. |
| ARCCore.PP.Vid | ARCCore | EnumMember | Validator id, that is entity which set -Valid- for this property. |
| ARCCore.StreamProcessorP.UnderClosure | ARCCore | EnumMember | Set to TRUE if to be closed, whenever an exception occurs or when class goes out of scope |
| ARCDoc.DocLinkResolution.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCCore.ConnectionInstructionP.DataTransferDirection | ARCCore | EnumMember | |
| ARCCore.PP.Invalid | ARCCore | EnumMember | Timestamp when property was invalidated / 'deleted'. |
| ARCCore.StreamProcessorP.WriteToConsole | ARCCore | EnumMember | If true then incoming data (from other nodes will be written to console. |
| ARCDoc.DocLinkResolutionCollection | ARCDoc | Class | Contains a collection of -DocLinkResolution- objects. |
| ARCCore.ConnectionInstructionP.Subscription | ARCCore | EnumMember | The actual subscripton. This is what the connecting party / (downstream) client would send over its TCP/IP connection to the (upstream) server. |
| ARCCore.PP.Iid | ARCCore | EnumMember | Invalidator id, that is entity which set -Invalid- for this property (or removed / 'undid' the invalidation by setting the value to '0001-01-01'). |
| ARCCore.StreamProcessorP.Timestamp | ARCCore | EnumMember | The timestamp inserted at regular intervals in the -PropertyStream- according to -TimestampResolution-. |
| ARCDoc.DocLinkResolutionCollection.TryGetV | ARCDoc | 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). |
| ARCCore.ConnectionInstructionP.MultipleConnectionUsage | ARCCore | EnumMember | |
| ARCCore.PP.ExceptionText | ARCCore | EnumMember | General property for logging of exceptions, usually set through -HandleException-. |
| ARCCore.StreamProcessorP.TimestampIsOld | ARCCore | EnumMember | A warning sent by -StreamProcessor- to -OutsideLocalReceiver- when it knows that data as served is out of date. |
| ARCDoc.DocLinkResolutionCollection.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCCore.ConnectionInstructionP.Sharding | ARCCore | EnumMember | |
| ARCCore.PConcurrentP | ARCCore | Enum | Describes class -PConcurrent-. |
| ARCCore.StreamProcessorP.TimestampResolution | ARCCore | EnumMember | The time interval between each timestamp update in the -PropertyStream-. |
| ARCDoc.Documentator | ARCDoc | Class | General class for documenting AgoRapide and also your own -ApplicationSpecificCode-. |
| ARCCore.MultipleConnectionUsage | ARCCore | Enum | Enables fault-tolerance by describing use of multiple connections |
| ARCCore.PConcurrentP.Heartbeat | ARCCore | EnumMember | |
| ARCCore.StreamProcessorP.DoNotStoreLocally | ARCCore | EnumMember | For -Client-, incoming data (as received from a -Outgoing-) is possible to store BOTH to disk, AND to (normally) a -PRich-. |
| ARCDoc.Documentator.CreateAndInsert | ARCDoc | ClassMember | Creates an instance of -Documentator- with a natural hierarchical representation of documentation attributes found in the given assemblies. |
| ARCCore.MultipleConnectionUsage.Admin | ARCCore | EnumMember | Connection is a special administrative connection to a central 'command-and-control' server which instructs which connections to make. |
| ARCCore.ActualConnectionP | ARCCore | Enum | Describes class -ActualConnection-. |
| ARCCore.StreamProcessorP.DoNotStoreLocalOriginLocally | ARCCore | EnumMember | Means 'do not store local origin locally but wait until it gets confirmed by core storage'. |
| ARCDoc.Documentator.ToHTMLSimpleSingle | ARCDoc | ClassMember | Alternative ('override') to -ToHTMLSimpleSingle-. |
| ARCCore.MultipleConnectionUsage.RoundRobin | ARCCore | EnumMember | This connection to be used in a turn based system, together with other connections with -RoundRobin-. |
| ARCCore.ActualConnectionP.Id | ARCCore | EnumMember | When connection is used with-StreamProcessor-, the Id should be the same as the key used in the incoming / outgoing connection dictionary collection. |
| ARCCore.TPropertyKeyEnum | ARCCore | Enum | Placeholder for any enum type suitable as generic type parameter for -PExact-. |
| ARCDoc.HTOC.TryGetV | ARCDoc | 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). |
| ARCCore.MultipleConnectionUsage.Simultaneous | ARCCore | EnumMember | This connection to be used simultaneously with other connections with -Simultaneous- |
| ARCCore.ActualConnectionP.ConnectionInstruction | ARCCore | EnumMember | Only relevant when we are an -Outgoing-. |
| Assembly ARCDoc | Assembly | A library supporting documentation and demonstrating usage of AgoRapide. | |
| ARCDoc.HTOC.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCCore.StreamProcessorP | ARCCore | Enum | Describes class -StreamProcessor-. |
| ARCCore.ActualConnectionP.ConnectionDirection | ARCCore | EnumMember | |
| ARCDoc.Apple | ARCDoc | Class | The most 'standard' way of implementing an entity-class in AgoRapide, by just inheriting -PRich-. |
| ARCDoc.HTOC.HTOCContentThisLevelKey | ARCDoc | ClassMember | The key used for storing the actual content at this level. |
| ARCCore.StreamProcessorP.LocalStorageFolder | ARCCore | EnumMember | The local path to which new properties are stored. Should NOT end with any trailing DirectorySeparatorChar |
| ARCCore.ActualConnectionP.CountReceiveMessage | ARCCore | EnumMember | |
| ARCDoc.Apple.AddName | ARCDoc | ClassMember | Convenience method, not obligatory. |
| ARCDoc.PKDocAttribute | ARCDoc | Class | Describes documentation and presentation of a property. |
| ARCCore.StreamProcessorP.IndividualStorageFileSize | ARCCore | EnumMember | Max size (in bytes) for a single storage file before a new file is created by call to -StreamProcessor.CreateNewStorageFile-. |
| ARCCore.ActualConnectionP.CountSendMessage | ARCCore | EnumMember | |
| ARCDoc.Apple.GetName | ARCDoc | ClassMember | Convenience method, not obligatory. |
| ARCDoc.PKDocAttribute.Initialize | ARCDoc | ClassMember | To be overridden in sub-classes, but do note that sub-classes are supposed to call base.Initialize() at end of their own initialization. |
| ARCCore.StreamProcessorP.CurrentlyInitializing | ARCCore | EnumMember | Set to TRUE at initialization (signals for instance -ReceiveAndDistribute- that it can only queue messages, not process them). |
| ARCCore.ActualConnectionP.ClientUpdatePosition | ARCCore | EnumMember | Note how this is stored both as -ClientUpdatePosition- (on the client side) and -ClientUpdatePosition- (on the server side). |
| ARCDoc.Apple.TryGetName | ARCDoc | ClassMember | Convenience method, not obligatory. |
| ARCDoc.PKDocAttribute.TryRemoveP | ARCDoc | ClassMember | Should probably never be used. |
| ARCCore.StreamProcessorP.ClientUpdatePositionPath | ARCCore | EnumMember | Complete path to file containing -ClientUpdatePosition-. |
| ARCCore.ActualConnectionP.SubscriptionAsRequestedByClient | ARCCore | EnumMember | Originates from -Subscription-. |
| ARCDoc.Apple.TryGetV | ARCDoc | 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). |
| ARCDoc.PKDocAttribute.PriorityOrder | ARCDoc | ClassMember | |
| ARCCore.StreamProcessorP.ClientUpdatePosition | ARCCore | EnumMember | Note how this is stored both as -ClientUpdatePosition- (on the client side) and -ClientUpdatePosition- (on the server side). |
| ARCCore.ActualConnectionP.ClosingReason | ARCCore | EnumMember | Reason why this connection was closed |
| ARCDoc.Apple.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCDoc.PKDocAttribute.IsDefault | ARCDoc | 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.) |
| ARCDoc.Apple.Name | ARCDoc | ClassMember | Convenience method, not obligatory. |
| ARCCore.StreamProcessorP.CacheDiskWrites | ARCCore | EnumMember | If TRUE then will write the -PropertyStream- to disk in bigger chunks, thereby increasing performance. |
| ARCDoc.DocLink.TryGetV | ARCDoc | 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). |
| ARCDoc.UtilDoc | ARCDoc | Class | Utility methods for -ARCDoc-. |
| ARCDoc.Banana | ARCDoc | Class | Implements -IP- directly and uses traditional property storage for optimum -MemoryConsumption- efficiency. |
| ARCCore.StreamProcessorP.CopyFileStructureFromCore | ARCCore | EnumMember | If TRUE, will copy the exact file structure (through information given in -ClientUpdatePosition-). |
| ARCDoc.DocLink.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCDoc.UtilDoc.GetCurrentLevelInHierarchyAsHTML | ARCDoc | ClassMember | Returns an HTML presentation of the given link context, with links pointing backwards to each level in the hierarchy. |
| ARCDoc.Banana.Name | ARCDoc | ClassMember | Annotated as nullable in order to keep flexibility of -PropertyAccess-, including what happens if values are not set (TryGetP etc) |
| ARCCore.StreamProcessorP.CountIncomingConnections | ARCCore | EnumMember | |
| ARCDoc.DocLink.Location | ARCDoc | ClassMember | Copy of -Location-. |
| ARCDoc.UtilDoc.GenerateHTMLPage | ARCDoc | ClassMember | Wraps the parameter inside a <html><head></head><body>...</body></html> enclosure with some rudimentare CSS. |
| ARCDoc.Banana.Colour | ARCDoc | ClassMember | Annotated as nullable in order to keep flexibility of -PropertyAccess-, including what happens if values are not set (TryGetP etc) |
| ARCCore.StreamProcessorP.CountOutgoingConnections | |||
| ARCDoc.DocLink.Filename | ARCDoc | ClassMember | Copy of -LinkWordHTML-. |
| ARCDoc.HTOC+ParentChain | ARCDoc | Class | Used by -FilterNode- in order to keep track of node's parents. |
| ARCDoc.Demonstrator | ARCDoc | Class | Demonstrates various concepts from -ARCCore-, especially -PropertyAccess-. |
| ARCCore.StreamProcessorP.CountOutsideLocalReceiver | ARCCore | EnumMember | Count of calls to -OutsideLocalReceiver-. |
| ARCDoc.DocLink.LinkWordHTML | ARCDoc | ClassMember | Copy of -LinkWordHTML-. |
| ARCDoc.AppleP | ARCDoc | Enum | Describes class -Apple-. |
| ARCDoc.Demonstrator.DemonstratePropertyAccessApple | ARCDoc | ClassMember | Demonstrates use of -PropertyAccess- through the -Apple- class. |
| ARCCore.StreamProcessorP.CountReceiveLocalOrigin | ARCCore | EnumMember | Count of -PropertyStreamLine- with -HasLocalOrigin-. |
| ARCDoc.DocLink.LinkWordHTMLWithHyphens | ARCDoc | ClassMember | -LinkWordHTML- with '-' (minus sign / hyphen) prepended and appended. |
| ARCDoc.AppleP.Name | ARCDoc | EnumMember | The name of the apple |
| ARCDoc.Demonstrator.DemonstratePropertyAccessOrange | ARCDoc | ClassMember | Demonstrates use of -PropertyAccess- through the -Orange- class. |
| ARCCore.StreamProcessorP.CountReceiveNonLocalOrigin | ARCCore | EnumMember | Count of -PropertyStreamLine- not with -HasLocalOrigin-. |
| ARCDoc.DocLink.LinkWordHTMLBeforeLt | ARCDoc | ClassMember | If -LinkWordHTML contains '<' (really '<') (for generic types, like 'PValue<TValue>') then this will contain the part before '<' like 'PValue'. |
| ARCDoc.AppleP.Colour | ARCDoc | EnumMember | |
| ARCDoc.Demonstrator.DemonstratePropertyAccessBanana | ARCDoc | ClassMember | Demonstrates use of -PropertyAccess- through the -Banana- class. |
| ARCCore.StorageFileP | ARCCore | Enum | Describes class -StorageFile-. |
| ARCDoc.DocLink.LinkWordHTMLBeforeLtWithHyphens | ARCDoc | ClassMember | -LinkWordHTMLBeforeLt- with '-' (minus sign / hyphen) prepended and appended. |
| ARCDoc.BananaP | ARCDoc | Enum | Describes class -Banana-. |
| ARCDoc.Demonstrator.DemonstrateITypeDescriber | ARCDoc | ClassMember | Demonstrates use of -ITypeDescriber- for describing single-property values. |
| ARCCore.StorageFileP.Filename | ARCCore | EnumMember | |
| ARCDoc.DocLink.AHrefEndPart | ARCDoc | ClassMember | 'Filename.Encoded + "> + LinkWordHTML + </a>' |
| ARCDoc.DocLinkResolutionP.DocLinks | ARCDoc | EnumMember | The possible links for -LinkWord- |
| ARCDoc.Demonstrator.DemonstratePRichHierarchicalStorage | ARCDoc | ClassMember | Demonstrates use of -PRich-, how it receives -PropertyStream--lines and builds up a strongly typed hierarchical object storage. |
| ARCCore.StorageFileP.Hash | ARCCore | EnumMember | Hash of storage file. Not implemented as of Apr 2020. It is envisaged to store hash-value as last line in storage file. In this case the hash must be the hash of the file excluding the last line |
| ARCDoc.DocLinkCollection | ARCDoc | Class | Contains a collection of -DocLink- objects. |
| ARCDoc.DocumentatorP | ARCDoc | Enum | Describes class -Documentator-. |
| ARCDoc.Demonstrator.DemonstratePropertyStream | ARCDoc | ClassMember | Demonstrates use of -PropertyStream- by generating local data (documentation data) and writing locally to console. |
| ARCCore.ConnectionDirection | ARCCore | Enum | The concept of who took the initiative for the connections (who asked to open the TCP/IP session). |
| ARCDoc.DocLinkCollection.Create | ARCDoc | ClassMember | Notes all locations and their positions in the hierarchical directory structure. |
| ARCDoc.DummyEnumP | ARCDoc | Enum | TODO: Document better what this is for (and change name) |
| ARCDoc.Demonstrator.DemonstrateBareBonesClient | ARCDoc | ClassMember | Demonstrates adding -PropertyStream--lines to -CoreDB- without using ANY AgoRapide component, only standard TCP/IP functionality in .NET. |
| ARCCore.ConnectionDirection.Incoming | ARCCore | EnumMember | ConnectionInstruction will not be set for these. |
| ARCDoc.DocLinkCollection.InsertLinks | ARCDoc | ClassMember | Does -LinkInsertionInDocumentation- on the given HTML content. |
| ARCDoc.DummyEnumP._MemberInherited | ARCDoc | EnumMember | Contains not only members which are inherited in the object-oriented sense, but also overrides for which the only documentation was found in base class |
| ARCDoc.Demonstrator.DemonstrateLogConsole | ARCDoc | ClassMember | Demonstrates a quite simple log console. |
| ARCCore.ConnectionDirection.Outgoing | ARCCore | EnumMember | There would normally exist two live outgoing connection at a given point in time for -Client- / -ArmDB-: |
| ARCDoc.DocLinkCollection.TryGetV | ARCDoc | 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). |
| ARCDoc.HLocationP | ARCDoc | Enum | Describes class -HLocation-. |
| ARCDoc.Demonstrator.DemonstrateStreamProcessorAsClient | ARCDoc | ClassMember | Demonstrates use of -StreamProcessor- as a general client. |
| ARCCore.DataTransferDirection | ARCCore | Enum | Direction for transfer of data. |
| ARCDoc.DocLinkCollection.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCDoc.HLocationP.Location | ARCDoc | EnumMember | Folder names / hierarchical levels. |
| ARCDoc.Orange | ARCDoc | Class | Inherits -PExact- for probably the best compromise between memory consumption and easy of development. |
| ARCCore.DataTransferDirection.Send | ARCCore | EnumMember | Like -Client- sending in-application generated properties to -ArmDB- / -CoreDB- or -ArmDB- sending data received over an incoming connection to -CoreDB-. |
| ARCDoc.DocLinkResolution | ARCDoc | Class | Contains a resolution page for a link word which has duplicate 'targets' (pointing to multiple -DocLink- instances). |
| ARCDoc.HLocationP.Filename | ARCDoc | EnumMember | Either the last hierarhical key for the content's location, or Index.html if no location. |
| ARCDoc.Orange.Name | ARCDoc | ClassMember | See -Name- for more information. |
| ARCCore.DataTransferDirection.Receive | ARCCore | EnumMember | Like -Client- receiving data from an upstream -ArmDB- / -CoreDB- or -ArmDB- receiving data from an upstream -CoreDB-. |
| ARCDoc.DocLinkResolution.ToHTMLSimpleSingle | ARCDoc | ClassMember | Gives a friendly description about possible targets for LinkWord-. |
| ARCDoc.HLocationP.ContentType | ARCDoc | EnumMember | The type of the content object. The actual content object is stored as -Content-. |
| ARCQuery.CompoundInvalidKey.FunctionKeys | ARCQuery | ClassMember | All -FunctionKey-s chained at end of compound key (but before an eventual -QuantileKey-). |
| ARCDoc.Orange.Storage | ARCDoc | ClassMember | Uses int-value of -__enum- minus 1 as index. |
| ARCDoc.Extensions.ValueToHTMLSimpleWithTooltip | ARCDoc | ClassMember | Creates a simple HTML representation of the Value with description as a 'tooltip'. |
| ARCQuery.EntityMethodKey.TryGetPInternal | ARCQuery | ClassMember | The internal executor, containing the specific functionality for how to evaluate the key. |
| ARCQuery.CompoundInvalidKey.QuantileKey | ARCQuery | ClassMember | Eventual final -QuantileKey- at end of compound key. |
| ARCDoc.SomeAppComponent | ARCDoc | Class | Demonstrates how also your actual application classes, not only your data classes, should implement -IP-. |
| ARCDoc.Extensions.KeyToHTMLSimpleWithTooltip | ARCDoc | ClassMember | Creates a simple HTML representation of the Key with description as a 'tooltip'. |
| ARCQuery.EntityMethodKey.ToString | ARCQuery | ClassMember | The ToString representation is the one relevant when used as key, like in -IK- or when selecting like 'SELECT {fieldName}'. |
| ARCQuery.CompoundKey | ARCQuery | Class | A class able to expand the concept of entity keys. |
| ARCDoc.SomeAppComponent.MethodC | ARCDoc | ClassMember | Note structured format in logging. |
| ARCDoc.HLocation | ARCDoc | Class | Simple class describing the location of a single -IP- instance within some hierarhical context. |
| ARCQuery.EntityMethodKey.AllEntityMethodKeysForEntityType | ARCQuery | ClassMember | Returns methods for the given entity type that can be used by -EntityMethodKey-. |
| ARCQuery.CompoundKey.TryGetP | ARCQuery | ClassMember | The outwards facing executor, understanding use of -FunctionKeys-. |
| ARCDoc.SomeAppComponent.MethodD | ARCDoc | ClassMember | Same as MethodC- but returns data ('Func<string>()' instead of 'Action()') |
| ARCDoc.HLocation.TryGetV | ARCDoc | 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.EntityMethodKey.TryGetForeignField | ARCQuery | ClassMember | Returns foreign field through foreign key given. |
| ARCQuery.CompoundKey.TryGetPInternal | ARCQuery | ClassMember | The internal executor, containing the specific functionality for how to evaluate the key. |
| ARCDoc.SomeAppComponent.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCDoc.HLocation.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCQuery.EntityMethodKey.TryGetP | ARCQuery | ClassMember | The outwards facing executor, understanding use of -FunctionKeys-. |
| ARCQuery.CompoundKey.Parse | ARCQuery | ClassMember | Note that no TryParse is offered here, because Parse will always succeed (it just returns -CompoundInvalidKey- if 'fails'). |
| ARCDoc.DocFrag | ARCDoc | Class | DocFrag = Document fragment. |
| ARCDoc.HLocation.Content | ARCDoc | ClassMember | The Content object is not stored within the standard -IP--mechanism. |
| ARCQuery.EntityMethodKey.Method | ARCQuery | ClassMember | The actuall TryGet method implemented in the relevant entity class. |
| ARCQuery.CompoundKey.ToString | ARCQuery | ClassMember | The ToString representation is the one relevant when used as key, like in -IK- or when selecting like 'SELECT {fieldName}'. |
| ARCDoc.DocFrag.Create Overload1 | ARCDoc | ClassMember | Creates a -DocFrag- object representing an assembly or a namespace. |
| ARCDoc.HLocationCollection | ARCDoc | Class | Contains a collection of -HLocation- objects. |
| ARCQuery.EntityMethodKey.FunctionKeys | |||
| ARCQuery.CompoundKey.FunctionKeys | ARCQuery | ClassMember | All -FunctionKey-s chained at end of compound key (but before an eventual -QuantileKey-). |
| ARCDoc.DocFrag.Create Overload2 | ARCDoc | ClassMember | Creates a -DocFrag- object representing a class, class member, enum or enum member. |
| ARCDoc.HLocationCollection.Create | ARCDoc | ClassMember | Transforms the parameter (and recursively all contained objects) into a collection of -HLocation- objects. |
| ARCQuery.EntityMethodKey.QuantileKey | ARCQuery | ClassMember | Eventual final -QuantileKey- at end of compound key. |
| ARCQuery.CompoundKey.QuantileKey | ARCQuery | ClassMember | Eventual final -QuantileKey- at end of compound key. |
| ARCDoc.DocFrag.ToHTMLSimpleSingle | ARCDoc | ClassMember | Alternative ('override') to -ToHTMLSimpleSingle-. |
| ARCDoc.HLocationCollection.WriteAllContentHTMLToDisk | ARCDoc | ClassMember | Writes all -HLocation- results to a hierarhical folder structure as static HTML files with (optionally) -LinkInsertionInDocumentation-. |
| ARCQuery.MemberEntityKey.TryGetP | ARCQuery | ClassMember | The outwards facing executor, understanding use of -FunctionKeys-. |
| ARCQuery.ConstantKey<T> | ARCQuery | Class | Represents a constant expression like "' '", "', '", "42". |
| ARCDoc.DocFrag.TryGetV | ARCDoc | 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). |
| ARCDoc.HLocationCollection.TryGetV | ARCDoc | 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.MemberEntityKey.FunctionKeys | ARCQuery | ClassMember | All -FunctionKey-s chained at end of compound key (but before an eventual -QuantileKey-). |
| ARCQuery.ConstantKey<T>.TryGetPInternal | ARCQuery | ClassMember | The internal executor, containing the specific functionality for how to evaluate the key. |
| ARCDoc.DocFrag.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCDoc.HLocationCollection.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCQuery.MemberEntityKey.QuantileKey | ARCQuery | ClassMember | Eventual final -QuantileKey- at end of compound key. |
| ARCQuery.ConstantKey<T>.ToString | ARCQuery | ClassMember | The ToString representation is the one relevant when used as key, like in -IK- or when selecting like 'SELECT {fieldName}'. |
| ARCDoc.DocFragCollection | ARCDoc | Class | Contains a collection of -DocFrag- objects. |
| ARCDoc.HTOC | ARCDoc | Class | HTOC = Hierarchical table of contents. |
| ARCQuery.OrdinaryKeyPlusFunctionOrQuantile | ARCQuery | Class | A -CompoundKey- containing some function keys or quantile key operating on an existing property of the entity in question. |
| ARCQuery.ConstantKey<T>.TryGetP | ARCQuery | ClassMember | The outwards facing executor, understanding use of -FunctionKeys-. |
| ARCDoc.DocFragCollection.Create | ARCDoc | ClassMember | Creates documentation fragments (-DocFrag-) for all possible -BaseAttribute- elements found in the given assemblies. |
| ARCDoc.HTOC.Create | ARCDoc | ClassMember | Structures content hierarchically according to the criteria for each level. |
| ARCQuery.OrdinaryKeyPlusFunctionOrQuantile.TryGetPInternal | ARCQuery | ClassMember | The internal executor, containing the specific functionality for how to evaluate the key. |
| ARCQuery.ConstantKey<T>.FunctionKeys | ARCQuery | ClassMember | All -FunctionKey-s chained at end of compound key (but before an eventual -QuantileKey-). |
| ARCDoc.DocFragCollection.TryGetV | ARCDoc | 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). |
| ARCDoc.HTOC.ToHTMLSimpleSingle Overload2 | ARCDoc | ClassMember | Alternative ('override') to -ToHTMLSimpleSingle-. |
| ARCQuery.OrdinaryKeyPlusFunctionOrQuantile.ToString | ARCQuery | ClassMember | The ToString representation is the one relevant when used as key, like in -IK- or when selecting like 'SELECT {fieldName}'. |
| ARCQuery.ConstantKey<T>.QuantileKey | ARCQuery | ClassMember | Eventual final -QuantileKey- at end of compound key. |
| ARCDoc.DocFragCollection.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCDoc.HTOC.ToHTMLSimpleSingle Overload1 | ARCDoc | ClassMember | Use this method in any class where a table-of-contents type of view is desireable |
| ARCQuery.OrdinaryKeyPlusFunctionOrQuantile.TryGetP | ARCQuery | ClassMember | The outwards facing executor, understanding use of -FunctionKeys-. |
| ARCQuery.EntityMethodKey | ARCQuery | Class | Key able to call read-only methods defined in the entity class with names like 'TryGet{FieldName}'. |
| ARCDoc.DocLink | ARCDoc | Class | Describes to where a single HTML link points. |
| ARCDoc.HTOC.CreateInitialContent | ARCDoc | ClassMember | Helper method for creation of a -FilterBranch-. |
| ARCQuery.OrdinaryKeyPlusFunctionOrQuantile..ctor | ARCQuery | ClassMember | Note that calling only this constructor without afterwards setting -FunctionKeys- and / or -QuantileKey- would be meaningless. |
| ARCQuery.QueryExpression | ARCQuery | Class | Represents part of a query (or actually a transformation) against a given collection and the data storage from which it was taken. |
| ARCDoc.Documentator.CreateHTOCStandard | ARCDoc | ClassMember | Creates a 'standard' table of contents, structured by assembly and each assembly divided into 'Class' and 'Enum'. |
| ARCDoc.BananaP.Name | ARCDoc | EnumMember | The name of the banana |
| ARCQuery.FunctionKeyAggregateMin | ARCQuery | Class | Calculates the minimum value of the given properties. |
| ARCQuery.QueryExpression.Execute | ARCQuery | ClassMember | Transforms the given input collection into a resulting collection. |
| ARCDoc.Documentator.CreateHTOCNamespace | ARCDoc | ClassMember | Creates a table of contents structured by namespace |
| ARCDoc.BananaP.Colour | ARCDoc | EnumMember | |
| ARCQuery.FunctionKeyAggregateMin.SyntaxHelp | ARCQuery | ClassMember | 'Min()' |
| ARCQuery.QueryExpression.AddParser | ARCQuery | ClassMember | Adds a -ApplicationSpecificCode- parser. |
| ARCDoc.Documentator.CreateHTOCInheritance | ARCDoc | ClassMember | Creates a table of contents structured by inheritance (classes and interfaces only, not members). |
| ARCDoc.OrangeP | ARCDoc | Enum | Describes class -Orange-. |
| ARCQuery.FunctionKeyAggregateSum | ARCQuery | Class | Sums the given properties. |
| ARCQuery.QueryExpression.TryParse | ARCQuery | ClassMember | Find parsers from -Parsers- based on first word in query. |
| ARCDoc.Documentator.TryGetV | ARCDoc | 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). |
| ARCDoc.OrangeP.Name | ARCDoc | EnumMember | The name of the orange |
| ARCQuery.FunctionKeyAggregateSum.SyntaxHelp | ARCQuery | ClassMember | 'Sum()' |
| ARCQuery.QueryExpression.TryCheckForExistenceOfKey | ARCQuery | ClassMember | Used by query expressions in order to catch wrong field names used or misspelling of field names. |
| ARCDoc.Documentator.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCDoc.OrangeP.Colour | ARCDoc | EnumMember | |
| ARCQuery.FunctionKey | ARCQuery | Class | Extracts data from an already existing value like extracting Year from a DateTime in 'Created.Year()'. |
| ARCQuery.QueryExpression.Parsers | ARCQuery | ClassMember | Parsers for all the relevant sub classes of -QueryExpression-. |
| ARCDoc.Documentator.DocLinks | ARCDoc | ClassMember | Set by -CreateAndInsert-. |
| ARCDoc.SomeAppComponentP | ARCDoc | Enum | Describes class -SomeAppComponent-. |
| ARCQuery.FunctionKey.TryGetP Overload1 | ARCQuery | ClassMember | NOTE: The in-parameter is a property, not an entity. |
| ARCQuery.QueryExpressionWithSuggestions | ARCQuery | Class | Keeps track as each query item gets executed. |
| ARCDoc.Documentator.DocLinkResolutionLocation | ARCDoc | ClassMember | Default position within the global storage context of doc link resolution pages. |
| ARCDoc.SomeAppComponentP.SomeCountValue | ARCDoc | EnumMember | |
| ARCQuery.FunctionKey.AddParser | ARCQuery | ClassMember | Adds a -ApplicationSpecificCode- parser. |
| ARCQuery.QueryExpressionWithSuggestions.Previous | ARCQuery | ClassMember | Suggestion for a 'browse backwards' button. |
| ARCDoc.DummyEnum | ARCDoc | Class | TODO: Document better what this is for (and change name) |
| ARCDoc.SomeAppComponentP.SomeCountValueNotToBeLogged | ARCDoc | EnumMember | |
| ARCQuery.FunctionKey.TryParse | ARCQuery | ClassMember | Find parsers from -Parsers- based on first word in query. |
| ARCDoc.DummyEnum.TryGetV | ARCDoc | 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). |
| ARCDoc.DocFragP | ARCDoc | Enum | Describes class -DocFrag-. |
| ARCQuery.FunctionKey.TryParseSingleWord | ARCQuery | ClassMember | Recommended parser to use for functions without parameters. |
| ARCDoc.DummyEnum.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCDoc.DocFragP.DocFragType | ARCDoc | EnumMember | |
| ARCQuery.FunctionKey.TryGetP Overload2 | ARCQuery | ClassMember | Overload which will try to call -TryGetV- with generic type parameter, and if that does not succeed will try to call the optional 'tryParser'. |
| ARCDoc.Extensions | ARCDoc | Class | Contains various extension methods for -IP- and -IKIP- related to documentating / reporting / HTML. |
| ARCDoc.DocFragP.Assembly | ARCDoc | EnumMember | Name of the assembly in which this fragment resides. |
| ARCQuery.FunctionKey.Parsers | ARCQuery | ClassMember | Instances of all the relevant sub classes of -FunctionKey-. |
| ARCDoc.Extensions.ToHTMLSimpleSingleRecursive | ARCDoc | ClassMember | Calls -ToHTMLSimpleSingle- recursively. |
| ARCDoc.DocFragP.Namespace | ARCDoc | EnumMember | Namespace in which this fragment resides. |
| ARCQuery.FunctionKeyDate | ARCQuery | Class | Formats a date without time component. |
| ARCDoc.Extensions.ToHTMLSimpleSingle | ARCDoc | ClassMember | Creates a simple HTML representation of the given parameter. |
| ARCDoc.DocFragP.ParentNamespace | ARCDoc | EnumMember | Parent namespace of namespace in which this fragment resides. |
| ARCQuery.FunctionKeyDate.TryGetP | ARCQuery | ClassMember | NOTE: The in-parameter is a property, not an entity. |
| ARCDoc.Extensions.ToHTMLSimpleSingleInternal | ARCDoc | ClassMember | Hack in order to escape check for direct implementation in actual class of -ToHTMLSimpleSingle- in -ToHTMLSimpleSingle-. |
| ARCDoc.DocFragP.Type | ARCDoc | EnumMember | Type of class or enum which this fragment describes (also relevant for class or enum member). |
| ARCQuery.FunctionKeyDate.SyntaxHelp | ARCQuery | ClassMember | 'Date()' |
| ARCDoc.Extensions.ToHTMLSimpleAsTableRow | ARCDoc | ClassMember | Creates a simple HTML representation of the given parameter as a single two column row (Key, Value) in a table. |
| ARCDoc.DocFragP.Name | ARCDoc | EnumMember | As simple a name as practical usable. Often not unique within a greater context. |
| ARCQuery.FunctionKeyDayOfWeek | ARCQuery | Class | Extracts DayOfWeek from field like 'Monday', 'Tuesday' and so on. |
| ARCDoc.Extensions.DescribeValue | ARCDoc | ClassMember | Describes the value contained withing an -IKIP- (-P-). |
| ARCDoc.DocFragP.IsInherited | ARCDoc | EnumMember | Relevant for class members. TRUE if method is inherited from a base type. |
| ARCQuery.FunctionKeyDayOfWeek.TryGetP | ARCQuery | ClassMember | NOTE: The in-parameter is a property, not an entity. |
| ARCDoc.DocFragP.IsInheritedDoc | ARCDoc | EnumMember | Relevant for class members (methods). |
| ARCDoc.PKDocAttributeP | ARCDoc | Enum | Describes class -PKDocAttribute-. |
| ARCQuery.FunctionKeyType.TryGetP | ARCQuery | ClassMember | NOTE: The in-parameter is a property, not an entity. |
| ARCDoc.DocFragP.Lines | ARCDoc | EnumMember | Number of lines of text in -Description- and -LongDescription- for this fragment. |
| ARCDoc.PKDocAttributeP.PriorityOrder | ARCDoc | EnumMember | Used by -DescribeValue-. |
| ARCQuery.FunctionKeyType.SyntaxHelp | ARCQuery | ClassMember | 'Type()' |
| ARCDoc.DocFragP.Attribute | ARCDoc | EnumMember | The -BaseAttribute- or -PK- from which this -DocFrag- originates. |
| ARCDoc.PriorityOrder | ARCDoc | Enum | Used for general sorting / prioritizing when showing properties for an entity. |
| ARCQuery.FunctionKeyWeek | ARCQuery | Class | Extract week-number from field according to ISO 8601. |
| ARCDoc.DocFragType | ARCDoc | Enum | Type of documentation fragment, like -Assembly-, -Class- or -ClassMember-. |
| ARCDoc.PriorityOrder.NotImportant | ARCDoc | EnumMember | |
| ARCQuery.FunctionKeyWeek.TryGetP | ARCQuery | ClassMember | NOTE: The in-parameter is a property, not an entity. |
| ARCDoc.DocFragType.Assembly | ARCDoc | EnumMember | |
| ARCDoc.PriorityOrder.Important | ARCDoc | EnumMember | |
| ARCQuery.FunctionKeyWeek.SyntaxHelp | ARCQuery | ClassMember | 'Week()' |
| ARCDoc.DocFragType.Namespace | ARCDoc | EnumMember | |
| Assembly ARCQuery | Assembly | ARCQuery provides a query language that mimicks SQL but is usable through HTTP as GET URLs. | |
| ARCQuery.FunctionKeyYear | ARCQuery | Class | Extracts Year-component from field. |
| ARCDoc.DocFragType.Class | ARCDoc | EnumMember | Does also include interfaces. |
| ARCQuery.BinaryOperatorKey | ARCQuery | Class | Offers expressions with operators like +, -, * and /. |
| ARCQuery.FunctionKeyYear.TryGetP | ARCQuery | ClassMember | NOTE: The in-parameter is a property, not an entity. |
| ARCDoc.DocFragType.ClassMember | ARCDoc | EnumMember | |
| ARCQuery.BinaryOperatorKey.TryGetPInternal | ARCQuery | ClassMember | The internal executor, containing the specific functionality for how to evaluate the key. |
| ARCQuery.FunctionKeyYear.SyntaxHelp | ARCQuery | ClassMember | 'Year()' |
| ARCDoc.DocFragType.Enum | ARCDoc | EnumMember | |
| ARCQuery.BinaryOperatorKey.ToString | ARCQuery | ClassMember | The ToString representation is the one relevant when used as key, like in -IK- or when selecting like 'SELECT {fieldName}'. |
| ARCQuery.FunctionKeyYearMonth | ARCQuery | Class | Extracts Year + Month component from field like 2020-06. |
| ARCDoc.DocFragType.EnumMember | ARCDoc | EnumMember | |
| ARCQuery.BinaryOperatorKey.TryGetP | ARCQuery | ClassMember | The outwards facing executor, understanding use of -FunctionKeys-. |
| ARCQuery.FunctionKeyYearMonth.TryGetP | ARCQuery | ClassMember | NOTE: The in-parameter is a property, not an entity. |
Generated 2026-11-04 23:24:55.889 UTC