[ROOT] doc DocFrag SELECT Assembly, DocFragType, Description.FirstLine() < SKIP 204 > < TAKE 496 >
496 items
| DocFragId | Assembly | DocFragType | Description.FirstLine() |
|---|---|---|---|
| ARCCore.EnumAttribute.GetAttribute | ARCCore | ClassMember | Throws exception if tagged as -PropertyKeyEnum- and name of type does not end with capital letter 'P' (like 'CustomerP' for enum describing class 'Customer' for instance). |
| ARCCore.EnumMemberAttribute | ARCCore | Class | Describes an enum's value. |
| ARCCore.EnumMemberAttribute.GetAttribute | ARCCore | ClassMember | Note that illegal to call for -PropertyKeyEnum-. |
| 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.CardinalityExtensions | ARCCore | Class | |
| ARCCore.CardinalityExtensions.IsMultiple | ARCCore | ClassMember | Returns TRUE if given cardinality implies that multiple items are stored simultaneously in a typical in-memory data storage. |
| ARCCore.Extensions | ARCCore | Class | Contains a few general nice to have extensions methods. |
| ARCCore.Extensions.ToStringShort | ARCCore | ClassMember | Returns a shorter representation than -ToStringDB-. |
| ARCCore.Extensions.ForEach | ARCCore | ClassMember | Useful when we want to write collection.ForEach( ... ) instead of |
| 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.Extensions.ToStringDateAndTime | ARCCore | ClassMember | Uses format 'yyyy-MM-dd HH:mm:ss.fff'. |
| ARCCore.Extensions.ToStringWithMS | ARCCore | ClassMember | Uses either format 'd\.hh\:mm\:ss\.fff' or 'hh\:mm\:ss\.fff' depending on TotalHours >=24 hours or not. |
| ARCCore.IKIP | ARCCore | Class | Container class for key (-IK-), and value (-IP-). |
| ARCCore.IKIP.AssertTypeIntegrity | ARCCore | ClassMember | See -TryAssertTypeIntegrity- for documentation. |
| ARCCore.IKCoded.TryCheckValidEncodedValue | ARCCore | ClassMember | Checks if encoded value is valid. |
| ARCCore.IKCoded.FromCacheEncoded | ARCCore | ClassMember | Reduces number of objects generated by caching those known to be within a limited range |
| ARCCore.IKCoded.FromCacheUnencoded | ARCCore | ClassMember | Reduces number of objects generated by caching those known to be within a limited range |
| ARCCore.IKCoded.FromEncoded | ARCCore | ClassMember | Note how uses instance cache if already exists there. |
| ARCCore.IKString | ARCCore | Class | Index key for any general id, like primary-key or sequence-number or similar. |
| ARCCore.IKString.FromCache | ARCCore | ClassMember | Reduces number of objects generated by caching those known to be within a limited range |
| ARCCore.IKString.FromString | ARCCore | ClassMember | Note how uses instance cache if already exists there |
| ARCCore.IKString.EnrichKey | ARCCore | ClassMember | 'Implementing' -ITypeDescriber-. |
| ARCCore.ParseResult | ARCCore | Class | NOTE: Concept is very old, from the dark ages of AgoRapide's very first inception. There might be room for improvement. |
| ARCCore.ParseResult.Result | ARCCore | ClassMember | Will be null if ErrorResponse is set. |
| ARCCore.ParseResult.ErrorResponse | ARCCore | ClassMember | Will be null if Result is set |
| ARCCore.PK | ARCCore | Class | PK = AgoRapide PropertyKey. |
| ARCCore.PK.TryGetEnum | ARCCore | ClassMember | Note that usually you will not have to ask for this value, usually in AgoRapide it goes the other way around, you have the enum member / enum value and want the corresponding property key. |
| ARCCore.PK.GetA | ARCCore | ClassMember | Convenience method for easy access to -BasePKAttribute- with corresponding explaining exception if fails |
| ARCCore.PK.TryGetA | ARCCore | ClassMember | Convenience method for easy access to -BasePKAttribute-. |
| ARCCore.PK.ModifyCleanerAndValidatorAndParserForCardinality | ARCCore | ClassMember | Called from -Initialize- after _cleaner and _validatorAndParser have been set. |
| ARCCore.IP | ARCCore | Class | IP = IProperty. |
| ARCCore.IP.TryGetV Overload2 | ARCCore | ClassMember | The actual value of the property. Mostly relevant for single-value properties like -PValue-. |
| ARCCore.IP.Inc | ARCCore | ClassMember | Increments given property key by 1. Sets to 1 if not found. Uses long, not integer. |
| ARCCore.IP.Dec | ARCCore | ClassMember | Decrements given property key by 1. Sets to -1 if not found. Uses long, not integer. |
| ARCCore.IP.Log | ARCCore | ClassMember | The 'final' overload of -Log- that is called by the other overloads. |
| ARCCore.IP.LogExecuteTime | ARCCore | ClassMember | Times the execution of the given function and logs details about elapsed time. |
| ARCCore.IP.HandleException | ARCCore | ClassMember | Note that most relevant to use for -PConcurrent-. |
| ARCCore.IP.Initialize | ARCCore | ClassMember | Note that has a default implementation (doing nothing). |
| ARCCore.IP.ToJSONSerializeable | ARCCore | ClassMember | Prepares the data into a format acceptable for System.Text.Json.JsonSerializer.Serialize. |
| ARCCore.IP.GetValueForJSONSerializer | ARCCore | ClassMember | Makes the following modifications to the data: |
| ARCCore.IP.TrySetP | ARCCore | ClassMember | Set property regardless of whether exists or not. |
| ARCCore.IP.TryGetV Overload1 | ARCCore | ClassMember | The actual 'unpacking' of the object. |
| 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). |
| ARCCore.IP.AddPV | ARCCore | ClassMember | Adds a property value (as a -PValue-) for this objectThrows -KeyAlreadyExistsException- when relevant. |
| ARCCore.IP.AddP | ARCCore | ClassMember | Adds a property for this object. |
| ARCCore.IP.AddOrUpdateP | ARCCore | ClassMember | Duplicates functionality of SetP. |
| ARCCore.IP.GetOrAddPV | ARCCore | ClassMember | Gets value. If not set then value will be added |
| ARCCore.IP.GetP | ARCCore | ClassMember | Gets a single property for this object. |
| ARCCore.IP.TryGetP Overload2 | ARCCore | ClassMember | Note that not relevant for single-value properties like -PValue-. |
| ARCCore.IP.GetPV | ARCCore | ClassMember | Gets a single property's value for this object. Returns default value if not successful. |
| ARCCore.IP.AssertIntegrity | ARCCore | ClassMember | See -TryAssertIntegrity-. |
| ARCCore.UtilCore.TimeSpanTryParse | ARCCore | ClassMember | Accepts on of the formats specified in -ValidDateTimeFormats-. |
| ARCCore.IP.TryAssertIntegrity | ARCCore | ClassMember | Asserts the integrity of this entity. |
| ARCCore.UtilCore.UseLocalTimeInsteadOfUTC | ARCCore | ClassMember | By default AgoRapide operates only with UTC time. |
| 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.UtilCore.DateTimeNow | ARCCore | ClassMember | Returns DateTime.UtcNow unless -UseLocalTimeInsteadOfUTC- has been set to TRUE in which case DateTime.Now is returned. |
| ARCCore.IP.TrySetPP | ARCCore | ClassMember | SetPP = set property of property. Sets property of entity contained within this class. |
| ARCCore.UtilCore.CurrentlyStartingUp | ARCCore | ClassMember | Called once at application startup after all Attribute instances in the C# code has been processed. |
| ARCCore.IP.GetKeysEqualToValue | ARCCore | ClassMember | Returns properties which themselves again have key and value equal to the given key and value. |
| ARCCore.UtilCore.Assemblies | ARCCore | ClassMember | All relevant assemblies for application. |
| 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.UtilCore.Culture | ARCCore | ClassMember | The general culture used for parsing. |
| ARCCore.IP.TryGetP Overload1 | ARCCore | ClassMember | Gets a single property for this object |
| ARCCore.UtilCore.Culture_en_US | ARCCore | ClassMember | Used by -DoubleTryParse-. |
| ARCCore.IP.ToPropertyStream | ARCCore | ClassMember | Turns object into a -PropertyStream- |
| ARCCore.UtilCore.DefaultAgoRapideEncoding | ARCCore | ClassMember | The standard encoding used for text (UTF8). |
| ARCCore.IP.TryGetPV | ARCCore | ClassMember | Gets a single property's value for the given property key. |
| 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.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.ValidTimeSpanFormats | ARCCore | ClassMember | 'hh\:mm', 'hh\:mm\:ss', 'd\.hh\:mm\:ss', 'hh\:mm\:ss\.fff' // Milliseconds,'d\.hh\:mm\:ss\.fff' |
| 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.REx | ARCCore | Class | REx = 'TooDeepRecursiveDepthException' |
| ARCCore.IP.Item | ARCCore | ClassMember | Offers string-based direct indexing. |
| ARCCore.REx.Inc | ARCCore | ClassMember | Increases recursive count. |
| ARCCore.IP.Keys | ARCCore | ClassMember | Returns all the keys for this instance. |
| 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.IP.Values | ARCCore | ClassMember | Returns all the values (all the properties) for this instance. |
| ARCCore.InvalidTypeException | ARCCore | Class | |
| ARCCore.IP.Logger | ARCCore | ClassMember | Describes a logger. |
| ARCCore.InvalidTypeException.AssertAssignable | ARCCore | ClassMember | Asserts that expectedType.IsAssignableFrom(foundType) |
| ARCCore.IP.AllIPDerivedTypes | ARCCore | ClassMember | All relevant -IP--derived types for the whole application. |
| ARCCore.InvalidTypeException.AssertEquals | ARCCore | ClassMember | Asserts that expectedType.Equals(foundType) |
| ARCCore.PCollection | ARCCore | Class | A class useful for storing a collection of entities (a table in RDBMS-terms) because it implements -Indexing-. |
| ARCCore.TValue | ARCCore | Class | Placeholder for any class type suitable as generic type parameter -PValue-. |
| ARCCore.PCollection.TrySetPP | ARCCore | ClassMember | Replaces default interface method -TrySetPP-. |
| ARCCore.BaseAttribute+IncorrectAttributeTypeUsedException | ARCCore | Class | Helps to clean up any confusion about which -BaseAttribute- to use in a given concept. |
| ARCCore.ARConcepts.AssertionsAndDetailedExceptionMessages | ARCCore | EnumMember | The abstraction level in AgoRapide is very high. |
| ARCCore.PCollection.GetKeysEqualToValue | ARCCore | ClassMember | Returns properties which themselves again have key and value equal to the given key and value. |
| ARCCore.PK+BasePKAttributeNotFoundException<T> | ARCCore | Class | Explains how to implement a given -BasePKAttribute- for an enum |
| 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.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). |
| 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.ARConcepts.LinkInsertionInDocumentation | ARCCore | EnumMember | Documentation with links is much easier to read. |
| ARCCore.PCollection.ToString | ARCCore | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCCore.PK+PKBoolPair.TrulyInitialized | ARCCore | ClassMember | Not used currently (May 2020). Useful for debugging purposes |
| ARCCore.ARConcepts.TryPatternAndNull | ARCCore | EnumMember | AgoRapide uses non-nullable reference types as default throughout the system |
| 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-. |
| ARCCore.StreamProcessor+StorageFile | ARCCore | Class | |
| ARCCore.AREnumType | ARCCore | Enum | Categories different types of enum used in AgoRapide. The most important one is -PropertyKeyEnum-. |
| ARCCore.PConcurrent | ARCCore | Class | A (somewhat) thread-safe alternative to -PRich- which also supports -ExposingApplicationState- (through -Logger-). |
| ARCCore.StreamProcessor+StorageFile.Filepath | ARCCore | ClassMember | Complete path to file |
| ARCCore.AREnumType.PropertyKeyEnum | |||
| ARCCore.PConcurrent.ToString | ARCCore | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCCore.StreamProcessor+StorageFile.Filename | ARCCore | ClassMember | Filename: Main file name, like 2020-04-03 08:42 |
| ARCCore.AREnumType.OrdinaryEnum | ARCCore | EnumMember | Designates "Ordinary" enums used for indicating range of valid values for a given key |
| ARCCore.IIKII.PackParseResultForStorageInIKII | ARCCore | ClassMember | This method corresponds to -PackParseResultForStorageInEntityObject-. |
| ARCCore.StreamProcessor+StorageFile.Length | ARCCore | ClassMember | Wrongly placed. Belongs to each individual revision file. |
| 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.IIKII.PackObjectForStorageInIKII | ARCCore | ClassMember | This method corresponds to -PackObjectForStorageInEntityObject-. |
| ARCCore.StreamProcessor+StorageFile.Properties | ARCCore | ClassMember | Key = revision number of file (due to compression / -DataRetention-), like R00001, R00002 and so on. |
| ARCCore.PSPrefix | ARCCore | Enum | Describes some recommended prefixed to use in a -PropertyStreamLine-. |
| ARCCore.PRich | ARCCore | Class | Fully flexible storage. Can store anything. Typical inherited for entity representations like 'Customer' or 'Order'. |
| ARCCore.BaseAttributeP | ARCCore | Enum | Describes class -BaseAttribute-. |
| ARCCore.PSPrefix.dt | ARCCore | EnumMember | Data, like dt/ |
| 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). |
| ARCCore.BaseAttributeP.Description | ARCCore | EnumMember | The description for the attribute, like this description |
| ARCCore.PSPrefix.cmd | ARCCore | EnumMember | Command, like cmd/ |
| ARCCore.PRich.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.PSPrefix.app | ARCCore | EnumMember | Application state, like app/ |
| ARCCore.PValue<T> | ARCCore | Class | Single value storage. |
| ARCCore.ClassAttributeP | ARCCore | Enum | Describes class -ClassAttribute-. |
| ARCCore.PSPrefix.doc | ARCCore | EnumMember | Documentation, like doc/. |
| ARCCore.PValue<T>.TrySetP | ARCCore | ClassMember | NOTE: -TryStore- is explicit aware that -PValue- and -PValueEmpty- |
| ARCCore.ClassAttributeP.AssemblyName | ARCCore | EnumMember | The assembly in which this class resides. |
| ARCCore.PKHTMLAttributeP | ARCCore | Enum | Describes class -PKRelAttribute-. |
| ARCCore.PValue<T>.TryGetV | ARCCore | ClassMember | Supports duck typing. |
| ARCCore.ClassAttributeP.ClassNamespace | ARCCore | EnumMember | The namespace for -ClassType-. |
| ARCCore.PKHTMLAttributeP.Encoder | ARCCore | EnumMember | The class doing the HTML-encoding. |
| ARCCore.ARConcepts.MemoryConsumption | ARCCore | EnumMember | A naïve implementation of key-value storages like AgoRapide may lead to excessive memory (RAM) consumption. |
| ARCCore.ClassAttributeP.ClassType | ARCCore | EnumMember | The actual type that we are a -ClassAttribute- for |
| ARCCore.PKLogAttributeP | ARCCore | Enum | Describes class -PKLogAttribute. |
| ARCCore.ARConcepts.Indexing | ARCCore | EnumMember | In-memory indexing of data is done 'behind-the-scenes' by some classes implementing -IP-. |
| 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.ActualConnectionP.ConnectionInstruction | ARCCore | EnumMember | Only relevant when we are an -Outgoing-. |
| ARCCore.ARConcepts.CoreDBSynchronization | ARCCore | EnumMember | The concept of how multiple -CoreDB- instances synchronizes their data. |
| ARCCore.ClassAttributeP.SubTypes | ARCCore | EnumMember | Direct and indirect sub types of this class. |
| ARCCore.ActualConnectionP.ConnectionDirection | ARCCore | EnumMember | |
| 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.ClassAttributeP.Interfaces | ARCCore | EnumMember | All interfaces that this class and its base classes implement |
| ARCCore.ActualConnectionP.CountReceiveMessage | ARCCore | EnumMember | |
| ARCCore.ARConcepts.DataRetention | ARCCore | EnumMember | The concept of when to delete old data (if deemed necessary). |
| ARCCore.ClassAttributeP.InterfacesDirectlyImplemented | ARCCore | EnumMember | All interfaces that this class directly implements. |
| ARCCore.ActualConnectionP.CountSendMessage | ARCCore | EnumMember | |
| 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.ClassAttributeP.CorrespondingEnumType | ARCCore | EnumMember | Only relevant when implements -IP-. |
| ARCCore.ActualConnectionP.ClientUpdatePosition | ARCCore | EnumMember | Note how this is stored both as -ClientUpdatePosition- (on the client side) and -ClientUpdatePosition- (on the server side). |
| 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.ClassAttributeP.BoilerplateCodePropertiesAndStorage | ARCCore | EnumMember | Only relevant when implements -IP- and when a -CorrespondingEnumType- is found. |
| ARCCore.ActualConnectionP.SubscriptionAsRequestedByClient | ARCCore | EnumMember | Originates from -Subscription-. |
| 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.ClassMemberAttributeP | ARCCore | Enum | Describes class -ClassMemberAttribute-. |
| ARCCore.ActualConnectionP.ClosingReason | ARCCore | EnumMember | Reason why this connection was closed |
| 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.ClassMemberAttributeP.DeclaringType | ARCCore | EnumMember | The actual MemberInfo.DeclaringType. |
| 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.ARNodeType.CoreDB | ARCCore | EnumMember | A node containing the core or central database. |
| ARCCore.ClassMemberAttributeP.MethodName | ARCCore | EnumMember | The actual MemberInfo.Name. |
| ARCCore.ActualConnectionP.ErrorConditionData | ARCCore | EnumMember | Detailed explanation about -IsErrorCondition- |
| 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.ClassMemberAttributeP.MethodSignature | ARCCore | EnumMember | The actual MemberInfo.ToString. |
| ARCCore.ActualConnectionP.UnderClosure | ARCCore | EnumMember | Set to TRUE if to be closed and reinitialized. |
| ARCCore.ARNodeType.Client | ARCCore | EnumMember | An outer node / 'end' node with (usually) -ApplicationSpecificCode- but based on -ARADB-. |
| ARCCore.EnumAttributeP | ARCCore | Enum | Describes class -EnumAttribute-. |
| ARCCore.ActualConnectionP.MonkeyWrench | ARCCore | EnumMember | |
| ARCCore.Cardinality | ARCCore | Enum | Describes how multiple instances of a property is supposed to be handled. |
| ARCCore.EnumAttributeP.AssemblyName | ARCCore | EnumMember | The assembly in which this class resides. |
| ARCCore.ActualConnectionP.PartnerIPAddress | ARCCore | EnumMember | TODO: Use more strongly typing for this. |
| ARCCore.Cardinality.HistoryOnly | ARCCore | EnumMember | The default value. |
| ARCCore.EnumAttributeP.EnumNamespace | ARCCore | EnumMember | The namespace for -EnumType-. |
| ARCCore.ConnectionInstructionP | ARCCore | Enum | Describes class -ConnectionInstruction-. |
| 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.EnumAttributeP.EnumType | ARCCore | EnumMember | The type of the enum (like type of 'CustomerP' in CustomerP.FirstName) that we are an attribute for |
| 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.Cardinality.IndividualItems | ARCCore | EnumMember | Values are supposed to be set and 'deleted' individually. |
| ARCCore.EnumAttributeP.AREnumType | ARCCore | EnumMember | Note that will default to -__invalid- if not explicit set. |
| ARCCore.ConnectionInstructionP.ServerHostName | ARCCore | EnumMember | The host (DNS or IP-address) for which to connect. |
| ARCCore.PKLogAttributeP.DoNotLogAtAll | ARCCore | EnumMember | Originates from -DoNotLogAtAll-. |
| ARCCore.EnumAttributeP.CorrespondingClass | ARCCore | EnumMember | Only relevant when -PropertyKeyEnum-. |
| ARCCore.ConnectionInstructionP.ServerPortNo | ARCCore | EnumMember | The port number for which to connect. |
| ARCCore.PKLogAttributeP.CountInterval | ARCCore | EnumMember | For a value of n, log only every n'th time the property is changed. |
| ARCCore.EnumMemberAttributeP | ARCCore | Enum | Describes class -EnumMemberAttribute-. |
| ARCCore.ConnectionInstructionP.DataTransferDirection | ARCCore | EnumMember | |
| ARCCore.PKLogAttributeP.TimeInterval | ARCCore | EnumMember | Specifies a certain time interval for which the property's value shall be sent over the -PropertyStream-. |
| ARCCore.EnumMemberAttributeP.EnumType | ARCCore | EnumMember | The type of the enum (like type of 'CustomerP' in CustomerP.FirstName) that we are an attribute for |
| 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.PKRelAttributeP | ARCCore | Enum | Describes class -PKRelAttribute-. |
| ARCCore.EnumMemberAttributeP.EnumMember | ARCCore | EnumMember | The actual enum member / enum value (like 'Firstname' in CustomerP.FirstName) that we are an attribute for |
| ARCCore.ConnectionInstructionP.MultipleConnectionUsage | ARCCore | EnumMember | |
| ARCCore.PKRelAttributeP.ForeignEntity | ARCCore | EnumMember | The type of foreign entity that this property points to. |
| ARCCore.ARComponents | ARCCore | Enum | Contains short descriptions of the different 'official' AgoRapide components. |
| ARCCore.ConnectionInstructionP.Sharding | ARCCore | EnumMember | |
| ARCCore.PKRelAttributeP.EnforceReferentialIntegrity | ARCCore | EnumMember | If TRUE then referential integrity will be enforced by -TryStore-. |
| ARCCore.ARComponents.ARCCore | ARCCore | EnumMember | A necessary library (.DLL in Windows terms) that every -ARNodeType- should link to. |
| ARCCore.MultipleConnectionUsage | ARCCore | Enum | Enables fault-tolerance by describing use of multiple connections |
| ARCCore.PKTypeAttributeP | ARCCore | Enum | Describes class -PKTypeAttribute-. |
| ARCCore.ARComponents.ARADB | ARCCore | EnumMember | An application constituting the full functionality of a -CoreDB- (linking to -ARCCore-). |
| 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.PKTypeAttributeP.Type | ARCCore | EnumMember | The type of this Property. |
| ARCCore.ARComponents.ARAClient | ARCCore | EnumMember | A template application for a -Client- (linking to -ARCCore-). |
| ARCCore.MultipleConnectionUsage.RoundRobin | ARCCore | EnumMember | This connection to be used in a turn based system, together with other connections with -RoundRobin-. |
| ARCCore.PKTypeAttributeP.Cardinality | ARCCore | EnumMember | Describes how multiple instances of a property is supposed to be handled. |
| ARCCore.ARComponents.ARCDoc | ARCCore | EnumMember | A library supporting documentation and demonstrating usage of AgoRapide. |
| ARCCore.MultipleConnectionUsage.Simultaneous | ARCCore | EnumMember | This connection to be used simultaneously with other connections with -Simultaneous- |
| ARCCore.PKTypeAttributeP.IsObligatory | ARCCore | EnumMember | True means value is obligatory. |
| ARCCore.ARComponents.ARCQuery | ARCCore | EnumMember | ARCQuery provides a query language that mimicks SQL but is usable through HTTP as GET URLs. |
| ARCCore.StreamProcessorP.CountIncomingConnections | ARCCore | EnumMember | |
| ARCCore.PKTypeAttributeP.BoilerplateCodeProperties | ARCCore | EnumMember | Automatically generated boilerplate code that implements traditional setters and getters for this key. |
| ARCCore.ARComponents.ARCSync | ARCCore | EnumMember | (Not implemented as of March 2020) |
| ARCCore.StreamProcessorP.CountOutgoingConnections | |||
| ARCCore.PP | ARCCore | Enum | Describes meta data for any class (property) implementing -IP-. |
| ARCCore.ARComponents.ARCSec | ARCCore | EnumMember | (Not implemented as of March 2020) |
| ARCCore.StreamProcessorP.CountOutsideLocalReceiver | ARCCore | EnumMember | Count of calls to -OutsideLocalReceiver-. |
| ARCCore.PP.Created | ARCCore | EnumMember | Timestamp when property was created in database. |
| ARCCore.ARComponents.ARCAPI | ARCCore | EnumMember | A library providing an API on top of the -PropertyStream-. |
| ARCCore.StreamProcessorP.CountReceiveLocalOrigin | ARCCore | EnumMember | Count of -PropertyStreamLine- with -HasLocalOrigin-. |
| ARCCore.PP.Cid | ARCCore | EnumMember | Creator id (entity which created this property). |
| 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.StreamProcessorP.CountReceiveNonLocalOrigin | ARCCore | EnumMember | Count of -PropertyStreamLine- not with -HasLocalOrigin-. |
| ARCCore.PP.Value | ARCCore | EnumMember | The actual value. |
| ARCCore.ARConcepts | ARCCore | Enum | The overarching concepts upon which AgoRapide is built. |
| ARCCore.StorageFileP | ARCCore | Enum | Describes class -StorageFile-. |
| ARCCore.PP.Valid | ARCCore | EnumMember | Timestamp when property was last known to be (still) valid |
| ARCCore.ARConcepts.GettingStarted | ARCCore | EnumMember | AgoRapide 2020 is an open source library for building data-oriented backend applications using .NET Standard 2.1. |
| ARCCore.StorageFileP.Filename | ARCCore | EnumMember | |
| ARCCore.ARConcepts.PropertyStream | ARCCore | EnumMember | AgoRapide, the 'streams-of-water' database". |
| 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 |
| ARCCore.ARConcepts.TaggingOfPropertyKeys | ARCCore | EnumMember | The concept of specifying in a single place all relevant information about a given property (data field). |
| ARCCore.ConnectionDirection | ARCCore | Enum | The concept of who took the initiative for the connections (who asked to open the TCP/IP session). |
| ARCCore.ARConcepts.PropertyAccess | ARCCore | EnumMember | The general mechanism for accessing properties of objects in AgoRapide. |
| ARCCore.ConnectionDirection.Incoming | ARCCore | EnumMember | ConnectionInstruction will not be set for these. |
| ARCCore.ARConcepts.AvoidingRepetition | ARCCore | EnumMember | Avoiding repetition, the overarching philosophy that inspired the rest of AgoRapide. |
| ARCCore.ConnectionDirection.Outgoing | ARCCore | EnumMember | There would normally exist two live outgoing connection at a given point in time for -Client- / -ArmDB-: |
| ARCCore.ARConcepts.AgoRapideHistory | ARCCore | EnumMember | AgoRapide has roots back to 2011 when Bjørn Erling Fløtten invented panSL (SL = Schema language). |
| ARCCore.DataTransferDirection | ARCCore | Enum | Direction for transfer of data. |
| ARCCore.ARConcepts.AdHocQuery | ARCCore | EnumMember | The concept of a -Client- doing an ad-hoc query against (normally) a -ArmDB-. |
| 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-. |
| ARCCore.ARConcepts.StandardAgoRapideCode | ARCCore | EnumMember | Code originating from the main official AgoRapide distribution (which therefore does not include any end-application specific code) |
| ARCCore.DataTransferDirection.Receive | ARCCore | EnumMember | Like -Client- receiving data from an upstream -ArmDB- / -CoreDB- or -ArmDB- receiving data from an upstream -CoreDB-. |
| ARCCore.ARConcepts.ApplicationSpecificCode | ARCCore | EnumMember | Code specific for an end-application. |
| ARCCore.TPropertyKeyEnum | ARCCore | Enum | Placeholder for any enum type suitable as generic type parameter for -PExact-. |
| ARCCore.StreamProcessorP | ARCCore | Enum | Describes class -StreamProcessor-. |
| Assembly ARCDoc | Assembly | A library supporting documentation and demonstrating usage of AgoRapide. | |
| ARCCore.StreamProcessorP.LocalStorageFolder | ARCCore | EnumMember | The local path to which new properties are stored. Should NOT end with any trailing DirectorySeparatorChar |
| ARCDoc.Apple | ARCDoc | Class | The most 'standard' way of implementing an entity-class in AgoRapide, by just inheriting -PRich-. |
| 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-. |
| ARCDoc.Apple.AddName | ARCDoc | ClassMember | Convenience method, not obligatory. |
| ARCCore.StreamProcessorP.CurrentlyInitializing | ARCCore | EnumMember | Set to TRUE at initialization (signals for instance -ReceiveAndDistribute- that it can only queue messages, not process them). |
| ARCDoc.Apple.GetName | ARCDoc | ClassMember | Convenience method, not obligatory. |
| ARCCore.StreamProcessorP.ClientUpdatePositionPath | ARCCore | EnumMember | Complete path to file containing -ClientUpdatePosition-. |
| ARCDoc.Apple.TryGetName | ARCDoc | ClassMember | Convenience method, not obligatory. |
| ARCCore.StreamProcessorP.ClientUpdatePosition | ARCCore | EnumMember | Note how this is stored both as -ClientUpdatePosition- (on the client side) and -ClientUpdatePosition- (on the server side). |
| 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). |
| 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.Apple.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCCore.StreamProcessorP.UnderClosure | ARCCore | EnumMember | Set to TRUE if to be closed, whenever an exception occurs or when class goes out of scope |
| ARCDoc.Apple.Name | ARCDoc | ClassMember | Convenience method, not obligatory. |
| ARCCore.StreamProcessorP.WriteToConsole | ARCCore | EnumMember | If true then incoming data (from other nodes will be written to console. |
| ARCDoc.Banana | ARCDoc | Class | Implements -IP- directly and uses traditional property storage for optimum -MemoryConsumption- efficiency. |
| ARCCore.StreamProcessorP.Timestamp | ARCCore | EnumMember | The timestamp inserted at regular intervals in the -PropertyStream- according to -TimestampResolution-. |
| 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.TimestampIsOld | ARCCore | EnumMember | A warning sent by -StreamProcessor- to -OutsideLocalReceiver- when it knows that data as served is out of date. |
| 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.TimestampResolution | ARCCore | EnumMember | The time interval between each timestamp update in the -PropertyStream-. |
| ARCDoc.Demonstrator | ARCDoc | Class | Demonstrates various concepts from -ARCCore-, especially -PropertyAccess-. |
| 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.Demonstrator.DemonstratePropertyAccessApple | ARCDoc | ClassMember | Demonstrates use of -PropertyAccess- through the -Apple- class. |
| ARCCore.StreamProcessorP.DoNotStoreLocalOriginLocally | ARCCore | EnumMember | Means 'do not store local origin locally but wait until it gets confirmed by core storage'. |
| ARCDoc.Demonstrator.DemonstratePropertyAccessOrange | ARCDoc | ClassMember | Demonstrates use of -PropertyAccess- through the -Orange- class. |
| ARCCore.StreamProcessorP.CacheDiskWrites | ARCCore | EnumMember | If TRUE then will write the -PropertyStream- to disk in bigger chunks, thereby increasing performance. |
| ARCDoc.Demonstrator.DemonstratePropertyAccessBanana | ARCDoc | ClassMember | Demonstrates use of -PropertyAccess- through the -Banana- class. |
| ARCCore.StreamProcessorP.CopyFileStructureFromCore | ARCCore | EnumMember | If TRUE, will copy the exact file structure (through information given in -ClientUpdatePosition-). |
| ARCDoc.Demonstrator.DemonstrateITypeDescriber | ARCDoc | ClassMember | Demonstrates use of -ITypeDescriber- for describing single-property values. |
| ARCDoc.Demonstrator.DemonstratePropertyStream | ARCDoc | ClassMember | Demonstrates use of -PropertyStream- by generating local data (documentation data) and writing locally to console. |
| ARCDoc.Demonstrator.DemonstratePRichHierarchicalStorage | ARCDoc | ClassMember | Demonstrates use of -PRich-, how it receives -PropertyStream--lines and builds up a strongly typed hierarchical object storage. |
| ARCDoc.Demonstrator.DemonstrateBareBonesClient | ARCDoc | ClassMember | Demonstrates adding -PropertyStream--lines to -CoreDB- without using ANY AgoRapide component, only standard TCP/IP functionality in .NET. |
| ARCDoc.DocFrag.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCDoc.Demonstrator.DemonstrateLogConsole | ARCDoc | ClassMember | Demonstrates a quite simple log console. |
| ARCDoc.DocFragCollection | ARCDoc | Class | Contains a collection of -DocFrag- objects. |
| ARCDoc.Demonstrator.DemonstrateStreamProcessorAsClient | ARCDoc | ClassMember | Demonstrates use of -StreamProcessor- as a general client. |
| ARCDoc.DocFragCollection.Create | ARCDoc | ClassMember | Creates documentation fragments (-DocFrag-) for all possible -BaseAttribute- elements found in the given assemblies. |
| ARCDoc.Orange | ARCDoc | Class | Inherits -PExact- for probably the best compromise between memory consumption and easy of development. |
| 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.Orange.Name | ARCDoc | ClassMember | See -Name- for more information. |
| ARCDoc.DocFragCollection.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCDoc.Orange.Storage | ARCDoc | ClassMember | Uses int-value of -__enum- minus 1 as index. |
| ARCDoc.DocLink | ARCDoc | Class | Describes to where a single HTML link points. |
| ARCDoc.SomeAppComponent | ARCDoc | Class | Demonstrates how also your actual application classes, not only your data classes, should implement -IP-. |
| 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.SomeAppComponent.MethodC | ARCDoc | ClassMember | Note structured format in logging. |
| ARCDoc.DocLink.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCDoc.SomeAppComponent.MethodD | ARCDoc | ClassMember | Same as MethodC- but returns data ('Func<string>()' instead of 'Action()') |
| ARCDoc.DocLink.Location | ARCDoc | ClassMember | Copy of -Location-. |
| ARCDoc.SomeAppComponent.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCDoc.DocLink.Filename | ARCDoc | ClassMember | Copy of -LinkWordHTML-. |
| ARCDoc.DocFrag | ARCDoc | Class | DocFrag = Document fragment. |
| ARCDoc.DocLink.LinkWordHTML | ARCDoc | ClassMember | Copy of -LinkWordHTML-. |
| ARCDoc.DocFrag.Create Overload1 | ARCDoc | ClassMember | Creates a -DocFrag- object representing an assembly or a namespace. |
| ARCDoc.DocLink.LinkWordHTMLWithHyphens | ARCDoc | ClassMember | -LinkWordHTML- with '-' (minus sign / hyphen) prepended and appended. |
| ARCDoc.DocFrag.Create Overload2 | ARCDoc | ClassMember | Creates a -DocFrag- object representing a class, class member, enum or enum member. |
| 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.DocFrag.ToHTMLSimpleSingle | ARCDoc | ClassMember | Alternative ('override') to -ToHTMLSimpleSingle-. |
| ARCDoc.DocLink.LinkWordHTMLBeforeLtWithHyphens | ARCDoc | ClassMember | -LinkWordHTMLBeforeLt- with '-' (minus sign / hyphen) prepended and appended. |
| 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.DocLink.AHrefEndPart | ARCDoc | ClassMember | 'Filename.Encoded + "> + LinkWordHTML + </a>' |
| ARCDoc.DocLinkCollection.Create | ARCDoc | ClassMember | Notes all locations and their positions in the hierarchical directory structure. |
| ARCDoc.DocLinkCollection | ARCDoc | Class | Contains a collection of -DocLink- objects. |
| ARCDoc.DocLinkCollection.InsertLinks | ARCDoc | ClassMember | Does -LinkInsertionInDocumentation- on the given HTML content. |
| 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.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.Documentator.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCDoc.DocLinkCollection.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCDoc.Documentator.DocLinks | ARCDoc | ClassMember | Set by -CreateAndInsert-. |
| ARCDoc.DocLinkResolution | ARCDoc | Class | Contains a resolution page for a link word which has duplicate 'targets' (pointing to multiple -DocLink- instances). |
| ARCDoc.Documentator.DocLinkResolutionLocation | ARCDoc | ClassMember | Default position within the global storage context of doc link resolution pages. |
| ARCDoc.DocLinkResolution.ToHTMLSimpleSingle | ARCDoc | ClassMember | Gives a friendly description about possible targets for LinkWord-. |
| ARCDoc.DummyEnum | ARCDoc | Class | TODO: Document better what this is for (and change name) |
| 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). |
| 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.DocLinkResolution.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCDoc.DummyEnum.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCDoc.DocLinkResolutionCollection | ARCDoc | Class | Contains a collection of -DocLinkResolution- objects. |
| ARCDoc.Extensions | ARCDoc | Class | Contains various extension methods for -IP- and -IKIP- related to documentating / reporting / HTML. |
| 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). |
| ARCDoc.Extensions.ToHTMLSimpleSingleRecursive | ARCDoc | ClassMember | Calls -ToHTMLSimpleSingle- recursively. |
| ARCDoc.DocLinkResolutionCollection.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCDoc.Extensions.ToHTMLSimpleSingle | ARCDoc | ClassMember | Creates a simple HTML representation of the given parameter. |
| ARCDoc.Documentator | ARCDoc | Class | General class for documenting AgoRapide and also your own -ApplicationSpecificCode-. |
| ARCDoc.Extensions.ToHTMLSimpleSingleInternal | ARCDoc | ClassMember | Hack in order to escape check for direct implementation in actual class of -ToHTMLSimpleSingle- in -ToHTMLSimpleSingle-. |
| ARCDoc.Documentator.CreateAndInsert | ARCDoc | ClassMember | Creates an instance of -Documentator- with a natural hierarchical representation of documentation attributes found in the given assemblies. |
| 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.Documentator.ToHTMLSimpleSingle | ARCDoc | ClassMember | Alternative ('override') to -ToHTMLSimpleSingle-. |
| ARCDoc.Extensions.DescribeValue | ARCDoc | ClassMember | Describes the value contained withing an -IKIP- (-P-). |
| ARCDoc.Documentator.CreateHTOCStandard | ARCDoc | ClassMember | Creates a 'standard' table of contents, structured by assembly and each assembly divided into 'Class' and 'Enum'. |
| ARCDoc.Extensions.ValueToHTMLSimpleWithTooltip | ARCDoc | ClassMember | Creates a simple HTML representation of the Value with description as a 'tooltip'. |
| ARCDoc.Documentator.CreateHTOCNamespace | ARCDoc | ClassMember | Creates a table of contents structured by namespace |
| ARCDoc.Extensions.KeyToHTMLSimpleWithTooltip | ARCDoc | ClassMember | Creates a simple HTML representation of the Key with description as a 'tooltip'. |
| 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). |
| ARCDoc.HLocation | ARCDoc | Class | Simple class describing the location of a single -IP- instance within some hierarhical context. |
| ARCDoc.HLocation.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCDoc.OrangeP.Name | ARCDoc | EnumMember | The name of the orange |
| ARCDoc.HLocation.Content | ARCDoc | ClassMember | The Content object is not stored within the standard -IP--mechanism. |
| ARCDoc.OrangeP.Colour | ARCDoc | EnumMember | |
| ARCDoc.HLocationCollection | ARCDoc | Class | Contains a collection of -HLocation- objects. |
| ARCDoc.SomeAppComponentP | ARCDoc | Enum | Describes class -SomeAppComponent-. |
| ARCDoc.HLocationCollection.Create | ARCDoc | ClassMember | Transforms the parameter (and recursively all contained objects) into a collection of -HLocation- objects. |
| ARCDoc.SomeAppComponentP.SomeCountValue | ARCDoc | EnumMember | |
| ARCDoc.HLocationCollection.WriteAllContentHTMLToDisk | ARCDoc | ClassMember | Writes all -HLocation- results to a hierarhical folder structure as static HTML files with (optionally) -LinkInsertionInDocumentation-. |
| ARCDoc.SomeAppComponentP.SomeCountValueNotToBeLogged | ARCDoc | EnumMember | |
| 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). |
| ARCDoc.DocFragP | ARCDoc | Enum | Describes class -DocFrag-. |
| ARCDoc.HLocationCollection.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCDoc.DocFragP.DocFragType | ARCDoc | EnumMember | |
| ARCDoc.HTOC | ARCDoc | Class | HTOC = Hierarchical table of contents. |
| ARCDoc.DocFragP.Assembly | ARCDoc | EnumMember | Name of the assembly in which this fragment resides. |
| ARCDoc.HTOC.Create | ARCDoc | ClassMember | Structures content hierarchically according to the criteria for each level. |
| ARCDoc.DocFragP.Namespace | ARCDoc | EnumMember | Namespace in which this fragment resides. |
| ARCDoc.HTOC.ToHTMLSimpleSingle Overload2 | ARCDoc | ClassMember | Alternative ('override') to -ToHTMLSimpleSingle-. |
| ARCDoc.DocFragP.ParentNamespace | ARCDoc | EnumMember | Parent namespace of namespace in which this fragment resides. |
| ARCDoc.HTOC.ToHTMLSimpleSingle Overload1 | ARCDoc | ClassMember | Use this method in any class where a table-of-contents type of view is desireable |
| ARCDoc.DocFragP.Type | ARCDoc | EnumMember | Type of class or enum which this fragment describes (also relevant for class or enum member). |
| ARCDoc.HTOC.CreateInitialContent | ARCDoc | ClassMember | Helper method for creation of a -FilterBranch-. |
| ARCDoc.DocFragP.Name | ARCDoc | EnumMember | As simple a name as practical usable. Often not unique within a greater context. |
| 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). |
| ARCDoc.DocFragP.IsInherited | ARCDoc | EnumMember | Relevant for class members. TRUE if method is inherited from a base type. |
| ARCDoc.HTOC.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCDoc.DocFragP.IsInheritedDoc | ARCDoc | EnumMember | Relevant for class members (methods). |
| ARCDoc.HTOC.HTOCContentThisLevelKey | ARCDoc | ClassMember | The key used for storing the actual content at this level. |
| ARCDoc.DocFragP.Lines | ARCDoc | EnumMember | Number of lines of text in -Description- and -LongDescription- for this fragment. |
| ARCDoc.PKDocAttribute | ARCDoc | Class | Describes documentation and presentation of a property. |
| ARCDoc.DocFragP.Attribute | ARCDoc | EnumMember | The -BaseAttribute- or -PK- from which this -DocFrag- originates. |
| 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. |
| ARCDoc.DocFragType | ARCDoc | Enum | Type of documentation fragment, like -Assembly-, -Class- or -ClassMember-. |
| ARCDoc.PKDocAttribute.TryRemoveP | ARCDoc | ClassMember | Should probably never be used. |
| ARCDoc.DocFragType.Assembly | ARCDoc | EnumMember | |
| ARCDoc.PKDocAttribute.PriorityOrder | ARCDoc | ClassMember | |
| ARCDoc.DocFragType.Namespace | ARCDoc | EnumMember | |
| 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.DocFragType.Class | ARCDoc | EnumMember | Does also include interfaces. |
| ARCDoc.UtilDoc | ARCDoc | Class | Utility methods for -ARCDoc-. |
| ARCDoc.DocFragType.ClassMember | ARCDoc | EnumMember | |
| 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.DocFragType.Enum | ARCDoc | EnumMember | |
| ARCDoc.UtilDoc.GenerateHTMLPage | ARCDoc | ClassMember | Wraps the parameter inside a <html><head></head><body>...</body></html> enclosure with some rudimentare CSS. |
| ARCDoc.DocFragType.EnumMember | ARCDoc | EnumMember | |
| ARCDoc.HTOC+ParentChain | ARCDoc | Class | Used by -FilterNode- in order to keep track of node's parents. |
| ARCDoc.DocLinkP | ARCDoc | Enum | Describes class -DocLink-. |
| ARCDoc.AppleP | ARCDoc | Enum | Describes class -Apple-. |
| ARCDoc.DocLinkP.Location | ARCDoc | EnumMember | The location that this link points to. |
| ARCDoc.AppleP.Name | ARCDoc | EnumMember | The name of the apple |
| ARCDoc.DocLinkP.Filename | ARCDoc | EnumMember | |
| ARCDoc.AppleP.Colour | ARCDoc | EnumMember | |
| ARCDoc.DocLinkP.LinkWordHTML | ARCDoc | EnumMember | Actual link as it is expected to occur in text, like '-MyCustomerClass<T>-'. |
| ARCDoc.BananaP | ARCDoc | Enum | Describes class -Banana-. |
| ARCDoc.DocLinkResolutionP | ARCDoc | Enum | Describes class -DocLinkResolution- |
| ARCDoc.BananaP.Name | ARCDoc | EnumMember | The name of the banana |
| ARCDoc.DocLinkResolutionP.LinkWord | ARCDoc | EnumMember | |
| ARCDoc.BananaP.Colour | ARCDoc | EnumMember | |
| ARCDoc.DocLinkResolutionP.DocLinks | ARCDoc | EnumMember | The possible links for -LinkWord- |
| ARCDoc.OrangeP | ARCDoc | Enum | Describes class -Orange-. |
| ARCDoc.DocumentatorP | ARCDoc | Enum | Describes class -Documentator-. |
| ARCQuery.BinaryOperatorKey.QuantileKey | ARCQuery | ClassMember | Eventual final -QuantileKey- at end of compound key. |
| ARCDoc.DummyEnumP | ARCDoc | Enum | TODO: Document better what this is for (and change name) |
| ARCQuery.CompoundInvalidKey | ARCQuery | Class | Used as a practical solution in order to know that a given key has been attemped parsed, but was not valid. |
| 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 |
| ARCQuery.CompoundInvalidKey.TryGetPInternal | ARCQuery | ClassMember | The internal executor, containing the specific functionality for how to evaluate the key. |
| ARCDoc.HLocationP | ARCDoc | Enum | Describes class -HLocation-. |
| ARCQuery.CompoundInvalidKey.ToString | ARCQuery | ClassMember | The ToString representation is the one relevant when used as key, like in -IK- or when selecting like 'SELECT {fieldName}'. |
| ARCDoc.HLocationP.Location | ARCDoc | EnumMember | Folder names / hierarchical levels. |
| ARCQuery.CompoundInvalidKey.TryGetP | ARCQuery | ClassMember | The outwards facing executor, understanding use of -FunctionKeys-. |
| ARCDoc.HLocationP.Filename | ARCDoc | EnumMember | Either the last hierarhical key for the content's location, or Index.html if no location. |
| ARCQuery.CompoundInvalidKey.FunctionKeys | ARCQuery | ClassMember | All -FunctionKey-s chained at end of compound key (but before an eventual -QuantileKey-). |
| ARCDoc.HLocationP.ContentType | ARCDoc | EnumMember | The type of the content object. The actual content object is stored as -Content-. |
| ARCQuery.CompoundInvalidKey.QuantileKey | ARCQuery | ClassMember | Eventual final -QuantileKey- at end of compound key. |
| ARCDoc.PKDocAttributeP | ARCDoc | Enum | Describes class -PKDocAttribute-. |
| ARCQuery.CompoundKey | ARCQuery | Class | A class able to expand the concept of entity keys. |
| ARCDoc.PKDocAttributeP.PriorityOrder | ARCDoc | EnumMember | Used by -DescribeValue-. |
| ARCQuery.CompoundKey.TryGetP | ARCQuery | ClassMember | The outwards facing executor, understanding use of -FunctionKeys-. |
| ARCDoc.PriorityOrder | ARCDoc | Enum | Used for general sorting / prioritizing when showing properties for an entity. |
| ARCQuery.CompoundKey.TryGetPInternal | ARCQuery | ClassMember | The internal executor, containing the specific functionality for how to evaluate the key. |
| ARCDoc.PriorityOrder.NotImportant | ARCDoc | EnumMember | |
| ARCQuery.CompoundKey.Parse | ARCQuery | ClassMember | Note that no TryParse is offered here, because Parse will always succeed (it just returns -CompoundInvalidKey- if 'fails'). |
| ARCDoc.PriorityOrder.Important | ARCDoc | EnumMember | |
| 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}'. |
| Assembly ARCQuery | Assembly | ARCQuery provides a query language that mimicks SQL but is usable through HTTP as GET URLs. | |
| ARCQuery.CompoundKey.FunctionKeys | ARCQuery | ClassMember | All -FunctionKey-s chained at end of compound key (but before an eventual -QuantileKey-). |
| ARCQuery.BinaryOperatorKey | ARCQuery | Class | Offers expressions with operators like +, -, * and /. |
| ARCQuery.CompoundKey.QuantileKey | ARCQuery | ClassMember | Eventual final -QuantileKey- at end of compound key. |
| ARCQuery.BinaryOperatorKey.TryGetPInternal | ARCQuery | ClassMember | The internal executor, containing the specific functionality for how to evaluate the key. |
| ARCQuery.ConstantKey<T> | ARCQuery | Class | Represents a constant expression like "' '", "', '", "42". |
| 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.ConstantKey<T>.TryGetPInternal | ARCQuery | ClassMember | The internal executor, containing the specific functionality for how to evaluate the key. |
| ARCQuery.BinaryOperatorKey.TryGetP | ARCQuery | ClassMember | The outwards facing executor, understanding use of -FunctionKeys-. |
| 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}'. |
| ARCQuery.BinaryOperatorKey.FunctionKeys | ARCQuery | ClassMember | All -FunctionKey-s chained at end of compound key (but before an eventual -QuantileKey-). |
| ARCQuery.ConstantKey<T>.TryGetP | ARCQuery | ClassMember | The outwards facing executor, understanding use of -FunctionKeys-. |
| ARCQuery.ForeignKey.AllForeignKeysForEntityType | ARCQuery | ClassMember | Returns all possible foreign keys relevant for the given entity type, like for Order: 'Customer.FirstName' and 'Customer.LastName'. |
| ARCQuery.ConstantKey<T>.FunctionKeys | ARCQuery | ClassMember | All -FunctionKey-s chained at end of compound key (but before an eventual -QuantileKey-). |
| ARCQuery.ForeignKey.TryGetP | ARCQuery | ClassMember | The outwards facing executor, understanding use of -FunctionKeys-. |
| ARCQuery.ConstantKey<T>.QuantileKey | ARCQuery | ClassMember | Eventual final -QuantileKey- at end of compound key. |
| ARCQuery.ForeignKey.Steps | ARCQuery | ClassMember | The actual -ForeignKeySingleStep- leading to the -ForeignField-. |
| ARCQuery.EntityMethodKey | ARCQuery | Class | Key able to call read-only methods defined in the entity class with names like 'TryGet{FieldName}'. |
| ARCQuery.ForeignKey.StepsAreOnlyDirectionToOne | ARCQuery | ClassMember | If TRUE then -TryGetPInternal) will use much simpler code without collections and parallell executions. |
| ARCQuery.EntityMethodKey.TryGetPInternal | ARCQuery | ClassMember | The internal executor, containing the specific functionality for how to evaluate the key. |
| ARCQuery.ForeignKey.ForeignField | ARCQuery | ClassMember | The actual field in the final foreign entity to return value for. |
| 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.ForeignKey.AggregateKeys | ARCQuery | ClassMember | Aggregations to be used on the multiple foreign entity values that are found when one of the -Steps- are -ToMany-. |
| ARCQuery.EntityMethodKey.AllEntityMethodKeysForEntityType | ARCQuery | ClassMember | Returns methods for the given entity type that can be used by -EntityMethodKey-. |
| ARCQuery.ForeignKey.FunctionKeys | ARCQuery | ClassMember | All -FunctionKey-s chained at end of compound key (but before an eventual -QuantileKey-). |
| ARCQuery.EntityMethodKey.TryGetForeignField | ARCQuery | ClassMember | Returns foreign field through foreign key given. |
| ARCQuery.ForeignKey.QuantileKey | ARCQuery | ClassMember | Eventual final -QuantileKey- at end of compound key. |
| ARCQuery.EntityMethodKey.TryGetP | ARCQuery | ClassMember | The outwards facing executor, understanding use of -FunctionKeys-. |
| ARCQuery.ForeignKey.IPRelationsKeysPointingTo | ARCQuery | ClassMember | Contains, for each (entity type) key, a list of entity types with foreign keys pointing to that entity type. |
| ARCQuery.EntityMethodKey.Method | ARCQuery | ClassMember | The actuall TryGet method implemented in the relevant entity class. |
| ARCQuery.ForeignKey.IPRelationsKeysPointingFrom | ARCQuery | ClassMember | Contains, for each (entity type) key, a list of entity types which that entity type points to. |
| ARCQuery.EntityMethodKey.FunctionKeys | |||
| ARCQuery.MemberEntityKey | ARCQuery | Class | Can find value for entity which is member of entity being queried. |
| ARCQuery.EntityMethodKey.QuantileKey | ARCQuery | ClassMember | Eventual final -QuantileKey- at end of compound key. |
| ARCQuery.MemberEntityKey.TryGetPInternal | ARCQuery | ClassMember | The internal executor, containing the specific functionality for how to evaluate the key. |
| ARCQuery.ForeignKey | ARCQuery | Class | Can find related values, through compound field names. |
| ARCQuery.MemberEntityKey.ToString | ARCQuery | ClassMember | The ToString representation is the one relevant when used as key, like in -IK- or when selecting like 'SELECT {fieldName}'. |
| ARCQuery.ForeignKey.TryGetPInternal | ARCQuery | ClassMember | The internal executor, containing the specific functionality for how to evaluate the key. |
| ARCQuery.MemberEntityKey.TryGetP | ARCQuery | ClassMember | The outwards facing executor, understanding use of -FunctionKeys-. |
| ARCQuery.ForeignKey.ToString | ARCQuery | ClassMember | The ToString representation is the one relevant when used as key, like in -IK- or when selecting like 'SELECT {fieldName}'. |
| ARCQuery.MemberEntityKey.FunctionKeys | ARCQuery | ClassMember | All -FunctionKey-s chained at end of compound key (but before an eventual -QuantileKey-). |
| ARCQuery.FunctionKeyAggregateDistinct.SyntaxHelp | ARCQuery | ClassMember | 'Distinct()' |
| ARCQuery.MemberEntityKey.QuantileKey | ARCQuery | ClassMember | Eventual final -QuantileKey- at end of compound key. |
| ARCQuery.FunctionKeyAggregateJoin | ARCQuery | Class | Joins the given list of properties into a single property. |
| ARCQuery.OrdinaryKeyPlusFunctionOrQuantile | ARCQuery | Class | A -CompoundKey- containing some function keys or quantile key operating on an existing property of the entity in question. |
| ARCQuery.FunctionKeyAggregateJoin.SyntaxHelp | ARCQuery | ClassMember | 'Join()' |
| ARCQuery.OrdinaryKeyPlusFunctionOrQuantile.TryGetPInternal | ARCQuery | ClassMember | The internal executor, containing the specific functionality for how to evaluate the key. |
| ARCQuery.FunctionKeyAggregateMax | |||
| 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.FunctionKeyAggregateMax.SyntaxHelp | ARCQuery | ClassMember | 'Max()' |
| ARCQuery.OrdinaryKeyPlusFunctionOrQuantile.TryGetP | ARCQuery | ClassMember | The outwards facing executor, understanding use of -FunctionKeys-. |
| ARCQuery.FunctionKeyAggregateMin | ARCQuery | Class | Calculates the minimum value of the given properties. |
| ARCQuery.OrdinaryKeyPlusFunctionOrQuantile..ctor | ARCQuery | ClassMember | Note that calling only this constructor without afterwards setting -FunctionKeys- and / or -QuantileKey- would be meaningless. |
| ARCQuery.FunctionKeyAggregateMin.SyntaxHelp | ARCQuery | ClassMember | 'Min()' |
| ARCQuery.OrdinaryKeyPlusFunctionOrQuantile.FunctionKeys | ARCQuery | ClassMember | All -FunctionKey-s chained at end of compound key (but before an eventual -QuantileKey-). |
| ARCQuery.FunctionKeyAggregateSum | ARCQuery | Class | Sums the given properties. |
| ARCQuery.OrdinaryKeyPlusFunctionOrQuantile.QuantileKey | ARCQuery | ClassMember | Eventual final -QuantileKey- at end of compound key. |
| ARCQuery.Extensions | ARCQuery | Class | |
| ARCQuery.Extensions.TryGetP | ARCQuery | ClassMember | Same functionality as -TryGetP- but understands the concept of -CompoundKey-. |
| ARCQuery.FunctionKeyAggregate | ARCQuery | Class | Operates over a collection of properties. |
| ARCQuery.FunctionKeyAggregate.TryGetP | ARCQuery | ClassMember | NOTE: The in-parameter is a property, not an entity. |
| ARCQuery.FunctionKeyAggregateAvg | ARCQuery | Class | Calculates the average of the given properties. |
| ARCQuery.FunctionKeyAggregateAvg.SyntaxHelp | ARCQuery | ClassMember | 'Avg()' |
| ARCQuery.FunctionKeyAggregateCount | ARCQuery | Class | Counts the number of properties found. |
| ARCQuery.FunctionKeyAggregateCount.SyntaxHelp | ARCQuery | ClassMember | 'Count()' |
| ARCQuery.FunctionKeyAggregateDistinct | ARCQuery | Class | Returns a list of the distinct values of the given properties. |
| ARCQuery.FunctionKeyInt.TryGetP | ARCQuery | ClassMember | NOTE: The in-parameter is a property, not an entity. |
| ARCQuery.FunctionKeyInt.SyntaxHelp | ARCQuery | ClassMember | 'Int()' |
| ARCQuery.FunctionKeyLength | ARCQuery | Class | Returns length of (string) value of field, like 4 for 'John'. |
Generated 2026-11-04 23:22:22.610 UTC