[ROOT] doc DocFrag SELECT Assembly, DocFragType, Description.FirstLine() < SKIP 141 > < TAKE 125 >
125 items
| DocFragId | Assembly | DocFragType | Description.FirstLine() |
|---|---|---|---|
| ARCCore.PKTypeAttribute.StandardCleaner | ARCCore | ClassMember | Returns a cleaner for well known types like bool |
| ARCCore.ActualConnection.SetSinglePropertyStreamReceiver | ARCCore | ClassMember | Set by -StreamProcessor-. |
| ARCCore.ITypeDescriber | ARCCore | Class | Provides a standardized mechanism for describing single-property values (like 'PhoneNumber' of 'Customer' for instance). |
| ARCCore.PKTypeAttribute.TryRemoveP | ARCCore | ClassMember | Should probably never be used. |
| ARCCore.ClientUpdatePosition | ARCCore | Class | Describes from WHERE (from WHEN) in the historic -PropertyStream- new data is to be returned. |
| ARCCore.PK | ARCCore | Class | PK = AgoRapide PropertyKey. |
| ARCCore.IP.Inc | ARCCore | ClassMember | Increments given property key by 1. Sets to 1 if not found. Uses long, not integer. |
| ARCCore.ClientUpdatePosition.Filename | ARCCore | ClassMember | Filename like '2020-04-03 08:42:22_R001' |
| 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.IP.Dec | ARCCore | ClassMember | Decrements given property key by 1. Sets to -1 if not found. Uses long, not integer. |
| ARCCore.ClientUpdatePosition.Index | ARCCore | ClassMember | Index (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.PK.GetA | ARCCore | ClassMember | Convenience method for easy access to -BasePKAttribute- with corresponding explaining exception if fails |
| ARCCore.IP.Log | ARCCore | ClassMember | The 'final' overload of -Log- that is called by the other overloads. |
| ARCCore.ClientUpdatePosition.ClientDatastoreIsEmpty | ARCCore | ClassMember | Used 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.PK.TryGetA | ARCCore | ClassMember | Convenience method for easy access to -BasePKAttribute-. |
| ARCCore.IP.LogExecuteTime | ARCCore | ClassMember | Times the execution of the given function and logs details about elapsed time. |
| ARCCore.ClientUpdatePosition.OnlyNewDataIsRequested | ARCCore | ClassMember | Used by the subscribing client to signify that it does not care about historical data, the server may start with sending only new data. |
| ARCCore.PK.PackParseResultForStorageInEntityObject | ARCCore | ClassMember | Packs result of parsing into a -IP--derived class, suitable for sending to -AddOrUpdateP-. |
| ARCCore.IP.TrySetPP | ARCCore | ClassMember | SetPP = set property of property. Sets property of entity contained within this class. |
| ARCCore.ClientUpdatePosition.IsGoBack | ARCCore | ClassMember | Has to be translated by -StreamProcessor- into a concrete filename / index. |
| ARCCore.PK.PackObjectForStorageInEntityObject | ARCCore | ClassMember | See -PackParseResultForStorageInEntityObject- for documentation. |
| ARCCore.IP.GetKeysEqualToValue | ARCCore | ClassMember | Returns properties which themselves again have key and value equal to the given key and value. |
| ARCCore.ClientUpdatePosition.IsAtEndOfStream | ARCCore | ClassMember | Necessary in order to implement -AdHocQuery-. |
| ARCCore.PK.FromEnum | ARCCore | ClassMember | Returns the corresponding -PK- instance from the given -PropertyKeyEnum-. |
| ARCCore.IP.OnTrySetP | ARCCore | ClassMember | Event handler to be called by -TrySetP- before it changes a property value (but AFTER it has done any validity checks, that is, after it has 'decided' to return TRUE, in other words, event handler should be called when change is guaranteed to go through, but before it actually has been done). |
| ARCCore.ClientUpdatePosition.ClientDatastoreIsEmptyInstance | ARCCore | ClassMember | See also -ClientDatastoreIsEmpty. |
| ARCCore.PK.TryGetFromTypeAndFieldName Overload3 | ARCCore | ClassMember | Returns property key based on type and field name. |
| ARCCore.IP.TryGetP Overload1 | ARCCore | ClassMember | Gets a single property for this object |
| ARCCore.PropertyStreamLine.EncodeValues | ARCCore | ClassMember | Typically used when turning -WholeCollection- into a value part of a -PropertyStreamLine-. |
| ARCCore.PK.BuildFromStringCache | ARCCore | ClassMember | Builds the content of -_fromStringCache- and also -_allPKForEntityTypeCache-. |
| ARCCore.IP.AddP | ARCCore | ClassMember | Adds a property for this object. |
| ARCCore.PropertyStreamLine.EncodeKeyPart | ARCCore | ClassMember | Converts a single key part of a -PropertyStreamLine- to a format suitable for sending over a -PropertyStream-. |
| ARCCore.PK.GetTypeMapping | ARCCore | ClassMember | Returns the relevant property key for a given type entity-type and field-type. |
| ARCCore.IP.AddOrUpdateP | ARCCore | ClassMember | Duplicates functionality of SetP. |
| ARCCore.PropertyStreamLine.EncodeValuePart | ARCCore | ClassMember | Converts a single value part of a -PropertyStreamLine- to a format suitable for sending over a -PropertyStream-. |
| ARCCore.PK.GetObligatoryValuesForEntityType | ARCCore | ClassMember | Returns all obligatory values (based on -IsObligatory-) |
| ARCCore.IP.GetOrAddPV | ARCCore | ClassMember | Gets value. If not set then value will be added |
| ARCCore.PropertyStreamLine.Decode | ARCCore | ClassMember | Decodes string as encoded by -EncodeKeyPart- or -EncodeValuePart-. |
| 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.IP.GetP | ARCCore | ClassMember | Gets a single property for this object. |
| ARCCore.PropertyStreamLine.TryParseDirectToIP | ARCCore | ClassMember | Parses a series of -PropertyStreamLine- directly to the given type of -IP-. |
| ARCCore.PK.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.IP.TryGetP Overload2 | ARCCore | ClassMember | Note that not relevant for single-value properties like -PValue-. |
| ARCCore.PropertyStreamLine.TryParseDirectToProperty | ARCCore | ClassMember | Parses direct to a given property value. |
| ARCCore.PK..ctor | ARCCore | ClassMember | Constructor with 'object _enum' is necessary in order for ToString to work. |
| ARCCore.IP.GetPV | ARCCore | ClassMember | Gets a single property's value for this object. Returns default value if not successful. |
| ARCCore.PropertyStreamLine.ParseAndStore | ARCCore | ClassMember | Note that throws exception if -TryParseAndStore- fails. |
| ARCCore.PK.Type | ARCCore | ClassMember | Returns type from -PKTypeAttribute-'s -Type-. |
| ARCCore.IP.TryGetPV | ARCCore | ClassMember | Gets a single property's value for the given property key. |
| ARCCore.PropertyStreamLine.ParseAndStoreFailSafe | ARCCore | ClassMember | If either parsing or storing fails then this method will call -StoreFailure- in order to keep some track of why parsing or storing failed. |
| ARCCore.PK.Cardinality | ARCCore | ClassMember | Returns cardinality from -PKTypeAttribute-'s -Cardinality-. |
| ARCCore.IP.EnumeratorReturnsEmptyCollection | ARCCore | ClassMember | Hint for how to avoid calling enumerator.Count() when all you need is to decide if collection is empty or not. |
| ARCCore.PropertyStreamLine.StoreFailSafe | ARCCore | ClassMember | Stores if possible and fails silently. |
| ARCCore.PropertyStreamLine.StoreFailure | ARCCore | ClassMember | Stores a 'ParseOrStoreFailure'-object. |
| ARCCore.PropertyStreamLine.TryStore | ARCCore | ClassMember | Stores the given -PropertyStreamLineParsed- in the given storage object. |
| ARCCore.PropertyStreamLine.AllowedKeyChars | ARCCore | ClassMember | Allowed characters in the Key-part of a -PropertyStreamLine-. |
| ARCCore.PropertyStreamLine.AllowedValueChars | ARCCore | ClassMember | Allowed characters in the Value-part of a -PropertyStreamLine-. |
| ARCCore.PropertyStreamLineParsed | ARCCore | Class | Parses the keys part of a line from -PropertyStream-, like 'Customer/42/FirstName = John. |
| ARCCore.PropertyStreamLineParsed.ToString | ARCCore | ClassMember | Note relatively complex operation of 'restoring' original property stream line. |
| ARCCore.PropertyStreamLineParsed.TryParse | ARCCore | ClassMember | Generate list of <(IK key, Type valueType)> together with value from value part. |
| 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.PropertyStreamLineWithOrigin.SendToLocalReceiver | ARCCore | ClassMember | Means 'send to local receiver regardless of origin'. |
| 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.REx.Dec | ARCCore | ClassMember | This method should be called from inside a 'finally' block, in order to secure its execution, if not 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.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.StreamProcessor+StorageFile.Length | ARCCore | ClassMember | Wrongly placed. Belongs to each individual revision file. |
| ARCCore.StreamProcessor+StorageFile.Properties | ARCCore | ClassMember | Key = revision number of file (due to compression / -DataRetention-), like R00001, R00002 and so on. |
| ARCCore.BaseAttributeP | ARCCore | Enum | Describes class -BaseAttribute-. |
| ARCCore.BaseAttributeP.Description | ARCCore | EnumMember | The description for the attribute, like this description |
| ARCCore.BaseAttributeP.LongDescription | ARCCore | EnumMember | The long (detailed) description for the attribute. |
| ARCCore.ClassAttributeP | ARCCore | Enum | Describes class -ClassAttribute-. |
| ARCCore.ClassAttributeP.AssemblyName | ARCCore | EnumMember | The assembly in which this class resides. |
| ARCCore.ClassAttributeP.ClassNamespace | ARCCore | EnumMember | The namespace for -ClassType-. |
| ARCCore.ClassAttributeP.ClassType | ARCCore | EnumMember | The actual type that we are a -ClassAttribute- for |
| ARCCore.ClassAttributeP.BaseTypes | ARCCore | EnumMember | The inheritance hierarchy for this class, starting with base type (excluding 'object').r Not set if class does not inherit any class except 'object' |
| ARCCore.ClassAttributeP.SubTypes | ARCCore | EnumMember | Direct and indirect sub types of this class. |
| ARCCore.ClassAttributeP.Interfaces | ARCCore | EnumMember | All interfaces that this class and its base classes implement |
| ARCCore.ClassAttributeP.InterfacesDirectlyImplemented | ARCCore | EnumMember | All interfaces that this class directly implements. |
| ARCCore.ClassAttributeP.CorrespondingEnumType | ARCCore | EnumMember | Only relevant when implements -IP-. |
| ARCCore.ClassAttributeP.BoilerplateCodePropertiesAndStorage | ARCCore | EnumMember | Only relevant when implements -IP- and when a -CorrespondingEnumType- is found. |
| ARCCore.ClassMemberAttributeP | ARCCore | Enum | Describes class -ClassMemberAttribute-. |
| ARCCore.ClassMemberAttributeP.DeclaringType | ARCCore | EnumMember | The actual MemberInfo.DeclaringType. |
| ARCCore.ClassMemberAttributeP.MethodName | ARCCore | EnumMember | The actual MemberInfo.Name. |
| ARCCore.ClassMemberAttributeP.MethodSignature | ARCCore | EnumMember | The actual MemberInfo.ToString. |
| ARCCore.EnumAttributeP | ARCCore | Enum | Describes class -EnumAttribute-. |
| ARCCore.EnumAttributeP.AssemblyName | ARCCore | EnumMember | The assembly in which this class resides. |
| ARCCore.EnumAttributeP.EnumNamespace | ARCCore | EnumMember | The namespace for -EnumType-. |
| ARCCore.EnumAttributeP.EnumType | ARCCore | EnumMember | The type of the enum (like type of 'CustomerP' in CustomerP.FirstName) that we are an attribute for |
| ARCCore.EnumAttributeP.AREnumType | ARCCore | EnumMember | Note that will default to -__invalid- if not explicit set. |
| ARCCore.EnumAttributeP.CorrespondingClass | ARCCore | EnumMember | Only relevant when -PropertyKeyEnum-. |
| ARCCore.EnumMemberAttributeP | ARCCore | Enum | Describes class -EnumMemberAttribute-. |
| ARCCore.EnumMemberAttributeP.EnumType | ARCCore | EnumMember | The type of the enum (like type of 'CustomerP' in CustomerP.FirstName) that we are an attribute for |
| ARCCore.EnumMemberAttributeP.EnumMember | ARCCore | EnumMember | The actual enum member / enum value (like 'Firstname' in CustomerP.FirstName) that we are an attribute for |
| ARCCore.ARComponents | ARCCore | Enum | Contains short descriptions of the different 'official' AgoRapide components. |
| ARCCore.ARComponents.ARCCore | ARCCore | EnumMember | A necessary library (.DLL in Windows terms) that every -ARNodeType- should link to. |
| ARCCore.ARComponents.ARADB | ARCCore | EnumMember | An application constituting the full functionality of a -CoreDB- (linking to -ARCCore-). |
| ARCCore.ARComponents.ARAClient | ARCCore | EnumMember | A template application for a -Client- (linking to -ARCCore-). |
| ARCCore.PKLogAttribute.DoNotLogAtAll | ARCCore | ClassMember | See -DoNotLogAtAll-. |
| ARCCore.PKLogAttribute.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.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.PKTypeAttribute | ARCCore | Class | Contains the most basic essential information about a property key, like its description, -Type-, -Cardinality-, -IsObligatory- and -DefaultValue-. |
| ARCCore.PKTypeAttribute.Type | ARCCore | ClassMember | See -Type-. |
| ARCCore.PKTypeAttribute.Cardinality | ARCCore | ClassMember | See -Cardinality-. |
| ARCCore.PKTypeAttribute.DefaultValue | ARCCore | ClassMember | See -DefaultValue-. |
| ARCCore.PKTypeAttribute.IsObligatory | ARCCore | ClassMember | See -IsObligatory-. |
Generated 2025-11-07 22:25:04.712 UTC