[ROOT] doc DocFrag SELECT Assembly, DocFragType, Description.FirstLine() < SKIP 273 > < TAKE 448 >
448 items
DocFragId | Assembly | DocFragType | Description.FirstLine() |
---|---|---|---|
ARCCore.PropertyStreamLine.EncodeKeyPart | ARCCore | ClassMember | Converts a single key part of a -PropertyStreamLine- to a format suitable for sending over a -PropertyStream-. |
ARCCore.ARComponents.ARCSync | ARCCore | EnumMember | (Not implemented as of March 2020) |
ARCCore.PK.Cleaner | ARCCore | ClassMember | Cleanup of values, to be used before value is attempted validated. |
ARCCore.PropertyStreamLine.EncodeValuePart | ARCCore | ClassMember | Converts a single value part of a -PropertyStreamLine- to a format suitable for sending over a -PropertyStream-. |
ARCCore.ARComponents.ARCSec | ARCCore | EnumMember | (Not implemented as of March 2020) |
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.PropertyStreamLine.Decode | ARCCore | ClassMember | Decodes string as encoded by -EncodeKeyPart- or -EncodeValuePart-. |
ARCCore.ARComponents.ARCAPI | ARCCore | EnumMember | A library providing an API on top of the -PropertyStream-. |
ARCCore.PKRelAttribute.TryRemoveP | ARCCore | ClassMember | Should probably never be used. |
ARCCore.PropertyStreamLine.TryParseDirectToIP | ARCCore | ClassMember | Parses a series of -PropertyStreamLine- directly to the given type of -IP-. |
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.PKRelAttribute.ForeignEntity | ARCCore | ClassMember | See -ForeignEntity-. |
ARCCore.PropertyStreamLine.TryParseDirectToProperty | ARCCore | ClassMember | Parses direct to a given property value. |
ARCCore.ARConcepts | ARCCore | Enum | The overarching concepts upon which AgoRapide is built. |
ARCCore.PKRelAttribute.OppositeTerm | ARCCore | ClassMember | See -OppositeTerm-. |
ARCCore.PropertyStreamLine.ParseAndStore | ARCCore | ClassMember | Note that throws exception if -TryParseAndStore- fails. |
ARCCore.ARConcepts.GettingStarted | ARCCore | EnumMember | AgoRapide 2020 is an open source library for building data-oriented backend applications using .NET. |
ARCCore.IP.TrySetPP | ARCCore | ClassMember | SetPP = set property of property. Sets property of entity contained within this class. |
ARCCore.PropertyStreamLineParsed.TryParse | ARCCore | ClassMember | Generate list of <(IK key, Type valueType)> together with value from value part. |
ARCCore.ARConcepts.PropertyStream | ARCCore | EnumMember | AgoRapide, the 'streams-of-water' database". |
ARCCore.IP.GetKeysEqualToValue | ARCCore | ClassMember | Returns properties which themselves again have key and value equal to the given key and value. |
ARCCore.PropertyStreamLineParsed.IsComment | ARCCore | ClassMember | Signifies that property stream line given for parsing started with '//' (two forward slashes). |
ARCCore.ARConcepts.PropertyStream2D | ARCCore | EnumMember | PropertyStream2D is an expansion of the -PropertyStream- concept supported by the library -ARCEvent-. |
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.PropertyStreamLineParsed.Keys | ARCCore | ClassMember | The keys part of the -PropertyStreamLine-, that is, everything before ' = '. |
ARCCore.ARConcepts.EventSourcing | ARCCore | EnumMember | (related to -ARCEvent-). |
ARCCore.IP.TryGetP | ARCCore | ClassMember | Gets a single property for this object |
ARCCore.PropertyStreamLineParsed.Value | ARCCore | ClassMember | The original (non-parsed, non-validated)) value part of the -PropertyStreamLine-, that is, everything after ' = '. |
ARCCore.ARConcepts.RegStream | ARCCore | EnumMember | The concept in -ARCEvent- of an "axis" (usefully referred to as the vertical axis) within the concept of -PropertyStream2D-. |
ARCCore.IP.AllIPDerivedTypesDictIKType | ARCCore | ClassMember | Same as -AllIPDerivedTypesDict- except that value is -IKType-, not string. |
ARCCore.StreamProcessor | ARCCore | Class | Implements the storage mechanism for AgoRapide. |
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.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.StreamProcessor.CreateBareBonesInstance | ARCCore | ClassMember | Creates a bare-bones -StreamProcessor- instance. |
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.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.StreamProcessor.Initialize | ARCCore | ClassMember | Initializes this instance of -StreamProcessor- |
ARCCore.ARConcepts.TaggingOfPropertyKeys | ARCCore | EnumMember | The concept of specifying in a single place all relevant information about a given property (data field). |
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.StreamProcessor.AddOrRemoveOutgoingConnections | ARCCore | ClassMember | Not relevant for -CoreDB-. |
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.PExact<TEnumType>..ctor | ARCCore | ClassMember | Set capacity to the number of members in the -PropertyKeyEnum- for this class (minus the __invalid-value) |
ARCCore.Subscription.FromTime | ARCCore | ClassMember | TODO: Implement concept of specifying starting-point in TIME (often for an -AdHocQuery-?). |
ARCCore.ARNodeType.Client | ARCCore | EnumMember | An outer node / 'end' node with (usually) -ApplicationSpecificCode- but based on -ARADB-. |
ARCCore.PExact<TEnumType>.Storage | ARCCore | ClassMember | Uses int-value of -__enum- minus 1 as index. |
ARCCore.Subscription.ToTime | ARCCore | ClassMember | TODO: Implement concept of specifying ending-point in TIME (often for an -AdHocQuery-?). |
ARCCore.Cardinality | ARCCore | Enum | Describes how multiple instances of a property is supposed to be handled. |
ARCCore.PII | ARCCore | Class | PII = property for storing individual items. |
ARCCore.Subscription.IsMatch Overload1 | ARCCore | ClassMember | Evaluates a query consisting of multiple instances of -Subscription- against a single property stream line. |
ARCCore.Cardinality.HistoryOnly | ARCCore | EnumMember | The default value. |
ARCCore.PII.TryGetV | ARCCore | ClassMember | Since value is stored in keys, we need to override this method. |
ARCCore.Subscription.IsMatch Overload2 | ARCCore | ClassMember | Evaluates this instance of -Subscription- against a single property stream line (which has been split up into its constituent elements). |
ARCCore.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.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. |
ARCCore.Subscription.SyntaxHelp | ARCCore | ClassMember | '+*' Subscribe to everything in database. |
ARCCore.Cardinality.IndividualItems | ARCCore | EnumMember | Values are supposed to be set and 'deleted' individually. |
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) |
ARCCore.Subscription.IsAdd | ARCCore | ClassMember | Corresponds to whether value starts with a plus sign, '+' or not. |
ARCCore.PSPrefix | ARCCore | Enum | Describes some recommended prefixes to use in a -PropertyStreamLine-. |
ARCCore.PValueEmpty | ARCCore | Class | Represents the 'no value'. |
ARCCore.Subscription.IsRemove | ARCCore | ClassMember | Corresponds to whether value starts with a minus sign, '+' or not. |
ARCCore.PSPrefix.dt | ARCCore | EnumMember | Data, single key + value. |
ARCCore.PValueEmpty.TrySetP | ARCCore | ClassMember | NOTE: -TryStore- is explicit aware that -PValue- and -PValueEmpty- |
ARCCore.UtilCore | ARCCore | Class | Utility methods for -ARCCore-. |
ARCCore.PSPrefix.dtr | ARCCore | EnumMember | Data, whole records. |
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). |
ARCCore.UtilCore.TryGetTypeFromStringFromCache | ARCCore | ClassMember | Corresponding method for creating string-representation of type is -ToStringDB-. |
ARCCore.PSPrefix.RS | ARCCore | EnumMember | RS = Registration Stream (see -RegStream-). |
ARCCore.ConnectionInstruction.ToString | ARCCore | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCCore.UtilCore.GetExceptionChainAsString | ARCCore | ClassMember | Follows the chain of InnerException and returns types as comma-separated string |
ARCCore.PSPrefix.ES | ARCCore | EnumMember | ES = Event Stream (see -EventStream-). |
ARCCore.Sharding | ARCCore | Class | Enables load-balancing by describing what data should be sent over a given connection. |
ARCCore.UtilCore.GetExeptionDetails | ARCCore | ClassMember | Gives as much information about exception as possible. |
ARCCore.PSPrefix.cmd | ARCCore | EnumMember | Command. |
ARCCore.PropertyStreamLine | ARCCore | Class | Has two main functions: |
ARCCore.UtilCore.DateTimeTryParse | ARCCore | ClassMember | Accepts on of the formats specified in -ValidDateTimeFormats-. |
ARCCore.PSPrefix.app | ARCCore | EnumMember | Application state, like app/ |
ARCCore.UtilCore.AssertCurrentlyStartingUp | ARCCore | ClassMember | Normally called from non-thread safe methods that should be run single-threaded at application startup only. |
ARCCore.UtilCore.TimeSpanTryParse | ARCCore | ClassMember | Accepts on of the formats specified in -ValidDateTimeFormats-. |
ARCCore.PSPrefix.doc | ARCCore | EnumMember | Documentation. |
ARCCore.UtilCore.DoubleTryParse | ARCCore | ClassMember | Note that treats ',' (comma) as decimal point (not as thousands separator). |
ARCCore.UtilCore.UseLocalTimeInsteadOfUTC | ARCCore | ClassMember | By default AgoRapide operates only with UTC time. |
ARCCore.PSPrefix.t | ARCCore | EnumMember | Translations. |
ARCCore.UtilCore.EnumTryParse | ARCCore | ClassMember | Same as the inbuilt .NET method -TryParse- but with some additional checks. |
ARCCore.UtilCore.DateTimeNow | ARCCore | ClassMember | Returns DateTime.UtcNow unless -UseLocalTimeInsteadOfUTC- has been set to TRUE in which case DateTime.Now is returned. |
ARCCore.PKHTMLAttributeP | ARCCore | Enum | Describes class -PKRelAttribute-. |
ARCCore.UtilCore.TryGetTypeFromStringNoCache | ARCCore | ClassMember | See -TryGetTypeFromStringFromCache- for documentation. |
ARCCore.UtilCore.CurrentlyStartingUp | ARCCore | ClassMember | Called once at application startup after all Attribute instances in the C# code has been processed. |
ARCCore.ActualConnectionP.ClientUpdatePosition | ARCCore | EnumMember | Note how this is stored both as -ClientUpdatePosition- (on the client side) and -ClientUpdatePosition- (on the server side). |
ARCCore.ClassAttributeP.ClassType | ARCCore | EnumMember | The actual type that we are a -ClassAttribute- for |
ARCCore.TIP.ToString | ARCCore | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCCore.ActualConnectionP.SubscriptionAsRequestedByClient | ARCCore | EnumMember | Originates from -Subscription-. |
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.BaseAttribute+IncorrectAttributeTypeUsedException | ARCCore | Class | Helps to clean up any confusion about which -BaseAttribute- to use in a given concept. |
ARCCore.ActualConnectionP.ClosingReason | ARCCore | EnumMember | Reason why this connection was closed |
ARCCore.ClassAttributeP.SubTypes | ARCCore | EnumMember | Direct and indirect sub types of this class. |
ARCCore.PK+BasePKAttributeNotFoundException<T> | ARCCore | Class | Explains how to implement a given -BasePKAttribute- for an enum |
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.ClassAttributeP.Interfaces | ARCCore | EnumMember | All interfaces that this class and its base classes implement |
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.ActualConnectionP.ErrorConditionData | ARCCore | EnumMember | Detailed explanation about -IsErrorCondition- |
ARCCore.ClassAttributeP.InterfacesDirectlyImplemented | ARCCore | EnumMember | All interfaces that this class directly implements. |
ARCCore.PK+PKBoolPair.TrulyInitialized | ARCCore | ClassMember | Not used currently (May 2020). Useful for debugging purposes |
ARCCore.ActualConnectionP.UnderClosure | ARCCore | EnumMember | Set to TRUE if to be closed and reinitialized. |
ARCCore.ClassAttributeP.CorrespondingEnumType | ARCCore | EnumMember | Only relevant when implements -IP-. |
ARCCore.StreamProcessor+StorageFile | ARCCore | Class | |
ARCCore.ActualConnectionP.MonkeyWrench | ARCCore | EnumMember | |
ARCCore.ClassAttributeP.BoilerplateCodePropertiesAndStorage | ARCCore | EnumMember | Only relevant when implements -IP- and when a -CorrespondingEnumType- is found. |
ARCCore.StreamProcessor+StorageFile.Filepath | ARCCore | ClassMember | Complete path to file |
ARCCore.ActualConnectionP.PartnerIPAddress | ARCCore | EnumMember | TODO: Use more strongly typing for this. |
ARCCore.ClassMemberAttributeP | ARCCore | Enum | Describes class -ClassMemberAttribute-. |
ARCCore.StreamProcessor+StorageFile.Filename | ARCCore | ClassMember | Filename: Main file name, like 2020-04-03 08:42 |
ARCCore.StreamProcessor+StorageFile.Length | ARCCore | ClassMember | Wrongly placed. Belongs to each individual revision file. |
ARCCore.StreamProcessor+StorageFile.Properties | ARCCore | ClassMember | Key = revision number of file (due to compression / -DataRetention-), like R00001, R00002 and so on. |
ARCCore.BaseAttributeP | ARCCore | Enum | Describes class -BaseAttribute-. |
ARCCore.BaseAttributeP.Description | ARCCore | EnumMember | The description for the attribute, like this description |
ARCCore.BaseAttributeP.LongDescription | ARCCore | EnumMember | The long (detailed) description for the attribute. |
ARCCore.ClassAttributeP | ARCCore | Enum | Describes class -ClassAttribute-. |
ARCCore.ClassAttributeP.AssemblyName | ARCCore | EnumMember | The assembly in which this class resides. |
ARCCore.ClassAttributeP.ClassNamespace | ARCCore | EnumMember | The namespace for -ClassType-. |
ARCCore.ClassMemberAttributeP.DeclaringType | ARCCore | EnumMember | The actual MemberInfo.DeclaringType. |
ARCCore.ClassMemberAttributeP.MethodName | ARCCore | EnumMember | The actual MemberInfo.Name. |
ARCCore.ClassMemberAttributeP.MethodSignature | ARCCore | EnumMember | The actual MemberInfo.ToString. |
ARCCore.EnumAttributeP | ARCCore | Enum | Describes class -EnumAttribute-. |
ARCCore.EnumAttributeP.AssemblyName | ARCCore | EnumMember | The assembly in which this class resides. |
ARCCore.EnumAttributeP.EnumNamespace | ARCCore | EnumMember | The namespace for -EnumType-. |
ARCCore.EnumAttributeP.EnumType | ARCCore | EnumMember | The type of the enum (like type of 'CustomerP' in CustomerP.FirstName) that we are an attribute for |
ARCCore.EnumAttributeP.AREnumType | ARCCore | EnumMember | Note that will default to -__invalid- if not explicit set. |
ARCCore.EnumAttributeP.CorrespondingClass | ARCCore | EnumMember | Only relevant when -PropertyKeyEnum-. |
ARCCore.EnumMemberAttributeP | ARCCore | Enum | Describes class -EnumMemberAttribute-. |
ARCCore.EnumMemberAttributeP.EnumType | ARCCore | EnumMember | The type of the enum (like type of 'CustomerP' in CustomerP.FirstName) that we are an attribute for |
ARCCore.EnumMemberAttributeP.EnumMember | ARCCore | EnumMember | The actual enum member / enum value (like 'Firstname' in CustomerP.FirstName) that we are an attribute for |
ARCCore.ARComponents | ARCCore | Enum | ARComponents = AgoRapide Components. Contains short descriptions of the different 'official' AgoRapide components. |
ARCCore.ARComponents.ARCCore | ARCCore | EnumMember | A necessary library (.DLL in Windows terms) that every -ARNodeType- should link to. |
ARCCore.ARComponents.ARADB | ARCCore | EnumMember | An application constituting the full functionality of a -CoreDB- (linking to -ARCCore-). |
ARCCore.ARComponents.ARAClient | ARCCore | EnumMember | A template application for a -Client- (linking to -ARCCore-). |
ARCCore.ARConcepts.CoreDBSynchronization | ARCCore | EnumMember | The concept of how multiple -CoreDB- instances synchronizes their data. |
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.ARConcepts.DataRetention | ARCCore | EnumMember | The concept of when to delete old data (if deemed necessary). |
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.ARConcepts.ManyToManyRelations | ARCCore | EnumMember | -ARCQuery- supports many-to-many relations in a simple manner without introducing a third entity type (a third table). |
ARCCore.ARConcepts.Documentation | ARCCore | EnumMember | Thanks to the tagging of enums and classes in AgoRapide (like this description), automatically generation of documentation is possible. |
ARCCore.ARConcepts.AssertionsAndDetailedExceptionMessages | ARCCore | EnumMember | The abstraction level in AgoRapide is very high. |
ARCCore.ARConcepts.ExposingApplicationState | ARCCore | EnumMember | The traditional debugging process usually entails reading through logs and querying about your application state through a debugging tool. |
ARCCore.ARConcepts.LinkInsertionInDocumentation | ARCCore | EnumMember | Documentation with links is much easier to read. |
ARCCore.ARConcepts.TryPatternAndNull | ARCCore | EnumMember | AgoRapide uses non-nullable reference types as default throughout the system |
ARCCore.AREnumType | ARCCore | Enum | Categories different types of enum used in AgoRapide. The most important one is -PropertyKeyEnum-. |
ARCCore.AREnumType.PropertyKeyEnum | ARCCore | EnumMember | Designates enums that describe relevant values for an 'entity' object like 'Customer'. |
ARCCore.AREnumType.OrdinaryEnum | ARCCore | EnumMember | Designates "Ordinary" enums used for indicating range of valid values for a given key |
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.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.ARNodeType.CoreDB | ARCCore | EnumMember | A node containing the core or central database. |
ARCCore.PKRelAttributeP.EnforceReferentialIntegrity | ARCCore | EnumMember | If TRUE then referential integrity will be enforced by -TryStore-. |
ARCCore.PKTypeAttributeP | ARCCore | Enum | Describes class -PKTypeAttribute-. |
ARCCore.PKTypeAttributeP.Type | ARCCore | EnumMember | The type of this Property. |
ARCCore.PKTypeAttributeP.DefaultValue | ARCCore | EnumMember | The default value. |
ARCCore.PKTypeAttributeP.Cardinality | ARCCore | EnumMember | Describes how multiple instances of a property is supposed to be handled. |
ARCCore.PKTypeAttributeP.IsObligatory | ARCCore | EnumMember | True means value is obligatory. |
ARCCore.PKTypeAttributeP.BoilerplateCodeProperties | ARCCore | EnumMember | Automatically generated boilerplate code that implements traditional setters and getters for this key. |
ARCCore.PP | ARCCore | Enum | Describes meta data for any class (property) implementing -IP-. |
ARCCore.PP.Created | ARCCore | EnumMember | Timestamp when property was created in database. |
ARCCore.PP.Cid | ARCCore | EnumMember | Creator id (entity which created this property). |
ARCCore.PP.Value | ARCCore | EnumMember | The actual value. |
ARCCore.PP.Valid | ARCCore | EnumMember | Timestamp when property was last known to be (still) valid |
ARCCore.PP.Vid | ARCCore | EnumMember | Validator id, that is entity which set -Valid- for this property. |
ARCCore.PP.Invalid | ARCCore | EnumMember | Timestamp when property was invalidated / 'deleted'. |
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.PP.ExceptionText | ARCCore | EnumMember | General property for logging of exceptions, usually set through -HandleException-. |
ARCCore.StreamProcessorP.CurrentlyInitializing | ARCCore | EnumMember | Set to TRUE at initialization (signals for instance -ReceiveAndDistribute- that it can only queue messages, not process them). |
ARCCore.StreamProcessorP.ClientUpdatePositionPath | ARCCore | EnumMember | Complete path to file containing -ClientUpdatePosition-. |
ARCCore.StreamProcessorP.ClientUpdatePosition | ARCCore | EnumMember | Note how this is stored both as -ClientUpdatePosition- (on the client side) and -ClientUpdatePosition- (on the server side). |
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.StreamProcessorP.UnderClosure | ARCCore | EnumMember | Set to TRUE if to be closed, whenever an exception occurs or when class goes out of scope |
ARCCore.StreamProcessorP.WriteToConsole | ARCCore | EnumMember | If true then incoming data (from other nodes will be written to console. |
ARCCore.StreamProcessorP.Timestamp | ARCCore | EnumMember | The timestamp inserted at regular intervals in the -PropertyStream- according to -TimestampResolution-. |
ARCCore.StreamProcessorP.TimestampIsOld | ARCCore | EnumMember | A warning sent by -StreamProcessor- to -OutsideLocalReceiver- when it knows that data as served is out of date. |
ARCCore.ARConcepts.PropertyAccess | ARCCore | EnumMember | The general mechanism for accessing properties of objects in AgoRapide. |
ARCCore.ConnectionInstructionP | ARCCore | Enum | Describes class -ConnectionInstruction-. |
ARCCore.ARConcepts.AvoidingRepetition | ARCCore | EnumMember | Avoiding repetition, the overarching philosophy that inspired the rest of AgoRapide. |
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.ARConcepts.AgoRapideHistory | ARCCore | EnumMember | AgoRapide has roots back to 2011 when Bjørn Erling Fløtten invented panSL (SL = Schema language). |
ARCCore.ConnectionInstructionP.ServerHostName | ARCCore | EnumMember | The host (DNS or IP-address) for which to connect. |
ARCCore.ARConcepts.AdHocQuery | ARCCore | EnumMember | The concept of a -Client- doing an ad-hoc query against (normally) a -ArmDB-. |
ARCCore.ConnectionInstructionP.ServerPortNo | ARCCore | EnumMember | The port number for which to connect. |
ARCCore.ARConcepts.StandardAgoRapideCode | ARCCore | EnumMember | Code originating from the main official AgoRapide distribution (which therefore does not include any end-application specific code) |
ARCCore.ConnectionInstructionP.ConnectionId | ARCCore | EnumMember | Usually a combination of -ClientId-, -ServerHostName- and -ServerPortNo-. |
ARCCore.ARConcepts.ApplicationSpecificCode | ARCCore | EnumMember | Code specific for an end-application. |
ARCCore.ConnectionInstructionP.DataTransferDirection | ARCCore | EnumMember | |
ARCCore.ARConcepts.MemoryConsumption | ARCCore | EnumMember | A naïve implementation of key-value storages like AgoRapide may lead to excessive memory (RAM) consumption. |
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.ARConcepts.Indexing | ARCCore | EnumMember | In-memory indexing of data is done 'behind-the-scenes' by some classes implementing -IP-. |
ARCCore.ConnectionInstructionP.MultipleConnectionUsage | ARCCore | EnumMember | |
ARCCore.PKHTMLAttributeP.Encoder | ARCCore | EnumMember | The class doing the HTML-encoding. |
ARCCore.StreamProcessorP.CountReceiveLocalOrigin | ARCCore | EnumMember | Count of -PropertyStreamLine- with -HasLocalOrigin-. |
ARCCore.PKLogAttributeP | ARCCore | Enum | Describes class -PKLogAttribute. |
ARCCore.StreamProcessorP.CountReceiveNonLocalOrigin | ARCCore | EnumMember | Count of -PropertyStreamLine- not with -HasLocalOrigin-. |
ARCCore.PKLogAttributeP.DoNotLogAtAll | ARCCore | EnumMember | Originates from -DoNotLogAtAll-. |
ARCCore.StorageFileP | ARCCore | Enum | Describes class -StorageFile-. |
ARCCore.PKLogAttributeP.CountInterval | ARCCore | EnumMember | For a value of n, log only every n'th time the property is changed. |
ARCCore.StorageFileP.Filename | 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.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.PKRelAttributeP | ARCCore | Enum | Describes class -PKRelAttribute-. |
ARCCore.ConnectionDirection | ARCCore | Enum | The concept of who took the initiative for the connections (who asked to open the TCP/IP session). |
ARCCore.PKRelAttributeP.ForeignEntity | ARCCore | EnumMember | The type of foreign entity that this property points to. |
ARCCore.ConnectionDirection.Incoming | ARCCore | EnumMember | ConnectionInstruction will not be set for these. |
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.ConnectionDirection.Outgoing | ARCCore | EnumMember | There would normally exist two live outgoing connection at a given point in time for -Client- / -ArmDB-: |
ARCCore.PConcurrentP | ARCCore | Enum | Describes class -PConcurrent-. |
ARCCore.DataTransferDirection | ARCCore | Enum | Direction for transfer of data. |
ARCCore.PConcurrentP.Heartbeat | ARCCore | EnumMember | |
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.ActualConnectionP | ARCCore | Enum | Describes class -ActualConnection-. |
ARCCore.DataTransferDirection.Receive | ARCCore | EnumMember | Like -Client- receiving data from an upstream -ArmDB- / -CoreDB- or -ArmDB- receiving data from an upstream -CoreDB-. |
ARCCore.ActualConnectionP.Id | ARCCore | EnumMember | When connection is used with-StreamProcessor-, the Id should be the same as the key used in the incoming / outgoing connection dictionary collection. |
ARCCore.TPropertyKeyEnum | ARCCore | Enum | Placeholder for any enum type suitable as generic type parameter for -PExact-. |
ARCCore.ActualConnectionP.ConnectionInstruction | ARCCore | EnumMember | Only relevant when we are an -Outgoing-. |
Assembly ARCDoc | Assembly | A library supporting documentation and demonstrating usage of AgoRapide. | |
ARCCore.ActualConnectionP.ConnectionDirection | ARCCore | EnumMember | |
ARCDoc.Apple | ARCDoc | Class | The most 'standard' way of implementing an entity-class in AgoRapide, by just inheriting -PRich-. |
ARCCore.ActualConnectionP.CountReceiveMessage | ARCCore | EnumMember | |
ARCDoc.Apple.AddName | ARCDoc | ClassMember | Convenience method, not obligatory. |
ARCCore.ActualConnectionP.CountSendMessage | ARCCore | EnumMember | |
ARCDoc.Apple.GetName | ARCDoc | ClassMember | Convenience method, not obligatory. |
ARCCore.ConnectionInstructionP.Sharding | ARCCore | EnumMember | |
ARCDoc.Orange.Storage | ARCDoc | ClassMember | Uses int-value of -__enum- minus 1 as index. |
ARCCore.MultipleConnectionUsage | ARCCore | Enum | Enables fault-tolerance by describing use of multiple connections |
ARCDoc.SomeAppComponent | ARCDoc | Class | Demonstrates how also your actual application classes, not only your data classes, should implement -IP-. |
ARCCore.MultipleConnectionUsage.Admin | ARCCore | EnumMember | Connection is a special administrative connection to a central 'command-and-control' server which instructs which connections to make. |
ARCDoc.SomeAppComponent.MethodC | ARCDoc | ClassMember | Note structured format in logging. |
ARCCore.MultipleConnectionUsage.RoundRobin | ARCCore | EnumMember | This connection to be used in a turn based system, together with other connections with -RoundRobin-. |
ARCDoc.SomeAppComponent.MethodD | ARCDoc | ClassMember | Same as MethodC- but returns data ('Func<string>()' instead of 'Action()') |
ARCCore.MultipleConnectionUsage.Simultaneous | ARCCore | EnumMember | This connection to be used simultaneously with other connections with -Simultaneous- |
ARCDoc.SomeAppComponent.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCCore.StreamProcessorP | ARCCore | Enum | Describes class -StreamProcessor-. |
ARCDoc.DocFrag | ARCDoc | Class | DocFrag = Document fragment. |
ARCCore.StreamProcessorP.LocalStorageFolder | ARCCore | EnumMember | The local path to which new properties are stored. Should NOT end with any trailing DirectorySeparatorChar |
ARCDoc.DocFrag.Create Overload1 | ARCDoc | ClassMember | Creates a -DocFrag- object representing an assembly or a namespace. |
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.DocFrag.Create Overload2 | ARCDoc | ClassMember | Creates a -DocFrag- object representing a class, class member, enum or enum member. |
ARCDoc.Apple.TryGetName | ARCDoc | ClassMember | Convenience method, not obligatory. |
ARCDoc.DocFrag.ToHTMLSimpleSingle | ARCDoc | ClassMember | Alternative ('override') to -ToHTMLSimpleSingle-. |
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. |
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. |
ARCDoc.Apple.TryGetV | ARCDoc | ClassMember | Note that 'normally' this method would be irrelevant for a -PRich- object because we will usually be an entity object (like 'Customer') not having an intrinsic value ourselves per se (because we will instead be containing a list of values). |
ARCDoc.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.Apple.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCDoc.DocFrag.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCDoc.Apple.Name | ARCDoc | ClassMember | Convenience method, not obligatory. |
ARCDoc.DocFragCollection | ARCDoc | Class | Contains a collection of -DocFrag- objects. |
ARCDoc.Banana | ARCDoc | Class | Implements -IP- directly and uses traditional property storage for optimum -MemoryConsumption- efficiency. |
ARCDoc.DocFragCollection.Create | ARCDoc | ClassMember | Creates documentation fragments (-DocFrag-) for all possible -BaseAttribute- elements found in the given assemblies. |
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) |
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. |
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) |
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.DocFragCollection.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
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.DocLink | ARCDoc | Class | Describes to where a single HTML link points. |
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.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. |
ARCDoc.DocLinkCollection.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
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.DocLinkResolution | ARCDoc | Class | Contains a resolution page for a link word which has duplicate 'targets' (pointing to multiple -DocLink- instances). |
ARCDoc.DocLink.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCDoc.DocLinkResolution.ToHTMLSimpleSingle | ARCDoc | ClassMember | Gives a friendly description about possible targets for LinkWord-. |
ARCDoc.DocLink.Location | ARCDoc | ClassMember | Copy of -Location-. |
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.DocLink.Filename | ARCDoc | ClassMember | Copy of -LinkWordHTML-. |
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.DocLink.LinkWordHTML | ARCDoc | ClassMember | Copy of -LinkWordHTML-. |
ARCDoc.DocLinkResolution.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCDoc.DocLink.LinkWordHTMLWithHyphens | ARCDoc | ClassMember | -LinkWordHTML- with '-' (minus sign / hyphen) prepended and appended. |
ARCDoc.DocLinkResolutionCollection | ARCDoc | Class | Contains a collection of -DocLinkResolution- objects. |
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.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.DocLink.LinkWordHTMLBeforeLtWithHyphens | ARCDoc | ClassMember | -LinkWordHTMLBeforeLt- with '-' (minus sign / hyphen) prepended and appended. |
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.DocLink.AHrefEndPart | ARCDoc | ClassMember | 'Filename.Encoded + "> + LinkWordHTML + </a>' |
ARCDoc.DocLinkResolutionCollection.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCDoc.DocLinkCollection | ARCDoc | Class | Contains a collection of -DocLink- objects. |
ARCDoc.Documentator | ARCDoc | Class | General class for documenting AgoRapide and also your own -ApplicationSpecificCode-. |
ARCDoc.DocLinkCollection.Create | ARCDoc | ClassMember | Notes all locations and their positions in the hierarchical directory structure. |
ARCDoc.Documentator.CreateAndInsert | ARCDoc | ClassMember | Creates an instance of -Documentator- with a natural hierarchical representation of documentation attributes found in the given assemblies. |
ARCDoc.DocLinkCollection.InsertLinks Overload1 | ARCDoc | ClassMember | Does -LinkInsertionInDocumentation- on the given HTML content. |
ARCDoc.Documentator.ToHTMLSimpleSingle | ARCDoc | ClassMember | Alternative ('override') to -ToHTMLSimpleSingle-. |
ARCDoc.DocLinkCollection.InsertLinks Overload2 | ARCDoc | ClassMember | See overload with 'contentLocation' as parameter for documentation. |
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-). |
ARCDoc.HTOC.Create | ARCDoc | ClassMember | Structures content hierarchically according to the criteria for each level. |
ARCDoc.Extensions.ValueToHTMLSimpleWithTooltip | ARCDoc | ClassMember | Creates a simple HTML representation of the Value with description as a 'tooltip'. |
ARCDoc.HTOC.ToHTMLSimpleSingle Overload2 | ARCDoc | ClassMember | Alternative ('override') to -ToHTMLSimpleSingle-. |
ARCDoc.Extensions.KeyToHTMLSimpleWithTooltip | ARCDoc | ClassMember | Creates a simple HTML representation of the Key with description as a 'tooltip'. |
ARCDoc.HTOC.ToHTMLSimpleSingle Overload1 | ARCDoc | ClassMember | Use this method in any class where a table-of-contents type of view is desireable |
ARCDoc.Extensions.GetHelptextHTML | ARCDoc | ClassMember | Returns content of -Description- and -LongDescription-. |
ARCDoc.HTOC.CreateInitialContent | ARCDoc | ClassMember | Helper method for creation of a -FilterBranch-. |
ARCDoc.HLocation | ARCDoc | Class | Simple class describing the location of a single -IP- instance within some hierarhical context. |
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.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.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.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.HTOC.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCDoc.HLocation.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCDoc.HTOC.HTOCContentThisLevelKey | ARCDoc | ClassMember | The key used for storing the actual content at this level. |
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-. |
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.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.DocFragP.Assembly | ARCDoc | EnumMember | Name of the assembly in which this fragment resides. |
ARCDoc.DocFragP.Namespace | ARCDoc | EnumMember | Namespace in which this fragment resides. |
ARCDoc.DocFragP.ParentNamespace | ARCDoc | EnumMember | Parent namespace of namespace in which this fragment resides. |
ARCDoc.DocFragP.Type | ARCDoc | EnumMember | Type of class or enum which this fragment describes (also relevant for class or enum member). |
ARCDoc.DocFragP.Name | ARCDoc | EnumMember | As simple a name as practical usable. Often not unique within a greater context. |
ARCDoc.DocFragP.IsInherited | ARCDoc | EnumMember | Relevant for class members. TRUE if method is inherited from a base type. |
ARCDoc.DocFragP.IsInheritedDoc | ARCDoc | EnumMember | Relevant for class members (methods). |
ARCDoc.DocFragP.Lines | ARCDoc | EnumMember | Number of lines of text in -Description- and -LongDescription- for this fragment. |
ARCDoc.DocFragP.Attribute | ARCDoc | EnumMember | The -BaseAttribute- or -PK- from which this -DocFrag- originates. |
ARCDoc.DocFragType | ARCDoc | Enum | Type of documentation fragment, like -Assembly-, -Class- or -ClassMember-. |
ARCDoc.DocFragType.Assembly | ARCDoc | EnumMember | |
ARCDoc.DocFragType.Namespace | ARCDoc | EnumMember | |
ARCDoc.DocFragType.Class | ARCDoc | EnumMember | Does also include interfaces. |
ARCDoc.DocFragType.ClassMember | ARCDoc | EnumMember | |
ARCDoc.DocFragType.Enum | ARCDoc | EnumMember | |
ARCDoc.DocFragType.EnumMember | ARCDoc | EnumMember | |
ARCDoc.PriorityOrder | ARCDoc | Enum | Used for general sorting / prioritizing when showing properties for an entity. |
ARCDoc.PriorityOrder.NotImportant | ARCDoc | EnumMember | |
ARCDoc.PriorityOrder.Important | ARCDoc | EnumMember | |
Assembly ARCQuery | Assembly | ARCQuery provides a query language that mimicks SQL but is usable through HTTP as GET URLs. | |
ARCQuery.BinaryOperatorKey | ARCQuery | Class | Offers expressions with operators like +, -, * and /. |
ARCQuery.BinaryOperatorKey.TryGetPInternal | ARCQuery | ClassMember | The internal executor, containing the specific functionality for how to evaluate the key. |
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.BinaryOperatorKey.TryGetP | ARCQuery | ClassMember | The outwards facing executor, understanding use of -FunctionKeys-. |
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-. |
ARCDoc.OrangeP.Name | ARCDoc | EnumMember | The name of the orange |
ARCDoc.OrangeP.Colour | ARCDoc | EnumMember | |
ARCDoc.SomeAppComponentP | ARCDoc | Enum | Describes class -SomeAppComponent-. |
ARCDoc.SomeAppComponentP.SomeCountValue | ARCDoc | EnumMember | |
ARCDoc.SomeAppComponentP.SomeCountValueNotToBeLogged | ARCDoc | EnumMember | |
ARCDoc.DocFragP | ARCDoc | Enum | Describes class -DocFrag-. |
ARCDoc.DocFragP.DocFragType | ARCDoc | EnumMember | |
ARCQuery.OrdinaryKeyPlusFunctionOrQuantile..ctor | ARCQuery | ClassMember | Note that calling only this constructor without afterwards setting -FunctionKeys- and / or -QuantileKey- would be meaningless. |
ARCQuery.OrdinaryKeyPlusFunctionOrQuantile.FunctionKeys | ARCQuery | ClassMember | All -FunctionKey-s chained at end of compound key (but before an eventual -QuantileKey-). |
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.FunctionKeyAggregateDistinct.SyntaxHelp | ARCQuery | ClassMember | 'Distinct()' |
ARCQuery.FunctionKeyAggregateJoin | ARCQuery | Class | Joins the given list of properties into a single property. |
ARCQuery.FunctionKeyAggregateJoin.SyntaxHelp | ARCQuery | ClassMember | 'Join()' |
ARCQuery.FunctionKeyAggregateMax | ARCQuery | Class | Calculates the maximum value of the given properties. |
ARCQuery.FunctionKeyAggregateMax.SyntaxHelp | ARCQuery | ClassMember | 'Max()' |
ARCQuery.FunctionKeyAggregateMin | ARCQuery | Class | Calculates the minimum value of the given properties. |
ARCQuery.FunctionKeyAggregateMin.SyntaxHelp | ARCQuery | ClassMember | 'Min()' |
ARCQuery.FunctionKeyAggregateSingle | ARCQuery | Class | Ensures that the given list of properties contains only a single item and returns that item. |
ARCQuery.FunctionKeyAggregateSingle.SyntaxHelp | ARCQuery | ClassMember | 'Single()' |
ARCQuery.FunctionKeyAggregateSum | ARCQuery | Class | Sums the given properties. |
ARCQuery.FunctionKeyAggregateSum.SyntaxHelp | ARCQuery | ClassMember | 'Sum()' |
ARCQuery.FunctionKey | ARCQuery | Class | Extracts data from an already existing value like extracting Year from a DateTime in 'Created.Year()'. |
ARCQuery.FunctionKey.TryGetP Overload1 | ARCQuery | ClassMember | NOTE: The in-parameter is a property, not an entity. |
ARCQuery.FunctionKey.AddParser | ARCQuery | ClassMember | Adds a -ApplicationSpecificCode- parser. |
ARCQuery.FunctionKey.TryParse | ARCQuery | ClassMember | Find parsers from -Parsers- based on first word in query. |
ARCQuery.FunctionKey.TryParseSingleWord | ARCQuery | ClassMember | Recommended parser to use for functions without parameters. |
ARCQuery.FunctionKey.TryGetP Overload2 | ARCQuery | ClassMember | Overload which will try to call -TryGetV- with generic type parameter, and if that does not succeed will try to call the optional 'tryParser'. |
ARCQuery.FunctionKey.Parsers | ARCQuery | ClassMember | Instances of all the relevant sub classes of -FunctionKey-. |
ARCQuery.FunctionKeyAbs | ARCQuery | Class | Returns the absolute value of field, like 4 for '-4'. |
ARCQuery.FunctionKeyAbs.TryGetP | ARCQuery | ClassMember | NOTE: The in-parameter is a property, not an entity. |
ARCQuery.FunctionKeyAbs.SyntaxHelp | ARCQuery | ClassMember | 'Abs()' |
ARCQuery.FunctionKeyDate | ARCQuery | Class | Formats a date without time component. |
ARCQuery.FunctionKeyDate.TryGetP | ARCQuery | ClassMember | NOTE: The in-parameter is a property, not an entity. |
ARCQuery.FunctionKeyDate.SyntaxHelp | ARCQuery | ClassMember | 'Date()' |
ARCQuery.FunctionKeyDayOfWeek | ARCQuery | Class | Extracts DayOfWeek from field like 'Monday', 'Tuesday' and so on. |
ARCQuery.FunctionKeyDayOfWeek.TryGetP | ARCQuery | ClassMember | NOTE: The in-parameter is a property, not an entity. |
ARCQuery.FunctionKeyDayOfWeek.SyntaxHelp | ARCQuery | ClassMember | 'DayOfWeek()' |
ARCQuery.FunctionKeyDouble | ARCQuery | Class | Converts an integer to a double (decimal value). |
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.DocLinkP | ARCDoc | Enum | Describes class -DocLink-. |
ARCDoc.DocLinkP.Location | ARCDoc | EnumMember | The location that this link points to. |
ARCDoc.DocLinkP.Filename | ARCDoc | EnumMember | |
ARCDoc.DocLinkP.LinkWordHTML | ARCDoc | EnumMember | Actual link as it is expected to occur in text, like '-MyCustomerClass<T>-'. |
ARCDoc.DocLinkResolutionP | ARCDoc | Enum | Describes class -DocLinkResolution- |
ARCDoc.DocLinkResolutionP.LinkWord | ARCDoc | EnumMember | |
ARCDoc.DocLinkResolutionP.DocLinks | ARCDoc | EnumMember | The possible links for -LinkWord- |
ARCDoc.DocumentatorP | ARCDoc | Enum | Describes class -Documentator-. |
Generated 2025-08-08 18:42:01.112 UTC