[ROOT]  doc  DocFrag  SELECT Assembly, DocFragType, Description.FirstLine()   <  SKIP 127  >   <  TAKE 480  >   

480 items

DocFragIdAssemblyDocFragTypeDescription.FirstLine()
ARCCore.PKTypeAttribute.CardinalityARCCoreClassMemberSee -Cardinality-.
ARCCore.PKTypeAttribute.DefaultValueARCCoreClassMemberSee -DefaultValue-.
ARCCore.PKTypeAttribute.IsObligatoryARCCoreClassMemberSee -IsObligatory-.
ARCCore.PKTypeAttribute.IsDefaultARCCoreClassMemberDoes 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.IPARCCoreClassIP = IProperty.
ARCCore.IP.TryGetV Overload2ARCCoreClassMemberThe actual value of the property. Mostly relevant for single-value properties like -PValue-.
ARCCore.IP.IncARCCoreClassMemberIncrements given property key by 1. Sets to 1 if not found. Uses long, not integer.
ARCCore.IP.DecARCCoreClassMemberDecrements given property key by 1. Sets to -1 if not found. Uses long, not integer.
ARCCore.IP.LogARCCoreClassMemberThe 'final' overload of -Log- that is called by the other overloads.
ARCCore.IP.LogExecuteTimeARCCoreClassMemberTimes the execution of the given function and logs details about elapsed time.
ARCCore.IP.HandleExceptionARCCoreClassMemberNote that most relevant to use for -PConcurrent-.
ARCCore.IP.InitializeARCCoreClassMemberNote that has a default implementation (doing nothing).
ARCCore.IP.AssertIntegrityARCCoreClassMemberSee -TryAssertIntegrity-.
ARCCore.IP.TryAssertIntegrityARCCoreClassMemberAsserts the integrity of this entity.
ARCCore.IP.ToStringARCCoreClassMemberThe ToString()-implementation in the classes implementing this interface is supposed to give a short concise representation of the object for debugging and logging purposes, that is, intended for human consumption. The most 'important' implementation is probably the one in -PRich- (-ToString-) because that one is often the basis for your entity classes like 'Customer', 'Order' and so on
ARCCore.IP.TrySetPPARCCoreClassMemberSetPP = set property of property. Sets property of entity contained within this class.
ARCCore.IP.GetKeysEqualToValueARCCoreClassMemberReturns properties which themselves again have key and value equal to the given key and value.
ARCCore.IP.OnTrySetPARCCoreClassMemberEvent 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.IP.TryGetP Overload1ARCCoreClassMemberGets a single property for this object
ARCCore.IP.ToPropertyStreamARCCoreClassMemberTurns object into a -PropertyStream-
ARCCore.IP.ToJSONSerializeableARCCoreClassMemberPrepares the data into a format acceptable for System.Text.Json.JsonSerializer.Serialize.
ARCCore.IP.GetValueForJSONSerializerARCCoreClassMemberMakes the following modifications to the data:
ARCCore.IP.TrySetPARCCoreClassMemberSet property regardless of whether exists or not.
ARCCore.IP.TryGetV Overload1ARCCoreClassMemberThe actual 'unpacking' of the object.
ARCCore.IP.DeepCopyARCCoreClassMemberCreates a deep copy of this object instance, that is, a copy with all new object instances (except for immutable objects).
ARCCore.IP.AddPVARCCoreClassMemberAdds a property value (as a -PValue-) for this objectThrows -KeyAlreadyExistsException- when relevant.
ARCCore.IP.AddPARCCoreClassMemberAdds a property for this object.
ARCCore.IP.AddOrUpdatePARCCoreClassMemberDuplicates functionality of SetP.
ARCCore.IP.GetOrAddPVARCCoreClassMemberGets value. If not set then value will be added
ARCCore.IP.GetPARCCoreClassMemberGets a single property for this object.
ARCCore.IP.TryGetP Overload2ARCCoreClassMemberNote that not relevant for single-value properties like -PValue-.
ARCCore.IP.GetPVARCCoreClassMemberGets a single property's value for this object. Returns default value if not successful.
ARCCore.IP.TryGetPVARCCoreClassMemberGets a single property's value for the given property key.
ARCCore.IP.EnumeratorReturnsEmptyCollectionARCCoreClassMemberHint for how to avoid calling enumerator.Count() when all you need is to decide if collection is empty or not.
ARCCore.IP.IsValidARCCoreClassMemberNote 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.IP.ItemARCCoreClassMemberOffers string-based direct indexing.
ARCCore.IP.KeysARCCoreClassMemberReturns all the keys for this instance.
ARCCore.IP.ValuesARCCoreClassMemberReturns all the values (all the properties) for this instance.
ARCCore.IP.LoggerARCCoreClassMemberDescribes a logger.
ARCCore.IP.AllIPDerivedTypesARCCoreClassMemberAll relevant -IP--derived types for the whole application.
ARCCore.IP.AllIPDerivedTypesWithPKEnumARCCoreClassMemberAll relevant -IP--derived types for the whole application for which the also is defined a -PropertyKeyEnum-.
ARCCore.IP.AllIPDerivedTypesWithPKEnumApplicationSpecificARCCoreClassMemberAll relevant -IP--derived types for the -ApplicationSpecificCode- part of the application for which also is defined a -PropertyKeyEnum-.
ARCCore.IP.AllIPDerivedEntityCollectionClassesDictARCCoreClassMemberAll -IP--derived types for which is found a corresponding class with name like '{EntityType}Collection'
ARCCore.IP.AllIPDerivedTypesInludingGenericAndAbstractARCCoreClassMemberAll relevant -IP--derived types (except the interface -IP- itself) known to the application.
ARCCore.IP.AllIPDerivedTypesDictARCCoreClassMemberOffers for lookup of a type given its string representation.
ARCCore.IP.AllIPDerivedTypesDictIKTypeARCCoreClassMemberSame as -AllIPDerivedTypesDict- except that value is -IKType-, not string.
ARCCore.PARCCoreClass'Dummy'-class, not necessarily in use. See -PP- for more information. Created because of the concept of CorrespondingClass which is strictly enforced
ARCCore.P.TryGetVARCCoreClassMemberNote 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.P.ToStringARCCoreClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.ICreatedARCCoreClassA dummy interface signifying that implementing class has the ability to store (in-memory) metadata -Created-
ARCCore.PCollectionARCCoreClassA class useful for storing a collection of entities (a table in RDBMS-terms) because it implements -Indexing-.
ARCCore.PCollection.TrySetPPARCCoreClassMemberReplaces default interface method -TrySetPP-.
ARCCore.PCollection.GetKeysEqualToValueARCCoreClassMemberReturns properties which themselves again have key and value equal to the given key and value.
ARCCore.PCollection.TryGetVARCCoreClassMemberNote 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.PCollection.ToStringARCCoreClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.IGetKeysEqualToValueARCCoreClassInterface 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.PConcurrentARCCoreClassA (somewhat) thread-safe alternative to -PRich- which also supports -ExposingApplicationState- (through -Logger-).
ARCCore.PConcurrent.ToStringARCCoreClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.PExact<EnumType>ARCCoreClassVery -MemoryConsumption- efficient alternative to -PRich-.
ARCCore.PExact<EnumType>..ctorARCCoreClassMemberSet capacity to the number of members in the -PropertyKeyEnum- for this class (minus the __invalid-value)
ARCCore.PExact<EnumType>.StorageARCCoreClassMemberUses int-value of -__enum- minus 1 as index.
ARCCore.PIIARCCoreClassPII = property for storing individual items.
ARCCore.PII.TryGetVARCCoreClassMemberSince value is stored in keys, we need to override this method.
ARCCore.PII.ToStringARCCoreClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.IPIIARCCoreClassFuture expansion, using different classes for storing, not only -PII-.
ARCCore.IIKIIARCCoreClassRelated to -PII-, property for storing individual items
ARCCore.PropertyStreamLine.EncodeValuesARCCoreClassMemberTypically used when turning -WholeCollection- into a value part of a -PropertyStreamLine-.
ARCCore.PropertyStreamLine.EncodeKeysARCCoreClassMemberEncodes the key part of a -PropertyStreamLine-.
ARCCore.PropertyStreamLine.EncodeValuePartARCCoreClassMemberConverts a single value part of a -PropertyStreamLine- to a format suitable for sending over a -PropertyStream-.
ARCCore.PropertyStreamLine.EncodeKeyPartARCCoreClassMemberConverts a single key part of a -PropertyStreamLine- to a format suitable for sending over a -PropertyStream-.
ARCCore.PropertyStreamLine.TryParseDirectToIPARCCoreClassMemberParses a series of -PropertyStreamLine- directly to the given type of -IP-.
ARCCore.PropertyStreamLine.DecodeARCCoreClassMemberDecodes string as encoded by -EncodeKeyPart- or -EncodeValuePart-.
ARCCore.PropertyStreamLine.ParseAndStoreARCCoreClassMemberNote that throws exception if -TryParseAndStore- fails.
ARCCore.PropertyStreamLine.TryParseDirectToPropertyARCCoreClassMemberParses direct to a given property value.
ARCCore.PropertyStreamLine.StoreFailSafeARCCoreClassMemberStores if possible and fails silently.
ARCCore.PropertyStreamLine.ParseAndStoreFailSafeARCCoreClassMemberIf either parsing or storing fails then this method will call -StoreFailure- in order to keep some track of why parsing or storing failed.
ARCCore.PropertyStreamLine.StoreFailureARCCoreClassMemberStores a 'ParseOrStoreFailure'-object.
ARCCore.PropertyStreamLine.TryStoreARCCoreClassMemberStores the given -PropertyStreamLineParsed- in the given storage object.
ARCCore.PropertyStreamLine.AllowedKeyCharsARCCoreClassMemberAllowed characters in the Key-part of a -PropertyStreamLine-.
ARCCore.PropertyStreamLine.AllowedValueCharsARCCoreClassMemberAllowed characters in the Value-part of a -PropertyStreamLine-.
ARCCore.PropertyStreamLineParsedARCCoreClassParses the keys part of a line from -PropertyStream-, like 'Customer/42/FirstName = John.
ARCCore.PropertyStreamLineParsed.ToStringARCCoreClassMemberNote relatively complex operation of 'restoring' original property stream line.
ARCCore.PropertyStreamLineParsed.TryParseARCCoreClassMemberGenerate list of <(IK key, Type valueType)> together with value from value part.
ARCCore.PropertyStreamLineParsed.KeysARCCoreClassMemberThe keys part of the -PropertyStreamLine-, that is, everything before ' = '.
ARCCore.PropertyStreamLineParsed.IsCommentARCCoreClassMemberSignifies that property stream line given for parsing started with '//' (two forward slashes).
ARCCore.PropertyStreamLineParsed.ValueARCCoreClassMemberThe original (non-parsed, non-validated)) value part of the -PropertyStreamLine-, that is, everything after ' = '.
ARCCore.StreamProcessorARCCoreClassImplements the storage mechanism for AgoRapide.
ARCCore.StreamProcessor.InitializeARCCoreClassMemberInitializes this instance of -StreamProcessor-
ARCCore.StreamProcessor.CreateBareBonesInstanceARCCoreClassMemberCreates a bare-bones -StreamProcessor- instance.
ARCCore.StreamProcessor.AddOrRemoveOutgoingConnectionsARCCoreClassMemberNot relevant for -CoreDB-.
ARCCore.StreamProcessor.StartTCPIPCommunicationARCCoreClassMemberStarts communicating over TCP/IP.
ARCCore.StreamProcessor.AddTimestampAsRequiredARCCoreClassMemberAdds -Timestamp- to the property stream (to -_queueReceive-) as specified by -TimestampResolution-.
ARCCore.StreamProcessor.ReceiveAndDistributeARCCoreClassMemberProcess all messages in receive queue.
ARCCore.StreamProcessor.ReadStorageFileARCCoreClassMemberReads one storage file from disk
ARCCore.StreamProcessor.ToStringARCCoreClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.PropertyStreamLineWithOriginARCCoreClassThe rationale for this class is that -ReceiveAndDistribute- needs to distingush origin of data when routing it (in general, in order to avoid sending it back to its source).
ARCCore.StreamProcessor.OutsideLocalReceiverARCCoreClassMemberThe outside (in the sense outside of this class) local mechanism which receives all -PropertyStreamLine- registered by this class.
ARCCore.PropertyStreamLineWithOrigin.HasLocalOriginARCCoreClassMemberLocally generated data is not to be sent to -OutsideLocalReceiver-). We instead leave it to the 'outside' to decide if
ARCCore.PropertyStreamLineWithOrigin.SendToLocalReceiverARCCoreClassMemberMeans 'send to local receiver regardless of origin'.
ARCCore.PropertyStreamLineWithOrigin.ReceivedFromOutgoingARCCoreClassMemberData received from an outgoing connection, that is, data received based on 'this' application's subscription request (as subscribing client).
ARCCore.PropertyStreamLineWithOrigin.DoNotAddTimestampARCCoreClassMemberNormally -StreamProcessor- inserts the required -Timestamp-s in the AgoRapide storage.
ARCCore.StorageFileARCCoreClassImplemented only in order to store some ideas about -Hash-.
ARCCore.StorageFile.TryGetVARCCoreClassMemberNote 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.SubscriptionARCCoreClassA stream -Subscription- is the concept of how nodes (see -ARNodeType-) subscribe to the -PropertyStream- (either the whole stream or just part of it) in a distributed manner.
ARCCore.StorageFile.ToStringARCCoreClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.Subscription.FromTimeARCCoreClassMemberTODO: Implement concept of specifying starting-point in TIME (often for an -AdHocQuery-?).
ARCCore.Subscription.ToTimeARCCoreClassMemberTODO: Implement concept of specifying ending-point in TIME (often for an -AdHocQuery-?).
ARCCore.Subscription.IsMatch Overload2ARCCoreClassMemberEvaluates this instance of -Subscription- against a single property stream line (which has been split up into its constituent elements).
ARCCore.Subscription.IsMatch Overload1ARCCoreClassMemberEvaluates a query consisting of multiple instances of -Subscription- against a single property stream line.
ARCCore.Subscription.SyntaxHelpARCCoreClassMember'+*' Subscribe to everything in database.
ARCCore.Subscription.IsAddARCCoreClassMemberCorresponds to whether value starts with a plus sign, '+' or not.
ARCCore.UtilCoreARCCoreClassUtility methods for -ARCCore-.
ARCCore.Subscription.IsRemoveARCCoreClassMemberCorresponds to whether value starts with a minus sign, '+' or not.
ARCCore.UtilCore.AssertCurrentlyStartingUpARCCoreClassMemberNormally called from non-thread safe methods that should be run single-threaded at application startup only.
ARCCore.UtilCore.DoubleTryParseARCCoreClassMemberNote that treats ',' (comma) as decimal point (not as thousands separator).
ARCCore.UtilCore.GetExceptionChainAsStringARCCoreClassMemberFollows the chain of InnerException and returns types as comma-separated string
ARCCore.UtilCore.EnumTryParseARCCoreClassMemberSame as the inbuilt .NET method -TryParse- but with some additional checks.
ARCCore.UtilCore.GetExeptionDetailsARCCoreClassMemberGives as much information about exception as possible.
ARCCore.UtilCore.TryGetTypeFromStringNoCacheARCCoreClassMemberSee -TryGetTypeFromStringFromCache- for documentation.
ARCCore.UtilCore.DateTimeTryParseARCCoreClassMemberAccepts on of the formats specified in -ValidDateTimeFormats-.
ARCCore.UtilCore.TryGetTypeFromStringFromCacheARCCoreClassMemberCorresponding method for creating string-representation of type is -ToStringDB-.
ARCCore.UtilCore.TimeSpanTryParseARCCoreClassMemberAccepts on of the formats specified in -ValidDateTimeFormats-.
ARCCore.UtilCore.UseLocalTimeInsteadOfUTCARCCoreClassMemberBy default AgoRapide operates only with UTC time.
ARCCore.UtilCore.CultureARCCoreClassMemberThe general culture used for parsing.
ARCCore.UtilCore.DateTimeNowARCCoreClassMemberReturns DateTime.UtcNow unless -UseLocalTimeInsteadOfUTC- has been set to TRUE in which case DateTime.Now is returned.
ARCCore.UtilCore.Culture_en_USARCCoreClassMemberUsed by -DoubleTryParse-.
ARCCore.UtilCore.CurrentlyStartingUpARCCoreClassMemberCalled once at application startup after all Attribute instances in the C# code has been processed.
ARCCore.UtilCore.DefaultAgoRapideEncodingARCCoreClassMemberThe standard encoding used for text (UTF8).
ARCCore.UtilCore.AssembliesARCCoreClassMemberAll relevant assemblies for application.
ARCCore.UtilCore.ValidDateTimeFormatsARCCoreClassMember'yyyy-MM-dd HH:mm:ss.fff', 'yyyy-MM-dd HH:mm:ss', 'yyyy-MM-dd HH:mm', 'yyyy-MM-dd'
ARCCore.UtilCore.ValidTimeSpanFormatsARCCoreClassMember'hh\:mm', 'hh\:mm\:ss', 'd\.hh\:mm\:ss', 'hh\:mm\:ss\.fff' // Milliseconds,'d\.hh\:mm\:ss\.fff'
ARCCore.InvalidTypeExceptionARCCoreClass 
ARCCore.RExARCCoreClassREx = 'TooDeepRecursiveDepthException'
ARCCore.InvalidTypeException.AssertAssignableARCCoreClassMemberAsserts that expectedType.IsAssignableFrom(foundType)
ARCCore.REx.IncARCCoreClassMemberIncreases recursive count.
ARCCore.InvalidTypeException.AssertEqualsARCCoreClassMemberAsserts that expectedType.Equals(foundType)
ARCCore.REx.DecARCCoreClassMemberThis method should be called from inside a 'finally' block, in order to secure its execution, if not your static recursion depth counter could slowly increase over time due to exceptions ocurring after call to -Inc- but before call to -Dec-.
ARCCore.TValueARCCoreClassPlaceholder for any class type suitable as generic type parameter -PValue-.
ARCCore.StreamProcessor+StorageFileARCCoreClass 
ARCCore.BaseAttribute+IncorrectAttributeTypeUsedExceptionARCCoreClassHelps to clean up any confusion about which -BaseAttribute- to use in a given concept.
ARCCore.StreamProcessor+StorageFile.FilepathARCCoreClassMemberComplete path to file
ARCCore.PK+BasePKAttributeNotFoundException<T>ARCCoreClassExplains how to implement a given -BasePKAttribute- for an enum
ARCCore.StreamProcessor+StorageFile.FilenameARCCoreClassMemberFilename: Main file name, like 2020-04-03 08:42
ARCCore.PK+PKBoolPairARCCoreClassUsed 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.StreamProcessor+StorageFile.LengthARCCoreClassMemberWrongly placed. Belongs to each individual revision file.
ARCCore.PK+PKBoolPair.TrulyInitializedARCCoreClassMemberNot used currently (May 2020). Useful for debugging purposes
ARCCore.StreamProcessor+StorageFile.PropertiesARCCoreClassMemberKey = revision number of file (due to compression / -DataRetention-), like R00001, R00002 and so on.
ARCCore.ClassAttributePARCCoreEnumDescribes class -ClassAttribute-.
ARCCore.BaseAttributePARCCoreEnumDescribes class -BaseAttribute-.
ARCCore.ClassAttributeP.AssemblyNameARCCoreEnumMemberThe assembly in which this class resides.
ARCCore.BaseAttributeP.DescriptionARCCoreEnumMemberThe description for the attribute, like this description
ARCCore.ClassAttributeP.ClassNamespaceARCCoreEnumMemberThe namespace for -ClassType-.
ARCCore.BaseAttributeP.LongDescriptionARCCoreEnumMemberThe long (detailed) description for the attribute.
ARCCore.ClassAttributeP.ClassTypeARCCoreEnumMemberThe actual type that we are a -ClassAttribute- for
ARCCore.ClassAttributeP.BaseTypesARCCoreEnumMemberThe inheritance hierarchy for this class, starting with base type (excluding 'object').r Not set if class does not inherit any class except 'object'
ARCCore.ClassAttributeP.CorrespondingEnumTypeARCCoreEnumMemberOnly relevant when implements -IP-.
ARCCore.ClassAttributeP.SubTypesARCCoreEnumMemberDirect and indirect sub types of this class.
ARCCore.ClassAttributeP.BoilerplateCodePropertiesAndStorageARCCoreEnumMemberOnly relevant when implements -IP- and when a -CorrespondingEnumType- is found.
ARCCore.ClassAttributeP.InterfacesARCCoreEnumMemberAll interfaces that this class and its base classes implement
ARCCore.ClassMemberAttributePARCCoreEnumDescribes class -ClassMemberAttribute-.
ARCCore.ClassAttributeP.InterfacesDirectlyImplementedARCCoreEnumMemberAll interfaces that this class directly implements.
ARCCore.ClassMemberAttributeP.DeclaringTypeARCCoreEnumMemberThe actual MemberInfo.DeclaringType.
ARCCore.EnumAttributeP.EnumNamespaceARCCoreEnumMemberThe namespace for -EnumType-.
ARCCore.ClassMemberAttributeP.MethodNameARCCoreEnumMemberThe actual MemberInfo.Name.
ARCCore.EnumAttributeP.EnumTypeARCCoreEnumMemberThe type of the enum (like type of 'CustomerP' in CustomerP.FirstName) that we are an attribute for
ARCCore.ClassMemberAttributeP.MethodSignatureARCCoreEnumMemberThe actual MemberInfo.ToString.
ARCCore.EnumAttributeP.AREnumTypeARCCoreEnumMemberNote that will default to -__invalid- if not explicit set.
ARCCore.EnumAttributePARCCoreEnumDescribes class -EnumAttribute-.
ARCCore.EnumAttributeP.CorrespondingClassARCCoreEnumMemberOnly relevant when -PropertyKeyEnum-.
ARCCore.EnumAttributeP.AssemblyNameARCCoreEnumMemberThe assembly in which this class resides.
ARCCore.ARComponents.ARCCoreARCCoreEnumMemberA necessary library (.DLL in Windows terms) that every -ARNodeType- should link to.
ARCCore.EnumMemberAttributePARCCoreEnumDescribes class -EnumMemberAttribute-.
ARCCore.ARComponents.ARADBARCCoreEnumMemberAn application constituting the full functionality of a -CoreDB- (linking to -ARCCore-).
ARCCore.EnumMemberAttributeP.EnumTypeARCCoreEnumMemberThe type of the enum (like type of 'CustomerP' in CustomerP.FirstName) that we are an attribute for
ARCCore.ARComponents.ARAClientARCCoreEnumMemberA template application for a -Client- (linking to -ARCCore-).
ARCCore.EnumMemberAttributeP.EnumMemberARCCoreEnumMemberThe actual enum member / enum value (like 'Firstname' in CustomerP.FirstName) that we are an attribute for
ARCCore.ARComponents.ARCDocARCCoreEnumMemberA library supporting documentation and demonstrating usage of AgoRapide.
ARCCore.ARComponentsARCCoreEnumContains short descriptions of the different 'official' AgoRapide components.
ARCCore.ARConcepts.TaggingOfPropertyKeysARCCoreEnumMemberThe concept of specifying in a single place all relevant information about a given property (data field).
ARCCore.ARComponents.ARCQueryARCCoreEnumMemberARCQuery provides a query language that mimicks SQL but is usable through HTTP as GET URLs.
ARCCore.ARConcepts.PropertyAccessARCCoreEnumMemberThe general mechanism for accessing properties of objects in AgoRapide.
ARCCore.ARComponents.ARCSyncARCCoreEnumMember(Not implemented as of March 2020)
ARCCore.ARConcepts.AvoidingRepetitionARCCoreEnumMemberAvoiding repetition, the overarching philosophy that inspired the rest of AgoRapide.
ARCCore.ARComponents.ARCSecARCCoreEnumMember(Not implemented as of March 2020)
ARCCore.ARConcepts.AgoRapideHistoryARCCoreEnumMemberAgoRapide has roots back to 2011 when Bjørn Erling Fløtten invented panSL (SL = Schema language).
ARCCore.ARComponents.ARCAPIARCCoreEnumMemberA library providing an API on top of the -PropertyStream-.
ARCCore.ARConcepts.AdHocQueryARCCoreEnumMemberThe concept of a -Client- doing an ad-hoc query against (normally) a -ArmDB-.
ARCCore.ARComponents.ARAAPIARCCoreEnumMemberThe corresponding template application for -ARCAPI- demonstrating its usage, providing an HTTP / HTTPS interface with the help of Microsoft.AspNetCore.Mvc.
ARCCore.ARConcepts.StandardAgoRapideCodeARCCoreEnumMemberCode originating from the main official AgoRapide distribution (which therefore does not include any end-application specific code)
ARCCore.ARConceptsARCCoreEnumThe overarching concepts upon which AgoRapide is built.
ARCCore.ARConcepts.ApplicationSpecificCodeARCCoreEnumMemberCode specific for an end-application.
ARCCore.ARConcepts.GettingStartedARCCoreEnumMemberAgoRapide 2020 is an open source library for building data-oriented backend applications using .NET Standard 2.1.
ARCCore.ARConcepts.MemoryConsumptionARCCoreEnumMemberA naïve implementation of key-value storages like AgoRapide may lead to excessive memory (RAM) consumption.
ARCCore.ARConcepts.PropertyStreamARCCoreEnumMemberAgoRapide, the 'streams-of-water' database".
ARCCore.PropertyStreamLineARCCoreClassHas two main functions:
ARCCore.ARConcepts.IndexingARCCoreEnumMemberIn-memory indexing of data is done 'behind-the-scenes' by some classes implementing -IP-.
ARCCore.ARConcepts.ExposingApplicationStateARCCoreEnumMemberThe traditional debugging process usually entails reading through logs and querying about your application state through a debugging tool.
ARCCore.StreamProcessorP.CopyFileStructureFromCoreARCCoreEnumMemberIf TRUE, will copy the exact file structure (through information given in -ClientUpdatePosition-).
ARCCore.ARConcepts.CoreDBSynchronizationARCCoreEnumMemberThe concept of how multiple -CoreDB- instances synchronizes their data.
ARCCore.ARConcepts.LinkInsertionInDocumentationARCCoreEnumMemberDocumentation with links is much easier to read.
ARCCore.StreamProcessorP.CountIncomingConnectionsARCCoreEnumMember 
ARCCore.ARConcepts.SingleThreadedCodeARCCoreEnumMemberSome 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.TryPatternAndNullARCCoreEnumMemberAgoRapide uses non-nullable reference types as default throughout the system
ARCCore.StreamProcessorP.CountOutgoingConnections   
ARCCore.ARConcepts.DataRetentionARCCoreEnumMemberThe concept of when to delete old data (if deemed necessary).
ARCCore.AREnumTypeARCCoreEnumCategories different types of enum used in AgoRapide. The most important one is -PropertyKeyEnum-.
ARCCore.StreamProcessorP.CountOutsideLocalReceiverARCCoreEnumMemberCount of calls to -OutsideLocalReceiver-.
ARCCore.ARConcepts.NoRealDeletionARCCoreEnumMemberAgoRapide has no real concept for deletion of data (apart from -DataRetention-, which is mostly relevant for 'old' data).
ARCCore.AREnumType.PropertyKeyEnum   
ARCCore.StreamProcessorP.CountReceiveLocalOriginARCCoreEnumMemberCount of -PropertyStreamLine- with -HasLocalOrigin-.
ARCCore.ARConcepts.ManyToManyRelationsARCCoreEnumMember-ARCQuery- supports many-to-many relations in a simple manner without introducing a third entity type (a third table).
ARCCore.AREnumType.OrdinaryEnumARCCoreEnumMemberDesignates "Ordinary" enums used for indicating range of valid values for a given key
ARCCore.StreamProcessorP.CountReceiveNonLocalOriginARCCoreEnumMemberCount of -PropertyStreamLine- not with -HasLocalOrigin-.
ARCCore.ARConcepts.DocumentationARCCoreEnumMemberThanks to the tagging of enums and classes in AgoRapide (like this description), automatically generation of documentation is possible.
ARCCore.AREnumType.DocumentationOnlyEnumARCCoreEnumMemberDesignates enums that provide a central repository of explanation of terms that are not present in the C# code.
ARCDoc.Apple.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.ARConcepts.AssertionsAndDetailedExceptionMessagesARCCoreEnumMemberThe abstraction level in AgoRapide is very high.
ARCCore.ARNodeTypeARCCoreEnumDescribes what function a node in an AgoRapide system serves. A given node may constitute of only -StandardAgoRapideCode- or a combination of -StandardAgoRapideCode- and -ApplicationSpecificCode-.
ARCDoc.Apple.NameARCDocClassMemberConvenience method, not obligatory.
ARCCore.ARNodeType.CoreDBARCCoreEnumMemberA node containing the core or central database.
ARCCore.PSPrefix.dtARCCoreEnumMemberData, like dt/
ARCDoc.BananaARCDocClassImplements -IP- directly and uses traditional property storage for optimum -MemoryConsumption- efficiency.
ARCCore.ARNodeType.ArmDBARCCoreEnumMemberA 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.PSPrefix.cmdARCCoreEnumMemberCommand, like cmd/
ARCDoc.Banana.NameARCDocClassMemberAnnotated as nullable in order to keep flexibility of -PropertyAccess-, including what happens if values are not set (TryGetP etc)
ARCCore.ARNodeType.ClientARCCoreEnumMemberAn outer node / 'end' node with (usually) -ApplicationSpecificCode- but based on -ARADB-.
ARCCore.PSPrefix.appARCCoreEnumMemberApplication state, like app/
ARCDoc.Banana.ColourARCDocClassMemberAnnotated as nullable in order to keep flexibility of -PropertyAccess-, including what happens if values are not set (TryGetP etc)
ARCCore.CardinalityARCCoreEnumDescribes how multiple instances of a property is supposed to be handled.
ARCCore.PSPrefix.docARCCoreEnumMemberDocumentation, like doc/.
ARCDoc.DemonstratorARCDocClassDemonstrates various concepts from -ARCCore-, especially -PropertyAccess-.
ARCCore.Cardinality.HistoryOnlyARCCoreEnumMemberThe default value.
ARCCore.PKHTMLAttributePARCCoreEnumDescribes class -PKRelAttribute-.
ARCDoc.Demonstrator.DemonstratePropertyAccessAppleARCDocClassMemberDemonstrates use of -PropertyAccess- through the -Apple- class.
ARCCore.Cardinality.WholeCollectionARCCoreEnumMemberValues are always set as a whole (there is no need or no meaning in setting or deleting individual items)
ARCCore.PKHTMLAttributeP.EncoderARCCoreEnumMemberThe class doing the HTML-encoding.
ARCDoc.Demonstrator.DemonstratePropertyAccessOrangeARCDocClassMemberDemonstrates use of -PropertyAccess- through the -Orange- class.
ARCCore.Cardinality.IndividualItemsARCCoreEnumMemberValues are supposed to be set and 'deleted' individually.
ARCCore.PKLogAttributePARCCoreEnumDescribes class -PKLogAttribute.
ARCDoc.Demonstrator.DemonstratePropertyAccessBananaARCDocClassMemberDemonstrates use of -PropertyAccess- through the -Banana- class.
ARCCore.PSPrefixARCCoreEnumDescribes some recommended prefixed to use in a -PropertyStreamLine-.
ARCCore.PKLogAttributeP.DoNotLogAtAllARCCoreEnumMemberOriginates from -DoNotLogAtAll-.
ARCDoc.Orange.StorageARCDocClassMemberUses int-value of -__enum- minus 1 as index.
ARCCore.PKLogAttributeP.CountIntervalARCCoreEnumMemberFor a value of n, log only every n'th time the property is changed.
ARCCore.PKTypeAttributeP.CardinalityARCCoreEnumMemberDescribes how multiple instances of a property is supposed to be handled.
ARCDoc.SomeAppComponentARCDocClassDemonstrates how also your actual application classes, not only your data classes, should implement -IP-.
ARCCore.PKLogAttributeP.TimeIntervalARCCoreEnumMemberSpecifies a certain time interval for which the property's value shall be sent over the -PropertyStream-.
ARCCore.PKTypeAttributeP.IsObligatoryARCCoreEnumMemberTrue means value is obligatory.
ARCDoc.SomeAppComponent.MethodCARCDocClassMemberNote structured format in logging.
ARCCore.PKRelAttributePARCCoreEnumDescribes class -PKRelAttribute-.
ARCCore.PKTypeAttributeP.BoilerplateCodePropertiesARCCoreEnumMemberAutomatically generated boilerplate code that implements traditional setters and getters for this key.
ARCDoc.SomeAppComponent.MethodDARCDocClassMemberSame as MethodC- but returns data ('Func<string>()' instead of 'Action()')
ARCCore.PKRelAttributeP.ForeignEntityARCCoreEnumMemberThe type of foreign entity that this property points to.
ARCCore.PPARCCoreEnumDescribes meta data for any class (property) implementing -IP-.
ARCDoc.SomeAppComponent.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.PKRelAttributeP.EnforceReferentialIntegrityARCCoreEnumMemberIf TRUE then referential integrity will be enforced by -TryStore-.
ARCCore.PP.CreatedARCCoreEnumMemberTimestamp when property was created in database.
ARCDoc.DocFragARCDocClassDocFrag = Document fragment.
ARCCore.PKTypeAttributePARCCoreEnumDescribes class -PKTypeAttribute-.
ARCCore.PP.CidARCCoreEnumMemberCreator id (entity which created this property).
ARCDoc.DocFrag.Create Overload1ARCDocClassMemberCreates a -DocFrag- object representing an assembly or a namespace.
ARCCore.PKTypeAttributeP.TypeARCCoreEnumMemberThe type of this Property.
ARCCore.PP.ValueARCCoreEnumMemberThe actual value.
ARCDoc.DocFrag.Create Overload2ARCDocClassMemberCreates a -DocFrag- object representing a class, class member, enum or enum member.
ARCCore.PKTypeAttributeP.DefaultValueARCCoreEnumMemberThe default value.
ARCCore.PP.ValidARCCoreEnumMemberTimestamp when property was last known to be (still) valid
ARCDoc.DocLink.TryGetVARCDocClassMemberNote 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.PP.VidARCCoreEnumMemberValidator id, that is entity which set -Valid- for this property.
ARCDoc.Demonstrator.DemonstrateITypeDescriberARCDocClassMemberDemonstrates use of -ITypeDescriber- for describing single-property values.
ARCDoc.DocLink.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.PP.InvalidARCCoreEnumMemberTimestamp when property was invalidated / 'deleted'.
ARCDoc.Demonstrator.DemonstratePRichHierarchicalStorageARCDocClassMemberDemonstrates use of -PRich-, how it receives -PropertyStream--lines and builds up a strongly typed hierarchical object storage.
ARCDoc.DocLink.LocationARCDocClassMemberCopy of -Location-.
ARCCore.PP.IidARCCoreEnumMemberInvalidator id, that is entity which set -Invalid- for this property (or removed / 'undid' the invalidation by setting the value to '0001-01-01').
ARCDoc.Demonstrator.DemonstratePropertyStreamARCDocClassMemberDemonstrates use of -PropertyStream- by generating local data (documentation data) and writing locally to console.
ARCDoc.DocLink.FilenameARCDocClassMemberCopy of -LinkWordHTML-.
ARCCore.PP.ExceptionTextARCCoreEnumMemberGeneral property for logging of exceptions, usually set through -HandleException-.
ARCDoc.Demonstrator.DemonstrateBareBonesClientARCDocClassMemberDemonstrates adding -PropertyStream--lines to -CoreDB- without using ANY AgoRapide component, only standard TCP/IP functionality in .NET.
ARCCore.PConcurrentPARCCoreEnumDescribes class -PConcurrent-.
ARCDoc.Demonstrator.DemonstrateLogConsoleARCDocClassMemberDemonstrates a quite simple log console.
ARCCore.PConcurrentP.HeartbeatARCCoreEnumMember 
ARCDoc.Demonstrator.DemonstrateStreamProcessorAsClientARCDocClassMemberDemonstrates use of -StreamProcessor- as a general client.
ARCCore.ActualConnectionPARCCoreEnumDescribes class -ActualConnection-.
ARCDoc.OrangeARCDocClassInherits -PExact- for probably the best compromise between memory consumption and easy of development.
ARCCore.ActualConnectionP.IdARCCoreEnumMemberWhen connection is used with-StreamProcessor-, the Id should be the same as the key used in the incoming / outgoing connection dictionary collection.
ARCDoc.Orange.NameARCDocClassMemberSee -Name- for more information.
ARCCore.ActualConnectionP.ConnectionInstructionARCCoreEnumMemberOnly relevant when we are an -Outgoing-.
ARCDoc.DocFrag.ToHTMLSimpleSingleARCDocClassMemberAlternative ('override') to -ToHTMLSimpleSingle-.
ARCCore.ActualConnectionP.ConnectionDirectionARCCoreEnumMember 
ARCDoc.DocFrag.TryGetVARCDocClassMemberNote 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.ActualConnectionP.CountReceiveMessageARCCoreEnumMember 
ARCDoc.DocFrag.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.ActualConnectionP.CountSendMessageARCCoreEnumMember 
ARCDoc.DocFragCollectionARCDocClassContains a collection of -DocFrag- objects.
ARCCore.ActualConnectionP.ClientUpdatePositionARCCoreEnumMemberNote how this is stored both as -ClientUpdatePosition- (on the client side) and -ClientUpdatePosition- (on the server side).
ARCDoc.DocFragCollection.CreateARCDocClassMemberCreates documentation fragments (-DocFrag-) for all possible -BaseAttribute- elements found in the given assemblies.
ARCCore.ActualConnectionP.SubscriptionAsRequestedByClientARCCoreEnumMemberOriginates from -Subscription-.
ARCDoc.DocFragCollection.TryGetVARCDocClassMemberNote 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.ActualConnectionP.ClosingReasonARCCoreEnumMemberReason why this connection was closed
ARCDoc.DocFragCollection.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.ActualConnectionP.IsErrorConditionARCCoreEnumMemberSome kind of error condition has occured regarding data going back and forth, but the TCP/IP connection itself is probably sound.
ARCDoc.DocLinkARCDocClassDescribes to where a single HTML link points.
ARCCore.ActualConnectionP.ErrorConditionDataARCCoreEnumMemberDetailed explanation about -IsErrorCondition-
ARCDoc.DocLink.LinkWordHTMLARCDocClassMemberCopy of -LinkWordHTML-.
ARCCore.ActualConnectionP.UnderClosureARCCoreEnumMemberSet to TRUE if to be closed and reinitialized.
ARCDoc.DocLink.LinkWordHTMLWithHyphensARCDocClassMember-LinkWordHTML- with '-' (minus sign / hyphen) prepended and appended.
ARCCore.ActualConnectionP.MonkeyWrenchARCCoreEnumMember 
ARCDoc.DocLink.LinkWordHTMLBeforeLtARCDocClassMemberIf -LinkWordHTML contains '<' (really '&lt;') (for generic types, like 'PValue<TValue>') then this will contain the part before '<' like 'PValue'.
ARCCore.ActualConnectionP.PartnerIPAddressARCCoreEnumMemberTODO: Use more strongly typing for this.
ARCDoc.DocLink.LinkWordHTMLBeforeLtWithHyphensARCDocClassMember-LinkWordHTMLBeforeLt- with '-' (minus sign / hyphen) prepended and appended.
ARCCore.ConnectionInstructionPARCCoreEnumDescribes class -ConnectionInstruction-.
ARCDoc.DocLink.AHrefEndPartARCDocClassMember'Filename.Encoded + "> + LinkWordHTML + </a>'
ARCCore.ConnectionInstructionP.ClientIdARCCoreEnumMemberThe AgoRapide node-id for which this connection is relevant. Used for distributing over the -PropertyStream- information to the clients about which possible nodes they can connect to.
ARCDoc.DocLinkCollectionARCDocClassContains a collection of -DocLink- objects.
ARCCore.ConnectionInstructionP.ServerHostNameARCCoreEnumMemberThe host (DNS or IP-address) for which to connect.
ARCDoc.DocLinkCollection.CreateARCDocClassMemberNotes all locations and their positions in the hierarchical directory structure.
ARCCore.ConnectionInstructionP.ServerPortNoARCCoreEnumMemberThe port number for which to connect.
ARCDoc.DocLinkCollection.InsertLinksARCDocClassMemberDoes -LinkInsertionInDocumentation- on the given HTML content.
ARCCore.StreamProcessorP.UnderClosureARCCoreEnumMemberSet to TRUE if to be closed, whenever an exception occurs or when class goes out of scope
ARCDoc.DocLinkCollection.TryGetVARCDocClassMemberNote 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.WriteToConsoleARCCoreEnumMemberIf true then incoming data (from other nodes will be written to console.
ARCDoc.DocLinkCollection.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.StreamProcessorP.TimestampARCCoreEnumMemberThe timestamp inserted at regular intervals in the -PropertyStream- according to -TimestampResolution-.
ARCDoc.DocLinkResolutionARCDocClassContains a resolution page for a link word which has duplicate 'targets' (pointing to multiple -DocLink- instances).
ARCCore.StreamProcessorP.TimestampIsOldARCCoreEnumMemberA warning sent by -StreamProcessor- to -OutsideLocalReceiver- when it knows that data as served is out of date.
ARCDoc.DocLinkResolution.ToHTMLSimpleSingleARCDocClassMemberGives a friendly description about possible targets for LinkWord-.
ARCCore.StreamProcessorP.TimestampResolutionARCCoreEnumMemberThe time interval between each timestamp update in the -PropertyStream-.
ARCDoc.DocLinkResolution.TryGetVARCDocClassMemberNote 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.DoNotStoreLocallyARCCoreEnumMemberFor -Client-, incoming data (as received from a -Outgoing-) is possible to store BOTH to disk, AND to (normally) a -PRich-.
ARCDoc.DocLinkResolution.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.StreamProcessorP.DoNotStoreLocalOriginLocallyARCCoreEnumMemberMeans 'do not store local origin locally but wait until it gets confirmed by core storage'.
ARCDoc.DocLinkResolutionCollectionARCDocClassContains a collection of -DocLinkResolution- objects.
ARCCore.StreamProcessorP.CacheDiskWritesARCCoreEnumMemberIf TRUE then will write the -PropertyStream- to disk in bigger chunks, thereby increasing performance.
ARCDoc.DocLinkResolutionCollection.TryGetVARCDocClassMemberNote 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.StorageFilePARCCoreEnumDescribes class -StorageFile-.
ARCDoc.DocLinkResolutionCollection.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.StorageFileP.FilenameARCCoreEnumMember 
ARCDoc.DocumentatorARCDocClassGeneral class for documenting AgoRapide and also your own -ApplicationSpecificCode-.
ARCCore.StorageFileP.HashARCCoreEnumMemberHash of storage file. Not implemented as of Apr 2020. It is envisaged to store hash-value as last line in storage file. In this case the hash must be the hash of the file excluding the last line
ARCDoc.Documentator.CreateAndInsertARCDocClassMemberCreates an instance of -Documentator- with a natural hierarchical representation of documentation attributes found in the given assemblies.
ARCCore.ConnectionDirectionARCCoreEnumThe concept of who took the initiative for the connections (who asked to open the TCP/IP session).
ARCDoc.Documentator.ToHTMLSimpleSingleARCDocClassMemberAlternative ('override') to -ToHTMLSimpleSingle-.
ARCCore.ConnectionDirection.IncomingARCCoreEnumMemberConnectionInstruction will not be set for these.
ARCDoc.Documentator.CreateHTOCStandardARCDocClassMemberCreates a 'standard' table of contents, structured by assembly and each assembly divided into 'Class' and 'Enum'.
ARCCore.ConnectionDirection.OutgoingARCCoreEnumMemberThere would normally exist two live outgoing connection at a given point in time for -Client- / -ArmDB-:
ARCDoc.Documentator.CreateHTOCNamespaceARCDocClassMemberCreates a table of contents structured by namespace
ARCCore.DataTransferDirectionARCCoreEnumDirection for transfer of data.
ARCDoc.Documentator.CreateHTOCInheritanceARCDocClassMemberCreates a table of contents structured by inheritance (classes and interfaces only, not members).
ARCCore.DataTransferDirection.SendARCCoreEnumMemberLike -Client- sending in-application generated properties to -ArmDB- / -CoreDB- or -ArmDB- sending data received over an incoming connection to -CoreDB-.
ARCDoc.Documentator.TryGetVARCDocClassMemberNote 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.DataTransferDirection.ReceiveARCCoreEnumMemberLike -Client- receiving data from an upstream -ArmDB- / -CoreDB- or -ArmDB- receiving data from an upstream -CoreDB-.
ARCDoc.Documentator.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.TPropertyKeyEnumARCCoreEnumPlaceholder for any enum type suitable as generic type parameter for -PExact-.
ARCDoc.Documentator.DocLinksARCDocClassMemberSet by -CreateAndInsert-.
Assembly ARCDoc AssemblyA library supporting documentation and demonstrating usage of AgoRapide.
ARCDoc.Documentator.DocLinkResolutionLocationARCDocClassMemberDefault position within the global storage context of doc link resolution pages.
ARCDoc.AppleARCDocClassThe most 'standard' way of implementing an entity-class in AgoRapide, by just inheriting -PRich-.
ARCDoc.DummyEnumARCDocClassTODO: Document better what this is for (and change name)
ARCDoc.Apple.AddNameARCDocClassMemberConvenience method, not obligatory.
ARCDoc.DummyEnum.TryGetVARCDocClassMemberNote 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.GetNameARCDocClassMemberConvenience method, not obligatory.
ARCDoc.DummyEnum.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCDoc.Apple.TryGetNameARCDocClassMemberConvenience method, not obligatory.
ARCDoc.ExtensionsARCDocClassContains various extension methods for -IP- and -IKIP- related to documentating / reporting / HTML.
ARCDoc.Apple.TryGetVARCDocClassMemberNote that 'normally' this method would be irrelevant for a -PRich- object because we will usually be an entity object (like 'Customer') not having an intrinsic value ourselves per se (because we will instead be containing a list of values).
ARCDoc.Extensions.ToHTMLSimpleSingleRecursiveARCDocClassMemberCalls -ToHTMLSimpleSingle- recursively.
AgoMail.Root.ToHTMLSimpleSingleAgoMailClassMemberAlternative ('override') to -ToHTMLSimpleSingle-.
ARCDoc.Extensions.ToHTMLSimpleSingleARCDocClassMemberCreates a simple HTML representation of the given parameter.
AgoMail.Root.TryGetVAgoMailClassMemberNote that 'normally' this method would be irrelevant for a -PRich- object because we will usually be an entity object (like 'Customer') not having an intrinsic value ourselves per se (because we will instead be containing a list of values).
ARCDoc.Extensions.ToHTMLSimpleSingleInternalARCDocClassMemberHack in order to escape check for direct implementation in actual class of -ToHTMLSimpleSingle- in -ToHTMLSimpleSingle-.
AgoMail.Root.ToStringAgoMailClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCDoc.Extensions.ToHTMLSimpleAsTableRowARCDocClassMemberCreates a simple HTML representation of the given parameter as a single two column row (Key, Value) in a table.
AgoMail.Controllers.ControllerFacadeAgoMailClassFacade for entry into the desired -BaseController-.
ARCDoc.Extensions.DescribeValueARCDocClassMemberDescribes the value contained withing an -IKIP- (-P-).
AgoMail.Controllers.ControllerFacade.CatchAll Overload2AgoMailClassMemberCatches all HTTP GET requests to this API.
ARCDoc.Extensions.ValueToHTMLSimpleWithTooltipARCDocClassMemberCreates a simple HTML representation of the Value with description as a 'tooltip'.
AgoMail.Controllers.ControllerFacade.CatchAll Overload1AgoMailClassMemberCatches all HTTP POST requests to this API.
ARCDoc.Extensions.KeyToHTMLSimpleWithTooltipARCDocClassMemberCreates a simple HTML representation of the Key with description as a 'tooltip'.
AgoMail.EmailPAgoMailEnum 
ARCDoc.HLocationARCDocClassSimple class describing the location of a single -IP- instance within some hierarhical context.
AgoMail.EmailP.DateAgoMailEnumMemberUTC-format
ARCDoc.HLocation.TryGetVARCDocClassMemberNote 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).
AgoMail.EmailP.FromAgoMailEnumMember 
ARCDoc.HLocation.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
AgoMail.EmailP.ToAgoMailEnumMember 
ARCDoc.HLocation.ContentARCDocClassMemberThe Content object is not stored within the standard -IP--mechanism.
AgoMail.EmailP.CCAgoMailEnumMember 
ARCDoc.HLocationCollectionARCDocClassContains a collection of -HLocation- objects.
AgoMail.EmailP.SubjectAgoMailEnumMember 
ARCDoc.HLocationCollection.CreateARCDocClassMemberTransforms the parameter (and recursively all contained objects) into a collection of -HLocation- objects.
AgoMail.EmailP.TextBodyAgoMailEnumMember 
ARCDoc.HLocationCollection.WriteAllContentHTMLToDiskARCDocClassMemberWrites all -HLocation- results to a hierarhical folder structure as static HTML files with (optionally) -LinkInsertionInDocumentation-.
AgoMail.EmailP.HTMLBodyAgoMailEnumMember 
ARCDoc.HLocationCollection.TryGetVARCDocClassMemberNote 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).
AgoMail.EmailP.HeadersAgoMailEnumMember 
ARCDoc.HLocationCollection.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
AgoMail.EmailP.AttachmentsAgoMailEnumMember 
ARCDoc.HTOCARCDocClassHTOC = Hierarchical table of contents.
Namespace ARCCore NamespaceA necessary library (.DLL in Windows terms) that every -ARNodeType- should link to.
ARCDoc.HTOC.CreateARCDocClassMemberStructures content hierarchically according to the criteria for each level.
Namespace ARCDoc NamespaceA library supporting documentation and demonstrating usage of AgoRapide.
ARCDoc.HTOC.ToHTMLSimpleSingle Overload2ARCDocClassMemberAlternative ('override') to -ToHTMLSimpleSingle-.
Namespace ARCQuery NamespaceARCQuery provides a query language that mimicks SQL but is usable through HTTP as GET URLs.
ARCDoc.HTOC.ToHTMLSimpleSingle Overload1ARCDocClassMemberUse this method in any class where a table-of-contents type of view is desireable
Namespace ARCAPI NamespaceA library providing an API on top of the -PropertyStream-.
ARCDoc.HTOC.CreateInitialContentARCDocClassMemberHelper method for creation of a -FilterBranch-.
Namespace AgoMail Namespace 
ARCDoc.HTOC.TryGetVARCDocClassMemberNote 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).
Namespace AgoMail.Controllers Namespace 
ARCDoc.HTOC.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCDoc.HTOC.HTOCContentThisLevelKeyARCDocClassMemberThe key used for storing the actual content at this level.
ARCDoc.PKDocAttributeARCDocClassDescribes documentation and presentation of a property.
ARCDoc.PKDocAttribute.InitializeARCDocClassMemberTo 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.TryRemovePARCDocClassMemberShould probably never be used.
ARCDoc.PKDocAttribute.PriorityOrderARCDocClassMember 
ARCDoc.PKDocAttribute.IsDefaultARCDocClassMemberDoes 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.UtilDocARCDocClassUtility methods for -ARCDoc-.
ARCDoc.UtilDoc.GetCurrentLevelInHierarchyAsHTMLARCDocClassMemberReturns an HTML presentation of the given link context, with links pointing backwards to each level in the hierarchy.
ARCDoc.UtilDoc.GenerateHTMLPageARCDocClassMemberWraps the parameter inside a <html><head></head><body>...</body></html> enclosure with some rudimentare CSS.
ARCDoc.HTOC+ParentChainARCDocClassUsed by -FilterNode- in order to keep track of node's parents.
ARCDoc.ApplePARCDocEnumDescribes class -Apple-.
ARCDoc.AppleP.NameARCDocEnumMemberThe name of the apple
ARCDoc.AppleP.ColourARCDocEnumMember 
ARCDoc.BananaPARCDocEnumDescribes class -Banana-.
ARCDoc.BananaP.NameARCDocEnumMemberThe name of the banana
ARCDoc.BananaP.ColourARCDocEnumMember 
ARCDoc.OrangePARCDocEnumDescribes class -Orange-.
ARCDoc.OrangeP.NameARCDocEnumMemberThe name of the orange
ARCDoc.OrangeP.ColourARCDocEnumMember 
ARCDoc.SomeAppComponentPARCDocEnumDescribes class -SomeAppComponent-.
ARCDoc.SomeAppComponentP.SomeCountValueARCDocEnumMember 
ARCDoc.SomeAppComponentP.SomeCountValueNotToBeLoggedARCDocEnumMember 
ARCDoc.DocFragPARCDocEnumDescribes class -DocFrag-.
ARCDoc.DocFragP.DocFragTypeARCDocEnumMember 
ARCDoc.DocFragP.AssemblyARCDocEnumMemberName of the assembly in which this fragment resides.
ARCDoc.DocFragP.NamespaceARCDocEnumMemberNamespace in which this fragment resides.
ARCDoc.DocFragP.ParentNamespaceARCDocEnumMemberParent namespace of namespace in which this fragment resides.
ARCDoc.DocFragP.TypeARCDocEnumMemberType of class or enum which this fragment describes (also relevant for class or enum member).
ARCDoc.DocFragP.NameARCDocEnumMemberAs simple a name as practical usable. Often not unique within a greater context.
ARCDoc.DocFragP.IsInheritedARCDocEnumMemberRelevant for class members. TRUE if method is inherited from a base type.
ARCDoc.DocFragP.IsInheritedDocARCDocEnumMemberRelevant for class members (methods).
ARCDoc.DocFragP.LinesARCDocEnumMemberNumber of lines of text in -Description- and -LongDescription- for this fragment.
ARCDoc.DocFragP.AttributeARCDocEnumMemberThe -BaseAttribute- or -PK- from which this -DocFrag- originates.
ARCDoc.DocFragTypeARCDocEnumType of documentation fragment, like -Assembly-, -Class- or -ClassMember-.
ARCDoc.DocFragType.AssemblyARCDocEnumMember 
ARCDoc.DocFragType.NamespaceARCDocEnumMember 
ARCDoc.DocFragType.ClassARCDocEnumMemberDoes also include interfaces.
ARCDoc.DocFragType.ClassMemberARCDocEnumMember 
ARCDoc.DocFragType.EnumARCDocEnumMember 
ARCDoc.DocFragType.EnumMemberARCDocEnumMember 
ARCDoc.DocLinkPARCDocEnumDescribes class -DocLink-.
ARCDoc.DocLinkP.LocationARCDocEnumMemberThe location that this link points to.
ARCDoc.DocLinkP.FilenameARCDocEnumMember 
ARCDoc.DocLinkP.LinkWordHTMLARCDocEnumMemberActual link as it is expected to occur in text, like '-MyCustomerClass&lt;T&gt;-'.
ARCDoc.DocLinkResolutionPARCDocEnumDescribes class -DocLinkResolution-
ARCDoc.DocLinkResolutionP.LinkWordARCDocEnumMember 
ARCDoc.DocLinkResolutionP.DocLinksARCDocEnumMemberThe possible links for -LinkWord-
ARCDoc.DocumentatorPARCDocEnumDescribes class -Documentator-.
ARCDoc.DummyEnumPARCDocEnumTODO: Document better what this is for (and change name)
ARCDoc.DummyEnumP._MemberInheritedARCDocEnumMemberContains not only members which are inherited in the object-oriented sense, but also overrides for which the only documentation was found in base class
ARCDoc.HLocationPARCDocEnumDescribes class -HLocation-.
ARCDoc.HLocationP.LocationARCDocEnumMemberFolder names / hierarchical levels.
ARCDoc.HLocationP.FilenameARCDocEnumMemberEither the last hierarhical key for the content's location, or Index.html if no location.
ARCDoc.HLocationP.ContentTypeARCDocEnumMemberThe type of the content object. The actual content object is stored as -Content-.
ARCDoc.PKDocAttributePARCDocEnumDescribes class -PKDocAttribute-.
ARCDoc.PKDocAttributeP.PriorityOrderARCDocEnumMemberUsed by -DescribeValue-.
ARCDoc.PriorityOrderARCDocEnumUsed for general sorting / prioritizing when showing properties for an entity.
ARCDoc.PriorityOrder.NotImportantARCDocEnumMember 
ARCDoc.PriorityOrder.ImportantARCDocEnumMember 
Assembly ARCQuery AssemblyARCQuery provides a query language that mimicks SQL but is usable through HTTP as GET URLs.
ARCQuery.BinaryOperatorKeyARCQueryClassOffers expressions with operators like +, -, * and /.
ARCQuery.BinaryOperatorKey.TryGetPInternalARCQueryClassMemberThe internal executor, containing the specific functionality for how to evaluate the key.
ARCQuery.BinaryOperatorKey.ToStringARCQueryClassMemberThe ToString representation is the one relevant when used as key, like in -IK- or when selecting like 'SELECT {fieldName}'.
ARCQuery.BinaryOperatorKey.TryGetPARCQueryClassMemberThe outwards facing executor, understanding use of -FunctionKeys-.
ARCQuery.BinaryOperatorKey.FunctionKeysARCQueryClassMemberAll -FunctionKey-s chained at end of compound key (but before an eventual -QuantileKey-).
ARCQuery.BinaryOperatorKey.QuantileKeyARCQueryClassMemberEventual final -QuantileKey- at end of compound key.
ARCQuery.CompoundInvalidKeyARCQueryClassUsed as a practical solution in order to know that a given key has been attemped parsed, but was not valid.
ARCQuery.CompoundInvalidKey.TryGetPInternalARCQueryClassMemberThe internal executor, containing the specific functionality for how to evaluate the key.
ARCQuery.CompoundInvalidKey.ToStringARCQueryClassMemberThe ToString representation is the one relevant when used as key, like in -IK- or when selecting like 'SELECT {fieldName}'.
ARCQuery.CompoundInvalidKey.TryGetPARCQueryClassMemberThe outwards facing executor, understanding use of -FunctionKeys-.

Generated 2026-11-04 06:47:19.045 UTC