[ROOT] doc DocFrag SELECT Assembly, DocFragType, Description.FirstLine() < SKIP 138 > < TAKE 448 >
448 items
DocFragId | Assembly | DocFragType | Description.FirstLine() |
---|---|---|---|
ARCCore.IKString | ARCCore | Class | Index key for any general id, like primary-key or sequence-number or similar. |
ARCCore.ARConcepts.EventStream | ARCCore | EnumMember | The concept in -ARCEvent- of an "axis" (usefully referred to as the horizontal axis) within the concept of -PropertyStream2D-. |
ARCCore.IKString.FromCache | ARCCore | ClassMember | Reduces number of objects generated by caching those known to be within a limited range |
ARCCore.ARConcepts.TransientEventTree | ARCCore | EnumMember | The concept in -ARCEvent- of how an -Event- in the -EventStream- generates transient events which in turn may generate |
ARCCore.IKString.FromString | ARCCore | ClassMember | Note how uses instance cache if already exists there |
ARCCore.ARConcepts.TaggingOfPropertyKeys | ARCCore | EnumMember | The concept of specifying in a single place all relevant information about a given property (data field). |
ARCCore.IKString.op_Equality | ARCCore | ClassMember | It is quite natural in the code to write code like "if (a.CustomerId == b.CustomerId)", therefore the need to implement == and != operators here. |
ARCCore.ARConcepts.PropertyAccess | ARCCore | EnumMember | The general mechanism for accessing properties of objects in AgoRapide. |
ARCCore.IKString.EnrichKey | ARCCore | ClassMember | 'Implementing' -ITypeDescriber-. |
ARCCore.ARConcepts.AvoidingRepetition | ARCCore | EnumMember | Avoiding repetition, the overarching philosophy that inspired the rest of AgoRapide. |
ARCCore.IKType | ARCCore | Class | Index key used when storing a collection of a given type, like 'Customer'. |
ARCCore.ARConcepts.AgoRapideHistory | ARCCore | EnumMember | AgoRapide has roots back to 2011 when Bjørn Erling Fløtten invented panSL (SL = Schema language). |
ARCCore.IKType.ToString | ARCCore | ClassMember | Caching is supposed to be useful because may be called quite often. |
ARCCore.ARConcepts.AdHocQuery | ARCCore | EnumMember | The concept of a -Client- doing an ad-hoc query against (normally) a -ArmDB-. |
ARCCore.ITypeDescriber | ARCCore | Class | Provides a standardized mechanism for describing single-property values (like 'PhoneNumber' of 'Customer' for instance). |
ARCCore.ARConcepts.StandardAgoRapideCode | ARCCore | EnumMember | Code originating from the main official AgoRapide distribution (which therefore does not include any end-application specific code) |
ARCCore.ITypeDescriber.GetSyntaxHelp | ARCCore | ClassMember | Enables explanation of syntax in different contexts from one source: |
ARCCore.ARConcepts.ApplicationSpecificCode | ARCCore | EnumMember | Code specific for an end-application. |
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.ARConcepts.MemoryConsumption | ARCCore | EnumMember | A naïve implementation of key-value storages like AgoRapide may lead to excessive memory (RAM) consumption. |
ARCCore.ParseResult.Result | ARCCore | ClassMember | Will be null if ErrorResponse is set. |
ARCCore.ARConcepts.Indexing | ARCCore | EnumMember | In-memory indexing of data is done 'behind-the-scenes' by some classes implementing -IP-. |
ARCCore.ParseResult.ErrorResponse | ARCCore | ClassMember | Will be null if Result is set |
ARCCore.ARConcepts.CoreDBSynchronization | ARCCore | EnumMember | The concept of how multiple -CoreDB- instances synchronizes their data. |
ARCCore.PK | ARCCore | Class | PK = AgoRapide PropertyKey. |
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.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.ARConcepts.DataRetention | ARCCore | EnumMember | The concept of when to delete old data (if deemed necessary). |
ARCCore.PK.TryGetV | ARCCore | ClassMember | Only type of PK, string or type of __enum is allowed to ask for (as TRequest generic type parameter). |
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.PK.GetA | ARCCore | ClassMember | Convenience method for easy access to -BasePKAttribute- with corresponding explaining exception if fails |
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.PK.TryGetA | ARCCore | ClassMember | Convenience method for easy access to -BasePKAttribute-. |
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.PK.ModifyCleanerAndValidatorAndParserForCardinality | ARCCore | ClassMember | Called from -Initialize- after _cleaner and _validatorAndParser have been set. |
ARCCore.ARConcepts.AssertionsAndDetailedExceptionMessages | ARCCore | EnumMember | The abstraction level in AgoRapide is very high. |
ARCCore.PK.ToString | ARCCore | ClassMember | Caching is supposed to be useful because may be called quite often. |
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.PK.TryValidateAndParse | ARCCore | ClassMember | Parses the value according to specifications for this property key. |
ARCCore.ARConcepts.LinkInsertionInDocumentation | ARCCore | EnumMember | Documentation with links is much easier to read. |
ARCCore.PK.TryCleanValidateAndParse | ARCCore | ClassMember | Cleans and parses the value according to specifications for this property key. |
ARCCore.ARConcepts.TryPatternAndNull | ARCCore | EnumMember | AgoRapide uses non-nullable reference types as default throughout the system |
ARCCore.PK.PackParseResultForStorageInEntityObject | ARCCore | ClassMember | Packs result of parsing into a -IP--derived class, suitable for sending to -AddOrUpdateP-. |
ARCCore.AREnumType | ARCCore | Enum | Categories different types of enum used in AgoRapide. The most important one is -PropertyKeyEnum-. |
ARCCore.PK.PackObjectForStorageInEntityObject | ARCCore | ClassMember | See -PackParseResultForStorageInEntityObject- for documentation. |
ARCCore.AREnumType.PropertyKeyEnum | ARCCore | EnumMember | Designates enums that describe relevant values for an 'entity' object like 'Customer'. |
ARCCore.PK.FromEnum | ARCCore | ClassMember | Returns the corresponding -PK- instance from the given -PropertyKeyEnum-. |
ARCCore.AREnumType.OrdinaryEnum | ARCCore | EnumMember | Designates "Ordinary" enums used for indicating range of valid values for a given key |
ARCCore.PK.TryGetFromTypeAndFieldName Overload3 | ARCCore | ClassMember | Returns property key based on type and field name. |
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.PK.TryGetFromTypeAndFieldName Overload2 | ARCCore | ClassMember | Returns property key based on type and field name. |
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.PK.TryGetFromTypeAndFieldName Overload1 | ARCCore | ClassMember | Returns property key based on type and field name. |
ARCCore.ARNodeType.CoreDB | ARCCore | EnumMember | A node containing the core or central database. |
ARCCore.PK.GetAllPKForEntityType | ARCCore | ClassMember | Returns all property keys relevant for the given entity type, |
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.PK.GetAllPKForEntityTypeString | ARCCore | ClassMember | Returns all property keys relevant for the given entity type, |
ARCCore.ARNodeType.Client | ARCCore | EnumMember | An outer node / 'end' node with (usually) -ApplicationSpecificCode- but based on -ARADB-. |
ARCCore.PK.BuildFromStringCache | ARCCore | ClassMember | Builds the content of -_fromStringCache- and also -_allPKForEntityTypeCache-. |
ARCCore.Cardinality | ARCCore | Enum | Describes how multiple instances of a property is supposed to be handled. |
ARCCore.PK.GetTypeMapping | ARCCore | ClassMember | Returns the relevant property key for a given type entity-type and field-type. |
ARCCore.Cardinality.HistoryOnly | ARCCore | EnumMember | The default value. |
ARCCore.PK.GetObligatoryValuesForEntityType | ARCCore | ClassMember | Returns all obligatory values (based on -IsObligatory-) |
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.PK.Equals | ARCCore | ClassMember | Note that ToString is only based on __enum, meaning that two enum members / enum values with same name but different type, like CustomerP.Name and OrderP.Name, will be considered equal. |
ARCCore.Cardinality.IndividualItems | ARCCore | EnumMember | Values are supposed to be set and 'deleted' individually. |
ARCCore.PK.TryGetP | ARCCore | ClassMember | Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway. |
ARCCore.PSPrefix | ARCCore | Enum | Describes some recommended prefixes to use in a -PropertyStreamLine-. |
ARCCore.PK..ctor | ARCCore | ClassMember | Constructor with 'object _enum' is necessary in order for ToString to work. |
ARCCore.PSPrefix.dt | ARCCore | EnumMember | Data, single key + value. |
ARCCore.PK.Type | ARCCore | ClassMember | Returns type from -PKTypeAttribute-'s -Type-. |
ARCCore.PSPrefix.dtr | ARCCore | EnumMember | Data, whole records. |
ARCCore.PK.Cardinality | ARCCore | ClassMember | Returns cardinality from -PKTypeAttribute-'s -Cardinality-. |
ARCCore.PSPrefix.RS | ARCCore | EnumMember | RS = Registration Stream (see -RegStream-). |
ARCCore.PK.CorrespondingClass | ARCCore | ClassMember | Returns -CorrespondingClass- based on -__enum-. |
ARCCore.PSPrefix.ES | ARCCore | EnumMember | ES = Event Stream (see -EventStream-). |
ARCCore.PK.ValidatorAndParser | ARCCore | ClassMember | Validates and parses a value. |
ARCCore.PSPrefix.cmd | ARCCore | EnumMember | Command. |
ARCCore.PK.Cleaner | ARCCore | ClassMember | Cleanup of values, to be used before value is attempted validated. |
ARCCore.PSPrefix.app | ARCCore | EnumMember | Application state, like app/ |
ARCCore.PK.AllEnums | ARCCore | ClassMember | All enums for the whole application. |
ARCCore.PSPrefix.doc | ARCCore | EnumMember | Documentation. |
ARCCore.PK.AllPKEnums | ARCCore | ClassMember | All -PropertyKeyEnum--tagged enums for the whole application. |
ARCCore.PSPrefix.t | ARCCore | EnumMember | Translations. |
ARCCore.PK.__enum | ARCCore | ClassMember | This information is also found as EnumMember. |
ARCCore.PKHTMLAttributeP | ARCCore | Enum | Describes class -PKRelAttribute-. |
ARCCore.PKHTMLAttribute | ARCCore | Class | Contains pointer to HTML encoder for a property. |
ARCCore.PKHTMLAttributeP.Encoder | ARCCore | EnumMember | The class doing the HTML-encoding. |
ARCCore.PKHTMLAttribute.Encode | ARCCore | ClassMember | Encodes the given string to HTML format through the static method implemented in class -Encoder-. |
ARCCore.PKLogAttributeP | ARCCore | Enum | Describes class -PKLogAttribute. |
ARCCore.PKHTMLAttribute.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.PKLogAttributeP.DoNotLogAtAll | ARCCore | EnumMember | Originates from -DoNotLogAtAll-. |
ARCCore.PKHTMLAttribute.TryRemoveP | ARCCore | ClassMember | Should probably never be used. |
ARCCore.PKLogAttributeP.CountInterval | ARCCore | EnumMember | For a value of n, log only every n'th time the property is changed. |
ARCCore.PKHTMLAttribute.Encoder | ARCCore | ClassMember | See -Encoder-. |
ARCCore.PKLogAttributeP.TimeInterval | ARCCore | EnumMember | Specifies a certain time interval for which the property's value shall be sent over the -PropertyStream-. |
ARCCore.PKHTMLAttribute.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.PKRelAttributeP | ARCCore | Enum | Describes class -PKRelAttribute-. |
ARCCore.IHTMLEncoder | ARCCore | Class | Pseudo-interface signifying that implementing class has a static metod called 'Encode' for encoding a string to HTML. |
ARCCore.PKRelAttributeP.ForeignEntity | ARCCore | EnumMember | The type of foreign entity that this property points to. |
ARCCore.PKLogAttribute | ARCCore | Class | Explains how logging of changes to a property should be done. |
ARCCore.PKRelAttributeP.OppositeTerm | ARCCore | EnumMember | Example: For 'Employee', the key 'SupervisorId' where the supervisor is another 'Employee', will have another meaning "as seen from" the Supervisor, namely "Subordinates" or similar. |
ARCCore.PKLogAttribute.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.PKRelAttributeP.EnforceReferentialIntegrity | ARCCore | EnumMember | If TRUE then referential integrity will be enforced by -TryStore-. |
ARCCore.PKLogAttribute.TryRemoveP | ARCCore | ClassMember | Should probably never be used. |
ARCCore.PKTypeAttributeP | ARCCore | Enum | Describes class -PKTypeAttribute-. |
ARCCore.PKLogAttribute.DoNotLogAtAll | ARCCore | ClassMember | See -DoNotLogAtAll-. |
ARCCore.PKTypeAttributeP.Type | ARCCore | EnumMember | The type of this Property. |
ARCCore.PKLogAttribute.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.PKTypeAttributeP.DefaultValue | ARCCore | EnumMember | The default value. |
ARCCore.PKRelAttribute | ARCCore | Class | Describes relationships between entities (between tables in RDBMS terms). |
ARCCore.PKTypeAttributeP.Cardinality | ARCCore | EnumMember | Describes how multiple instances of a property is supposed to be handled. |
ARCCore.PKRelAttribute.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.PKTypeAttributeP.IsObligatory | ARCCore | EnumMember | True means value is obligatory. |
ARCCore.PKRelAttribute.TryRemoveP | ARCCore | ClassMember | Should probably never be used. |
ARCCore.PKTypeAttributeP.BoilerplateCodeProperties | ARCCore | EnumMember | Automatically generated boilerplate code that implements traditional setters and getters for this key. |
ARCCore.PKRelAttribute.ForeignEntity | ARCCore | ClassMember | See -ForeignEntity-. |
ARCCore.PP | ARCCore | Enum | Describes meta data for any class (property) implementing -IP-. |
ARCCore.PKRelAttribute.OppositeTerm | ARCCore | ClassMember | See -OppositeTerm-. |
ARCCore.PP.Created | ARCCore | EnumMember | Timestamp when property was created in database. |
ARCCore.PKRelAttribute.EnforceReferentialIntegrity | ARCCore | ClassMember | See -EnforceReferentialIntegrity-. |
ARCCore.PP.Cid | ARCCore | EnumMember | Creator id (entity which created this property). |
ARCCore.PKRelAttribute.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.PP.Value | ARCCore | EnumMember | The actual value. |
ARCCore.PKTypeAttribute | ARCCore | Class | Contains the most basic essential information about a property key, like its description, -Type-, -Cardinality-, -IsObligatory- and -DefaultValue-. |
ARCCore.PP.Valid | ARCCore | EnumMember | Timestamp when property was last known to be (still) valid |
ARCCore.PKTypeAttribute.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.PP.Vid | ARCCore | EnumMember | Validator id, that is entity which set -Valid- for this property. |
ARCCore.PKTypeAttribute.StandardValidatorAndParser | ARCCore | ClassMember | Returns validator and parser for well known types like string, int, long, bool, DateTime, TimeSpan, Type, Uri. |
ARCCore.PP.Invalid | ARCCore | EnumMember | Timestamp when property was invalidated / 'deleted'. |
ARCCore.PKTypeAttribute.StandardCleaner | ARCCore | ClassMember | Returns a cleaner for well known types like bool |
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.PKTypeAttribute.TryRemoveP | ARCCore | ClassMember | Should probably never be used. |
ARCCore.PP.ExceptionText | ARCCore | EnumMember | General property for logging of exceptions, usually set through -HandleException-. |
ARCCore.PKTypeAttribute.Type | ARCCore | ClassMember | See -Type-. |
ARCCore.PConcurrentP | ARCCore | Enum | Describes class -PConcurrent-. |
ARCCore.PKTypeAttribute.Cardinality | ARCCore | ClassMember | See -Cardinality-. |
ARCCore.PConcurrentP.Heartbeat | ARCCore | EnumMember | |
ARCCore.PKTypeAttribute.DefaultValue | ARCCore | ClassMember | See -DefaultValue-. |
ARCCore.ActualConnectionP | ARCCore | Enum | Describes class -ActualConnection-. |
ARCCore.PKTypeAttribute.IsObligatory | ARCCore | ClassMember | See -IsObligatory-. |
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.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.ActualConnectionP.ConnectionInstruction | ARCCore | EnumMember | Only relevant when we are an -Outgoing-. |
ARCCore.IP | ARCCore | Class | IP = IProperty. |
ARCCore.ActualConnectionP.ConnectionDirection | ARCCore | EnumMember | |
ARCCore.IP.TryGetV Overload2 | ARCCore | ClassMember | The actual value of the property. Mostly relevant for single-value properties like -PValue-. |
ARCCore.ActualConnectionP.CountReceiveMessage | ARCCore | EnumMember | |
ARCCore.IP.Inc | ARCCore | ClassMember | Increments given property key by 1. Sets to 1 if not found. Uses long, not integer. |
ARCCore.ActualConnectionP.CountSendMessage | ARCCore | EnumMember | |
ARCCore.IP.Dec | ARCCore | ClassMember | Decrements given property key by 1. Sets to -1 if not found. Uses long, not integer. |
ARCCore.ActualConnectionP.ClientUpdatePosition | ARCCore | EnumMember | Note how this is stored both as -ClientUpdatePosition- (on the client side) and -ClientUpdatePosition- (on the server side). |
ARCCore.IP.Log | ARCCore | ClassMember | The 'final' overload of -Log- that is called by the other overloads. |
ARCCore.ActualConnectionP.SubscriptionAsRequestedByClient | ARCCore | EnumMember | Originates from -Subscription-. |
ARCCore.IP.LogExecuteTime | ARCCore | ClassMember | Times the execution of the given function and logs details about elapsed time. |
ARCCore.ActualConnectionP.ClosingReason | ARCCore | EnumMember | Reason why this connection was closed |
ARCCore.IP.HandleException | ARCCore | ClassMember | Note that most relevant to use for -PConcurrent-. |
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.IP.TryParseDtr | ARCCore | ClassMember | Parses a PropertyStreamLine- beginning with -dtr-. |
ARCCore.ActualConnectionP.ErrorConditionData | ARCCore | EnumMember | Detailed explanation about -IsErrorCondition- |
ARCCore.IP.Initialize | ARCCore | ClassMember | Note that has a default implementation (doing nothing). |
ARCCore.ActualConnectionP.UnderClosure | ARCCore | EnumMember | Set to TRUE if to be closed and reinitialized. |
ARCCore.IP.AssertIntegrity | ARCCore | ClassMember | See -TryAssertIntegrity-. |
ARCCore.ActualConnectionP.MonkeyWrench | ARCCore | EnumMember | |
ARCCore.IP.TryAssertIntegrity | ARCCore | ClassMember | Asserts the integrity of this entity. |
ARCCore.ActualConnectionP.PartnerIPAddress | ARCCore | EnumMember | TODO: Use more strongly typing for this. |
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.ConnectionInstructionP | ARCCore | Enum | Describes class -ConnectionInstruction-. |
ARCCore.IP.TrySetPP | ARCCore | ClassMember | SetPP = set property of property. Sets property of entity contained within this class. |
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.IP.GetKeysEqualToValue | ARCCore | ClassMember | Returns properties which themselves again have key and value equal to the given key and value. |
ARCCore.ConnectionInstructionP.ServerHostName | ARCCore | EnumMember | The host (DNS or IP-address) for which to connect. |
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.ConnectionInstructionP.ServerPortNo | ARCCore | EnumMember | The port number for which to connect. |
ARCCore.IP.TryGetP | ARCCore | ClassMember | Gets a single property for this object |
ARCCore.ConnectionInstructionP.ConnectionId | ARCCore | EnumMember | Usually a combination of -ClientId-, -ServerHostName- and -ServerPortNo-. |
ARCCore.IP.ToPropertyStream | ARCCore | ClassMember | Turns object into a -PropertyStream- |
ARCCore.ConnectionInstructionP.DataTransferDirection | ARCCore | EnumMember | |
ARCCore.IP.ToJSONSerializeable | ARCCore | ClassMember | Prepares the data into a format acceptable for System.Text.Json.JsonSerializer.Serialize. |
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.IP.GetValueForJSONSerializer | ARCCore | ClassMember | Practical approach to serializing of -IP- based values to JSON. |
ARCCore.ConnectionInstructionP.MultipleConnectionUsage | ARCCore | EnumMember | |
ARCCore.IP.TrySetP | ARCCore | ClassMember | Set property regardless of whether exists or not. |
ARCCore.ConnectionInstructionP.Sharding | ARCCore | EnumMember | |
ARCCore.IP.TryGetV Overload1 | ARCCore | ClassMember | The actual 'unpacking' of the object. |
ARCCore.MultipleConnectionUsage | ARCCore | Enum | Enables fault-tolerance by describing use of multiple connections |
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.MultipleConnectionUsage.Admin | ARCCore | EnumMember | Connection is a special administrative connection to a central 'command-and-control' server which instructs which connections to make. |
ARCCore.IP.AddPV Overload2 | ARCCore | ClassMember | NOTE: The different AddPV / AddP overloads should only be used if you want an assertion against the |
ARCCore.MultipleConnectionUsage.RoundRobin | ARCCore | EnumMember | This connection to be used in a turn based system, together with other connections with -RoundRobin-. |
ARCCore.IP.AddPV Overload1 | ARCCore | ClassMember | Adds a property value (as a -PValue-) for this objectThrows -KeyAlreadyExistsException- when relevant. |
ARCCore.MultipleConnectionUsage.Simultaneous | ARCCore | EnumMember | This connection to be used simultaneously with other connections with -Simultaneous- |
ARCCore.IP.AddP | ARCCore | ClassMember | Adds a property for this object. |
ARCCore.StreamProcessorP | ARCCore | Enum | Describes class -StreamProcessor-. |
ARCCore.IP.AddOrUpdateP | ARCCore | ClassMember | Duplicates functionality of SetP. |
ARCCore.StreamProcessorP.LocalStorageFolder | ARCCore | EnumMember | The local path to which new properties are stored. Should NOT end with any trailing DirectorySeparatorChar |
ARCCore.IP.GetOrAddPV | ARCCore | ClassMember | Gets value. If not set then value will be added |
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.IP.GetPV | ARCCore | ClassMember | Gets a single property's value for this object. Returns default value if not successful. |
ARCCore.StreamProcessorP.CurrentlyInitializing | ARCCore | EnumMember | Set to TRUE at initialization (signals for instance -ReceiveAndDistribute- that it can only queue messages, not process them). |
ARCCore.IP.TryGetPV | ARCCore | ClassMember | Gets a single property's value for the given property key. |
ARCCore.StreamProcessorP.ClientUpdatePositionPath | ARCCore | EnumMember | Complete path to file containing -ClientUpdatePosition-. |
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.StreamProcessorP.ClientUpdatePosition | ARCCore | EnumMember | Note how this is stored both as -ClientUpdatePosition- (on the client side) and -ClientUpdatePosition- (on the server side). |
ARCCore.IP.Item | ARCCore | ClassMember | Offers string-based direct indexing. |
ARCCore.StreamProcessorP.IncomingConnectionsPortNo | ARCCore | EnumMember | If not set, then class will not listen for incoming connections (meaning that our application is probably a -Client-). |
ARCCore.IP.Keys | ARCCore | ClassMember | Returns all the keys for this instance. |
ARCCore.StreamProcessorP.UnderClosure | ARCCore | EnumMember | Set to TRUE if to be closed, whenever an exception occurs or when class goes out of scope |
ARCCore.IP.Values | ARCCore | ClassMember | Returns all the values (all the properties) for this instance. |
ARCCore.StreamProcessorP.WriteToConsole | ARCCore | EnumMember | If true then incoming data (from other nodes will be written to console. |
ARCCore.IP.Logger | ARCCore | ClassMember | Describes a logger. |
ARCCore.StreamProcessorP.Timestamp | ARCCore | EnumMember | The timestamp inserted at regular intervals in the -PropertyStream- according to -TimestampResolution-. |
ARCCore.IP.AllIPDerivedTypes | ARCCore | ClassMember | All relevant -IP--derived types for the whole application. |
ARCCore.StreamProcessorP.TimestampIsOld | ARCCore | EnumMember | A warning sent by -StreamProcessor- to -OutsideLocalReceiver- when it knows that data as served is out of date. |
ARCCore.IP.AllIPDerivedTypesWithPKEnum | ARCCore | ClassMember | All relevant -IP--derived types for the whole application for which the also is defined a -PropertyKeyEnum-. |
ARCCore.StreamProcessorP.TimestampResolution | ARCCore | EnumMember | The time interval between each timestamp update in the -PropertyStream-. |
ARCCore.IP.AllIPDerivedTypesWithPKEnumApplicationSpecific | ARCCore | ClassMember | All relevant -IP--derived types for the -ApplicationSpecificCode- part of the application for which also is defined a -PropertyKeyEnum-. |
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.IP.AllIPDerivedEntityCollectionClassesDict | ARCCore | ClassMember | All -IP--derived types for which is found a corresponding class with name like '{EntityType}Collection' |
ARCCore.StreamProcessorP.DoNotStoreLocalOriginLocally | ARCCore | EnumMember | Means 'do not store local origin locally but wait until it gets confirmed by core storage'. |
ARCCore.IP.AllIPDerivedTypesInludingGenericAndAbstract | ARCCore | ClassMember | All relevant -IP--derived types (except the interface -IP- itself) known to the application. |
ARCCore.StreamProcessorP.CacheDiskWrites | ARCCore | EnumMember | If TRUE then will write the -PropertyStream- to disk in bigger chunks, thereby increasing performance. |
ARCCore.IP.AllIPDerivedTypesDict | ARCCore | ClassMember | Provides lookup of a type in -AllIPDerivedTypes- given its string representation. |
ARCCore.StreamProcessorP.CopyFileStructureFromCore | ARCCore | EnumMember | If TRUE, will copy the exact file structure (through information given in -ClientUpdatePosition-). |
ARCCore.IP.AllIPDerivedTypesDictIKType | ARCCore | ClassMember | Same as -AllIPDerivedTypesDict- except that value is -IKType-, not string. |
ARCCore.StreamProcessorP.CountIncomingConnections | ARCCore | EnumMember | |
ARCCore.P | ARCCore | Class | 'Dummy'-class, not necessarily in use. See -PP- for more information. Created because of the concept of CorrespondingClass which is strictly enforced |
ARCCore.StreamProcessorP.CountOutgoingConnections | ARCCore | EnumMember | |
ARCCore.P.TryGetP | ARCCore | ClassMember | Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway. |
ARCCore.StreamProcessorP.CountOutsideLocalReceiver | ARCCore | EnumMember | Count of calls to -OutsideLocalReceiver-. |
ARCCore.P.TryGetV | ARCCore | ClassMember | Note that 'normally' this method would be irrelevant for a -PRich- object because we will usually be an entity object (like 'Customer') not having an intrinsic value ourselves per se (because we will instead be containing a list of values). |
ARCCore.StreamProcessorP.CountReceiveLocalOrigin | ARCCore | EnumMember | Count of -PropertyStreamLine- with -HasLocalOrigin-. |
ARCCore.P.ToString | ARCCore | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCCore.StreamProcessorP.CountReceiveNonLocalOrigin | ARCCore | EnumMember | Count of -PropertyStreamLine- not with -HasLocalOrigin-. |
ARCCore.ICreated | ARCCore | Class | A dummy interface signifying that implementing class has the ability to store (in-memory) metadata -Created- |
ARCCore.StorageFileP | ARCCore | Enum | Describes class -StorageFile-. |
ARCCore.PCollection | ARCCore | Class | A class useful for storing a collection of entities (a table in RDBMS-terms) because it implements -Indexing-. |
ARCCore.StorageFileP.Filename | ARCCore | EnumMember | |
ARCCore.PCollection.TrySetPP | ARCCore | ClassMember | Replaces default interface method -TrySetPP-. |
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.PCollection.GetKeysEqualToValue | ARCCore | ClassMember | Returns properties which themselves again have key and value equal to the given key and value. |
ARCCore.ConnectionDirection | ARCCore | Enum | The concept of who took the initiative for the connections (who asked to open the TCP/IP session). |
ARCCore.PCollection.TryGetP | ARCCore | ClassMember | Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway. |
ARCCore.ConnectionDirection.Incoming | ARCCore | EnumMember | ConnectionInstruction will not be set for these. |
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.ConnectionDirection.Outgoing | ARCCore | EnumMember | There would normally exist two live outgoing connection at a given point in time for -Client- / -ArmDB-: |
ARCCore.PCollection.ToString | ARCCore | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCCore.DataTransferDirection | ARCCore | Enum | Direction for transfer of data. |
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.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.PConcurrent | ARCCore | Class | A (somewhat) thread-safe alternative to -PRich- which also supports -ExposingApplicationState- (through -Logger-). |
ARCCore.DataTransferDirection.Receive | ARCCore | EnumMember | Like -Client- receiving data from an upstream -ArmDB- / -CoreDB- or -ArmDB- receiving data from an upstream -CoreDB-. |
ARCCore.PConcurrent.ToString | ARCCore | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCCore.TPropertyKeyEnum | ARCCore | Enum | Placeholder for any enum type suitable as generic type parameter for -PExact-. |
ARCCore.PExact<TEnumType> | ARCCore | Class | Very -MemoryConsumption- efficient alternative to -PRich-. |
Assembly ARCDoc | Assembly | A library supporting documentation and demonstrating usage of AgoRapide. | |
ARCCore.PExact<TEnumType>.SetPVDirect | ARCCore | ClassMember | High performance alternative to -TrySetP-, accessing -Storage- more direct. |
ARCDoc.Apple | ARCDoc | Class | The most 'standard' way of implementing an entity-class in AgoRapide, by just inheriting -PRich-. |
ARCCore.PExact<TEnumType>.GetPVDirect | ARCCore | ClassMember | High performance alternative to -TryGetP-, accessing -Storage- more direct. |
ARCDoc.Apple.AddName | ARCDoc | ClassMember | Convenience method, not obligatory. |
ARCCore.PExact<TEnumType>.TryGetPVDirect | ARCCore | ClassMember | High performance alternative to -TryGetP-, accessing -Storage- more direct. |
ARCDoc.Apple.GetName | ARCDoc | ClassMember | Convenience method, not obligatory. |
ARCCore.PExact<TEnumType>.ToString | ARCCore | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCDoc.Apple.TryGetName | ARCDoc | ClassMember | Convenience method, not obligatory. |
ARCCore.PExact<TEnumType>..ctor | ARCCore | ClassMember | Set capacity to the number of members in the -PropertyKeyEnum- for this class (minus the __invalid-value) |
ARCDoc.Apple.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.PExact<TEnumType>.Storage | ARCCore | ClassMember | Uses int-value of -__enum- minus 1 as index. |
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.PII | ARCCore | Class | PII = property for storing individual items. |
ARCDoc.Apple.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCCore.PII.TryGetV | ARCCore | ClassMember | Since value is stored in keys, we need to override this method. |
ARCDoc.Apple.Name | ARCDoc | ClassMember | Convenience method, not obligatory. |
ARCCore.PII.TryGetP | ARCCore | ClassMember | Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway. |
ARCDoc.Banana | ARCDoc | Class | Implements -IP- directly and uses traditional property storage for optimum -MemoryConsumption- efficiency. |
ARCCore.PII.ToString | ARCCore | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
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.IPII | ARCCore | Class | Future expansion, using different classes for storing, not only -PII-. |
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.IIKII | ARCCore | Class | Related to -PII-, property for storing individual items |
ARCDoc.Demonstrator | ARCDoc | Class | Demonstrates various concepts from -ARCCore-, especially -PropertyAccess-. |
ARCCore.IIKII.PackParseResultForStorageInIKII | ARCCore | ClassMember | This method corresponds to -PackParseResultForStorageInEntityObject-. |
ARCDoc.Demonstrator.DemonstratePropertyAccessApple | ARCDoc | ClassMember | Demonstrates use of -PropertyAccess- through the -Apple- class. |
ARCCore.IIKII.PackObjectForStorageInIKII | ARCCore | ClassMember | This method corresponds to -PackObjectForStorageInEntityObject-. |
ARCDoc.Demonstrator.DemonstratePropertyAccessOrange | ARCDoc | ClassMember | Demonstrates use of -PropertyAccess- through the -Orange- class. |
ARCCore.PReadOnly | ARCCore | Class | Experimental (from Feb 2022) class suitable for classes that do not need to be deserialized, or to accept write requests through -PropertyAccess-. |
ARCDoc.Demonstrator.DemonstratePropertyAccessBanana | ARCDoc | ClassMember | Demonstrates use of -PropertyAccess- through the -Banana- class. |
ARCCore.PRich | ARCCore | Class | Fully flexible storage. Can store anything. Typical inherited for entity representations like 'Customer' or 'Order'. |
ARCDoc.Demonstrator.DemonstrateITypeDescriber | ARCDoc | ClassMember | Demonstrates use of -ITypeDescriber- for describing single-property values. |
ARCCore.PRich.TryGetP | ARCCore | ClassMember | Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway. |
ARCDoc.Demonstrator.DemonstratePRichHierarchicalStorage | ARCDoc | ClassMember | Demonstrates use of -PRich-, how it receives -PropertyStream--lines and builds up a strongly typed hierarchical object storage. |
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). |
ARCDoc.Demonstrator.DemonstratePropertyStream | ARCDoc | ClassMember | Demonstrates use of -PropertyStream- by generating local data (documentation data) and writing locally to console. |
ARCCore.PRich.ToString | ARCCore | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCDoc.Demonstrator.DemonstrateBareBonesClient | ARCDoc | ClassMember | Demonstrates adding -PropertyStream--lines to -CoreDB- without using ANY AgoRapide component, only standard TCP/IP functionality in .NET. |
ARCCore.PValue<T> | ARCCore | Class | Single value storage. |
ARCDoc.Demonstrator.DemonstrateLogConsole | ARCDoc | ClassMember | Demonstrates a quite simple log console. |
ARCCore.PValue<T>.TrySetP | ARCCore | ClassMember | NOTE: -TryStore- is explicit aware that -PValue- and -PValueEmpty- |
ARCDoc.Demonstrator.DemonstrateStreamProcessorAsClient | ARCDoc | ClassMember | Demonstrates use of -StreamProcessor- as a general client. |
ARCCore.PValue<T>.TryGetV | ARCCore | ClassMember | Supports duck typing. |
ARCDoc.Orange | ARCDoc | Class | Inherits -PExact- for probably the best compromise between memory consumption and easy of development. |
ARCCore.PValue<T>.ConvertObjectToString | ARCCore | ClassMember | Converts object to string. |
ARCDoc.Orange.SetPVDirect | ARCDoc | ClassMember | High performance alternative to -TrySetP-, accessing -Storage- more direct. |
ARCCore.PValue<T>.ToString | ARCCore | ClassMember | Do no cache this value, because memory consumption would then increase significantly in your applicationj |
ARCDoc.Orange.GetPVDirect | ARCDoc | ClassMember | High performance alternative to -TryGetP-, accessing -Storage- more direct. |
ARCCore.PValue<T>.DeepCopy | ARCCore | ClassMember | Note that if the generic type (T) is not immutable, then what we return will not be a truly deep copy. |
ARCDoc.Orange.TryGetPVDirect | ARCDoc | ClassMember | High performance alternative to -TryGetP-, accessing -Storage- more direct. |
ARCCore.PValue<T>..ctor | ARCCore | ClassMember | Note how this class does not have a parameter-less constructor (unlike all other -IP--derived classes in AgoRapide) |
ARCDoc.Orange.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCCore.PValueEmpty | ARCCore | Class | Represents the 'no value'. |
ARCDoc.Orange.Name | ARCDoc | ClassMember | See -Name- for more information. |
ARCCore.PValueEmpty.TrySetP | ARCCore | ClassMember | NOTE: -TryStore- is explicit aware that -PValue- and -PValueEmpty- |
ARCDoc.Orange.Storage | ARCDoc | ClassMember | Uses int-value of -__enum- minus 1 as index. |
ARCCore.PValueEmpty.ToPropertyStream | ARCCore | ClassMember | Typicall return value could be something like |
ARCDoc.SomeAppComponent | ARCDoc | Class | Demonstrates how also your actual application classes, not only your data classes, should implement -IP-. |
ARCCore.ActualConnection | ARCCore | Class | The actual connection, its internal state, queue for sending and so on. |
ARCDoc.SomeAppComponent.MethodC | ARCDoc | ClassMember | Note structured format in logging. |
ARCCore.ActualConnection.SetMyUpdatePositionGenerator | ARCCore | ClassMember | Set by -StreamProcessor-. |
ARCDoc.SomeAppComponent.MethodD | ARCDoc | ClassMember | Same as MethodC- but returns data ('Func<string>()' instead of 'Action()') |
ARCCore.ActualConnection.SetSinglePropertyStreamReceiver | ARCCore | ClassMember | Set by -StreamProcessor-. |
ARCDoc.SomeAppComponent.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCCore.ActualConnection.SetUpToDatePositionGenerator | ARCCore | ClassMember | Set by -StreamProcessor-. Not used by -Client-. |
ARCDoc.DocFrag | ARCDoc | Class | DocFrag = Document fragment. |
ARCCore.ActualConnection.InitializeOutgoingConnection | ARCCore | ClassMember | Relevant for -Outgoing-. |
ARCDoc.DocFrag.Create Overload1 | ARCDoc | ClassMember | Creates a -DocFrag- object representing an assembly or a namespace. |
ARCCore.ActualConnection.Communicate | ARCCore | ClassMember | Common for both -Incoming- and -Outgoing-. |
ARCDoc.DocFrag.Create Overload2 | ARCDoc | ClassMember | Creates a -DocFrag- object representing a class, class member, enum or enum member. |
ARCCore.ActualConnection.LogAndSendErrorConditionData | ARCCore | ClassMember | Called when a serious error condition has been discovered and connection should be terminated. |
ARCDoc.DocFrag.ToHTMLSimpleSingle | ARCDoc | ClassMember | Alternative ('override') to -ToHTMLSimpleSingle-. |
ARCCore.ActualConnection.Send | ARCCore | ClassMember | Sends all messages in queue. |
ARCDoc.DocFrag.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.ActualConnection.ToString | ARCCore | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
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). |
ARCCore.ActualConnection..ctor | ARCCore | ClassMember | Note parameter-less constructor as desired for all classes inheriting -IP-. |
ARCDoc.DocFrag.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCCore.MonkeyWrench | ARCCore | Class | Describes level of 'spanner-throwing' this connection shall contibute with |
ARCDoc.DocFragCollection | ARCDoc | Class | Contains a collection of -DocFrag- objects. |
ARCCore.ClientUpdatePosition | ARCCore | Class | Describes from WHERE (from WHEN) in the historic -PropertyStream- new data is to be returned. |
ARCDoc.DocFragCollection.Create | ARCDoc | ClassMember | Creates documentation fragments (-DocFrag-) for all possible -BaseAttribute- elements found in the given assemblies. |
ARCCore.ClientUpdatePosition.Filename | ARCCore | ClassMember | Filename like '2020-04-03 08:42:22_R001' |
ARCDoc.DocFragCollection.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.ClientUpdatePosition.Index | ARCCore | ClassMember | Index (zero-based) into file. Value of -1 means blank update status / no data received at all (or no data received for this specific filename) |
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). |
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'. |
ARCDoc.DocFragCollection.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
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. |
ARCDoc.DocLink | ARCDoc | Class | Describes to where a single HTML link points. |
ARCCore.ClientUpdatePosition.IsGoBack | ARCCore | ClassMember | Has to be translated by -StreamProcessor- into a concrete filename / index. |
ARCDoc.DocLink.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.ClientUpdatePosition.IsAtEndOfStream | ARCCore | ClassMember | Necessary in order to implement -AdHocQuery-. |
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). |
ARCCore.ClientUpdatePosition.ClientDatastoreIsEmptyInstance | ARCCore | ClassMember | See also -ClientDatastoreIsEmpty. |
ARCDoc.DocLink.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCCore.ClientUpdatePosition.OnlyNewDataIsRequestedInstance | ARCCore | ClassMember | See also -OnlyNewDataIsRequested. |
ARCDoc.DocLink.Location | ARCDoc | ClassMember | Copy of -Location-. |
ARCCore.ConnectionInstruction | ARCCore | Class | The instruction about what connections to make (host, portnr, data transfer direction and so on). |
ARCDoc.DocLink.Filename | ARCDoc | ClassMember | Copy of -LinkWordHTML-. |
ARCCore.ConnectionInstruction.Initialize | ARCCore | ClassMember | Initializes to sane values. |
ARCDoc.DocLink.LinkWordHTML | ARCDoc | ClassMember | Copy of -LinkWordHTML-. |
ARCCore.ConnectionInstruction.TryGetP | ARCCore | ClassMember | Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway. |
ARCDoc.DocLink.LinkWordHTMLWithHyphens | ARCDoc | ClassMember | -LinkWordHTML- with '-' (minus sign / hyphen) prepended and appended. |
ARCCore.ConnectionInstruction.TryGetV | ARCCore | ClassMember | Note that 'normally' this method would be irrelevant for a -PRich- object because we will usually be an entity object (like 'Customer') not having an intrinsic value ourselves per se (because we will instead be containing a list of values). |
ARCDoc.DocLink.LinkWordHTMLBeforeLt | ARCDoc | ClassMember | If -LinkWordHTML contains '<' (really '<') (for generic types, like 'PValue<TValue>') then this will contain the part before '<' like 'PValue'. |
ARCCore.ConnectionInstruction.ToString | ARCCore | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCDoc.DocLink.LinkWordHTMLBeforeLtWithHyphens | ARCDoc | ClassMember | -LinkWordHTMLBeforeLt- with '-' (minus sign / hyphen) prepended and appended. |
ARCCore.Sharding | ARCCore | Class | Enables load-balancing by describing what data should be sent over a given connection. |
ARCDoc.DocLink.AHrefEndPart | ARCDoc | ClassMember | 'Filename.Encoded + "> + LinkWordHTML + </a>' |
ARCCore.PropertyStreamLine | ARCCore | Class | Has two main functions: |
ARCDoc.DocLinkCollection | ARCDoc | Class | Contains a collection of -DocLink- objects. |
ARCCore.PropertyStreamLine.EncodeKeys | ARCCore | ClassMember | Encodes the key part of a -PropertyStreamLine-. |
ARCDoc.DocLinkCollection.Create | ARCDoc | ClassMember | Notes all locations and their positions in the hierarchical directory structure. |
ARCCore.PropertyStreamLine.EncodeValues | ARCCore | ClassMember | Typically used when turning -WholeCollection- into a value part of a -PropertyStreamLine-. |
ARCDoc.DocLinkCollection.InsertLinks Overload1 | ARCDoc | ClassMember | Does -LinkInsertionInDocumentation- on the given HTML content. |
ARCCore.PropertyStreamLine.EncodeKeyPart | ARCCore | ClassMember | Converts a single key part of a -PropertyStreamLine- to a format suitable for sending over a -PropertyStream-. |
ARCDoc.DocLinkCollection.InsertLinks Overload2 | ARCDoc | ClassMember | See overload with 'contentLocation' as parameter for documentation. |
ARCCore.PropertyStreamLine.EncodeValuePart | ARCCore | ClassMember | Converts a single value part of a -PropertyStreamLine- to a format suitable for sending over a -PropertyStream-. |
ARCDoc.DocLinkCollection.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.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.DocLinkCollection.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCDoc.DocLinkResolution | ARCDoc | Class | Contains a resolution page for a link word which has duplicate 'targets' (pointing to multiple -DocLink- instances). |
ARCDoc.DocLinkResolution.ToHTMLSimpleSingle | ARCDoc | ClassMember | Gives a friendly description about possible targets for LinkWord-. |
ARCDoc.DocLinkResolution.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.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.DocLinkResolution.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.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.Documentator.CreateHTOCNamespace | ARCDoc | ClassMember | Creates a table of contents structured by namespace |
ARCDoc.Documentator.CreateHTOCInheritance | ARCDoc | ClassMember | Creates a table of contents structured by inheritance (classes and interfaces only, not members). |
ARCDoc.Documentator.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.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.Documentator.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCDoc.Documentator.DocLinks | ARCDoc | ClassMember | Set by -CreateAndInsert-. |
ARCDoc.Documentator.DocLinkResolutionLocation | ARCDoc | ClassMember | Default position within the global storage context of doc link resolution pages. |
ARCDoc.DummyEnum | ARCDoc | Class | TODO: Document better what this is for (and change name) |
ARCDoc.DummyEnum.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.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.DummyEnum.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCDoc.Extensions | ARCDoc | Class | Contains various extension methods for -IP- and -IKIP- related to documentating / reporting / HTML. |
ARCDoc.Extensions.ToHTMLSimpleSingleRecursive | ARCDoc | ClassMember | Calls -ToHTMLSimpleSingle- recursively. |
ARCDoc.Extensions.ToHTMLSimpleSingle | ARCDoc | ClassMember | Creates a simple HTML representation of the given parameter. |
ARCDoc.Extensions.ToHTMLSimpleSingleInternal | ARCDoc | ClassMember | Hack in order to escape check for direct implementation in actual class of -ToHTMLSimpleSingle- in -ToHTMLSimpleSingle-. |
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.Extensions.DescribeValue | ARCDoc | ClassMember | Describes the value contained withing an -IKIP- (-P-). |
ARCDoc.Extensions.ValueToHTMLSimpleWithTooltip | ARCDoc | ClassMember | Creates a simple HTML representation of the Value with description as a 'tooltip'. |
ARCDoc.Extensions.KeyToHTMLSimpleWithTooltip | ARCDoc | ClassMember | Creates a simple HTML representation of the Key with description as a 'tooltip'. |
ARCDoc.Extensions.GetHelptextHTML | ARCDoc | ClassMember | Returns content of -Description- and -LongDescription-. |
ARCDoc.HLocation | ARCDoc | Class | Simple class describing the location of a single -IP- instance within some hierarhical context. |
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. |
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.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCDoc.HLocation.Content | ARCDoc | ClassMember | The Content object is not stored within the standard -IP--mechanism. |
ARCDoc.HLocationCollection | ARCDoc | Class | Contains a collection of -HLocation- objects. |
ARCDoc.HLocationCollection.Create | ARCDoc | ClassMember | Transforms the parameter (and recursively all contained objects) into a collection of -HLocation- objects. |
ARCDoc.HLocationCollection.WriteAllContentHTMLToDisk | ARCDoc | ClassMember | Writes all -HLocation- results to a hierarhical folder structure as static HTML files with (optionally) -LinkInsertionInDocumentation-. |
ARCDoc.HLocationCollection.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.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.HLocationCollection.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCDoc.HTOC | ARCDoc | Class | HTOC = Hierarchical table of contents. |
ARCDoc.HTOC.Create | ARCDoc | ClassMember | Structures content hierarchically according to the criteria for each level. |
ARCDoc.HTOC.ToHTMLSimpleSingle Overload2 | ARCDoc | ClassMember | Alternative ('override') to -ToHTMLSimpleSingle-. |
ARCDoc.HTOC.ToHTMLSimpleSingle Overload1 | ARCDoc | ClassMember | Use this method in any class where a table-of-contents type of view is desireable |
ARCDoc.HTOC.CreateInitialContent | ARCDoc | ClassMember | Helper method for creation of a -FilterBranch-. |
ARCDoc.HTOC.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.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.HTOC.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCDoc.HTOC.HTOCContentThisLevelKey | ARCDoc | ClassMember | The key used for storing the actual content at this level. |
ARCDoc.PKDocAttribute | ARCDoc | Class | Describes documentation and presentation of a property. |
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.PKDocAttribute.TryRemoveP | ARCDoc | ClassMember | Should probably never be used. |
ARCDoc.PKDocAttribute.PriorityOrder | ARCDoc | ClassMember | See -PriorityOrder-. |
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.UtilDoc | ARCDoc | Class | Utility methods for -ARCDoc-. |
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.UtilDoc.GenerateHTMLPage | ARCDoc | ClassMember | Wraps the parameter inside a <html><head></head><body>...</body></html> enclosure with some rudimentare CSS. |
ARCDoc.UtilDoc.GlobalHeaderHTML | ARCDoc | ClassMember | Global header to be inserted at the top of every HTML page created by -GenerateHTMLPage-. |
ARCDoc.HTOC+ParentChain | ARCDoc | Class | Used by -FilterNode- in order to keep track of node's parents. |
ARCDoc.AppleP | ARCDoc | Enum | Describes class -Apple-. |
ARCDoc.AppleP.Name | ARCDoc | EnumMember | The name of the apple |
ARCDoc.AppleP.Colour | ARCDoc | EnumMember | |
ARCDoc.BananaP | ARCDoc | Enum | Describes class -Banana-. |
ARCDoc.BananaP.Name | ARCDoc | EnumMember | The name of the banana |
ARCDoc.BananaP.Colour | ARCDoc | EnumMember | |
ARCDoc.OrangeP | ARCDoc | Enum | Describes class -Orange-. |
Generated 2025-06-21 20:03:04.477 UTC