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

124 items

DocFragIdAssemblyDocFragTypeDescription.FirstLine()
ARCCore.IP.LogExecuteTimeARCCoreClassMemberTimes the execution of the given function and logs details about elapsed time.
ARCCore.IP.GetKeysEqualToValueARCCoreClassMemberReturns properties which themselves again have key and value equal to the given key and value.
ARCCore.IP.IncARCCoreClassMemberIncrements given property key by 1. Sets to 1 if not found. Uses long, not integer.
ARCCore.IP.HandleExceptionARCCoreClassMemberNote that most relevant to use for -PConcurrent-.
ARCCore.IP.OnTrySetPARCCoreClassMemberEvent 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.IP.DecARCCoreClassMemberDecrements given property key by 1. Sets to -1 if not found. Uses long, not integer.
ARCCore.IP.TryParseDtrARCCoreClassMemberParses a PropertyStreamLine- beginning with -dtr-.
ARCCore.IP.TryGetPARCCoreClassMemberGets a single property for this object
ARCCore.IP.ToPropertyStreamARCCoreClassMemberTurns object into a -PropertyStream-
ARCCore.IP.TryGetV Overload1ARCCoreClassMemberThe actual 'unpacking' of the object.
ARCCore.IP.AddPARCCoreClassMemberAdds a property for this object.
ARCCore.IP.ToJSONSerializeableARCCoreClassMemberPrepares the data into a format acceptable for System.Text.Json.JsonSerializer.Serialize.
ARCCore.IP.DeepCopyARCCoreClassMemberCreates a deep copy of this object instance, that is, a copy with all new object instances (except for immutable objects).
ARCCore.IP.AddOrUpdatePARCCoreClassMemberDuplicates functionality of SetP.
ARCCore.IP.GetValueForJSONSerializerARCCoreClassMemberPractical approach to serializing of -IP- based values to JSON.
ARCCore.IP.AddPV Overload2ARCCoreClassMemberNOTE: The different AddPV / AddP overloads should only be used if you want an assertion against the
ARCCore.IP.GetOrAddPVARCCoreClassMemberGets value. If not set then value will be added
ARCCore.IP.TrySetPARCCoreClassMemberSet property regardless of whether exists or not.
ARCCore.IP.AddPV Overload1ARCCoreClassMemberAdds a property value (as a -PValue-) for this objectThrows -KeyAlreadyExistsException- when relevant.
ARCCore.IP.GetPVARCCoreClassMemberGets a single property's value for this object. Returns default value if not successful.
ARCCore.IP.ValuesARCCoreClassMemberReturns all the values (all the properties) for this instance.
ARCCore.IP.AllIPDerivedTypesWithPKEnumApplicationSpecificARCCoreClassMemberAll relevant -IP--derived types for the -ApplicationSpecificCode- part of the application for which also is defined a -PropertyKeyEnum-.
ARCCore.IP.AllIPDerivedTypesDictIKTypeARCCoreClassMemberSame as -AllIPDerivedTypesDict- except that value is -IKType-, not string.
ARCCore.IP.LoggerARCCoreClassMemberDescribes a logger.
ARCCore.IP.AllIPDerivedEntityCollectionClassesDictARCCoreClassMemberAll -IP--derived types for which is found a corresponding class with name like '{EntityType}Collection'
ARCCore.PARCCoreClass'Dummy'-class, not necessarily in use. See -PP- for more information. Created because of the concept of CorrespondingClass which is strictly enforced
ARCCore.IP.AllIPDerivedTypesARCCoreClassMemberAll relevant -IP--derived types for the whole application.
ARCCore.IP.AllIPDerivedTypesInludingGenericAndAbstractARCCoreClassMemberAll relevant -IP--derived types (except the interface -IP- itself) known to the application.
ARCCore.P.TryGetPARCCoreClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCCore.IP.AllIPDerivedTypesWithPKEnumARCCoreClassMemberAll relevant -IP--derived types for the whole application for which the also is defined a -PropertyKeyEnum-.
ARCCore.IP.AllIPDerivedTypesDictARCCoreClassMemberProvides lookup of a type in -AllIPDerivedTypes- given its string representation.
ARCCore.P.TryGetVARCCoreClassMemberNote 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.IGetKeysEqualToValueARCCoreClassInterface 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.PCollection.GetKeysEqualToValueARCCoreClassMemberReturns properties which themselves again have key and value equal to the given key and value.
ARCCore.PExact<TEnumType>.SetPVDirectARCCoreClassMemberHigh performance alternative to -TrySetP-, accessing -Storage- more direct.
ARCCore.PConcurrentARCCoreClassA (somewhat) thread-safe alternative to -PRich- which also supports -ExposingApplicationState- (through -Logger-).
ARCCore.PCollection.TryGetPARCCoreClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCCore.PExact<TEnumType>.GetPVDirectARCCoreClassMemberHigh performance alternative to -TryGetP-, accessing -Storage- more direct.
ARCCore.PConcurrent.ToStringARCCoreClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.PCollection.TryGetVARCCoreClassMemberNote 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.PExact<TEnumType>.TryGetPVDirectARCCoreClassMemberHigh performance alternative to -TryGetP-, accessing -Storage- more direct.
ARCCore.PExact<TEnumType>ARCCoreClassVery -MemoryConsumption- efficient alternative to -PRich-.
ARCCore.PCollection.ToStringARCCoreClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.PExact<TEnumType>.ToStringARCCoreClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.PValue<T>.TrySetPARCCoreClassMemberNOTE: -TryStore- is explicit aware that -PValue- and -PValueEmpty-
ARCCore.PII.TryGetPARCCoreClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCCore.IIKII.PackParseResultForStorageInIKIIARCCoreClassMemberThis method corresponds to -PackParseResultForStorageInEntityObject-.
ARCCore.PValue<T>.TryGetVARCCoreClassMemberSupports duck typing.
ARCCore.PII.ToStringARCCoreClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.IIKII.PackObjectForStorageInIKIIARCCoreClassMemberThis method corresponds to -PackObjectForStorageInEntityObject-.
ARCCore.PValue<T>.ConvertObjectToStringARCCoreClassMemberConverts object to string.
ARCCore.IPIIARCCoreClassFuture expansion, using different classes for storing, not only -PII-.
ARCCore.PReadOnlyARCCoreClassExperimental (from Feb 2022) class suitable for classes that do not need to be deserialized, or to accept write requests through -PropertyAccess-.
ARCCore.PValue<T>.ToStringARCCoreClassMemberDo no cache this value, because memory consumption would then increase significantly in your applicationj
ARCCore.IIKIIARCCoreClassRelated to -PII-, property for storing individual items
ARCCore.PRichARCCoreClassFully flexible storage. Can store anything. Typical inherited for entity representations like 'Customer' or 'Order'.
ARCCore.ClientUpdatePositionARCCoreClassDescribes from WHERE (from WHEN) in the historic -PropertyStream- new data is to be returned.
ARCCore.PValue<T>.DeepCopyARCCoreClassMemberNote that if the generic type (T) is not immutable, then what we return will not be a truly deep copy.
ARCCore.ActualConnection.SetUpToDatePositionGeneratorARCCoreClassMemberSet by -StreamProcessor-. Not used by -Client-.
ARCCore.ClientUpdatePosition.FilenameARCCoreClassMemberFilename like '2020-04-03 08:42:22_R001'
ARCCore.PValue<T>..ctorARCCoreClassMemberNote how this class does not have a parameter-less constructor (unlike all other -IP--derived classes in AgoRapide)
ARCCore.ActualConnection.InitializeOutgoingConnectionARCCoreClassMemberRelevant for -Outgoing-.
ARCCore.ClientUpdatePosition.IndexARCCoreClassMemberIndex (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.PValueEmptyARCCoreClassRepresents the 'no value'.
ARCCore.ActualConnection.CommunicateARCCoreClassMemberCommon for both -Incoming- and -Outgoing-.
ARCCore.ClientUpdatePosition.ClientDatastoreIsEmptyARCCoreClassMemberUsed 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.PValueEmpty.TrySetPARCCoreClassMemberNOTE: -TryStore- is explicit aware that -PValue- and -PValueEmpty-
ARCCore.ActualConnection.LogAndSendErrorConditionDataARCCoreClassMemberCalled when a serious error condition has been discovered and connection should be terminated.
ARCCore.ClientUpdatePosition.OnlyNewDataIsRequestedARCCoreClassMemberUsed by the subscribing client to signify that it does not care about historical data, the server may start with sending only new data.
ARCCore.PValueEmpty.ToPropertyStreamARCCoreClassMemberTypicall return value could be something like
ARCCore.ActualConnection.SendARCCoreClassMemberSends all messages in queue.
ARCCore.ClientUpdatePosition.IsGoBackARCCoreClassMemberHas to be translated by -StreamProcessor- into a concrete filename / index.
ARCCore.ActualConnectionARCCoreClassThe actual connection, its internal state, queue for sending and so on.
ARCCore.ActualConnection.ToStringARCCoreClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.ClientUpdatePosition.IsAtEndOfStreamARCCoreClassMemberNecessary in order to implement -AdHocQuery-.
ARCCore.ActualConnection.SetMyUpdatePositionGeneratorARCCoreClassMemberSet by -StreamProcessor-.
ARCCore.ActualConnection..ctorARCCoreClassMemberNote parameter-less constructor as desired for all classes inheriting -IP-.
ARCCore.ClientUpdatePosition.ClientDatastoreIsEmptyInstanceARCCoreClassMemberSee also -ClientDatastoreIsEmpty.
ARCCore.ActualConnection.SetSinglePropertyStreamReceiverARCCoreClassMemberSet by -StreamProcessor-.
ARCCore.MonkeyWrenchARCCoreClassDescribes level of 'spanner-throwing' this connection shall contibute with
ARCCore.BaseAttributeARCCoreClassInstances of this class are used as source of documentation and data for the API.
ARCCore.BasePKAttribute.InitializeARCCoreClassMemberTo 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.TryRemovePARCCoreClassMemberShould probably never be used.
ARCCore.EnumAttribute.InitializeARCCoreClassMemberTo be overridden in sub-classes, but do note that sub-classes are supposed to call base.Initialize() at end of their own initialization.
ARCCore.EnumMemberAttributeARCCoreClassDescribes an enum's value.
ARCCore.EnumMemberAttribute.TryRemovePARCCoreClassMemberShould probably never be used.
ARCCore.CardinalityExtensions.IsMultipleARCCoreClassMemberReturns TRUE if given cardinality implies that multiple items are stored simultaneously in a typical in-memory data storage.
ARCCore.Extensions.ForEachARCCoreClassMemberUseful when we want to write collection.ForEach( ... ) instead of
ARCCore.Extensions.KeysAsStringARCCoreClassMemberGives a compressed overview of keys in a dictionary. Helpful for building exception messages.
ARCCore.Extensions.GetValueARCCoreClassMemberGives better error messages when reading value from directory if key does not exist
ARCCore.IKIP.AssertTypeIntegrityARCCoreClassMemberSee -TryAssertTypeIntegrity- for documentation.
ARCCore.IKIP.TryAssertTypeIntegrityARCCoreClassMemberAsserts that value is of correct type as specified by the key.
ARCCore.IKCoded.FromCacheEncodedARCCoreClassMemberReduces number of objects generated by caching those known to be within a limited range
ARCCore.IKCoded.FromCacheUnencodedARCCoreClassMemberReduces number of objects generated by caching those known to be within a limited range
ARCCore.IKDate.ValidDateTimeFormatsARCCoreClassMemberNote: Be very careful about expanding this array. ToString must be considered, and also how Equals should work with other sub classes of IK.
ARCCore.IKLongARCCoreClassA more memory efficient alternative to -IKString-.
ARCCore.ITypeDescriber.GetSyntaxHelpARCCoreClassMemberEnables explanation of syntax in different contexts from one source:
ARCCore.ParseResultARCCoreClassNOTE: Concept is very old, from the dark ages of AgoRapide's very first inception. There might be room for improvement.
ARCCore.PK.ToStringARCCoreClassMemberCaching is supposed to be useful because may be called quite often.
ARCCore.PK.TryValidateAndParseARCCoreClassMemberParses the value according to specifications for this property key.
ARCCore.PK.GetAllPKForEntityTypeStringARCCoreClassMemberReturns all property keys relevant for the given entity type,
ARCCore.PK.BuildFromStringCacheARCCoreClassMemberBuilds the content of -_fromStringCache- and also -_allPKForEntityTypeCache-.
ARCCore.PK..ctorARCCoreClassMemberConstructor with 'object _enum' is necessary in order for ToString to work.
ARCCore.PK.TypeARCCoreClassMemberReturns type from -PKTypeAttribute-'s -Type-.
ARCCore.PKHTMLAttribute.EncodeARCCoreClassMemberEncodes the given string to HTML format through the static method implemented in class -Encoder-.
ARCCore.PKHTMLAttribute.InitializeARCCoreClassMemberTo be overridden in sub-classes, but do note that sub-classes are supposed to call base.Initialize() at end of their own initialization.
ARCCore.PKHTMLAttribute.TryRemovePARCCoreClassMemberShould probably never be used.
ARCCore.PKHTMLAttribute.EncoderARCCoreClassMemberSee -Encoder-.
ARCCore.PKRelAttribute.EnforceReferentialIntegrityARCCoreClassMemberSee -EnforceReferentialIntegrity-.
ARCCore.PKRelAttribute.IsDefaultARCCoreClassMemberDoes 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.PKTypeAttributeARCCoreClassContains the most basic essential information about a property key, like its description, -Type-, -Cardinality-, -IsObligatory- and -DefaultValue-.
ARCCore.PKTypeAttribute.InitializeARCCoreClassMemberTo be overridden in sub-classes, but do note that sub-classes are supposed to call base.Initialize() at end of their own initialization.
ARCCore.IP.InitializeARCCoreClassMemberNote that has a default implementation (doing nothing).
ARCCore.IP.AssertIntegrityARCCoreClassMemberSee -TryAssertIntegrity-.
ARCCore.IP.TryAssertIntegrityARCCoreClassMemberAsserts the integrity of this entity.
ARCCore.IP.ToStringARCCoreClassMemberThe ToString()-implementation in the classes implementing this interface is supposed to give a short concise representation of the object for debugging and logging purposes, that is, intended for human consumption. The most 'important' implementation is probably the one in -PRich- (-ToString-) because that one is often the basis for your entity classes like 'Customer', 'Order' and so on
ARCCore.IP.TryGetPVARCCoreClassMemberGets a single property's value for the given property key.
ARCCore.IP.IsValidARCCoreClassMemberNote that by default all properties are 'valid' but because of -NoRealDeletion-, we must have a mechanism for invalidating properties. This property returns FALSE if property has been invalidated and timestamp for invalidation is not '0001-01-01'.
ARCCore.IP.ItemARCCoreClassMemberOffers string-based direct indexing.
ARCCore.IP.KeysARCCoreClassMemberReturns all the keys for this instance.
ARCCore.P.ToStringARCCoreClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.ICreatedARCCoreClassA dummy interface signifying that implementing class has the ability to store (in-memory) metadata -Created-
ARCCore.PCollectionARCCoreClassA class useful for storing a collection of entities (a table in RDBMS-terms) because it implements -Indexing-.
ARCCore.PCollection.TrySetPPARCCoreClassMemberReplaces default interface method -TrySetPP-.

Generated 2026-05-05 08:04:01.822 UTC