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

124 items

DocFragIdAssemblyDocFragTypeDescription.FirstLine()
ARCCore.EnumMemberAttribute.TryRemovePARCCoreClassMemberShould probably never be used.
ARCCore.EnumAttribute.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.EnumMemberAttribute.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.IPAttributeARCCoreClassDescribes -IP- classes (describes at class-level)
ARCCore.Extensions.ToStringDBARCCoreClassMemberGives the minimum representation of type as string suitable for later reconstruction by -GetType-.
ARCCore.CardinalityExtensionsARCCoreClass 
ARCCore.Extensions.ForEachARCCoreClassMemberUseful when we want to write collection.ForEach( ... ) instead of
ARCCore.Extensions.ToStringShortARCCoreClassMemberReturns a shorter representation than -ToStringDB-.
ARCCore.Extensions.KeysAsStringARCCoreClassMemberGives a compressed overview of keys in a dictionary. Helpful for building exception messages.
ARCCore.Extensions.ToStringVeryShortARCCoreClassMemberReturns same as -ToStringShort- but without any generics information at all.
ARCCore.Extensions.GetValueARCCoreClassMemberGives better error messages when reading value from directory if key does not exist
ARCCore.Extensions.UseARCCoreClassMemberConvenience 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.Extensions.ResultARCCoreClassMemberReturns heading plus return-value of function (calls function). If function == null then empty string is returned
ARCCore.Extensions.AddValueARCCoreClassMemberGives better error messages compared to 'original' Add when adding a value to a directory if key already exists
ARCCore.Extensions.ToStringDateAndTimeARCCoreClassMemberUses format 'yyyy-MM-dd HH:mm:ss.fff'.
ARCCore.Extensions.SingleARCCoreClassMemberSame as inbuilt LINQ's Single except that gives a more friendly exception message
ARCCore.IKARCCoreClassIK = Interface Key / Index key. Key used to lookup 'inside' an instance of -IP-.
ARCCore.Extensions.SingleOrDefaultARCCoreClassMemberSame as inbuilt LINQ's SingleOrDefault except that gives a more friendly exception message
ARCCore.IP.TryGetPVARCCoreClassMemberGets a single property's value for the given property key.
ARCCore.IKCodedARCCoreClassUnderstands coded and unencoded variants of -IK-.
ARCCore.IKIP.AssertTypeIntegrityARCCoreClassMemberSee -TryAssertTypeIntegrity- for documentation.
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.IKCoded.FromEncodedARCCoreClassMemberNote how uses instance cache if already exists there.
ARCCore.IKIP.TryAssertTypeIntegrityARCCoreClassMemberAsserts that value is of correct type as specified by the key.
ARCCore.IP.AllIPDerivedTypesARCCoreClassMemberAll relevant -IP--derived types for the whole application.
ARCCore.IKCoded.TryEncodeARCCoreClassMemberReturns a string containing only characters in -AllowedEncodedCharacters-.
ARCCore.IKCoded.FromCacheEncodedARCCoreClassMemberReduces number of objects generated by caching those known to be within a limited range
ARCCore.IP.AllIPDerivedTypesWithPKEnumARCCoreClassMemberAll relevant -IP--derived types for the whole application for which the also is defined a -PropertyKeyEnum-.
ARCCore.IKDate.op_EqualityARCCoreClassMemberIt is quite natural in the code to write code like "if (a.CustomerId == b.CustomerId)", therefore the need to implement == and != operators here.
ARCCore.IKCoded.FromCacheUnencodedARCCoreClassMemberReduces number of objects generated by caching those known to be within a limited range
ARCCore.IP.AllIPDerivedTypesWithPKEnumApplicationSpecificARCCoreClassMemberAll relevant -IP--derived types for the -ApplicationSpecificCode- part of the application for which also is defined a -PropertyKeyEnum-.
ARCCore.IKDate.EnrichKeyARCCoreClassMember'Implementing' -ITypeDescriber-.
ARCCore.IKCoded.AllowedEncodedCharactersARCCoreClassMemberThe character set 'A...Za...z0...9-_().,='.
ARCCore.ICreatedARCCoreClassA dummy interface signifying that implementing class has the ability to store (in-memory) metadata -Created-
ARCCore.IKString.FromStringARCCoreClassMemberNote how uses instance cache if already exists there
ARCCore.IKDateARCCoreClassA more memory efficient alternative to -IKString- (together with -IKLong-).
ARCCore.PConcurrent.ToStringARCCoreClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.IKString.op_EqualityARCCoreClassMemberIt is quite natural in the code to write code like "if (a.CustomerId == b.CustomerId)", therefore the need to implement == and != operators here.
ARCCore.IKLong.op_EqualityARCCoreClassMemberIt is quite natural in the code to write code like "if (a.CustomerId == b.CustomerId)", therefore the need to implement == and != operators here.
ARCCore.PExact<TEnumType>ARCCoreClassVery -MemoryConsumption- efficient alternative to -PRich-.
ARCCore.IKType.ToStringARCCoreClassMemberCaching is supposed to be useful because may be called quite often.
ARCCore.IKLong.EnrichKeyARCCoreClassMember'Implementing' -ITypeDescriber-.
ARCCore.PExact<TEnumType>.SetPVDirectARCCoreClassMemberHigh performance alternative to -TrySetP-, accessing -Storage- more direct.
ARCCore.ITypeDescriberARCCoreClassProvides a standardized mechanism for describing single-property values (like 'PhoneNumber' of 'Customer' for instance).
ARCCore.IKStringARCCoreClassIndex key for any general id, like primary-key or sequence-number or similar.
ARCCore.PExact<TEnumType>.GetPVDirectARCCoreClassMemberHigh performance alternative to -TryGetP-, accessing -Storage- more direct.
ARCCore.ITypeDescriber.GetSyntaxHelpARCCoreClassMemberEnables explanation of syntax in different contexts from one source:
ARCCore.IKString.FromCacheARCCoreClassMemberReduces number of objects generated by caching those known to be within a limited range
ARCCore.PExact<TEnumType>.TryGetPVDirectARCCoreClassMemberHigh performance alternative to -TryGetP-, accessing -Storage- more direct.
ARCCore.ParseResultARCCoreClassNOTE: Concept is very old, from the dark ages of AgoRapide's very first inception. There might be room for improvement.
ARCCore.PKARCCoreClassPK = AgoRapide PropertyKey.
ARCCore.PExact<TEnumType>.ToStringARCCoreClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.PK.TryCleanValidateAndParseARCCoreClassMemberCleans and parses the value according to specifications for this property key.
ARCCore.PK.TryGetEnumARCCoreClassMemberNote 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.PExact<TEnumType>..ctorARCCoreClassMemberSet capacity to the number of members in the -PropertyKeyEnum- for this class (minus the __invalid-value)
ARCCore.PK.PackParseResultForStorageInEntityObjectARCCoreClassMemberPacks result of parsing into a -IP--derived class, suitable for sending to -AddOrUpdateP-.
ARCCore.PK.TryGetVARCCoreClassMemberOnly type of PK, string or type of __enum is allowed to ask for (as TRequest generic type parameter).
ARCCore.PExact<TEnumType>.StorageARCCoreClassMemberUses int-value of -__enum- minus 1 as index.
ARCCore.PK.PackObjectForStorageInEntityObjectARCCoreClassMemberSee -PackParseResultForStorageInEntityObject- for documentation.
ARCCore.PK.GetAARCCoreClassMemberConvenience method for easy access to -BasePKAttribute- with corresponding explaining exception if fails
ARCCore.PReadOnlyARCCoreClassExperimental (from Feb 2022) class suitable for classes that do not need to be deserialized, or to accept write requests through -PropertyAccess-.
ARCCore.PK.FromEnumARCCoreClassMemberReturns the corresponding -PK- instance from the given -PropertyKeyEnum-.
ARCCore.PK.TryGetFromTypeAndFieldName Overload3ARCCoreClassMemberReturns property key based on type and field name.
ARCCore.PRichARCCoreClassFully flexible storage. Can store anything. Typical inherited for entity representations like 'Customer' or 'Order'.
ARCCore.PK.EqualsARCCoreClassMemberNote 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.PK.TryGetFromTypeAndFieldName Overload2ARCCoreClassMemberReturns property key based on type and field name.
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.PK.TryGetPARCCoreClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCCore.PK.TryGetFromTypeAndFieldName Overload1ARCCoreClassMemberReturns property key based on type and field name.
ARCCore.PValue<T>..ctorARCCoreClassMemberNote how this class does not have a parameter-less constructor (unlike all other -IP--derived classes in AgoRapide)
ARCCore.PK..ctorARCCoreClassMemberConstructor with 'object _enum' is necessary in order for ToString to work.
ARCCore.PK.GetAllPKForEntityTypeARCCoreClassMemberReturns all property keys relevant for the given entity type,
ARCCore.PValueEmptyARCCoreClassRepresents the 'no value'.
ARCCore.PK.TypeARCCoreClassMemberReturns type from -PKTypeAttribute-'s -Type-.
ARCCore.PK.CardinalityARCCoreClassMemberReturns cardinality from -PKTypeAttribute-'s -Cardinality-.
ARCCore.PValueEmpty.TrySetPARCCoreClassMemberNOTE: -TryStore- is explicit aware that -PValue- and -PValueEmpty-
ARCCore.PKHTMLAttribute.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.PK.CorrespondingClassARCCoreClassMemberReturns -CorrespondingClass- based on -__enum-.
ARCCore.PValueEmpty.ToPropertyStreamARCCoreClassMemberTypicall return value could be something like
ARCCore.IHTMLEncoderARCCoreClassPseudo-interface signifying that implementing class has a static metod called 'Encode' for encoding a string to HTML.
ARCCore.PK.ValidatorAndParserARCCoreClassMemberValidates and parses a value.
ARCCore.ActualConnectionARCCoreClassThe actual connection, its internal state, queue for sending and so on.
ARCCore.PKLogAttributeARCCoreClassExplains how logging of changes to a property should be done.
ARCCore.PK.CleanerARCCoreClassMemberCleanup of values, to be used before value is attempted validated.
ARCCore.ActualConnection..ctorARCCoreClassMemberNote parameter-less constructor as desired for all classes inheriting -IP-.
ARCCore.PKLogAttribute.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.EncodeARCCoreClassMemberEncodes the given string to HTML format through the static method implemented in class -Encoder-.
ARCCore.MonkeyWrenchARCCoreClassDescribes level of 'spanner-throwing' this connection shall contibute with
ARCCore.PKTypeAttribute.StandardValidatorAndParserARCCoreClassMemberReturns validator and parser for well known types like string, int, long, bool, DateTime, TimeSpan, Type, Uri.
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.ClientUpdatePositionARCCoreClassDescribes from WHERE (from WHEN) in the historic -PropertyStream- new data is to be returned.
ARCCore.PKTypeAttribute.StandardCleanerARCCoreClassMemberReturns a cleaner for well known types like bool
ARCCore.PKHTMLAttribute.TryRemovePARCCoreClassMemberShould probably never be used.
ARCCore.ClientUpdatePosition.FilenameARCCoreClassMemberFilename like '2020-04-03 08:42:22_R001'
ARCCore.PKTypeAttribute.TryRemovePARCCoreClassMemberShould probably never be used.
ARCCore.PKHTMLAttribute.EncoderARCCoreClassMemberSee -Encoder-.
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.PKTypeAttribute.TypeARCCoreClassMemberSee -Type-.
ARCCore.PKRelAttribute.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.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.IPARCCoreClassIP = IProperty.
ARCCore.PKRelAttribute.TryRemovePARCCoreClassMemberShould probably never be used.
ARCCore.PropertyStreamLine.DecodeARCCoreClassMemberDecodes string as encoded by -EncodeKeyPart- or -EncodeValuePart-.
ARCCore.IP.TryGetV Overload2ARCCoreClassMemberThe actual value of the property. Mostly relevant for single-value properties like -PValue-.
ARCCore.PKRelAttribute.ForeignEntityARCCoreClassMemberSee -ForeignEntity-.
ARCCore.PropertyStreamLine.TryParseDirectToIPARCCoreClassMemberParses a series of -PropertyStreamLine- directly to the given type of -IP-.
ARCCore.IP.IncARCCoreClassMemberIncrements given property key by 1. Sets to 1 if not found. Uses long, not integer.
ARCCore.PKRelAttribute.OppositeTermARCCoreClassMemberSee -OppositeTerm-.
ARCCore.PropertyStreamLine.TryParseDirectToPropertyARCCoreClassMemberParses direct to a given property value.
ARCCore.IP.DecARCCoreClassMemberDecrements given property key by 1. Sets to -1 if not found. Uses long, not integer.
ARCCore.PKTypeAttribute.CardinalityARCCoreClassMemberSee -Cardinality-.
ARCCore.PropertyStreamLine.ParseAndStoreARCCoreClassMemberNote that throws exception if -TryParseAndStore- fails.
ARCCore.IP.ToPropertyStreamARCCoreClassMemberTurns object into a -PropertyStream-
ARCCore.PKTypeAttribute.DefaultValueARCCoreClassMemberSee -DefaultValue-.
ARCCore.PropertyStreamLineParsed.TryParseARCCoreClassMemberGenerate list of <(IK key, Type valueType)> together with value from value part.
ARCCore.IP.ToJSONSerializeableARCCoreClassMemberPrepares the data into a format acceptable for System.Text.Json.JsonSerializer.Serialize.
ARCCore.PKTypeAttribute.IsObligatoryARCCoreClassMemberSee -IsObligatory-.
ARCCore.PropertyStreamLineParsed.IsCommentARCCoreClassMemberSignifies that property stream line given for parsing started with '//' (two forward slashes).
ARCCore.IP.GetValueForJSONSerializerARCCoreClassMemberPractical approach to serializing of -IP- based values to JSON.
ARCCore.PKTypeAttribute.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.PropertyStreamLineParsed.KeysARCCoreClassMemberThe keys part of the -PropertyStreamLine-, that is, everything before ' = '.
ARCCore.IP.TrySetPARCCoreClassMemberSet property regardless of whether exists or not.
ARCCore.IP.InitializeARCCoreClassMemberNote that has a default implementation (doing nothing).
ARCCore.PropertyStreamLineParsed.ValueARCCoreClassMemberThe original (non-parsed, non-validated)) value part of the -PropertyStreamLine-, that is, everything after ' = '.

Generated 2025-10-02 20:02:53.178 UTC