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

128 items

DocFragId	Assembly	DocFragType	Description.FirstLine()
ARCCore.BaseAttribute	ARCCore	Class	Instances of this class are used as source of documentation and data for the API.
ARCCore.PKRelAttributeP.EnforceReferentialIntegrity	ARCCore	EnumMember	If TRUE then referential integrity will be enforced by -TryStore-.
ARCDoc.Demonstrator.DemonstrateStreamProcessorAsClient	ARCDoc	ClassMember	Demonstrates use of -StreamProcessor- as a general client.
ARCCore.IKLong	ARCCore	Class	A more memory efficient alternative to -IKString-.
ARCCore.PKTypeAttributeP	ARCCore	Enum	Describes class -PKTypeAttribute-.
ARCDoc.Orange	ARCDoc	Class	Inherits -PExact- for probably the best compromise between memory consumption and easy of development.
ARCCore.IKString.FromString	ARCCore	ClassMember	Note how uses instance cache if already exists there
ARCCore.PKTypeAttributeP.Type	ARCCore	EnumMember	The type of this Property.
ARCDoc.Orange.SetPVDirect	ARCDoc	ClassMember	High performance alternative to -TrySetP-, accessing -Storage- more direct.
ARCCore.IKString.op_Equality	ARCCore	ClassMember	It is quite natural in the code to write code like "if (a.CustomerId == b.CustomerId)", therefore the need to implement == and != operators here.
ARCCore.PKTypeAttributeP.DefaultValue	ARCCore	EnumMember	The default value.
ARCDoc.Orange.GetPVDirect	ARCDoc	ClassMember	High performance alternative to -TryGetP-, accessing -Storage- more direct.
ARCCore.IKString.EnrichKey	ARCCore	ClassMember	'Implementing' -ITypeDescriber-.
ARCCore.PKTypeAttributeP.Cardinality	ARCCore	EnumMember	Describes how multiple instances of a property is supposed to be handled.
ARCDoc.Orange.TryGetPVDirect	ARCDoc	ClassMember	High performance alternative to -TryGetP-, accessing -Storage- more direct.
ARCCore.PK.TryGetEnum	ARCCore	ClassMember	Note that usually you will not have to ask for this value, usually in AgoRapide it goes the other way around, you have the enum member / enum value and want the corresponding property key.
ARCCore.PKTypeAttributeP.IsObligatory	ARCCore	EnumMember	True means value is obligatory.
ARCDoc.Orange.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCCore.PK.TryGetV	ARCCore	ClassMember	Only type of PK, string or type of __enum is allowed to ask for (as TRequest generic type parameter).
ARCCore.PKTypeAttributeP.BoilerplateCodeProperties	ARCCore	EnumMember	Automatically generated boilerplate code that implements traditional setters and getters for this key.
ARCDoc.Orange.Name	ARCDoc	ClassMember	See -Name- for more information.
ARCCore.PK.GetAllPKForEntityType	ARCCore	ClassMember	Returns all property keys relevant for the given entity type,
ARCCore.PP	ARCCore	Enum	Describes meta data for any class (property) implementing -IP-.
ARCDoc.Orange.Storage	ARCDoc	ClassMember	Uses int-value of -__enum- minus 1 as index.
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.ConnectionInstructionP.Sharding	ARCCore	EnumMember
ARCDoc.SomeAppComponent	ARCDoc	Class	Demonstrates how also your actual application classes, not only your data classes, should implement -IP-.
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.MultipleConnectionUsage	ARCCore	Enum	Enables fault-tolerance by describing use of multiple connections
ARCDoc.SomeAppComponent.MethodC	ARCDoc	ClassMember	Note structured format in logging.
ARCCore.PKHTMLAttribute.TryRemoveP	ARCCore	ClassMember	Should probably never be used.
ARCCore.MultipleConnectionUsage.Admin	ARCCore	EnumMember	Connection is a special administrative connection to a central 'command-and-control' server which instructs which connections to make.
ARCDoc.SomeAppComponent.MethodD	ARCDoc	ClassMember	Same as MethodC- but returns data ('Func<string>()' instead of 'Action()')
ARCCore.PKHTMLAttribute.Encoder	ARCCore	ClassMember	See -Encoder-.
ARCCore.MultipleConnectionUsage.RoundRobin	ARCCore	EnumMember	This connection to be used in a turn based system, together with other connections with -RoundRobin-.
ARCDoc.SomeAppComponent.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCCore.PKRelAttribute.EnforceReferentialIntegrity	ARCCore	ClassMember	See -EnforceReferentialIntegrity-.
ARCCore.MultipleConnectionUsage.Simultaneous	ARCCore	EnumMember	This connection to be used simultaneously with other connections with -Simultaneous-
ARCDoc.DocFrag	ARCDoc	Class	DocFrag = Document fragment.
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.StreamProcessorP	ARCCore	Enum	Describes class -StreamProcessor-.
ARCDoc.DocFrag.Create Overload1	ARCDoc	ClassMember	Creates a -DocFrag- object representing an assembly or a namespace.
ARCCore.IP.Inc	ARCCore	ClassMember	Increments given property key by 1. Sets to 1 if not found. Uses long, not integer.
ARCCore.StreamProcessorP.LocalStorageFolder	ARCCore	EnumMember	The local path to which new properties are stored. Should NOT end with any trailing DirectorySeparatorChar
ARCDoc.DocFrag.Create Overload2	ARCDoc	ClassMember	Creates a -DocFrag- object representing a class, class member, enum or enum member.
ARCCore.IP.Dec	ARCCore	ClassMember	Decrements given property key by 1. Sets to -1 if not found. Uses long, not integer.
ARCCore.StreamProcessorP.IndividualStorageFileSize	ARCCore	EnumMember	Max size (in bytes) for a single storage file before a new file is created by call to -StreamProcessor.CreateNewStorageFile-.
ARCDoc.DocFrag.ToHTMLSimpleSingle	ARCDoc	ClassMember	Alternative ('override') to -ToHTMLSimpleSingle-.
ARCCore.IP.TrySetPP	ARCCore	ClassMember	SetPP = set property of property. Sets property of entity contained within this class.
ARCCore.StreamProcessorP.CurrentlyInitializing	ARCCore	EnumMember	Set to TRUE at initialization (signals for instance -ReceiveAndDistribute- that it can only queue messages, not process them).
ARCDoc.DocFrag.TryGetP	ARCDoc	ClassMember	Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCCore.IP.GetKeysEqualToValue	ARCCore	ClassMember	Returns properties which themselves again have key and value equal to the given key and value.
ARCCore.StreamProcessorP.ClientUpdatePositionPath	ARCCore	EnumMember	Complete path to file containing -ClientUpdatePosition-.
ARCDoc.DocFrag.TryGetV	ARCDoc	ClassMember	Note that 'normally' this method would be irrelevant for a -PRich- object because we will usually be an entity object (like 'Customer') not having an intrinsic value ourselves per se (because we will instead be containing a list of values).
ARCCore.IP.Item	ARCCore	ClassMember	Offers string-based direct indexing.
ARCCore.StreamProcessorP.ClientUpdatePosition	ARCCore	EnumMember	Note how this is stored both as -ClientUpdatePosition- (on the client side) and -ClientUpdatePosition- (on the server side).
ARCDoc.DocFrag.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCCore.IP.Keys	ARCCore	ClassMember	Returns all the keys for this instance.
ARCCore.StreamProcessorP.IncomingConnectionsPortNo	ARCCore	EnumMember	If not set, then class will not listen for incoming connections (meaning that our application is probably a -Client-).
ARCDoc.DocFragCollection	ARCDoc	Class	Contains a collection of -DocFrag- objects.
ARCCore.IP.AllIPDerivedTypesDictIKType	ARCCore	ClassMember	Same as -AllIPDerivedTypesDict- except that value is -IKType-, not string.
ARCCore.StreamProcessorP.UnderClosure	ARCCore	EnumMember	Set to TRUE if to be closed, whenever an exception occurs or when class goes out of scope
ARCDoc.DocFragCollection.Create	ARCDoc	ClassMember	Creates documentation fragments (-DocFrag-) for all possible -BaseAttribute- elements found in the given assemblies.
ARCCore.P	ARCCore	Class	'Dummy'-class, not necessarily in use. See -PP- for more information. Created because of the concept of CorrespondingClass which is strictly enforced
ARCCore.StreamProcessorP.WriteToConsole	ARCCore	EnumMember	If true then incoming data (from other nodes will be written to console.
ARCDoc.DocFragCollection.TryGetP	ARCDoc	ClassMember	Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCCore.PCollection.TryGetV	ARCCore	ClassMember	Note that 'normally' this method would be irrelevant for a -PRich- object because we will usually be an entity object (like 'Customer') not having an intrinsic value ourselves per se (because we will instead be containing a list of values).
ARCCore.StreamProcessorP.Timestamp	ARCCore	EnumMember	The timestamp inserted at regular intervals in the -PropertyStream- according to -TimestampResolution-.
ARCDoc.DocFragCollection.TryGetV	ARCDoc	ClassMember	Note that 'normally' this method would be irrelevant for a -PRich- object because we will usually be an entity object (like 'Customer') not having an intrinsic value ourselves per se (because we will instead be containing a list of values).
ARCCore.PCollection.ToString	ARCCore	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCCore.StreamProcessorP.TimestampIsOld	ARCCore	EnumMember	A warning sent by -StreamProcessor- to -OutsideLocalReceiver- when it knows that data as served is out of date.
ARCDoc.PKDocAttribute	ARCDoc	Class	Describes documentation and presentation of a property.
ARCCore.PExact<TEnumType>..ctor	ARCCore	ClassMember	Set capacity to the number of members in the -PropertyKeyEnum- for this class (minus the __invalid-value)
ARCCore.DataTransferDirection	ARCCore	Enum	Direction for transfer of data.
ARCDoc.PKDocAttribute.Initialize	ARCDoc	ClassMember	To be overridden in sub-classes, but do note that sub-classes are supposed to call base.Initialize() at end of their own initialization.
ARCCore.PExact<TEnumType>.Storage	ARCCore	ClassMember	Uses int-value of -__enum- minus 1 as index.
ARCCore.DataTransferDirection.Send	ARCCore	EnumMember	Like -Client- sending in-application generated properties to -ArmDB- / -CoreDB- or -ArmDB- sending data received over an incoming connection to -CoreDB-.
ARCDoc.PKDocAttribute.TryRemoveP	ARCDoc	ClassMember	Should probably never be used.
ARCCore.PII	ARCCore	Class	PII = property for storing individual items.
ARCCore.DataTransferDirection.Receive	ARCCore	EnumMember	Like -Client- receiving data from an upstream -ArmDB- / -CoreDB- or -ArmDB- receiving data from an upstream -CoreDB-.
ARCDoc.PKDocAttribute.PriorityOrder	ARCDoc	ClassMember	See -PriorityOrder-.
ARCCore.PII.TryGetV	ARCCore	ClassMember	Since value is stored in keys, we need to override this method.
ARCCore.TPropertyKeyEnum	ARCCore	Enum	Placeholder for any enum type suitable as generic type parameter for -PExact-.
ARCDoc.PKDocAttribute.IsDefault	ARCDoc	ClassMember	Does not have a corresponding -BaseAttributeP- since all attributes relevant for querying (for instance in the documentation) will be IsDefault = FALSE anyway. (if we had included it in -BaseAttributeP- it would just have led to a lot of confusing IsDefault = FALSE key-values showing up.)
ARCCore.ActualConnection.SetUpToDatePositionGenerator	ARCCore	ClassMember	Set by -StreamProcessor-. Not used by -Client-.
Assembly ARCDoc		Assembly	A library supporting documentation and demonstrating usage of AgoRapide.
ARCDoc.UtilDoc	ARCDoc	Class	Utility methods for -ARCDoc-.
ARCCore.ActualConnection.InitializeOutgoingConnection	ARCCore	ClassMember	Relevant for -Outgoing-.
ARCDoc.Apple	ARCDoc	Class	The most 'standard' way of implementing an entity-class in AgoRapide, by just inheriting -PRich-.
ARCDoc.UtilDoc.GetCurrentLevelInHierarchyAsHTML	ARCDoc	ClassMember	Returns an HTML presentation of the given link context, with links pointing backwards to each level in the hierarchy.
ARCCore.ActualConnection.Communicate	ARCCore	ClassMember	Common for both -Incoming- and -Outgoing-.
ARCDoc.Apple.AddName	ARCDoc	ClassMember	Convenience method, not obligatory.
ARCDoc.UtilDoc.GenerateHTMLPage	ARCDoc	ClassMember	Wraps the parameter inside a <html><head></head><body>...</body></html> enclosure with some rudimentare CSS.
ARCCore.ActualConnection.LogAndSendErrorConditionData	ARCCore	ClassMember	Called when a serious error condition has been discovered and connection should be terminated.
ARCDoc.Apple.GetName	ARCDoc	ClassMember	Convenience method, not obligatory.
ARCDoc.UtilDoc.GlobalHeaderHTML	ARCDoc	ClassMember	Global header to be inserted at the top of every HTML page created by -GenerateHTMLPage-.
ARCCore.ConnectionInstruction.TryGetV	ARCCore	ClassMember	Note that 'normally' this method would be irrelevant for a -PRich- object because we will usually be an entity object (like 'Customer') not having an intrinsic value ourselves per se (because we will instead be containing a list of values).
ARCDoc.Apple.TryGetName	ARCDoc	ClassMember	Convenience method, not obligatory.
ARCDoc.HTOC+ParentChain	ARCDoc	Class	Used by -FilterNode- in order to keep track of node's parents.
ARCCore.ConnectionInstruction.ToString	ARCCore	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCDoc.Apple.TryGetP	ARCDoc	ClassMember	Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.AppleP	ARCDoc	Enum	Describes class -Apple-.
ARCCore.Sharding	ARCCore	Class	Enables load-balancing by describing what data should be sent over a given connection.
ARCDoc.Apple.TryGetV	ARCDoc	ClassMember	Note that 'normally' this method would be irrelevant for a -PRich- object because we will usually be an entity object (like 'Customer') not having an intrinsic value ourselves per se (because we will instead be containing a list of values).
ARCDoc.AppleP.Name	ARCDoc	EnumMember	The name of the apple
ARCCore.PropertyStreamLine	ARCCore	Class	Has two main functions:
ARCDoc.Apple.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCDoc.AppleP.Colour	ARCDoc	EnumMember
ARCCore.PropertyStreamLineParsed.TryParse	ARCCore	ClassMember	Generate list of <(IK key, Type valueType)> together with value from value part.
ARCDoc.Apple.Name	ARCDoc	ClassMember	Convenience method, not obligatory.
ARCDoc.BananaP	ARCDoc	Enum	Describes class -Banana-.
ARCCore.PropertyStreamLineParsed.IsComment	ARCCore	ClassMember	Signifies that property stream line given for parsing started with '//' (two forward slashes).
ARCDoc.Banana	ARCDoc	Class	Implements -IP- directly and uses traditional property storage for optimum -MemoryConsumption- efficiency.
ARCDoc.BananaP.Name	ARCDoc	EnumMember	The name of the banana
ARCCore.PropertyStreamLineParsed.Keys	ARCCore	ClassMember	The keys part of the -PropertyStreamLine-, that is, everything before ' = '.
ARCDoc.Banana.Name	ARCDoc	ClassMember	Annotated as nullable in order to keep flexibility of -PropertyAccess-, including what happens if values are not set (TryGetP etc)
ARCDoc.BananaP.Colour	ARCDoc	EnumMember
ARCCore.PropertyStreamLineParsed.Value	ARCCore	ClassMember	The original (non-parsed, non-validated)) value part of the -PropertyStreamLine-, that is, everything after ' = '.
ARCDoc.Banana.Colour	ARCDoc	ClassMember	Annotated as nullable in order to keep flexibility of -PropertyAccess-, including what happens if values are not set (TryGetP etc)
ARCDoc.OrangeP	ARCDoc	Enum	Describes class -Orange-.
ARCDoc.DocLinkCollection.TryGetP	ARCDoc	ClassMember	Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.DocFragCollection.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCDoc.OrangeP.Name	ARCDoc	EnumMember	The name of the orange
ARCDoc.DocLinkCollection.TryGetV	ARCDoc	ClassMember	Note that 'normally' this method would be irrelevant for a -PRich- object because we will usually be an entity object (like 'Customer') not having an intrinsic value ourselves per se (because we will instead be containing a list of values).
ARCDoc.DocLink	ARCDoc	Class	Describes to where a single HTML link points.
ARCDoc.OrangeP.Colour	ARCDoc	EnumMember
ARCDoc.DocLinkCollection.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCDoc.DocLink.TryGetP	ARCDoc	ClassMember	Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.

Generated 2025-09-17 13:20:29.608 UTC