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

448 items

DocFragIdAssemblyDocFragTypeDescription.FirstLine()
ARCCore.ARComponents.ARCAPIARCCoreEnumMemberA library providing an API on top of the -PropertyStream-.
ARCCore.StreamProcessorP.TimestampARCCoreEnumMemberThe timestamp inserted at regular intervals in the -PropertyStream- according to -TimestampResolution-.
ARCCore.EnumAttribute.TryGetAsTypeScriptARCCoreClassMemberGenerates typescript code corresponding to the enum which this instance describes.
ARCCore.IPIIARCCoreClassFuture expansion, using different classes for storing, not only -PII-.
ARCCore.ARComponents.ARAAPIARCCoreEnumMemberThe corresponding template application for -ARCAPI- demonstrating its usage, providing an HTTP / HTTPS interface with the help of Microsoft.AspNetCore.Mvc.
ARCCore.StreamProcessorP.TimestampIsOldARCCoreEnumMemberA warning sent by -StreamProcessor- to -OutsideLocalReceiver- when it knows that data as served is out of date.
ARCCore.EnumAttribute.TryRemovePARCCoreClassMemberShould probably never be used.
ARCCore.IIKIIARCCoreClassRelated to -PII-, property for storing individual items
ARCCore.ARConceptsARCCoreEnumThe overarching concepts upon which AgoRapide is built.
ARCCore.StreamProcessorP.TimestampResolutionARCCoreEnumMemberThe time interval between each timestamp update in the -PropertyStream-.
ARCCore.EnumAttribute.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.IIKII.PackParseResultForStorageInIKIIARCCoreClassMemberThis method corresponds to -PackParseResultForStorageInEntityObject-.
ARCCore.ARConcepts.GettingStartedARCCoreEnumMemberAgoRapide 2020 is an open source library for building data-oriented backend applications using .NET.
ARCCore.StreamProcessorP.DoNotStoreLocallyARCCoreEnumMemberFor -Client-, incoming data (as received from a -Outgoing-) is possible to store BOTH to disk, AND to (normally) a -PRich-.
ARCCore.EnumMemberAttributeARCCoreClassDescribes an enum's value.
ARCCore.IIKII.PackObjectForStorageInIKIIARCCoreClassMemberThis method corresponds to -PackObjectForStorageInEntityObject-.
ARCCore.ARConcepts.PropertyStreamARCCoreEnumMemberAgoRapide, the 'streams-of-water' database".
ARCCore.StreamProcessorP.DoNotStoreLocalOriginLocallyARCCoreEnumMemberMeans 'do not store local origin locally but wait until it gets confirmed by core storage'.
ARCCore.EnumMemberAttribute.GetAttributeARCCoreClassMemberNote that illegal to call for -PropertyKeyEnum-.
ARCCore.PReadOnlyARCCoreClassExperimental (from Feb 2022) class suitable for classes that do not need to be deserialized, or to accept write requests through -PropertyAccess-.
ARCCore.ARConcepts.PropertyStream2DARCCoreEnumMemberPropertyStream2D is an expansion of the -PropertyStream- concept supported by the library -ARCEvent-.
ARCCore.StreamProcessorP.CacheDiskWritesARCCoreEnumMemberIf TRUE then will write the -PropertyStream- to disk in bigger chunks, thereby increasing performance.
ARCCore.EnumMemberAttribute.InitializeARCCoreClassMemberTo be overridden in sub-classes, but do note that sub-classes are supposed to call base.Initialize() at end of their own initialization.
ARCCore.PRichARCCoreClassFully flexible storage. Can store anything. Typical inherited for entity representations like 'Customer' or 'Order'.
ARCCore.ARConcepts.EventSourcingARCCoreEnumMember(related to -ARCEvent-).
ARCCore.StreamProcessorP.CopyFileStructureFromCoreARCCoreEnumMemberIf TRUE, will copy the exact file structure (through information given in -ClientUpdatePosition-).
ARCCore.EnumMemberAttribute.TryRemovePARCCoreClassMemberShould probably never be used.
ARCCore.PRich.TryGetPARCCoreClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCCore.ARConcepts.RegStreamARCCoreEnumMemberThe concept in -ARCEvent- of an "axis" (usefully referred to as the vertical axis) within the concept of -PropertyStream2D-.
ARCCore.StreamProcessorP.CountIncomingConnectionsARCCoreEnumMember 
ARCCore.EnumMemberAttribute.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.PRich.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.ARConcepts.EventStreamARCCoreEnumMemberThe concept in -ARCEvent- of an "axis" (usefully referred to as the horizontal axis) within the concept of -PropertyStream2D-.
ARCCore.StreamProcessorP.CountOutgoingConnectionsARCCoreEnumMember 
ARCCore.IPAttributeARCCoreClassDescribes -IP- classes (describes at class-level)
ARCCore.PRich.ToStringARCCoreClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.ARConcepts.TransientEventTreeARCCoreEnumMemberThe concept in -ARCEvent- of how an -Event- in the -EventStream- generates transient events which in turn may generate
ARCCore.StreamProcessorP.CountOutsideLocalReceiverARCCoreEnumMemberCount of calls to -OutsideLocalReceiver-.
ARCCore.CardinalityExtensionsARCCoreClass 
ARCCore.PValue<T>ARCCoreClassSingle value storage.
ARCCore.ARConcepts.TaggingOfPropertyKeysARCCoreEnumMemberThe concept of specifying in a single place all relevant information about a given property (data field).
ARCCore.StreamProcessorP.CountReceiveLocalOriginARCCoreEnumMemberCount of -PropertyStreamLine- with -HasLocalOrigin-.
ARCCore.CardinalityExtensions.IsMultipleARCCoreClassMemberReturns TRUE if given cardinality implies that multiple items are stored simultaneously in a typical in-memory data storage.
ARCCore.PValue<T>.TrySetPARCCoreClassMemberNOTE: -TryStore- is explicit aware that -PValue- and -PValueEmpty-
ARCCore.ARConcepts.PropertyAccessARCCoreEnumMemberThe general mechanism for accessing properties of objects in AgoRapide.
ARCCore.StreamProcessorP.CountReceiveNonLocalOriginARCCoreEnumMemberCount of -PropertyStreamLine- not with -HasLocalOrigin-.
ARCCore.ExtensionsARCCoreClassContains a few general nice to have extensions methods.
ARCCore.PValue<T>.TryGetVARCCoreClassMemberSupports duck typing.
ARCCore.ARConcepts.AvoidingRepetitionARCCoreEnumMemberAvoiding repetition, the overarching philosophy that inspired the rest of AgoRapide.
ARCCore.StorageFilePARCCoreEnumDescribes class -StorageFile-.
ARCCore.Extensions.ToStringShortARCCoreClassMemberReturns a shorter representation than -ToStringDB-.
ARCCore.PValue<T>.ConvertObjectToStringARCCoreClassMemberConverts object to string.
ARCCore.ARConcepts.AgoRapideHistoryARCCoreEnumMemberAgoRapide has roots back to 2011 when Bjørn Erling Fløtten invented panSL (SL = Schema language).
ARCCore.StorageFileP.FilenameARCCoreEnumMember 
ARCCore.Extensions.ToStringVeryShortARCCoreClassMemberReturns same as -ToStringShort- but without any generics information at all.
ARCCore.PValue<T>.ToStringARCCoreClassMemberDo no cache this value, because memory consumption would then increase significantly in your applicationj
ARCCore.ARConcepts.AdHocQueryARCCoreEnumMemberThe concept of a -Client- doing an ad-hoc query against (normally) a -ArmDB-.
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
ARCCore.Extensions.ToStringDBARCCoreClassMemberGives the minimum representation of type as string suitable for later reconstruction by -GetType-.
ARCCore.PValue<T>.DeepCopyARCCoreClassMemberNote that if the generic type (T) is not immutable, then what we return will not be a truly deep copy.
ARCCore.ARConcepts.StandardAgoRapideCodeARCCoreEnumMemberCode originating from the main official AgoRapide distribution (which therefore does not include any end-application specific code)
ARCCore.ConnectionDirectionARCCoreEnumThe concept of who took the initiative for the connections (who asked to open the TCP/IP session).
ARCCore.Extensions.ForEachARCCoreClassMemberUseful when we want to write collection.ForEach( ... ) instead of
ARCCore.PValue<T>..ctorARCCoreClassMemberNote how this class does not have a parameter-less constructor (unlike all other -IP--derived classes in AgoRapide)
ARCCore.ARConcepts.ApplicationSpecificCodeARCCoreEnumMemberCode specific for an end-application.
ARCCore.ConnectionDirection.IncomingARCCoreEnumMemberConnectionInstruction will not be set for these.
ARCCore.Extensions.UseARCCoreClassMemberConvenience method that shortens down code in cases where an instance of an object must be created first in order to use that same variable multiple times
ARCCore.PValueEmptyARCCoreClassRepresents the 'no value'.
ARCCore.ARConcepts.MemoryConsumptionARCCoreEnumMemberA naïve implementation of key-value storages like AgoRapide may lead to excessive memory (RAM) consumption.
ARCCore.ConnectionDirection.OutgoingARCCoreEnumMemberThere would normally exist two live outgoing connection at a given point in time for -Client- / -ArmDB-:
ARCCore.Extensions.AddValueARCCoreClassMemberGives better error messages compared to 'original' Add when adding a value to a directory if key already exists
ARCCore.PValueEmpty.TrySetPARCCoreClassMemberNOTE: -TryStore- is explicit aware that -PValue- and -PValueEmpty-
ARCCore.ARConcepts.IndexingARCCoreEnumMemberIn-memory indexing of data is done 'behind-the-scenes' by some classes implementing -IP-.
ARCCore.DataTransferDirectionARCCoreEnumDirection for transfer of data.
ARCCore.Extensions.KeysAsStringARCCoreClassMemberGives a compressed overview of keys in a dictionary. Helpful for building exception messages.
ARCCore.PValueEmpty.ToPropertyStreamARCCoreClassMemberTypicall return value could be something like
ARCCore.ARConcepts.CoreDBSynchronizationARCCoreEnumMemberThe concept of how multiple -CoreDB- instances synchronizes their data.
ARCCore.DataTransferDirection.SendARCCoreEnumMemberLike -Client- sending in-application generated properties to -ArmDB- / -CoreDB- or -ArmDB- sending data received over an incoming connection to -CoreDB-.
ARCCore.Extensions.GetValueARCCoreClassMemberGives better error messages when reading value from directory if key does not exist
ARCCore.ActualConnectionARCCoreClassThe actual connection, its internal state, queue for sending and so on.
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.DataTransferDirection.ReceiveARCCoreEnumMemberLike -Client- receiving data from an upstream -ArmDB- / -CoreDB- or -ArmDB- receiving data from an upstream -CoreDB-.
ARCCore.Extensions.SingleARCCoreClassMemberSame as inbuilt LINQ's Single except that gives a more friendly exception message
ARCCore.ActualConnection.SetMyUpdatePositionGeneratorARCCoreClassMemberSet by -StreamProcessor-.
ARCCore.ARConcepts.DataRetentionARCCoreEnumMemberThe concept of when to delete old data (if deemed necessary).
ARCCore.TPropertyKeyEnumARCCoreEnumPlaceholder for any enum type suitable as generic type parameter for -PExact-.
ARCCore.Extensions.SingleOrDefaultARCCoreClassMemberSame as inbuilt LINQ's SingleOrDefault except that gives a more friendly exception message
ARCCore.ActualConnection.SetSinglePropertyStreamReceiverARCCoreClassMemberSet by -StreamProcessor-.
ARCCore.ARConcepts.NoRealDeletionARCCoreEnumMemberAgoRapide has no real concept for deletion of data (apart from -DataRetention-, which is mostly relevant for 'old' data).
Assembly ARCDoc AssemblyA library supporting documentation and demonstrating usage of AgoRapide.
ARCCore.Extensions.ResultARCCoreClassMemberReturns heading plus return-value of function (calls function). If function == null then empty string is returned
ARCCore.ActualConnection.SetUpToDatePositionGeneratorARCCoreClassMemberSet by -StreamProcessor-. Not used by -Client-.
ARCCore.ARConcepts.ManyToManyRelationsARCCoreEnumMember-ARCQuery- supports many-to-many relations in a simple manner without introducing a third entity type (a third table).
ARCDoc.AppleARCDocClassThe most 'standard' way of implementing an entity-class in AgoRapide, by just inheriting -PRich-.
ARCCore.Extensions.ToStringDateAndTimeARCCoreClassMemberUses format 'yyyy-MM-dd HH:mm:ss.fff'.
ARCCore.ActualConnection.InitializeOutgoingConnectionARCCoreClassMemberRelevant for -Outgoing-.
ARCCore.ARConcepts.DocumentationARCCoreEnumMemberThanks to the tagging of enums and classes in AgoRapide (like this description), automatically generation of documentation is possible.
ARCDoc.Apple.AddNameARCDocClassMemberConvenience method, not obligatory.
ARCCore.Extensions.ToStringWithMSARCCoreClassMemberUses either format 'd\.hh\:mm\:ss\.fff' or 'hh\:mm\:ss\.fff' depending on TotalHours >=24 hours or not.
ARCCore.ActualConnection.CommunicateARCCoreClassMemberCommon for both -Incoming- and -Outgoing-.
ARCCore.ARConcepts.AssertionsAndDetailedExceptionMessagesARCCoreEnumMemberThe abstraction level in AgoRapide is very high.
ARCDoc.Apple.GetNameARCDocClassMemberConvenience method, not obligatory.
ARCCore.IKIPARCCoreClassContainer class for key (-IK-), and value (-IP-).
ARCCore.ActualConnection.LogAndSendErrorConditionDataARCCoreClassMemberCalled when a serious error condition has been discovered and connection should be terminated.
ARCCore.ARConcepts.ExposingApplicationStateARCCoreEnumMemberThe traditional debugging process usually entails reading through logs and querying about your application state through a debugging tool.
ARCDoc.Apple.TryGetNameARCDocClassMemberConvenience method, not obligatory.
ARCCore.IKIP.AssertTypeIntegrityARCCoreClassMemberSee -TryAssertTypeIntegrity- for documentation.
ARCCore.ActualConnection.SendARCCoreClassMemberSends all messages in queue.
ARCCore.ARConcepts.LinkInsertionInDocumentationARCCoreEnumMemberDocumentation with links is much easier to read.
ARCDoc.Apple.TryGetPARCDocClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCCore.IKIP.TryAssertTypeIntegrityARCCoreClassMemberAsserts that value is of correct type as specified by the key.
ARCCore.ActualConnection.ToStringARCCoreClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.ARConcepts.TryPatternAndNullARCCoreEnumMemberAgoRapide uses non-nullable reference types as default throughout the system
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).
ARCCore.IKARCCoreClassIK = Interface Key / Index key. Key used to lookup 'inside' an instance of -IP-.
ARCCore.ActualConnection..ctorARCCoreClassMemberNote parameter-less constructor as desired for all classes inheriting -IP-.
ARCCore.AREnumTypeARCCoreEnumCategories different types of enum used in AgoRapide. The most important one is -PropertyKeyEnum-.
ARCDoc.Apple.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.IKCodedARCCoreClassUnderstands coded and unencoded variants of -IK-.
ARCCore.MonkeyWrenchARCCoreClassDescribes level of 'spanner-throwing' this connection shall contibute with
ARCCore.AREnumType.PropertyKeyEnumARCCoreEnumMemberDesignates enums that describe relevant values for an 'entity' object like 'Customer'.
ARCDoc.Apple.NameARCDocClassMemberConvenience method, not obligatory.
ARCCore.IKCoded.EnrichKeyARCCoreClassMember'Implementing' -ITypeDescriber-.
ARCCore.ClientUpdatePositionARCCoreClassDescribes from WHERE (from WHEN) in the historic -PropertyStream- new data is to be returned.
ARCCore.AREnumType.OrdinaryEnumARCCoreEnumMemberDesignates "Ordinary" enums used for indicating range of valid values for a given key
ARCDoc.BananaARCDocClassImplements -IP- directly and uses traditional property storage for optimum -MemoryConsumption- efficiency.
ARCCore.IKCoded.TryCheckValidEncodedValueARCCoreClassMemberChecks if encoded value is valid.
ARCCore.ClientUpdatePosition.FilenameARCCoreClassMemberFilename like '2020-04-03 08:42:22_R001'
ARCCore.AREnumType.DocumentationOnlyEnumARCCoreEnumMemberDesignates enums that provide a central repository of explanation of terms that are not present in the C# code.
ARCDoc.Banana.NameARCDocClassMemberAnnotated as nullable in order to keep flexibility of -PropertyAccess-, including what happens if values are not set (TryGetP etc)
ARCCore.IKCoded.FromCacheEncodedARCCoreClassMemberReduces number of objects generated by caching those known to be within a limited range
ARCCore.ClientUpdatePosition.IndexARCCoreClassMemberIndex (zero-based) into file. Value of -1 means blank update status / no data received at all (or no data received for this specific filename)
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.Banana.ColourARCDocClassMemberAnnotated as nullable in order to keep flexibility of -PropertyAccess-, including what happens if values are not set (TryGetP etc)
ARCCore.IKCoded.FromCacheUnencodedARCCoreClassMemberReduces number of objects generated by caching those known to be within a limited range
ARCCore.ClientUpdatePosition.ClientDatastoreIsEmptyARCCoreClassMemberUsed by the subscribing client to signify that it has no data stored locally, and it therefore needs an update from the beginning of the -PropertyStream-, that is, 'from the beginning of time'.
ARCCore.ARNodeType.CoreDBARCCoreEnumMemberA node containing the core or central database.
ARCDoc.DemonstratorARCDocClassDemonstrates various concepts from -ARCCore-, especially -PropertyAccess-.
ARCCore.IKCoded.FromEncodedARCCoreClassMemberNote how uses instance cache if already exists there.
ARCCore.ClientUpdatePosition.OnlyNewDataIsRequestedARCCoreClassMemberUsed by the subscribing client to signify that it does not care about historical data, the server may start with sending only new data.
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)
ARCDoc.Demonstrator.DemonstratePropertyAccessAppleARCDocClassMemberDemonstrates use of -PropertyAccess- through the -Apple- class.
ARCCore.IKCoded.TryEncodeARCCoreClassMemberReturns a string containing only characters in -AllowedEncodedCharacters-.
ARCCore.ClientUpdatePosition.IsGoBackARCCoreClassMemberHas to be translated by -StreamProcessor- into a concrete filename / index.
ARCCore.ARNodeType.ClientARCCoreEnumMemberAn outer node / 'end' node with (usually) -ApplicationSpecificCode- but based on -ARADB-.
ARCDoc.Demonstrator.DemonstratePropertyAccessOrangeARCDocClassMemberDemonstrates use of -PropertyAccess- through the -Orange- class.
ARCCore.IKCoded.ToStringARCCoreClassMemberReturns -Encoded-'s string representation.
ARCCore.ClientUpdatePosition.IsAtEndOfStreamARCCoreClassMemberNecessary in order to implement -AdHocQuery-.
ARCCore.CardinalityARCCoreEnumDescribes how multiple instances of a property is supposed to be handled.
ARCDoc.Demonstrator.DemonstratePropertyAccessBananaARCDocClassMemberDemonstrates use of -PropertyAccess- through the -Banana- class.
ARCCore.IKCoded.EncodedARCCoreClassMemberThis string value can be used directly in folder names, file names and HTTP URL's without any further encoding being necessary.
ARCCore.ClientUpdatePosition.ClientDatastoreIsEmptyInstanceARCCoreClassMemberSee also -ClientDatastoreIsEmpty.
ARCCore.Cardinality.HistoryOnlyARCCoreEnumMemberThe default value.
ARCDoc.Demonstrator.DemonstrateITypeDescriberARCDocClassMemberDemonstrates use of -ITypeDescriber- for describing single-property values.
ARCCore.IKCoded.AllowedEncodedCharactersARCCoreClassMemberThe character set 'A...Za...z0...9-_().,='.
ARCCore.ClientUpdatePosition.OnlyNewDataIsRequestedInstanceARCCoreClassMemberSee also -OnlyNewDataIsRequested.
ARCCore.Cardinality.WholeCollectionARCCoreEnumMemberValues are always set as a whole (there is no need or no meaning in setting or deleting individual items)
ARCDoc.Demonstrator.DemonstratePRichHierarchicalStorageARCDocClassMemberDemonstrates use of -PRich-, how it receives -PropertyStream--lines and builds up a strongly typed hierarchical object storage.
ARCCore.IKDateARCCoreClassA more memory efficient alternative to -IKString- (together with -IKLong-).
ARCCore.ConnectionInstructionARCCoreClassThe instruction about what connections to make (host, portnr, data transfer direction and so on).
ARCCore.Cardinality.IndividualItemsARCCoreEnumMemberValues are supposed to be set and 'deleted' individually.
ARCDoc.Demonstrator.DemonstratePropertyStreamARCDocClassMemberDemonstrates use of -PropertyStream- by generating local data (documentation data) and writing locally to console.
ARCCore.IKDate.op_EqualityARCCoreClassMemberIt is quite natural in the code to write code like "if (a.CustomerId == b.CustomerId)", therefore the need to implement == and != operators here.
ARCCore.ConnectionInstruction.InitializeARCCoreClassMemberInitializes to sane values.
ARCCore.PSPrefixARCCoreEnumDescribes some recommended prefixes to use in a -PropertyStreamLine-.
ARCDoc.Demonstrator.DemonstrateBareBonesClientARCDocClassMemberDemonstrates adding -PropertyStream--lines to -CoreDB- without using ANY AgoRapide component, only standard TCP/IP functionality in .NET.
ARCCore.IKDate.EnrichKeyARCCoreClassMember'Implementing' -ITypeDescriber-.
ARCCore.ConnectionInstruction.TryGetPARCCoreClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCCore.PSPrefix.dtARCCoreEnumMemberData, single key + value.
ARCDoc.Demonstrator.DemonstrateLogConsoleARCDocClassMemberDemonstrates a quite simple log console.
ARCCore.IKDate.ValidDateTimeFormatsARCCoreClassMemberNote: Be very careful about expanding this array. ToString must be considered, and also how Equals should work with other sub classes of IK.
ARCCore.ConnectionInstruction.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).
ARCDoc.Demonstrator.DemonstrateStreamProcessorAsClientARCDocClassMemberDemonstrates use of -StreamProcessor- as a general client.
ARCCore.IKLongARCCoreClassA more memory efficient alternative to -IKString-.
ARCCore.ConnectionInstruction.ToStringARCCoreClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCDoc.OrangeARCDocClassInherits -PExact- for probably the best compromise between memory consumption and easy of development.
ARCCore.IKLong.op_EqualityARCCoreClassMemberIt is quite natural in the code to write code like "if (a.CustomerId == b.CustomerId)", therefore the need to implement == and != operators here.
ARCCore.ShardingARCCoreClassEnables load-balancing by describing what data should be sent over a given connection.
ARCDoc.Orange.SetPVDirectARCDocClassMemberHigh performance alternative to -TrySetP-, accessing -Storage- more direct.
ARCCore.IKLong.EnrichKeyARCCoreClassMember'Implementing' -ITypeDescriber-.
ARCCore.PropertyStreamLineARCCoreClassHas two main functions:
ARCDoc.Orange.GetPVDirectARCDocClassMemberHigh performance alternative to -TryGetP-, accessing -Storage- more direct.
ARCCore.IKStringARCCoreClassIndex key for any general id, like primary-key or sequence-number or similar.
ARCCore.PropertyStreamLine.EncodeKeysARCCoreClassMemberEncodes the key part of a -PropertyStreamLine-.
ARCDoc.Orange.TryGetPVDirectARCDocClassMemberHigh performance alternative to -TryGetP-, accessing -Storage- more direct.
ARCCore.IKString.FromCacheARCCoreClassMemberReduces number of objects generated by caching those known to be within a limited range
ARCCore.PropertyStreamLine.EncodeValuesARCCoreClassMemberTypically used when turning -WholeCollection- into a value part of a -PropertyStreamLine-.
ARCDoc.Orange.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.IKString.FromStringARCCoreClassMemberNote how uses instance cache if already exists there
ARCCore.PropertyStreamLine.EncodeKeyPartARCCoreClassMemberConverts a single key part of a -PropertyStreamLine- to a format suitable for sending over a -PropertyStream-.
ARCDoc.Orange.NameARCDocClassMemberSee -Name- for more information.
ARCCore.IKString.op_EqualityARCCoreClassMemberIt is quite natural in the code to write code like "if (a.CustomerId == b.CustomerId)", therefore the need to implement == and != operators here.
ARCCore.PropertyStreamLine.EncodeValuePartARCCoreClassMemberConverts a single value part of a -PropertyStreamLine- to a format suitable for sending over a -PropertyStream-.
ARCDoc.Orange.StorageARCDocClassMemberUses int-value of -__enum- minus 1 as index.
ARCCore.IKString.EnrichKeyARCCoreClassMember'Implementing' -ITypeDescriber-.
ARCCore.PropertyStreamLine.DecodeARCCoreClassMemberDecodes string as encoded by -EncodeKeyPart- or -EncodeValuePart-.
ARCDoc.SomeAppComponentARCDocClassDemonstrates how also your actual application classes, not only your data classes, should implement -IP-.
ARCCore.IKTypeARCCoreClassIndex key used when storing a collection of a given type, like 'Customer'.
ARCCore.PropertyStreamLine.TryParseDirectToIPARCCoreClassMemberParses a series of -PropertyStreamLine- directly to the given type of -IP-.
ARCDoc.SomeAppComponent.MethodCARCDocClassMemberNote structured format in logging.
ARCCore.IKType.ToStringARCCoreClassMemberCaching is supposed to be useful because may be called quite often.
ARCCore.PropertyStreamLine.TryParseDirectToPropertyARCCoreClassMemberParses direct to a given property value.
ARCDoc.SomeAppComponent.MethodDARCDocClassMemberSame as MethodC- but returns data ('Func<string>()' instead of 'Action()')
ARCCore.ITypeDescriberARCCoreClassProvides a standardized mechanism for describing single-property values (like 'PhoneNumber' of 'Customer' for instance).
ARCCore.PropertyStreamLine.ParseAndStoreARCCoreClassMemberNote that throws exception if -TryParseAndStore- fails.
ARCDoc.SomeAppComponent.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.ITypeDescriber.GetSyntaxHelpARCCoreClassMemberEnables explanation of syntax in different contexts from one source:
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.
ARCDoc.DocFragARCDocClassDocFrag = Document fragment.
ARCCore.ParseResultARCCoreClassNOTE: Concept is very old, from the dark ages of AgoRapide's very first inception. There might be room for improvement.
ARCCore.PropertyStreamLine.StoreFailSafeARCCoreClassMemberStores if possible and fails silently.
ARCDoc.DocFrag.Create Overload1ARCDocClassMemberCreates a -DocFrag- object representing an assembly or a namespace.
ARCCore.ParseResult.ResultARCCoreClassMemberWill be null if ErrorResponse is set.
ARCCore.PropertyStreamLine.StoreFailureARCCoreClassMemberStores a 'ParseOrStoreFailure'-object.
ARCDoc.DocFrag.Create Overload2ARCDocClassMemberCreates a -DocFrag- object representing a class, class member, enum or enum member.
ARCCore.ParseResult.ErrorResponseARCCoreClassMemberWill be null if Result is set
ARCCore.PropertyStreamLine.TryStoreARCCoreClassMemberStores the given -PropertyStreamLineParsed- in the given storage object.
ARCDoc.DocFrag.ToHTMLSimpleSingleARCDocClassMemberAlternative ('override') to -ToHTMLSimpleSingle-.
ARCCore.PKARCCoreClassPK = AgoRapide PropertyKey.
ARCCore.PropertyStreamLine.AllowedKeyCharsARCCoreClassMemberAllowed characters in the Key-part of a -PropertyStreamLine-.
ARCDoc.DocFrag.TryGetPARCDocClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCCore.PK.TryGetEnumARCCoreClassMemberNote that usually you will not have to ask for this value, usually in AgoRapide it goes the other way around, you have the enum member / enum value and want the corresponding property key.
ARCCore.PropertyStreamLine.AllowedValueCharsARCCoreClassMemberAllowed characters in the Value-part of a -PropertyStreamLine-.
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.PK.TryGetVARCCoreClassMemberOnly type of PK, string or type of __enum is allowed to ask for (as TRequest generic type parameter).
ARCCore.PropertyStreamLineParsedARCCoreClassParses the keys part of a line from -PropertyStream-, like 'Customer/42/FirstName = John.
ARCDoc.DocFrag.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.PK.GetAARCCoreClassMemberConvenience method for easy access to -BasePKAttribute- with corresponding explaining exception if fails
ARCCore.PropertyStreamLineParsed.ToStringARCCoreClassMemberNote relatively complex operation of 'restoring' original property stream line.
ARCDoc.DocFragCollectionARCDocClassContains a collection of -DocFrag- objects.
ARCCore.PK.TryGetAARCCoreClassMemberConvenience method for easy access to -BasePKAttribute-.
ARCCore.PropertyStreamLineParsed.TryParseARCCoreClassMemberGenerate list of <(IK key, Type valueType)> together with value from value part.
ARCDoc.DocFragCollection.CreateARCDocClassMemberCreates documentation fragments (-DocFrag-) for all possible -BaseAttribute- elements found in the given assemblies.
ARCCore.PK.ModifyCleanerAndValidatorAndParserForCardinalityARCCoreClassMemberCalled from -Initialize- after _cleaner and _validatorAndParser have been set.
ARCCore.PropertyStreamLineParsed.IsCommentARCCoreClassMemberSignifies that property stream line given for parsing started with '//' (two forward slashes).
ARCDoc.DocFragCollection.TryGetPARCDocClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCCore.PK.ToStringARCCoreClassMemberCaching is supposed to be useful because may be called quite often.
ARCCore.PropertyStreamLineParsed.KeysARCCoreClassMemberThe keys part of the -PropertyStreamLine-, that is, everything before ' = '.
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.PK.TryValidateAndParseARCCoreClassMemberParses the value according to specifications for this property key.
ARCCore.PropertyStreamLineParsed.ValueARCCoreClassMemberThe original (non-parsed, non-validated)) value part of the -PropertyStreamLine-, that is, everything after ' = '.
ARCDoc.DocFragCollection.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.PK.TryCleanValidateAndParseARCCoreClassMemberCleans and parses the value according to specifications for this property key.
ARCCore.StreamProcessorARCCoreClassImplements the storage mechanism for AgoRapide.
ARCDoc.DocLinkARCDocClassDescribes to where a single HTML link points.
ARCCore.PK.PackParseResultForStorageInEntityObjectARCCoreClassMemberPacks result of parsing into a -IP--derived class, suitable for sending to -AddOrUpdateP-.
ARCCore.StreamProcessor.CreateBareBonesInstanceARCCoreClassMemberCreates a bare-bones -StreamProcessor- instance.
ARCDoc.DocLink.TryGetPARCDocClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCCore.PK.PackObjectForStorageInEntityObjectARCCoreClassMemberSee -PackParseResultForStorageInEntityObject- for documentation.
ARCCore.StreamProcessor.InitializeARCCoreClassMemberInitializes this instance of -StreamProcessor-
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.PK.FromEnumARCCoreClassMemberReturns the corresponding -PK- instance from the given -PropertyKeyEnum-.
ARCCore.StreamProcessor.AddOrRemoveOutgoingConnectionsARCCoreClassMemberNot relevant for -CoreDB-.
ARCDoc.DocLink.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.PK.TryGetFromTypeAndFieldName Overload3ARCCoreClassMemberReturns property key based on type and field name.
ARCCore.StreamProcessor.StartTCPIPCommunicationARCCoreClassMemberStarts communicating over TCP/IP.
ARCDoc.DocLink.LocationARCDocClassMemberCopy of -Location-.
ARCCore.PK.TryGetFromTypeAndFieldName Overload2ARCCoreClassMemberReturns property key based on type and field name.
ARCCore.StreamProcessor.ReceiveAndDistributeARCCoreClassMemberProcess all messages in receive queue.
ARCDoc.DocLink.FilenameARCDocClassMemberCopy of -LinkWordHTML-.
ARCCore.PK.TryGetFromTypeAndFieldName Overload1ARCCoreClassMemberReturns property key based on type and field name.
ARCCore.StreamProcessor.AddTimestampAsRequiredARCCoreClassMemberAdds -Timestamp- to the property stream (to -_queueReceive-) as specified by -TimestampResolution-.
ARCDoc.DocLink.LinkWordHTMLARCDocClassMemberCopy of -LinkWordHTML-.
ARCCore.PK.GetAllPKForEntityTypeARCCoreClassMemberReturns all property keys relevant for the given entity type,
ARCCore.StreamProcessor.ReadStorageFileARCCoreClassMemberReads one storage file from disk
ARCDoc.DocLink.LinkWordHTMLWithHyphensARCDocClassMember-LinkWordHTML- with '-' (minus sign / hyphen) prepended and appended.
ARCCore.PK.GetAllPKForEntityTypeStringARCCoreClassMemberReturns all property keys relevant for the given entity type,
ARCCore.StreamProcessor.ToStringARCCoreClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCDoc.DocLink.LinkWordHTMLBeforeLtARCDocClassMemberIf -LinkWordHTML contains '<' (really '&lt;') (for generic types, like 'PValue<TValue>') then this will contain the part before '<' like 'PValue'.
ARCCore.PK.BuildFromStringCacheARCCoreClassMemberBuilds the content of -_fromStringCache- and also -_allPKForEntityTypeCache-.
ARCCore.StreamProcessor.OutsideLocalReceiverARCCoreClassMemberThe outside (in the sense outside of this class) local mechanism which receives all -PropertyStreamLine- registered by this class.
ARCDoc.DocLink.LinkWordHTMLBeforeLtWithHyphensARCDocClassMember-LinkWordHTMLBeforeLt- with '-' (minus sign / hyphen) prepended and appended.
ARCCore.PK.GetTypeMappingARCCoreClassMemberReturns the relevant property key for a given type entity-type and field-type.
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).
ARCDoc.DocLink.AHrefEndPartARCDocClassMember'Filename.Encoded + "> + LinkWordHTML + </a>'
ARCCore.PK.GetObligatoryValuesForEntityTypeARCCoreClassMemberReturns all obligatory values (based on -IsObligatory-)
ARCCore.PropertyStreamLineWithOrigin.HasLocalOriginARCCoreClassMemberLocally generated data is not to be sent to -OutsideLocalReceiver-). We instead leave it to the 'outside' to decide if
ARCDoc.DocLinkCollectionARCDocClassContains a collection of -DocLink- objects.
ARCCore.PK.EqualsARCCoreClassMemberNote that ToString is only based on __enum, meaning that two enum members / enum values with same name but different type, like CustomerP.Name and OrderP.Name, will be considered equal.
ARCCore.PropertyStreamLineWithOrigin.SendToLocalReceiverARCCoreClassMemberMeans 'send to local receiver regardless of origin'.
ARCDoc.DocLinkCollection.CreateARCDocClassMemberNotes all locations and their positions in the hierarchical directory structure.
ARCCore.PK.TryGetPARCCoreClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCCore.PropertyStreamLineWithOrigin.DoNotAddTimestampARCCoreClassMemberNormally -StreamProcessor- inserts the required -Timestamp-s in the AgoRapide storage.
ARCDoc.DocLinkCollection.InsertLinks Overload1ARCDocClassMemberDoes -LinkInsertionInDocumentation- on the given HTML content.
ARCCore.PK..ctorARCCoreClassMemberConstructor with 'object _enum' is necessary in order for ToString to work.
ARCCore.PropertyStreamLineWithOrigin.ReceivedFromOutgoingARCCoreClassMemberData received from an outgoing connection, that is, data received based on 'this' application's subscription request (as subscribing client).
ARCDoc.DocLinkCollection.InsertLinks Overload2ARCDocClassMemberSee overload with 'contentLocation' as parameter for documentation.
ARCCore.PK.TypeARCCoreClassMemberReturns type from -PKTypeAttribute-'s -Type-.
ARCCore.StorageFileARCCoreClassImplemented only in order to store some ideas about -Hash-.
ARCDoc.DocLinkCollection.TryGetPARCDocClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCCore.PK.CardinalityARCCoreClassMemberReturns cardinality from -PKTypeAttribute-'s -Cardinality-.
ARCCore.StorageFile.TryGetPARCCoreClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
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.PK.CorrespondingClassARCCoreClassMemberReturns -CorrespondingClass- based on -__enum-.
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).
ARCDoc.DocLinkCollection.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.PK.ValidatorAndParserARCCoreClassMemberValidates and parses a value.
ARCCore.StorageFile.ToStringARCCoreClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCDoc.DocLinkResolutionARCDocClassContains a resolution page for a link word which has duplicate 'targets' (pointing to multiple -DocLink- instances).
ARCCore.PK.CleanerARCCoreClassMemberCleanup of values, to be used before value is attempted validated.
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.
ARCDoc.DocLinkResolution.ToHTMLSimpleSingleARCDocClassMemberGives a friendly description about possible targets for LinkWord-.
ARCCore.PK.AllEnumsARCCoreClassMemberAll enums for the whole application.
ARCCore.Subscription.FromTimeARCCoreClassMemberTODO: Implement concept of specifying starting-point in TIME (often for an -AdHocQuery-?).
ARCDoc.DocLinkResolution.TryGetPARCDocClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCCore.PK.AllPKEnumsARCCoreClassMemberAll -PropertyKeyEnum--tagged enums for the whole application.
ARCCore.Subscription.ToTimeARCCoreClassMemberTODO: Implement concept of specifying ending-point in TIME (often for an -AdHocQuery-?).
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.PK.__enumARCCoreClassMemberThis information is also found as EnumMember.
ARCCore.Subscription.IsMatch Overload1ARCCoreClassMemberEvaluates a query consisting of multiple instances of -Subscription- against a single property stream line.
ARCDoc.DocLinkResolution.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.PKHTMLAttributeARCCoreClassContains pointer to HTML encoder for a property.
ARCCore.Subscription.IsMatch Overload2ARCCoreClassMemberEvaluates this instance of -Subscription- against a single property stream line (which has been split up into its constituent elements).
ARCDoc.DocLinkResolutionCollectionARCDocClassContains a collection of -DocLinkResolution- objects.
ARCCore.PKHTMLAttribute.EncodeARCCoreClassMemberEncodes the given string to HTML format through the static method implemented in class -Encoder-.
ARCCore.Subscription.SyntaxHelpARCCoreClassMember'+*' Subscribe to everything in database.
ARCDoc.DocLinkResolutionCollection.TryGetPARCDocClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCCore.PKHTMLAttribute.InitializeARCCoreClassMemberTo be overridden in sub-classes, but do note that sub-classes are supposed to call base.Initialize() at end of their own initialization.
ARCCore.Subscription.IsAddARCCoreClassMemberCorresponds to whether value starts with a plus sign, '+' or not.
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.PKHTMLAttribute.TryRemovePARCCoreClassMemberShould probably never be used.
ARCCore.Subscription.IsRemoveARCCoreClassMemberCorresponds to whether value starts with a minus sign, '+' or not.
ARCDoc.DocLinkResolutionCollection.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.PKHTMLAttribute.EncoderARCCoreClassMemberSee -Encoder-.
ARCCore.UtilCoreARCCoreClassUtility methods for -ARCCore-.
ARCDoc.DocumentatorARCDocClassGeneral class for documenting AgoRapide and also your own -ApplicationSpecificCode-.
ARCCore.PKHTMLAttribute.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.UtilCore.AssertCurrentlyStartingUpARCCoreClassMemberNormally called from non-thread safe methods that should be run single-threaded at application startup only.
ARCDoc.Documentator.CreateAndInsertARCDocClassMemberCreates an instance of -Documentator- with a natural hierarchical representation of documentation attributes found in the given assemblies.
ARCCore.IHTMLEncoderARCCoreClassPseudo-interface signifying that implementing class has a static metod called 'Encode' for encoding a string to HTML.
ARCCore.UtilCore.DoubleTryParseARCCoreClassMemberNote that treats ',' (comma) as decimal point (not as thousands separator).
ARCDoc.Documentator.ToHTMLSimpleSingleARCDocClassMemberAlternative ('override') to -ToHTMLSimpleSingle-.
ARCCore.PKLogAttributeARCCoreClassExplains how logging of changes to a property should be done.
ARCCore.UtilCore.EnumTryParseARCCoreClassMemberSame as the inbuilt .NET method -TryParse- but with some additional checks.
ARCDoc.Documentator.CreateHTOCStandardARCDocClassMemberCreates a 'standard' table of contents, structured by assembly and each assembly divided into 'Class' and 'Enum'.
ARCCore.PKLogAttribute.InitializeARCCoreClassMemberTo be overridden in sub-classes, but do note that sub-classes are supposed to call base.Initialize() at end of their own initialization.
ARCCore.UtilCore.TryGetTypeFromStringNoCacheARCCoreClassMemberSee -TryGetTypeFromStringFromCache- for documentation.
ARCDoc.Documentator.CreateHTOCNamespaceARCDocClassMemberCreates a table of contents structured by namespace
ARCCore.PKLogAttribute.TryRemovePARCCoreClassMemberShould probably never be used.
ARCCore.UtilCore.TryGetTypeFromStringFromCacheARCCoreClassMemberCorresponding method for creating string-representation of type is -ToStringDB-.
ARCDoc.Documentator.CreateHTOCInheritanceARCDocClassMemberCreates a table of contents structured by inheritance (classes and interfaces only, not members).
ARCCore.PKLogAttribute.DoNotLogAtAllARCCoreClassMemberSee -DoNotLogAtAll-.
ARCCore.UtilCore.GetExceptionChainAsStringARCCoreClassMemberFollows the chain of InnerException and returns types as comma-separated string
ARCDoc.Documentator.TryGetPARCDocClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCCore.PKLogAttribute.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.UtilCore.GetExeptionDetailsARCCoreClassMemberGives as much information about exception as possible.
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.PKRelAttributeARCCoreClassDescribes relationships between entities (between tables in RDBMS terms).
ARCCore.UtilCore.DateTimeTryParseARCCoreClassMemberAccepts on of the formats specified in -ValidDateTimeFormats-.
ARCDoc.Documentator.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.PKRelAttribute.InitializeARCCoreClassMemberTo be overridden in sub-classes, but do note that sub-classes are supposed to call base.Initialize() at end of their own initialization.
ARCCore.UtilCore.TimeSpanTryParseARCCoreClassMemberAccepts on of the formats specified in -ValidDateTimeFormats-.
ARCDoc.Documentator.DocLinksARCDocClassMemberSet by -CreateAndInsert-.
ARCCore.PKRelAttribute.TryRemovePARCCoreClassMemberShould probably never be used.
ARCCore.UtilCore.UseLocalTimeInsteadOfUTCARCCoreClassMemberBy default AgoRapide operates only with UTC time.
ARCDoc.Documentator.DocLinkResolutionLocationARCDocClassMemberDefault position within the global storage context of doc link resolution pages.
ARCCore.PKRelAttribute.ForeignEntityARCCoreClassMemberSee -ForeignEntity-.
ARCCore.UtilCore.DateTimeNowARCCoreClassMemberReturns DateTime.UtcNow unless -UseLocalTimeInsteadOfUTC- has been set to TRUE in which case DateTime.Now is returned.
ARCDoc.DummyEnumARCDocClassTODO: Document better what this is for (and change name)
ARCCore.PKRelAttribute.OppositeTermARCCoreClassMemberSee -OppositeTerm-.
ARCCore.UtilCore.CurrentlyStartingUpARCCoreClassMemberCalled once at application startup after all Attribute instances in the C# code has been processed.
ARCDoc.DummyEnum.TryGetPARCDocClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
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.DummyEnum.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCDoc.ExtensionsARCDocClassContains various extension methods for -IP- and -IKIP- related to documentating / reporting / HTML.
ARCDoc.Extensions.ToHTMLSimpleSingleRecursiveARCDocClassMemberCalls -ToHTMLSimpleSingle- recursively.
ARCDoc.Extensions.ToHTMLSimpleSingleARCDocClassMemberCreates a simple HTML representation of the given parameter.
ARCDoc.Extensions.ToHTMLSimpleSingleInternalARCDocClassMemberHack in order to escape check for direct implementation in actual class of -ToHTMLSimpleSingle- in -ToHTMLSimpleSingle-.
ARCDoc.Extensions.ToHTMLSimpleAsTableRowARCDocClassMemberCreates a simple HTML representation of the given parameter as a single two column row (Key, Value) in a table.
ARCDoc.Extensions.DescribeValueARCDocClassMemberDescribes the value contained withing an -IKIP- (-P-).
ARCDoc.Extensions.ValueToHTMLSimpleWithTooltipARCDocClassMemberCreates a simple HTML representation of the Value with description as a 'tooltip'.
ARCDoc.Extensions.KeyToHTMLSimpleWithTooltipARCDocClassMemberCreates a simple HTML representation of the Key with description as a 'tooltip'.
ARCDoc.Extensions.GetHelptextHTMLARCDocClassMemberReturns content of -Description- and -LongDescription-.
ARCDoc.HLocationARCDocClassSimple class describing the location of a single -IP- instance within some hierarhical context.
ARCDoc.HLocation.TryGetPARCDocClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
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).
ARCDoc.HLocation.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCDoc.HLocation.ContentARCDocClassMemberThe Content object is not stored within the standard -IP--mechanism.
ARCDoc.HLocationCollectionARCDocClassContains a collection of -HLocation- objects.
ARCDoc.HLocationCollection.CreateARCDocClassMemberTransforms the parameter (and recursively all contained objects) into a collection of -HLocation- objects.
ARCDoc.HLocationCollection.WriteAllContentHTMLToDiskARCDocClassMemberWrites all -HLocation- results to a hierarhical folder structure as static HTML files with (optionally) -LinkInsertionInDocumentation-.
ARCDoc.HLocationCollection.TryGetPARCDocClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
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).
ARCDoc.HLocationCollection.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCDoc.HTOCARCDocClassHTOC = Hierarchical table of contents.
ARCDoc.HTOC.CreateARCDocClassMemberStructures content hierarchically according to the criteria for each level.
ARCDoc.HTOC.ToHTMLSimpleSingle Overload2ARCDocClassMemberAlternative ('override') to -ToHTMLSimpleSingle-.
ARCDoc.HTOC.ToHTMLSimpleSingle Overload1ARCDocClassMemberUse this method in any class where a table-of-contents type of view is desireable
ARCDoc.HTOC.CreateInitialContentARCDocClassMemberHelper method for creation of a -FilterBranch-.
ARCDoc.HTOC.TryGetPARCDocClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
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).
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.PriorityOrderARCDocClassMemberSee -PriorityOrder-.
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.UtilDoc.GlobalHeaderHTMLARCDocClassMemberGlobal header to be inserted at the top of every HTML page created by -GenerateHTMLPage-.
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-.

Generated 2026-06-28 12:53:03.179 UTC