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

128 items

DocFragId	Assembly	DocFragType	Description.FirstLine()
ARCCore.ARConcepts.SingleThreadedCode	ARCCore	EnumMember	Some practical choices have been made in AgoRapide which requires object access to be done in a single-threaded manner, or within a locking context (using for instance -ReaderWriterLockSlim-).
ARCCore.ARConcepts.DataRetention	ARCCore	EnumMember	The concept of when to delete old data (if deemed necessary).
ARCCore.ARConcepts.NoRealDeletion	ARCCore	EnumMember	AgoRapide has no real concept for deletion of data (apart from -DataRetention-, which is mostly relevant for 'old' data).
ARCCore.ARConcepts.ManyToManyRelations	ARCCore	EnumMember	-ARCQuery- supports many-to-many relations in a simple manner without introducing a third entity type (a third table).
ARCCore.ARConcepts.Documentation	ARCCore	EnumMember	Thanks to the tagging of enums and classes in AgoRapide (like this description), automatically generation of documentation is possible.
ARCCore.ARConcepts.AssertionsAndDetailedExceptionMessages	ARCCore	EnumMember	The abstraction level in AgoRapide is very high.
ARCCore.ARConcepts.ExposingApplicationState	ARCCore	EnumMember	The traditional debugging process usually entails reading through logs and querying about your application state through a debugging tool.
ARCCore.ARConcepts.LinkInsertionInDocumentation	ARCCore	EnumMember	Documentation with links is much easier to read.
ARCCore.ARConcepts.TryPatternAndNull	ARCCore	EnumMember	AgoRapide uses non-nullable reference types as default throughout the system
ARCCore.AREnumType	ARCCore	Enum	Categories different types of enum used in AgoRapide. The most important one is -PropertyKeyEnum-.
ARCCore.AREnumType.PropertyKeyEnum	ARCCore	EnumMember	Designates enums that describe relevant values for an 'entity' object like 'Customer'.
ARCCore.AREnumType.OrdinaryEnum	ARCCore	EnumMember	Designates "Ordinary" enums used for indicating range of valid values for a given key
ARCCore.AREnumType.DocumentationOnlyEnum	ARCCore	EnumMember	Designates enums that provide a central repository of explanation of terms that are not present in the C# code.
ARCCore.ARNodeType	ARCCore	Enum	Describes what function a node in an AgoRapide system serves. A given node may constitute of only -StandardAgoRapideCode- or a combination of -StandardAgoRapideCode- and -ApplicationSpecificCode-.
ARCCore.ARNodeType.CoreDB	ARCCore	EnumMember	A node containing the core or central database.
ARCCore.BaseAttribute	ARCCore	Class	Instances of this class are used as source of documentation and data for the API.
ARCCore.BaseAttribute.IsDefault	ARCCore	ClassMember	Does not have a corresponding -BaseAttributeP- since all attributes relevant for querying (for instance in the documentation) will be IsDefault = FALSE anyway. (if we had included it in -BaseAttributeP- it would just have led to a lot of confusing IsDefault = FALSE key-values showing up.)
ARCCore.BasePKAttribute.GetAttributes	ARCCore	ClassMember	Note that illegal to call for other than -PropertyKeyEnum-.
ARCCore.BasePKAttribute.TryRemoveP	ARCCore	ClassMember	Should probably never be used.
ARCCore.ClassAttribute	ARCCore	Class	Describes a class.
ARCCore.ClassAttribute.GetAttribute	ARCCore	ClassMember	Throws exception if type implements -IP- and no corresponding enum found (enum ending with capital letter 'P' (like 'CustomerP' for enum describing class 'Customer' for instance)
ARCCore.ClassAttribute.TryGetAsTypeScript	ARCCore	ClassMember	Generates typescript code corresponding to the class which this instance describes.
ARCCore.ClassAttribute.IsDefault	ARCCore	ClassMember	Does not have a corresponding -BaseAttributeP- since all attributes relevant for querying (for instance in the documentation) will be IsDefault = FALSE anyway. (if we had included it in -BaseAttributeP- it would just have led to a lot of confusing IsDefault = FALSE key-values showing up.)
ARCCore.ClassMemberAttribute.IsDefault	ARCCore	ClassMember	Does not have a corresponding -BaseAttributeP- since all attributes relevant for querying (for instance in the documentation) will be IsDefault = FALSE anyway. (if we had included it in -BaseAttributeP- it would just have led to a lot of confusing IsDefault = FALSE key-values showing up.)
ARCCore.EnumAttribute	ARCCore	Class	Describes an enum.
ARCCore.EnumAttribute.TryGetAsTypeScript	ARCCore	ClassMember	Generates typescript code corresponding to the enum which this instance describes.
ARCCore.EnumAttribute.TryRemoveP	ARCCore	ClassMember	Should probably never be used.
ARCCore.EnumMemberAttribute.GetAttribute	ARCCore	ClassMember	Note that illegal to call for -PropertyKeyEnum-.
ARCCore.EnumMemberAttribute.Initialize	ARCCore	ClassMember	To be overridden in sub-classes, but do note that sub-classes are supposed to call base.Initialize() at end of their own initialization.
ARCCore.CardinalityExtensions	ARCCore	Class
ARCCore.CardinalityExtensions.IsMultiple	ARCCore	ClassMember	Returns TRUE if given cardinality implies that multiple items are stored simultaneously in a typical in-memory data storage.
ARCCore.Extensions	ARCCore	Class	Contains a few general nice to have extensions methods.
ARCCore.Extensions.ToStringShort	ARCCore	ClassMember	Returns a shorter representation than -ToStringDB-.
ARCCore.Extensions.ToStringVeryShort	ARCCore	ClassMember	Returns same as -ToStringShort- but without any generics information at all.
ARCCore.Extensions.ToStringDB	ARCCore	ClassMember	Gives the minimum representation of type as string suitable for later reconstruction by -GetType-.
ARCCore.Extensions.KeysAsString	ARCCore	ClassMember	Gives a compressed overview of keys in a dictionary. Helpful for building exception messages.
ARCCore.Extensions.GetValue	ARCCore	ClassMember	Gives better error messages when reading value from directory if key does not exist
ARCCore.IKIP	ARCCore	Class	Container class for key (-IK-), and value (-IP-).
ARCCore.IKIP.AssertTypeIntegrity	ARCCore	ClassMember	See -TryAssertTypeIntegrity- for documentation.
ARCCore.IKCoded	ARCCore	Class	Understands coded and unencoded variants of -IK-.
ARCCore.IKCoded.EnrichKey	ARCCore	ClassMember	'Implementing' -ITypeDescriber-.
ARCCore.IKCoded.TryCheckValidEncodedValue	ARCCore	ClassMember	Checks if encoded value is valid.
ARCCore.IKCoded.FromCacheEncoded	ARCCore	ClassMember	Reduces number of objects generated by caching those known to be within a limited range
ARCCore.IKDate.op_Equality	ARCCore	ClassMember	It is quite natural in the code to write code like "if (a.CustomerId == b.CustomerId)", therefore the need to implement == and != operators here.
ARCCore.IKDate.EnrichKey	ARCCore	ClassMember	'Implementing' -ITypeDescriber-.
ARCCore.IKDate.ValidDateTimeFormats	ARCCore	ClassMember	Note: Be very careful about expanding this array. ToString must be considered, and also how Equals should work with other sub classes of IK.
ARCCore.IKLong	ARCCore	Class	A more memory efficient alternative to -IKString-.
ARCCore.ITypeDescriber.GetSyntaxHelp	ARCCore	ClassMember	Enables explanation of syntax in different contexts from one source:
ARCCore.ParseResult	ARCCore	Class	NOTE: Concept is very old, from the dark ages of AgoRapide's very first inception. There might be room for improvement.
ARCCore.ParseResult.Result	ARCCore	ClassMember	Will be null if ErrorResponse is set.
ARCCore.ParseResult.ErrorResponse	ARCCore	ClassMember	Will be null if Result is set
ARCCore.PK.ToString	ARCCore	ClassMember	Caching is supposed to be useful because may be called quite often.
ARCCore.PK.TryValidateAndParse	ARCCore	ClassMember	Parses the value according to specifications for this property key.
ARCCore.PK.TryCleanValidateAndParse	ARCCore	ClassMember	Cleans and parses the value according to specifications for this property key.
ARCCore.PK.PackParseResultForStorageInEntityObject	ARCCore	ClassMember	Packs result of parsing into a -IP--derived class, suitable for sending to -AddOrUpdateP-.
ARCCore.PK.Equals	ARCCore	ClassMember	Note that ToString is only based on __enum, meaning that two enum members / enum values with same name but different type, like CustomerP.Name and OrderP.Name, will be considered equal.
ARCCore.PK.TryGetP	ARCCore	ClassMember	Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCCore.PK..ctor	ARCCore	ClassMember	Constructor with 'object _enum' is necessary in order for ToString to work.
ARCCore.PK.Type	ARCCore	ClassMember	Returns type from -PKTypeAttribute-'s -Type-.
ARCCore.PKHTMLAttribute.TryRemoveP	ARCCore	ClassMember	Should probably never be used.
ARCCore.PKHTMLAttribute.Encoder	ARCCore	ClassMember	See -Encoder-.
ARCCore.PKHTMLAttribute.IsDefault	ARCCore	ClassMember	Does not have a corresponding -BaseAttributeP- since all attributes relevant for querying (for instance in the documentation) will be IsDefault = FALSE anyway. (if we had included it in -BaseAttributeP- it would just have led to a lot of confusing IsDefault = FALSE key-values showing up.)
ARCCore.IHTMLEncoder	ARCCore	Class	Pseudo-interface signifying that implementing class has a static metod called 'Encode' for encoding a string to HTML.
ARCCore.PKRelAttribute.ForeignEntity	ARCCore	ClassMember	See -ForeignEntity-.
ARCCore.PKRelAttribute.OppositeTerm	ARCCore	ClassMember	See -OppositeTerm-.
ARCCore.PKRelAttribute.EnforceReferentialIntegrity	ARCCore	ClassMember	See -EnforceReferentialIntegrity-.
ARCCore.PKRelAttribute.IsDefault	ARCCore	ClassMember	Does not have a corresponding -BaseAttributeP- since all attributes relevant for querying (for instance in the documentation) will be IsDefault = FALSE anyway. (if we had included it in -BaseAttributeP- it would just have led to a lot of confusing IsDefault = FALSE key-values showing up.)
ARCCore.Subscription.FromTime	ARCCore	ClassMember	TODO: Implement concept of specifying starting-point in TIME (often for an -AdHocQuery-?).
ARCCore.Subscription.ToTime	ARCCore	ClassMember	TODO: Implement concept of specifying ending-point in TIME (often for an -AdHocQuery-?).
ARCCore.Subscription.IsMatch Overload1	ARCCore	ClassMember	Evaluates a query consisting of multiple instances of -Subscription- against a single property stream line.
ARCCore.Subscription.IsMatch Overload2	ARCCore	ClassMember	Evaluates this instance of -Subscription- against a single property stream line (which has been split up into its constituent elements).
ARCCore.ARComponents.ARCDoc	ARCCore	EnumMember	A library supporting documentation and demonstrating usage of AgoRapide.
ARCCore.ARComponents.ARCQuery	ARCCore	EnumMember	ARCQuery provides a query language that mimicks SQL but is usable through HTTP as GET URLs.
ARCCore.ARComponents.ARCEvent	ARCCore	EnumMember	ARCEvent contains an -EventSourcing- engine offering a unique -PropertyStream2D- concept where processes (of some business domain) can be expressed in very compact manner through the concept of -IRegHandler-.
ARCCore.ARComponents.ARCSync	ARCCore	EnumMember	(Not implemented as of March 2020)
ARCCore.ARComponents.ARCSec	ARCCore	EnumMember	(Not implemented as of March 2020)
ARCCore.ARComponents.ARCAPI	ARCCore	EnumMember	A library providing an API on top of the -PropertyStream-.
ARCCore.ARComponents.ARAAPI	ARCCore	EnumMember	The corresponding template application for -ARCAPI- demonstrating its usage, providing an HTTP / HTTPS interface with the help of Microsoft.AspNetCore.Mvc.
ARCCore.ARConcepts	ARCCore	Enum	The overarching concepts upon which AgoRapide is built.
ARCCore.ARConcepts.PropertyAccess	ARCCore	EnumMember	The general mechanism for accessing properties of objects in AgoRapide.
ARCCore.ARConcepts.AvoidingRepetition	ARCCore	EnumMember	Avoiding repetition, the overarching philosophy that inspired the rest of AgoRapide.
ARCCore.ARConcepts.AgoRapideHistory	ARCCore	EnumMember	AgoRapide has roots back to 2011 when Bjørn Erling Fløtten invented panSL (SL = Schema language).
ARCCore.ARConcepts.AdHocQuery	ARCCore	EnumMember	The concept of a -Client- doing an ad-hoc query against (normally) a -ArmDB-.
ARCCore.ARConcepts.StandardAgoRapideCode	ARCCore	EnumMember	Code originating from the main official AgoRapide distribution (which therefore does not include any end-application specific code)
ARCCore.ARConcepts.ApplicationSpecificCode	ARCCore	EnumMember	Code specific for an end-application.
ARCCore.ARConcepts.MemoryConsumption	ARCCore	EnumMember	A naïve implementation of key-value storages like AgoRapide may lead to excessive memory (RAM) consumption.
ARCCore.ARConcepts.Indexing	ARCCore	EnumMember	In-memory indexing of data is done 'behind-the-scenes' by some classes implementing -IP-.
ARCCore.PKHTMLAttributeP.Encoder	ARCCore	EnumMember	The class doing the HTML-encoding.
ARCCore.PKLogAttributeP	ARCCore	Enum	Describes class -PKLogAttribute.
ARCCore.PKLogAttributeP.DoNotLogAtAll	ARCCore	EnumMember	Originates from -DoNotLogAtAll-.
ARCCore.PKLogAttributeP.CountInterval	ARCCore	EnumMember	For a value of n, log only every n'th time the property is changed.
ARCCore.PKLogAttributeP.TimeInterval	ARCCore	EnumMember	Specifies a certain time interval for which the property's value shall be sent over the -PropertyStream-.
ARCCore.PKRelAttributeP	ARCCore	Enum	Describes class -PKRelAttribute-.
ARCCore.PKRelAttributeP.ForeignEntity	ARCCore	EnumMember	The type of foreign entity that this property points to.
ARCCore.PKRelAttributeP.OppositeTerm	ARCCore	EnumMember	Example: For 'Employee', the key 'SupervisorId' where the supervisor is another 'Employee', will have another meaning "as seen from" the Supervisor, namely "Subordinates" or similar.
ARCCore.PKRelAttributeP.EnforceReferentialIntegrity	ARCCore	EnumMember	If TRUE then referential integrity will be enforced by -TryStore-.
ARCCore.PKTypeAttributeP	ARCCore	Enum	Describes class -PKTypeAttribute-.
ARCCore.PKTypeAttributeP.Type	ARCCore	EnumMember	The type of this Property.
ARCCore.PKTypeAttributeP.DefaultValue	ARCCore	EnumMember	The default value.
ARCCore.PKTypeAttributeP.Cardinality	ARCCore	EnumMember	Describes how multiple instances of a property is supposed to be handled.
ARCCore.PKTypeAttributeP.IsObligatory	ARCCore	EnumMember	True means value is obligatory.
ARCCore.PKTypeAttributeP.BoilerplateCodeProperties	ARCCore	EnumMember	Automatically generated boilerplate code that implements traditional setters and getters for this key.
ARCCore.PP	ARCCore	Enum	Describes meta data for any class (property) implementing -IP-.
ARCCore.ConnectionInstructionP.Sharding	ARCCore	EnumMember
ARCCore.MultipleConnectionUsage	ARCCore	Enum	Enables fault-tolerance by describing use of multiple connections
ARCCore.MultipleConnectionUsage.Admin	ARCCore	EnumMember	Connection is a special administrative connection to a central 'command-and-control' server which instructs which connections to make.
ARCCore.MultipleConnectionUsage.RoundRobin	ARCCore	EnumMember	This connection to be used in a turn based system, together with other connections with -RoundRobin-.
ARCCore.MultipleConnectionUsage.Simultaneous	ARCCore	EnumMember	This connection to be used simultaneously with other connections with -Simultaneous-
ARCCore.StreamProcessorP	ARCCore	Enum	Describes class -StreamProcessor-.
ARCCore.StreamProcessorP.LocalStorageFolder	ARCCore	EnumMember	The local path to which new properties are stored. Should NOT end with any trailing DirectorySeparatorChar
ARCCore.StreamProcessorP.IndividualStorageFileSize	ARCCore	EnumMember	Max size (in bytes) for a single storage file before a new file is created by call to -StreamProcessor.CreateNewStorageFile-.
ARCCore.StreamProcessorP.CurrentlyInitializing	ARCCore	EnumMember	Set to TRUE at initialization (signals for instance -ReceiveAndDistribute- that it can only queue messages, not process them).
ARCCore.StreamProcessorP.ClientUpdatePositionPath	ARCCore	EnumMember	Complete path to file containing -ClientUpdatePosition-.
ARCCore.StreamProcessorP.ClientUpdatePosition	ARCCore	EnumMember	Note how this is stored both as -ClientUpdatePosition- (on the client side) and -ClientUpdatePosition- (on the server side).
ARCCore.StreamProcessorP.IncomingConnectionsPortNo	ARCCore	EnumMember	If not set, then class will not listen for incoming connections (meaning that our application is probably a -Client-).
ARCCore.StreamProcessorP.UnderClosure	ARCCore	EnumMember	Set to TRUE if to be closed, whenever an exception occurs or when class goes out of scope
ARCCore.StreamProcessorP.WriteToConsole	ARCCore	EnumMember	If true then incoming data (from other nodes will be written to console.
ARCCore.StreamProcessorP.Timestamp	ARCCore	EnumMember	The timestamp inserted at regular intervals in the -PropertyStream- according to -TimestampResolution-.
ARCCore.StreamProcessorP.TimestampIsOld	ARCCore	EnumMember	A warning sent by -StreamProcessor- to -OutsideLocalReceiver- when it knows that data as served is out of date.
ARCDoc.Orange.Storage	ARCDoc	ClassMember	Uses int-value of -__enum- minus 1 as index.
ARCDoc.SomeAppComponent	ARCDoc	Class	Demonstrates how also your actual application classes, not only your data classes, should implement -IP-.
ARCDoc.SomeAppComponent.MethodC	ARCDoc	ClassMember	Note structured format in logging.
ARCDoc.SomeAppComponent.MethodD	ARCDoc	ClassMember	Same as MethodC- but returns data ('Func<string>()' instead of 'Action()')
ARCDoc.SomeAppComponent.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCDoc.DocFrag	ARCDoc	Class	DocFrag = Document fragment.
ARCDoc.DocFrag.Create Overload1	ARCDoc	ClassMember	Creates a -DocFrag- object representing an assembly or a namespace.
ARCDoc.DocFrag.Create Overload2	ARCDoc	ClassMember	Creates a -DocFrag- object representing a class, class member, enum or enum member.
ARCDoc.DocFrag.ToHTMLSimpleSingle	ARCDoc	ClassMember	Alternative ('override') to -ToHTMLSimpleSingle-.

Generated 2026-06-28 15:38:29.291 UTC