[ROOT] doc DocFrag SELECT Assembly, DocFragType, Description.FirstLine() < SKIP 88 > < TAKE 125 >
125 items
| DocFragId | Assembly | DocFragType | Description.FirstLine() |
|---|---|---|---|
| ARCCore.Cardinality.IndividualItems | ARCCore | EnumMember | Values are supposed to be set and 'deleted' individually. |
| ARCCore.Extensions.Use | ARCCore | ClassMember | Convenience 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.PSPrefix | ARCCore | Enum | Describes some recommended prefixes to use in a -PropertyStreamLine-. |
| ARCCore.Extensions.AddValue | ARCCore | ClassMember | Gives better error messages compared to 'original' Add when adding a value to a directory if key already exists |
| ARCCore.PSPrefix.dt | ARCCore | EnumMember | Data, single key + value. |
| ARCCore.Extensions.KeysAsString | ARCCore | ClassMember | Gives a compressed overview of keys in a dictionary. Helpful for building exception messages. |
| ARCCore.PConcurrentP | ARCCore | Enum | Describes class -PConcurrent-. |
| ARCCore.Extensions.GetValue | ARCCore | ClassMember | Gives better error messages when reading value from directory if key does not exist |
| ARCCore.PConcurrentP.Heartbeat | ARCCore | EnumMember | |
| ARCCore.Extensions.Single | ARCCore | ClassMember | Same as inbuilt LINQ's Single except that gives a more friendly exception message |
| ARCCore.ActualConnectionP | ARCCore | Enum | Describes class -ActualConnection-. |
| ARCCore.Extensions.SingleOrDefault | ARCCore | ClassMember | Same as inbuilt LINQ's SingleOrDefault except that gives a more friendly exception message |
| ARCCore.ActualConnectionP.Id | ARCCore | EnumMember | When connection is used with-StreamProcessor-, the Id should be the same as the key used in the incoming / outgoing connection dictionary collection. |
| ARCCore.Extensions.Result | ARCCore | ClassMember | Returns heading plus return-value of function (calls function). If function == null then empty string is returned |
| ARCCore.ActualConnectionP.ConnectionInstruction | ARCCore | EnumMember | Only relevant when we are an -Outgoing-. |
| ARCCore.Extensions.ToStringDateAndTime | ARCCore | ClassMember | Uses format 'yyyy-MM-dd HH:mm:ss.fff'. |
| ARCCore.ActualConnectionP.ConnectionDirection | ARCCore | EnumMember | |
| ARCCore.Extensions.ToStringWithMS | ARCCore | ClassMember | Uses either format 'd\.hh\:mm\:ss\.fff' or 'hh\:mm\:ss\.fff' depending on TotalHours >=24 hours or not. |
| ARCCore.ActualConnectionP.CountReceiveMessage | ARCCore | EnumMember | |
| ARCCore.IKIP | ARCCore | Class | Container class for key (-IK-), and value (-IP-). |
| ARCCore.ActualConnectionP.CountSendMessage | ARCCore | EnumMember | |
| ARCCore.IKIP.AssertTypeIntegrity | ARCCore | ClassMember | See -TryAssertTypeIntegrity- for documentation. |
| ARCCore.ActualConnectionP.ClientUpdatePosition | ARCCore | EnumMember | Note how this is stored both as -ClientUpdatePosition- (on the client side) and -ClientUpdatePosition- (on the server side). |
| ARCCore.IKIP.TryAssertTypeIntegrity | ARCCore | ClassMember | Asserts that value is of correct type as specified by the key. |
| ARCCore.ActualConnectionP.SubscriptionAsRequestedByClient | ARCCore | EnumMember | Originates from -Subscription-. |
| ARCCore.IK | ARCCore | Class | IK = Interface Key / Index key. Key used to lookup 'inside' an instance of -IP-. |
| ARCCore.ActualConnectionP.ClosingReason | ARCCore | EnumMember | Reason why this connection was closed |
| ARCCore.IKCoded | ARCCore | Class | Understands coded and unencoded variants of -IK-. |
| ARCCore.ActualConnectionP.IsErrorCondition | ARCCore | EnumMember | Some kind of error condition has occured regarding data going back and forth, but the TCP/IP connection itself is probably sound. |
| ARCCore.IKCoded.EnrichKey | ARCCore | ClassMember | 'Implementing' -ITypeDescriber-. |
| ARCCore.ActualConnectionP.ErrorConditionData | ARCCore | EnumMember | Detailed explanation about -IsErrorCondition- |
| ARCCore.IKCoded.TryCheckValidEncodedValue | ARCCore | ClassMember | Checks if encoded value is valid. |
| ARCCore.ActualConnectionP.UnderClosure | ARCCore | EnumMember | Set to TRUE if to be closed and reinitialized. |
| ARCCore.IKCoded.FromCacheEncoded | ARCCore | ClassMember | Reduces number of objects generated by caching those known to be within a limited range |
| ARCCore.ActualConnectionP.MonkeyWrench | ARCCore | EnumMember | |
| ARCCore.IKCoded.FromCacheUnencoded | ARCCore | ClassMember | Reduces number of objects generated by caching those known to be within a limited range |
| ARCCore.ActualConnectionP.PartnerIPAddress | ARCCore | EnumMember | TODO: Use more strongly typing for this. |
| ARCCore.IKCoded.FromEncoded | ARCCore | ClassMember | Note how uses instance cache if already exists there. |
| ARCCore.ConnectionInstructionP | ARCCore | Enum | Describes class -ConnectionInstruction-. |
| ARCCore.IKCoded.TryEncode | ARCCore | ClassMember | Returns a string containing only characters in -AllowedEncodedCharacters-. |
| ARCCore.ConnectionInstructionP.ClientId | ARCCore | EnumMember | The AgoRapide node-id for which this connection is relevant. Used for distributing over the -PropertyStream- information to the clients about which possible nodes they can connect to. |
| ARCCore.IKCoded.ToString | ARCCore | ClassMember | Returns -Encoded-'s string representation. |
| ARCCore.ConnectionInstructionP.ServerHostName | ARCCore | EnumMember | The host (DNS or IP-address) for which to connect. |
| ARCCore.IKCoded.Encoded | ARCCore | ClassMember | This string value can be used directly in folder names, file names and HTTP URL's without any further encoding being necessary. |
| ARCCore.ConnectionInstructionP.ServerPortNo | ARCCore | EnumMember | The port number for which to connect. |
| ARCCore.IKCoded.AllowedEncodedCharacters | ARCCore | ClassMember | The character set 'A...Za...z0...9-_().,='. |
| ARCCore.ConnectionInstructionP.ConnectionId | ARCCore | EnumMember | Usually a combination of -ClientId-, -ServerHostName- and -ServerPortNo-. |
| ARCCore.IKDate | ARCCore | Class | A more memory efficient alternative to -IKString- (together with -IKLong-). |
| ARCCore.ConnectionInstructionP.DataTransferDirection | ARCCore | EnumMember | |
| 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.ConnectionInstructionP.Subscription | ARCCore | EnumMember | The actual subscripton. This is what the connecting party / (downstream) client would send over its TCP/IP connection to the (upstream) server. |
| ARCCore.IKDate.EnrichKey | ARCCore | ClassMember | 'Implementing' -ITypeDescriber-. |
| ARCCore.ConnectionInstructionP.MultipleConnectionUsage | ARCCore | EnumMember | |
| 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.ConnectionInstructionP.Sharding | ARCCore | EnumMember | |
| ARCCore.IKLong | ARCCore | Class | A more memory efficient alternative to -IKString-. |
| ARCCore.MultipleConnectionUsage | ARCCore | Enum | Enables fault-tolerance by describing use of multiple connections |
| ARCCore.IKLong.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.MultipleConnectionUsage.Admin | ARCCore | EnumMember | Connection is a special administrative connection to a central 'command-and-control' server which instructs which connections to make. |
| ARCCore.IKLong.EnrichKey | ARCCore | ClassMember | 'Implementing' -ITypeDescriber-. |
| ARCCore.MultipleConnectionUsage.RoundRobin | ARCCore | EnumMember | This connection to be used in a turn based system, together with other connections with -RoundRobin-. |
| ARCCore.IKString | ARCCore | Class | Index key for any general id, like primary-key or sequence-number or similar. |
| ARCCore.MultipleConnectionUsage.Simultaneous | ARCCore | EnumMember | This connection to be used simultaneously with other connections with -Simultaneous- |
| ARCCore.IKString.FromCache | ARCCore | ClassMember | Reduces number of objects generated by caching those known to be within a limited range |
| ARCCore.StreamProcessorP | ARCCore | Enum | Describes class -StreamProcessor-. |
| ARCCore.IKString.FromString | ARCCore | ClassMember | Note how uses instance cache if already exists there |
| ARCCore.StreamProcessorP.LocalStorageFolder | ARCCore | EnumMember | The local path to which new properties are stored. Should NOT end with any trailing DirectorySeparatorChar |
| 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.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.IKString.EnrichKey | ARCCore | ClassMember | 'Implementing' -ITypeDescriber-. |
| ARCDoc.Apple.TryGetName | ARCDoc | ClassMember | Convenience method, not obligatory. |
| ARCCore.IKType | ARCCore | Class | Index key used when storing a collection of a given type, like 'Customer'. |
| 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. |
| ARCCore.IKType.ToString | ARCCore | ClassMember | Caching is supposed to be useful because may be called quite often. |
| 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). |
| ARCCore.ITypeDescriber | ARCCore | Class | Provides a standardized mechanism for describing single-property values (like 'PhoneNumber' of 'Customer' for instance). |
| ARCDoc.Apple.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCCore.ITypeDescriber.GetSyntaxHelp | ARCCore | ClassMember | Enables explanation of syntax in different contexts from one source: |
| ARCDoc.Apple.Name | ARCDoc | ClassMember | Convenience method, not obligatory. |
| 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. |
| ARCDoc.Banana | ARCDoc | Class | Implements -IP- directly and uses traditional property storage for optimum -MemoryConsumption- efficiency. |
| ARCCore.ParseResult.Result | ARCCore | ClassMember | Will be null if ErrorResponse is set. |
| 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) |
| ARCCore.ParseResult.ErrorResponse | ARCCore | ClassMember | Will be null if Result is set |
| 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) |
| ARCCore.PK | ARCCore | Class | PK = AgoRapide PropertyKey. |
| ARCDoc.Demonstrator | ARCDoc | Class | Demonstrates various concepts from -ARCCore-, especially -PropertyAccess-. |
| 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. |
| ARCDoc.Demonstrator.DemonstratePropertyAccessApple | ARCDoc | ClassMember | Demonstrates use of -PropertyAccess- through the -Apple- 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). |
| ARCDoc.Demonstrator.DemonstratePropertyAccessOrange | ARCDoc | ClassMember | Demonstrates use of -PropertyAccess- through the -Orange- class. |
| ARCCore.PK.GetA | ARCCore | ClassMember | Convenience method for easy access to -BasePKAttribute- with corresponding explaining exception if fails |
| ARCDoc.Demonstrator.DemonstratePropertyAccessBanana | ARCDoc | ClassMember | Demonstrates use of -PropertyAccess- through the -Banana- class. |
| ARCCore.PK.TryGetA | ARCCore | ClassMember | Convenience method for easy access to -BasePKAttribute-. |
| ARCDoc.Demonstrator.DemonstrateITypeDescriber | ARCDoc | ClassMember | Demonstrates use of -ITypeDescriber- for describing single-property values. |
| ARCCore.PK.ModifyCleanerAndValidatorAndParserForCardinality | ARCCore | ClassMember | Called from -Initialize- after _cleaner and _validatorAndParser have been set. |
| ARCDoc.Demonstrator.DemonstratePRichHierarchicalStorage | ARCDoc | ClassMember | Demonstrates use of -PRich-, how it receives -PropertyStream--lines and builds up a strongly typed hierarchical object storage. |
| ARCCore.PK.ToString | ARCCore | ClassMember | Caching is supposed to be useful because may be called quite often. |
| ARCDoc.Demonstrator.DemonstratePropertyStream | ARCDoc | ClassMember | Demonstrates use of -PropertyStream- by generating local data (documentation data) and writing locally to console. |
| ARCCore.PK.TryValidateAndParse | ARCCore | ClassMember | Parses the value according to specifications for this property key. |
| ARCDoc.Demonstrator.DemonstrateBareBonesClient | ARCDoc | ClassMember | Demonstrates adding -PropertyStream--lines to -CoreDB- without using ANY AgoRapide component, only standard TCP/IP functionality in .NET. |
| ARCCore.PK.TryCleanValidateAndParse | ARCCore | ClassMember | Cleans and parses the value according to specifications for this property key. |
| ARCDoc.Demonstrator.DemonstrateLogConsole | ARCDoc | ClassMember | Demonstrates a quite simple log console. |
| ARCCore.PK.PackParseResultForStorageInEntityObject | ARCCore | ClassMember | Packs result of parsing into a -IP--derived class, suitable for sending to -AddOrUpdateP-. |
| ARCDoc.Demonstrator.DemonstrateStreamProcessorAsClient | ARCDoc | ClassMember | Demonstrates use of -StreamProcessor- as a general client. |
| ARCCore.PK.PackObjectForStorageInEntityObject | ARCCore | ClassMember | See -PackParseResultForStorageInEntityObject- for documentation. |
| ARCDoc.Orange | ARCDoc | Class | Inherits -PExact- for probably the best compromise between memory consumption and easy of development. |
| ARCCore.PK.FromEnum | ARCCore | ClassMember | Returns the corresponding -PK- instance from the given -PropertyKeyEnum-. |
| ARCDoc.Orange.SetPVDirect | ARCDoc | ClassMember | High performance alternative to -TrySetP-, accessing -Storage- more direct. |
| ARCCore.PK.TryGetFromTypeAndFieldName Overload3 | ARCCore | ClassMember | Returns property key based on type and field name. |
| ARCDoc.Orange.GetPVDirect | ARCDoc | ClassMember | High performance alternative to -TryGetP-, accessing -Storage- more direct. |
| ARCCore.PK.TryGetFromTypeAndFieldName Overload2 | ARCCore | ClassMember | Returns property key based on type and field name. |
| ARCDoc.Orange.TryGetPVDirect | ARCDoc | ClassMember | High performance alternative to -TryGetP-, accessing -Storage- more direct. |
| ARCCore.PK.TryGetFromTypeAndFieldName Overload1 | ARCCore | ClassMember | Returns property key based on type and field name. |
| ARCDoc.Orange.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCCore.PK.GetAllPKForEntityType | ARCCore | ClassMember | Returns all property keys relevant for the given entity type, |
| ARCDoc.Orange.Name | ARCDoc | ClassMember | See -Name- for more information. |
| ARCCore.PK.GetAllPKForEntityTypeString | ARCCore | ClassMember | Returns all property keys relevant for the given entity type, |
| 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. |
| ARCCore.PK.BuildFromStringCache | ARCCore | ClassMember | Builds the content of -_fromStringCache- and also -_allPKForEntityTypeCache-. |
| 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). |
| ARCCore.PK.GetTypeMapping | ARCCore | ClassMember | Returns the relevant property key for a given type entity-type and field-type. |
| ARCDoc.DocLinkCollection.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCCore.PK.GetObligatoryValuesForEntityType | ARCCore | ClassMember | Returns all obligatory values (based on -IsObligatory-) |
| ARCDoc.DocLinkResolution | ARCDoc | Class | Contains a resolution page for a link word which has duplicate 'targets' (pointing to multiple -DocLink- instances). |
Generated 2025-12-20 17:18:22.482 UTC