[ROOT] doc DocFrag SELECT Assembly, DocFragType, Description.FirstLine() < SKIP 193 > < TAKE 120 >
120 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.BaseAttribute.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.BasePKAttribute | ARCCore | Class | The class containing the actual attributes used for -TaggingOfPropertyKeys-. |
| ARCCore.BasePKAttribute.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.BasePKAttribute.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.ClassAttribute.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.ClassAttribute.TryRemoveP | ARCCore | ClassMember | Should probably never be used. |
| ARCCore.ClassMemberAttribute | ARCCore | Class | Describes a member of a class (a method). |
| ARCCore.ClassMemberAttribute.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.ClassMemberAttribute.TryRemoveP | ARCCore | ClassMember | Should probably never be used. |
| ARCCore.EnumAttribute.GetAttribute | ARCCore | ClassMember | Throws exception if tagged as -PropertyKeyEnum- and name of type does not end with capital letter 'P' (like 'CustomerP' for enum describing class 'Customer' for instance). |
| ARCCore.EnumAttribute.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.EnumAttribute.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.EnumMemberAttribute | ARCCore | Class | Describes an enum's value. |
| ARCCore.EnumMemberAttribute.TryRemoveP | ARCCore | ClassMember | Should probably never be used. |
| ARCCore.EnumMemberAttribute.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.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.ToStringDB | ARCCore | ClassMember | Gives the minimum representation of type as string suitable for later reconstruction by -GetType-. |
| ARCCore.Extensions.ForEach | ARCCore | ClassMember | Useful when we want to write collection.ForEach( ... ) instead of |
| 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.Extensions.Result | ARCCore | ClassMember | Returns heading plus return-value of function (calls function). If function == null then empty string is returned |
| ARCCore.Extensions.ToStringDateAndTime | ARCCore | ClassMember | Uses format 'yyyy-MM-dd HH:mm:ss.fff'. |
| ARCCore.IKIP.AssertTypeIntegrity | ARCCore | ClassMember | See -TryAssertTypeIntegrity- for documentation. |
| ARCCore.IKIP.TryAssertTypeIntegrity | ARCCore | ClassMember | Asserts that value is of correct type as specified by the key. |
| ARCCore.IK | ARCCore | Class | IK = Interface Key / Index key. Key used to lookup 'inside' an instance of -IP-. |
| ARCCore.IKCoded | ARCCore | Class | Understands coded and unencoded variants of -IK-. |
| ARCCore.IKCoded.FromEncoded | ARCCore | ClassMember | Note how uses instance cache if already exists there. |
| ARCCore.IKCoded.TryEncode | ARCCore | ClassMember | Returns a string containing only characters in -AllowedEncodedCharacters-. |
| ARCCore.IKCoded.ToString | ARCCore | ClassMember | Returns -Encoded-'s string representation. |
| 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.IKString | ARCCore | Class | Index key for any general id, like primary-key or sequence-number or similar. |
| ARCCore.IKString.FromCache | ARCCore | ClassMember | Reduces number of objects generated by caching those known to be within a limited range |
| ARCCore.IKString.FromString | ARCCore | ClassMember | Note how uses instance cache if already exists there |
| 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.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.TryGetA | ARCCore | ClassMember | Convenience method for easy access to -BasePKAttribute-. |
| ARCCore.PK.ModifyCleanerAndValidatorAndParserForCardinality | ARCCore | ClassMember | Called from -Initialize- after _cleaner and _validatorAndParser have been 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.PackObjectForStorageInEntityObject | ARCCore | ClassMember | See -PackParseResultForStorageInEntityObject- for documentation. |
| ARCCore.PK.FromEnum | ARCCore | ClassMember | Returns the corresponding -PK- instance from the given -PropertyKeyEnum-. |
| ARCCore.IGetKeysEqualToValue | ARCCore | Class | Interface stating that implementing class does not use the default implementation of -GetKeysEqualToValue- (which does not use -Indexing-) but has replaced it with a more efficient implementation assumed to utilize -Indexing-. |
| ARCCore.PConcurrent | ARCCore | Class | A (somewhat) thread-safe alternative to -PRich- which also supports -ExposingApplicationState- (through -Logger-). |
| ARCCore.PConcurrent.ToString | ARCCore | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCCore.PExact<TEnumType> | ARCCore | Class | Very -MemoryConsumption- efficient alternative to -PRich-. |
| ARCCore.UtilCore.ValidDateTimeFormats | ARCCore | ClassMember | 'yyyy-MM-dd HH:mm:ss.fff', 'yyyy-MM-dd HH:mm:ss', 'yyyy-MM-dd HH:mm', 'yyyy-MM-dd' |
| ARCCore.UtilCore.ValidTimeSpanFormats | ARCCore | ClassMember | 'hh\:mm', 'hh\:mm\:ss', 'd\.hh\:mm\:ss', 'hh\:mm\:ss\.fff' // Milliseconds,'d\.hh\:mm\:ss\.fff' |
| ARCCore.REx | ARCCore | Class | REx = 'TooDeepRecursiveDepthException' |
| ARCCore.REx.Inc | ARCCore | ClassMember | Increases recursive count. |
| ARCCore.TIP.ToString | ARCCore | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCCore.BaseAttribute+IncorrectAttributeTypeUsedException | ARCCore | Class | Helps to clean up any confusion about which -BaseAttribute- to use in a given concept. |
| ARCCore.PK+BasePKAttributeNotFoundException<T> | ARCCore | Class | Explains how to implement a given -BasePKAttribute- for an enum |
| ARCCore.PK+PKBoolPair | ARCCore | Class | Used to signify that a given -PK- returned from value factory inside -FromEnum- has not been initialized (has not yet been populated with -PKTypeAttribute- collection). |
| ARCCore.PK+PKBoolPair.TrulyInitialized | ARCCore | ClassMember | Not used currently (May 2020). Useful for debugging purposes |
| ARCCore.StreamProcessor+StorageFile | ARCCore | Class | |
| ARCCore.StreamProcessor+StorageFile.Filepath | ARCCore | ClassMember | Complete path to file |
| ARCCore.StreamProcessor+StorageFile.Filename | ARCCore | ClassMember | Filename: Main file name, like 2020-04-03 08:42 |
| ARCCore.PValue<T>.DeepCopy | ARCCore | ClassMember | Note that if the generic type (T) is not immutable, then what we return will not be a truly deep copy. |
| ARCCore.PValue<T>..ctor | ARCCore | ClassMember | Note how this class does not have a parameter-less constructor (unlike all other -IP--derived classes in AgoRapide) |
| ARCCore.PValueEmpty | ARCCore | Class | Represents the 'no value'. |
| ARCCore.PValueEmpty.TrySetP | ARCCore | ClassMember | NOTE: -TryStore- is explicit aware that -PValue- and -PValueEmpty- |
| ARCCore.PValueEmpty.ToPropertyStream | ARCCore | ClassMember | Typicall return value could be something like |
| ARCCore.ActualConnection | ARCCore | Class | The actual connection, its internal state, queue for sending and so on. |
| ARCCore.ActualConnection.SetMyUpdatePositionGenerator | ARCCore | ClassMember | Set by -StreamProcessor-. |
| ARCCore.ActualConnection.SetSinglePropertyStreamReceiver | ARCCore | ClassMember | Set by -StreamProcessor-. |
| ARCCore.ClientUpdatePosition.OnlyNewDataIsRequestedInstance | ARCCore | ClassMember | See also -OnlyNewDataIsRequested. |
| ARCCore.ConnectionInstruction | ARCCore | Class | The instruction about what connections to make (host, portnr, data transfer direction and so on). |
| ARCCore.ConnectionInstruction.Initialize | ARCCore | ClassMember | Initializes to sane values. |
| ARCCore.ConnectionInstruction.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.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). |
| ARCCore.ConnectionInstruction.ToString | ARCCore | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCCore.Sharding | ARCCore | Class | Enables load-balancing by describing what data should be sent over a given connection. |
| ARCCore.PropertyStreamLine | ARCCore | Class | Has two main functions: |
| ARCCore.PropertyStreamLine.EncodeKeys | ARCCore | ClassMember | Encodes the key part of a -PropertyStreamLine-. |
| ARCCore.PropertyStreamLine.EncodeValues | ARCCore | ClassMember | Typically used when turning -WholeCollection- into a value part of a -PropertyStreamLine-. |
| ARCCore.PropertyStreamLine.EncodeKeyPart | ARCCore | ClassMember | Converts a single key part of a -PropertyStreamLine- to a format suitable for sending over a -PropertyStream-. |
| ARCCore.PropertyStreamLine.EncodeValuePart | ARCCore | ClassMember | Converts a single value part of a -PropertyStreamLine- to a format suitable for sending over a -PropertyStream-. |
| ARCCore.PropertyStreamLine.Decode | ARCCore | ClassMember | Decodes string as encoded by -EncodeKeyPart- or -EncodeValuePart-. |
| ARCCore.PropertyStreamLine.TryParseDirectToIP | ARCCore | ClassMember | Parses a series of -PropertyStreamLine- directly to the given type of -IP-. |
| ARCCore.PropertyStreamLine.TryParseDirectToProperty | ARCCore | ClassMember | Parses direct to a given property value. |
| ARCCore.PropertyStreamLine.ParseAndStore | ARCCore | ClassMember | Note that throws exception if -TryParseAndStore- fails. |
| ARCCore.StreamProcessor.StartTCPIPCommunication | ARCCore | ClassMember | Starts communicating over TCP/IP. |
| ARCCore.StreamProcessor.ReceiveAndDistribute | ARCCore | ClassMember | Process all messages in receive queue. |
| ARCCore.StreamProcessor.AddTimestampAsRequired | ARCCore | ClassMember | Adds -Timestamp- to the property stream (to -_queueReceive-) as specified by -TimestampResolution-. |
| ARCCore.StreamProcessor.ReadStorageFile | ARCCore | ClassMember | Reads one storage file from disk |
| ARCCore.StreamProcessor.ToString | ARCCore | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCCore.StreamProcessor.OutsideLocalReceiver | ARCCore | ClassMember | The outside (in the sense outside of this class) local mechanism which receives all -PropertyStreamLine- registered by this class. |
| ARCCore.PropertyStreamLineWithOrigin | ARCCore | Class | The rationale for this class is that -ReceiveAndDistribute- needs to distingush origin of data when routing it (in general, in order to avoid sending it back to its source). |
| ARCCore.PropertyStreamLineWithOrigin.HasLocalOrigin | ARCCore | ClassMember | Locally generated data is not to be sent to -OutsideLocalReceiver-). We instead leave it to the 'outside' to decide if |
| ARCCore.UtilCore.AssertCurrentlyStartingUp | ARCCore | ClassMember | Normally called from non-thread safe methods that should be run single-threaded at application startup only. |
| ARCCore.UtilCore.DoubleTryParse | ARCCore | ClassMember | Note that treats ',' (comma) as decimal point (not as thousands separator). |
| ARCCore.UtilCore.EnumTryParse | ARCCore | ClassMember | Same as the inbuilt .NET method -TryParse- but with some additional checks. |
| ARCCore.UtilCore.TryGetTypeFromStringNoCache | ARCCore | ClassMember | See -TryGetTypeFromStringFromCache- for documentation. |
| ARCCore.UtilCore.TryGetTypeFromStringFromCache | ARCCore | ClassMember | Corresponding method for creating string-representation of type is -ToStringDB-. |
| ARCCore.UtilCore.GetExceptionChainAsString | ARCCore | ClassMember | Follows the chain of InnerException and returns types as comma-separated string |
| ARCCore.UtilCore.GetExeptionDetails | ARCCore | ClassMember | Gives as much information about exception as possible. |
| ARCCore.UtilCore.DateTimeTryParse | ARCCore | ClassMember | Accepts on of the formats specified in -ValidDateTimeFormats-. |
| ARCCore.UtilCore.TimeSpanTryParse | ARCCore | ClassMember | Accepts on of the formats specified in -ValidDateTimeFormats-. |
| ARCCore.UtilCore.UseLocalTimeInsteadOfUTC | ARCCore | ClassMember | By default AgoRapide operates only with UTC time. |
| ARCCore.UtilCore.DateTimeNow | ARCCore | ClassMember | Returns DateTime.UtcNow unless -UseLocalTimeInsteadOfUTC- has been set to TRUE in which case DateTime.Now is returned. |
| ARCCore.UtilCore.CurrentlyStartingUp | ARCCore | ClassMember | Called once at application startup after all Attribute instances in the C# code has been processed. |
| ARCCore.UtilCore.Assemblies | ARCCore | ClassMember | All relevant assemblies for application. |
| ARCCore.UtilCore.Culture | ARCCore | ClassMember | The general culture used for parsing. |
| ARCCore.UtilCore.Culture_en_US | ARCCore | ClassMember | Used by -DoubleTryParse-. |
| ARCCore.UtilCore.DefaultAgoRapideEncoding | ARCCore | ClassMember | The standard encoding used for text (UTF8). |
| ARCCore.REx.Dec | ARCCore | ClassMember | This method should be called from inside a 'finally' block, in order to secure its execution, if not then your static recursion depth counter could slowly increase over time due to exceptions ocurring after call to -Inc- but before call to -Dec-. |
| ARCCore.InvalidTypeException | ARCCore | Class | |
| ARCCore.InvalidTypeException.AssertAssignable | ARCCore | ClassMember | Asserts that expectedType.IsAssignableFrom(foundType) |
| ARCCore.InvalidTypeException.AssertEquals | ARCCore | ClassMember | Asserts that expectedType.Equals(foundType) |
| ARCCore.TValue | ARCCore | Class | Placeholder for any class type suitable as generic type parameter -PValue-. |
| ARCCore.TIP | ARCCore | Class | Placeholder for any class type suitable as generic type parameter restricted to -IP. |
| ARCCore.TIP.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.TIP.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). |
Generated 2026-05-18 10:16:40.410 UTC