[ROOT] doc DocFrag SELECT Assembly, DocFragType, Description.FirstLine() < SKIP 471 > < TAKE 128 >
128 items
DocFragId | Assembly | DocFragType | Description.FirstLine() |
---|---|---|---|
ARCCore.PSPrefix | ARCCore | Enum | Describes some recommended prefixes to use in a -PropertyStreamLine-. |
ARCCore.PSPrefix.dt | ARCCore | EnumMember | Data, single key + value. |
ARCCore.StreamProcessorP.TimestampResolution | ARCCore | EnumMember | The time interval between each timestamp update in the -PropertyStream-. |
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-. |
ARCCore.StreamProcessorP.DoNotStoreLocalOriginLocally | ARCCore | EnumMember | Means 'do not store local origin locally but wait until it gets confirmed by core storage'. |
ARCCore.StreamProcessorP.CacheDiskWrites | ARCCore | EnumMember | If TRUE then will write the -PropertyStream- to disk in bigger chunks, thereby increasing performance. |
ARCCore.StreamProcessorP.CopyFileStructureFromCore | ARCCore | EnumMember | If TRUE, will copy the exact file structure (through information given in -ClientUpdatePosition-). |
ARCCore.StreamProcessorP.CountIncomingConnections | ARCCore | EnumMember | |
ARCCore.StreamProcessorP.CountOutgoingConnections | ARCCore | EnumMember | |
ARCCore.StreamProcessorP.CountOutsideLocalReceiver | ARCCore | EnumMember | Count of calls to -OutsideLocalReceiver-. |
ARCCore.StreamProcessorP.CountReceiveLocalOrigin | ARCCore | EnumMember | Count of -PropertyStreamLine- with -HasLocalOrigin-. |
ARCCore.StreamProcessorP.CountReceiveNonLocalOrigin | ARCCore | EnumMember | Count of -PropertyStreamLine- not with -HasLocalOrigin-. |
ARCCore.StorageFileP | ARCCore | Enum | Describes class -StorageFile-. |
ARCCore.StorageFileP.Filename | ARCCore | EnumMember | |
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.ConnectionDirection | ARCCore | Enum | The concept of who took the initiative for the connections (who asked to open the TCP/IP session). |
ARCCore.ConnectionDirection.Incoming | ARCCore | EnumMember | ConnectionInstruction will not be set for these. |
ARCCore.ConnectionDirection.Outgoing | ARCCore | EnumMember | There would normally exist two live outgoing connection at a given point in time for -Client- / -ArmDB-: |
ARCDoc.Demonstrator | ARCDoc | Class | Demonstrates various concepts from -ARCCore-, especially -PropertyAccess-. |
ARCDoc.Demonstrator.DemonstratePropertyAccessApple | ARCDoc | ClassMember | Demonstrates use of -PropertyAccess- through the -Apple- class. |
ARCDoc.Demonstrator.DemonstratePropertyAccessOrange | ARCDoc | ClassMember | Demonstrates use of -PropertyAccess- through the -Orange- class. |
ARCDoc.Demonstrator.DemonstratePropertyAccessBanana | ARCDoc | ClassMember | Demonstrates use of -PropertyAccess- through the -Banana- class. |
ARCDoc.Demonstrator.DemonstrateITypeDescriber | ARCDoc | ClassMember | Demonstrates use of -ITypeDescriber- for describing single-property values. |
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.DemonstratePropertyStream | ARCDoc | ClassMember | Demonstrates use of -PropertyStream- by generating local data (documentation data) and writing locally to console. |
ARCDoc.Demonstrator.DemonstrateBareBonesClient | ARCDoc | ClassMember | Demonstrates adding -PropertyStream--lines to -CoreDB- without using ANY AgoRapide component, only standard TCP/IP functionality in .NET. |
ARCDoc.Demonstrator.DemonstrateLogConsole | ARCDoc | ClassMember | Demonstrates a quite simple log console. |
ARCDoc.Demonstrator.DemonstrateStreamProcessorAsClient | ARCDoc | ClassMember | Demonstrates use of -StreamProcessor- as a general client. |
ARCDoc.Orange | ARCDoc | Class | Inherits -PExact- for probably the best compromise between memory consumption and easy of development. |
ARCDoc.Orange.SetPVDirect | ARCDoc | ClassMember | High performance alternative to -TrySetP-, accessing -Storage- more direct. |
ARCDoc.Orange.GetPVDirect | ARCDoc | ClassMember | High performance alternative to -TryGetP-, accessing -Storage- more direct. |
ARCDoc.Orange.TryGetPVDirect | ARCDoc | ClassMember | High performance alternative to -TryGetP-, accessing -Storage- more direct. |
ARCDoc.Orange.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCDoc.Orange.Name | ARCDoc | ClassMember | See -Name- for more information. |
ARCDoc.DocLinkResolutionCollection | ARCDoc | Class | Contains a collection of -DocLinkResolution- objects. |
ARCDoc.DocLinkResolutionCollection.TryGetP | ARCDoc | ClassMember | Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway. |
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.DocLinkResolutionCollection.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCDoc.Documentator | ARCDoc | Class | General class for documenting AgoRapide and also your own -ApplicationSpecificCode-. |
ARCDoc.Documentator.CreateAndInsert | ARCDoc | ClassMember | Creates an instance of -Documentator- with a natural hierarchical representation of documentation attributes found in the given assemblies. |
ARCDoc.Documentator.ToHTMLSimpleSingle | ARCDoc | ClassMember | Alternative ('override') to -ToHTMLSimpleSingle-. |
ARCDoc.Documentator.CreateHTOCStandard | ARCDoc | ClassMember | Creates a 'standard' table of contents, structured by assembly and each assembly divided into 'Class' and 'Enum'. |
ARCDoc.Extensions.DescribeValue | ARCDoc | ClassMember | Describes the value contained withing an -IKIP- (-P-). |
ARCCore.ARComponents.ARCSec | ARCCore | EnumMember | (Not implemented as of March 2020) |
ARCCore.ConnectionInstructionP | ARCCore | Enum | Describes class -ConnectionInstruction-. |
ARCDoc.Extensions.ValueToHTMLSimpleWithTooltip | ARCDoc | ClassMember | Creates a simple HTML representation of the Value with description as a 'tooltip'. |
ARCCore.ARComponents.ARCAPI | ARCCore | EnumMember | A library providing an API on top of the -PropertyStream-. |
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. |
ARCDoc.Extensions.KeyToHTMLSimpleWithTooltip | ARCDoc | ClassMember | Creates a simple HTML representation of the Key with description as a 'tooltip'. |
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.ConnectionInstructionP.ServerHostName | ARCCore | EnumMember | The host (DNS or IP-address) for which to connect. |
ARCDoc.Extensions.GetHelptextHTML | ARCDoc | ClassMember | Returns content of -Description- and -LongDescription-. |
ARCCore.ARConcepts | ARCCore | Enum | The overarching concepts upon which AgoRapide is built. |
ARCCore.ConnectionInstructionP.ServerPortNo | ARCCore | EnumMember | The port number for which to connect. |
ARCDoc.HLocation | ARCDoc | Class | Simple class describing the location of a single -IP- instance within some hierarhical context. |
ARCCore.ARConcepts.GettingStarted | ARCCore | EnumMember | AgoRapide 2020 is an open source library for building data-oriented backend applications using .NET. |
ARCCore.ConnectionInstructionP.ConnectionId | ARCCore | EnumMember | Usually a combination of -ClientId-, -ServerHostName- and -ServerPortNo-. |
ARCDoc.HLocation.TryGetP | ARCDoc | ClassMember | Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway. |
ARCCore.ARConcepts.PropertyStream | ARCCore | EnumMember | AgoRapide, the 'streams-of-water' database". |
ARCCore.ConnectionInstructionP.DataTransferDirection | ARCCore | EnumMember | |
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). |
ARCCore.ARConcepts.PropertyStream2D | ARCCore | EnumMember | PropertyStream2D is an expansion of the -PropertyStream- concept supported by the library -ARCEvent-. |
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. |
ARCDoc.HLocation.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCCore.ARConcepts.EventSourcing | ARCCore | EnumMember | (related to -ARCEvent-). |
ARCCore.ConnectionInstructionP.MultipleConnectionUsage | ARCCore | EnumMember | |
ARCQuery.FunctionKeyDouble.TryGetP | ARCQuery | ClassMember | NOTE: The in-parameter is a property, not an entity. |
ARCCore.ARConcepts.StandardAgoRapideCode | ARCCore | EnumMember | Code originating from the main official AgoRapide distribution (which therefore does not include any end-application specific code) |
ARCDoc.PKDocAttribute | ARCDoc | Class | Describes documentation and presentation of a property. |
ARCQuery.FunctionKeyDouble.SyntaxHelp | ARCQuery | ClassMember | 'Double()' |
ARCCore.ARConcepts.ApplicationSpecificCode | ARCCore | EnumMember | Code specific for an end-application. |
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. |
ARCQuery.FunctionKeyFirstLine | ARCQuery | Class | Extracts first line from string of text. |
ARCCore.ARConcepts.MemoryConsumption | ARCCore | EnumMember | A naïve implementation of key-value storages like AgoRapide may lead to excessive memory (RAM) consumption. |
ARCDoc.PKDocAttribute.TryRemoveP | ARCDoc | ClassMember | Should probably never be used. |
ARCQuery.FunctionKeyFirstLine.TryGetP | ARCQuery | ClassMember | NOTE: The in-parameter is a property, not an entity. |
ARCCore.ARConcepts.Indexing | ARCCore | EnumMember | In-memory indexing of data is done 'behind-the-scenes' by some classes implementing -IP-. |
ARCDoc.PKDocAttribute.PriorityOrder | ARCDoc | ClassMember | See -PriorityOrder-. |
ARCQuery.FunctionKeyFirstLine.SyntaxHelp | ARCQuery | ClassMember | 'FirstLine()' |
ARCCore.ARConcepts.CoreDBSynchronization | ARCCore | EnumMember | The concept of how multiple -CoreDB- instances synchronizes their data. |
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.) |
ARCQuery.FunctionKeyVeryShort | ARCQuery | Class | Returns the -ToStringVeryShort- representation of the given type. |
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-). |
ARCDoc.UtilDoc | ARCDoc | Class | Utility methods for -ARCDoc-. |
ARCQuery.FunctionKeyVeryShort.TryGetP | ARCQuery | ClassMember | NOTE: The in-parameter is a property, not an entity. |
ARCCore.ARConcepts.DataRetention | ARCCore | EnumMember | The concept of when to delete old data (if deemed necessary). |
ARCDoc.UtilDoc.GetCurrentLevelInHierarchyAsHTML | ARCDoc | ClassMember | Returns an HTML presentation of the given link context, with links pointing backwards to each level in the hierarchy. |
ARCQuery.FunctionKeyVeryShort.SyntaxHelp | ARCQuery | ClassMember | 'VeryShort()' |
ARCCore.ARConcepts.NoRealDeletion | ARCCore | EnumMember | AgoRapide has no real concept for deletion of data (apart from -DataRetention-, which is mostly relevant for 'old' data). |
ARCDoc.UtilDoc.GenerateHTMLPage | ARCDoc | ClassMember | Wraps the parameter inside a <html><head></head><body>...</body></html> enclosure with some rudimentare CSS. |
ARCQuery.FunctionKeyHourMinute | ARCQuery | Class | Formats a timespan with only the hour and minute part. Uses format hh:mm. |
ARCCore.PKTypeAttributeP.Cardinality | ARCCore | EnumMember | Describes how multiple instances of a property is supposed to be handled. |
ARCDoc.UtilDoc.GlobalHeaderHTML | ARCDoc | ClassMember | Global header to be inserted at the top of every HTML page created by -GenerateHTMLPage-. |
ARCQuery.FunctionKeyHourMinute.TryGetP | ARCQuery | ClassMember | NOTE: The in-parameter is a property, not an entity. |
ARCCore.PKTypeAttributeP.IsObligatory | ARCCore | EnumMember | True means value is obligatory. |
ARCDoc.HTOC+ParentChain | ARCDoc | Class | Used by -FilterNode- in order to keep track of node's parents. |
ARCQuery.FunctionKeyHourMinute.SyntaxHelp | ARCQuery | ClassMember | 'HourMinute()' |
ARCCore.PKTypeAttributeP.BoilerplateCodeProperties | ARCCore | EnumMember | Automatically generated boilerplate code that implements traditional setters and getters for this key. |
ARCDoc.AppleP | ARCDoc | Enum | Describes class -Apple-. |
ARCQuery.FunctionKeyInt | ARCQuery | Class | Rounds a double value to the nearest integer (uses .NET data type Int64 (long)). |
ARCCore.PP | ARCCore | Enum | Describes meta data for any class (property) implementing -IP-. |
ARCDoc.AppleP.Name | ARCDoc | EnumMember | The name of the apple |
ARCQuery.FunctionKeyInt.TryGetP | ARCQuery | ClassMember | NOTE: The in-parameter is a property, not an entity. |
ARCCore.PP.Created | ARCCore | EnumMember | Timestamp when property was created in database. |
ARCDoc.AppleP.Colour | ARCDoc | EnumMember | |
ARCQuery.FunctionKeyInt.SyntaxHelp | ARCQuery | ClassMember | 'Int()' |
ARCCore.PP.Cid | ARCCore | EnumMember | Creator id (entity which created this property). |
ARCDoc.BananaP | ARCDoc | Enum | Describes class -Banana-. |
ARCQuery.FunctionKeyLength | ARCQuery | Class | Returns length of (string) value of field, like 4 for 'John'. |
ARCCore.PP.Value | ARCCore | EnumMember | The actual value. |
ARCDoc.BananaP.Name | ARCDoc | EnumMember | The name of the banana |
ARCQuery.FunctionKeyLength.TryGetP | ARCQuery | ClassMember | NOTE: The in-parameter is a property, not an entity. |
ARCCore.PP.Valid | ARCCore | EnumMember | Timestamp when property was last known to be (still) valid |
ARCDoc.BananaP.Colour | ARCDoc | EnumMember | |
ARCQuery.FunctionKeyTotalMinutes | ARCQuery | Class | Converts a timespan to total minutes (as an integer). |
ARCCore.ActualConnectionP.ClientUpdatePosition | ARCCore | EnumMember | Note how this is stored both as -ClientUpdatePosition- (on the client side) and -ClientUpdatePosition- (on the server side). |
ARCDoc.OrangeP | ARCDoc | Enum | Describes class -Orange-. |
ARCQuery.FunctionKeyTotalMinutes.TryGetP | ARCQuery | ClassMember | NOTE: The in-parameter is a property, not an entity. |
ARCCore.ActualConnectionP.SubscriptionAsRequestedByClient | ARCCore | EnumMember | Originates from -Subscription-. |
ARCDoc.OrangeP.Name | ARCDoc | EnumMember | The name of the orange |
ARCQuery.FunctionKeyTotalMinutes.SyntaxHelp | ARCQuery | ClassMember | 'TotalMinutes()' |
ARCCore.ActualConnectionP.ClosingReason | ARCCore | EnumMember | Reason why this connection was closed |
ARCDoc.OrangeP.Colour | ARCDoc | EnumMember | |
ARCQuery.FunctionKeyType | ARCQuery | Class | Returns the type of a property. |
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. |
ARCDoc.SomeAppComponentP | ARCDoc | Enum | Describes class -SomeAppComponent-. |
ARCQuery.FunctionKeyType.TryGetP | ARCQuery | ClassMember | NOTE: The in-parameter is a property, not an entity. |
ARCCore.ActualConnectionP.ErrorConditionData | ARCCore | EnumMember | Detailed explanation about -IsErrorCondition- |
Generated 2025-09-17 22:50:21.458 UTC