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

192 items

DocFragIdAssemblyDocFragTypeDescription.FirstLine()
ARCCore.EnumMemberAttribute.TryRemovePARCCoreClassMemberShould probably never be used.
ARCCore.PKTypeAttributeP.CardinalityARCCoreEnumMemberDescribes how multiple instances of a property is supposed to be handled.
ARCQuery.Extensions.TryGetPARCQueryClassMemberSame functionality as -TryGetP- but understands the concept of -CompoundKey-.
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.PKTypeAttributeP.IsObligatoryARCCoreEnumMemberTrue means value is obligatory.
ARCQuery.FunctionKeyAggregateARCQueryClassOperates over a collection of properties.
ARCCore.IPAttributeARCCoreClassDescribes -IP- classes (describes at class-level)
ARCCore.PKTypeAttributeP.BoilerplateCodePropertiesARCCoreEnumMemberAutomatically generated boilerplate code that implements traditional setters and getters for this key.
ARCQuery.FunctionKeyAggregate.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCCore.CardinalityExtensionsARCCoreClass 
ARCCore.PPARCCoreEnumDescribes meta data for any class (property) implementing -IP-.
ARCQuery.FunctionKeyAggregateAvgARCQueryClassCalculates the average of the given properties.
ARCCore.CardinalityExtensions.IsMultipleARCCoreClassMemberReturns TRUE if given cardinality implies that multiple items are stored simultaneously in a typical in-memory data storage.
ARCCore.PP.CreatedARCCoreEnumMemberTimestamp when property was created in database.
ARCQuery.FunctionKeyAggregateAvg.SyntaxHelpARCQueryClassMember'Avg()'
ARCCore.ExtensionsARCCoreClassContains a few general nice to have extensions methods.
ARCCore.PP.CidARCCoreEnumMemberCreator id (entity which created this property).
ARCQuery.FunctionKeyAggregateCountARCQueryClassCounts the number of properties found.
ARCCore.Extensions.ToStringShortARCCoreClassMemberReturns a shorter representation than -ToStringDB-.
ARCCore.PP.ValueARCCoreEnumMemberThe actual value.
ARCQuery.FunctionKeyAggregateCount.SyntaxHelpARCQueryClassMember'Count()'
ARCCore.Extensions.ToStringVeryShortARCCoreClassMemberReturns same as -ToStringShort- but without any generics information at all.
ARCCore.PP.ValidARCCoreEnumMemberTimestamp when property was last known to be (still) valid
ARCQuery.FunctionKeyAggregateDistinctARCQueryClassReturns a list of the distinct values of the given properties.
ARCCore.Extensions.ToStringDBARCCoreClassMemberGives the minimum representation of type as string suitable for later reconstruction by -GetType-.
ARCCore.PP.VidARCCoreEnumMemberValidator id, that is entity which set -Valid- for this property.
ARCQuery.FunctionKeyAggregateDistinct.SyntaxHelpARCQueryClassMember'Distinct()'
ARCCore.Extensions.ForEachARCCoreClassMemberUseful when we want to write collection.ForEach( ... ) instead of
ARCCore.PP.InvalidARCCoreEnumMemberTimestamp when property was invalidated / 'deleted'.
ARCQuery.FunctionKeyAggregateJoinARCQueryClassJoins the given list of properties into a single property.
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.PP.IidARCCoreEnumMemberInvalidator id, that is entity which set -Invalid- for this property (or removed / 'undid' the invalidation by setting the value to '0001-01-01').
ARCQuery.FunctionKeyAggregateJoin.SyntaxHelpARCQueryClassMember'Join()'
ARCCore.Extensions.AddValueARCCoreClassMemberGives better error messages compared to 'original' Add when adding a value to a directory if key already exists
ARCCore.PP.ExceptionTextARCCoreEnumMemberGeneral property for logging of exceptions, usually set through -HandleException-.
ARCQuery.FunctionKeyAggregateMaxARCQueryClassCalculates the maximum value of the given properties.
ARCCore.Extensions.KeysAsStringARCCoreClassMemberGives a compressed overview of keys in a dictionary. Helpful for building exception messages.
ARCCore.PConcurrentPARCCoreEnumDescribes class -PConcurrent-.
ARCQuery.FunctionKeyAggregateMax.SyntaxHelpARCQueryClassMember'Max()'
ARCCore.Extensions.GetValueARCCoreClassMemberGives better error messages when reading value from directory if key does not exist
ARCCore.PConcurrentP.HeartbeatARCCoreEnumMember 
ARCQuery.FunctionKeyAggregateMinARCQueryClassCalculates the minimum value of the given properties.
ARCCore.Extensions.SingleARCCoreClassMemberSame as inbuilt LINQ's Single except that gives a more friendly exception message
ARCCore.ActualConnectionPARCCoreEnumDescribes class -ActualConnection-.
ARCQuery.FunctionKeyAggregateMin.SyntaxHelpARCQueryClassMember'Min()'
ARCCore.Extensions.SingleOrDefaultARCCoreClassMemberSame as inbuilt LINQ's SingleOrDefault except that gives a more friendly exception message
ARCCore.ActualConnectionP.IdARCCoreEnumMemberWhen connection is used with-StreamProcessor-, the Id should be the same as the key used in the incoming / outgoing connection dictionary collection.
ARCQuery.FunctionKeyAggregateSingleARCQueryClassEnsures that the given list of properties contains only a single item and returns that item.
ARCCore.Extensions.ResultARCCoreClassMemberReturns heading plus return-value of function (calls function). If function == null then empty string is returned
ARCCore.ActualConnectionP.ConnectionInstructionARCCoreEnumMemberOnly relevant when we are an -Outgoing-.
ARCQuery.FunctionKeyAggregateSingle.SyntaxHelpARCQueryClassMember'Single()'
ARCCore.Extensions.ToStringDateAndTimeARCCoreClassMemberUses format 'yyyy-MM-dd HH:mm:ss.fff'.
ARCCore.ActualConnectionP.ConnectionDirectionARCCoreEnumMember 
ARCQuery.FunctionKeyAggregateSumARCQueryClassSums the given properties.
ARCCore.Extensions.ToStringWithMSARCCoreClassMemberUses either format 'd\.hh\:mm\:ss\.fff' or 'hh\:mm\:ss\.fff' depending on TotalHours >=24 hours or not.
ARCCore.ActualConnectionP.CountReceiveMessageARCCoreEnumMember 
ARCQuery.FunctionKeyAggregateSum.SyntaxHelpARCQueryClassMember'Sum()'
ARCCore.IKIPARCCoreClassContainer class for key (-IK-), and value (-IP-).
ARCCore.ActualConnectionP.CountSendMessageARCCoreEnumMember 
ARCQuery.FunctionKeyARCQueryClassExtracts data from an already existing value like extracting Year from a DateTime in 'Created.Year()'.
ARCCore.IKIP.AssertTypeIntegrityARCCoreClassMemberSee -TryAssertTypeIntegrity- for documentation.
ARCCore.ActualConnectionP.ClientUpdatePositionARCCoreEnumMemberNote how this is stored both as -ClientUpdatePosition- (on the client side) and -ClientUpdatePosition- (on the server side).
ARCQuery.FunctionKey.TryGetP Overload1ARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCCore.IKIP.TryAssertTypeIntegrityARCCoreClassMemberAsserts that value is of correct type as specified by the key.
ARCCore.ActualConnectionP.SubscriptionAsRequestedByClientARCCoreEnumMemberOriginates from -Subscription-.
ARCQuery.FunctionKey.AddParserARCQueryClassMemberAdds a -ApplicationSpecificCode- parser.
ARCCore.IKARCCoreClassIK = Interface Key / Index key. Key used to lookup 'inside' an instance of -IP-.
ARCCore.ActualConnectionP.ClosingReasonARCCoreEnumMemberReason why this connection was closed
ARCQuery.FunctionKey.TryParseARCQueryClassMemberFind parsers from -Parsers- based on first word in query.
ARCCore.IKCodedARCCoreClassUnderstands coded and unencoded variants of -IK-.
ARCCore.ActualConnectionP.IsErrorConditionARCCoreEnumMemberSome kind of error condition has occured regarding data going back and forth, but the TCP/IP connection itself is probably sound.
ARCQuery.FunctionKey.TryParseSingleWordARCQueryClassMemberRecommended parser to use for functions without parameters.
ARCCore.IKCoded.EnrichKeyARCCoreClassMember'Implementing' -ITypeDescriber-.
ARCCore.ActualConnectionP.ErrorConditionDataARCCoreEnumMemberDetailed explanation about -IsErrorCondition-
ARCQuery.FunctionKey.TryGetP Overload2ARCQueryClassMemberOverload which will try to call -TryGetV- with generic type parameter, and if that does not succeed will try to call the optional 'tryParser'.
ARCCore.IKCoded.TryCheckValidEncodedValueARCCoreClassMemberChecks if encoded value is valid.
ARCCore.ActualConnectionP.UnderClosureARCCoreEnumMemberSet to TRUE if to be closed and reinitialized.
ARCQuery.FunctionKey.ParsersARCQueryClassMemberInstances of all the relevant sub classes of -FunctionKey-.
ARCCore.IKCoded.FromCacheEncodedARCCoreClassMemberReduces number of objects generated by caching those known to be within a limited range
ARCCore.ActualConnectionP.MonkeyWrenchARCCoreEnumMember 
ARCQuery.FunctionKeyAbsARCQueryClassReturns the absolute value of field, like 4 for '-4'.
ARCCore.IKCoded.FromCacheUnencodedARCCoreClassMemberReduces number of objects generated by caching those known to be within a limited range
ARCCore.ActualConnectionP.PartnerIPAddressARCCoreEnumMemberTODO: Use more strongly typing for this.
ARCQuery.FunctionKeyAbs.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCCore.IKCoded.FromEncodedARCCoreClassMemberNote how uses instance cache if already exists there.
ARCCore.ConnectionInstructionPARCCoreEnumDescribes class -ConnectionInstruction-.
ARCQuery.FunctionKeyAbs.SyntaxHelpARCQueryClassMember'Abs()'
ARCCore.IKCoded.TryEncodeARCCoreClassMemberReturns a string containing only characters in -AllowedEncodedCharacters-.
ARCCore.ConnectionInstructionP.ClientIdARCCoreEnumMemberThe 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.
ARCQuery.FunctionKeyDateARCQueryClassFormats a date without time component.
ARCCore.IKCoded.ToStringARCCoreClassMemberReturns -Encoded-'s string representation.
ARCCore.ConnectionInstructionP.ServerHostNameARCCoreEnumMemberThe host (DNS or IP-address) for which to connect.
ARCQuery.FunctionKeyDate.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCCore.IKCoded.EncodedARCCoreClassMemberThis string value can be used directly in folder names, file names and HTTP URL's without any further encoding being necessary.
ARCCore.ConnectionInstructionP.ServerPortNoARCCoreEnumMemberThe port number for which to connect.
ARCQuery.FunctionKeyDate.SyntaxHelpARCQueryClassMember'Date()'
ARCCore.IKCoded.AllowedEncodedCharactersARCCoreClassMemberThe character set 'A...Za...z0...9-_().,='.
ARCCore.ConnectionInstructionP.ConnectionIdARCCoreEnumMemberUsually a combination of -ClientId-, -ServerHostName- and -ServerPortNo-.
ARCQuery.FunctionKeyDayOfWeekARCQueryClassExtracts DayOfWeek from field like 'Monday', 'Tuesday' and so on.
ARCCore.IKDateARCCoreClassA more memory efficient alternative to -IKString- (together with -IKLong-).
ARCCore.ConnectionInstructionP.DataTransferDirectionARCCoreEnumMember 
ARCQuery.FunctionKeyDayOfWeek.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
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.ConnectionInstructionP.SubscriptionARCCoreEnumMemberThe actual subscripton. This is what the connecting party / (downstream) client would send over its TCP/IP connection to the (upstream) server.
ARCQuery.FunctionKeyDayOfWeek.SyntaxHelpARCQueryClassMember'DayOfWeek()'
ARCCore.IKDate.EnrichKeyARCCoreClassMember'Implementing' -ITypeDescriber-.
ARCCore.ConnectionInstructionP.MultipleConnectionUsageARCCoreEnumMember 
ARCQuery.FunctionKeyDoubleARCQueryClassConverts an integer to a double (decimal value).
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.ConnectionInstructionP.ShardingARCCoreEnumMember 
ARCQuery.FunctionKeyTotalMinutesARCQueryClassConverts a timespan to total minutes (as an integer).
ARCCore.IKLongARCCoreClassA more memory efficient alternative to -IKString-.
ARCCore.MultipleConnectionUsageARCCoreEnumEnables fault-tolerance by describing use of multiple connections
ARCQuery.FunctionKeyTotalMinutes.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
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.MultipleConnectionUsage.AdminARCCoreEnumMemberConnection is a special administrative connection to a central 'command-and-control' server which instructs which connections to make.
ARCQuery.FunctionKeyTotalMinutes.SyntaxHelpARCQueryClassMember'TotalMinutes()'
ARCCore.IKLong.EnrichKeyARCCoreClassMember'Implementing' -ITypeDescriber-.
ARCCore.MultipleConnectionUsage.RoundRobinARCCoreEnumMemberThis connection to be used in a turn based system, together with other connections with -RoundRobin-.
ARCQuery.FunctionKeyTypeARCQueryClassReturns the type of a property.
ARCCore.IKStringARCCoreClassIndex key for any general id, like primary-key or sequence-number or similar.
ARCCore.MultipleConnectionUsage.SimultaneousARCCoreEnumMemberThis connection to be used simultaneously with other connections with -Simultaneous-
ARCQuery.FunctionKeyType.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCCore.IKString.FromCacheARCCoreClassMemberReduces number of objects generated by caching those known to be within a limited range
ARCCore.StreamProcessorPARCCoreEnumDescribes class -StreamProcessor-.
ARCQuery.FunctionKeyType.SyntaxHelpARCQueryClassMember'Type()'
ARCCore.IKString.FromStringARCCoreClassMemberNote how uses instance cache if already exists there
ARCCore.StreamProcessorP.LocalStorageFolderARCCoreEnumMemberThe local path to which new properties are stored. Should NOT end with any trailing DirectorySeparatorChar
ARCQuery.FunctionKeyWeekARCQueryClassExtract week-number from field according to ISO 8601.
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.StreamProcessorP.IndividualStorageFileSizeARCCoreEnumMemberMax size (in bytes) for a single storage file before a new file is created by call to -StreamProcessor.CreateNewStorageFile-.
ARCQuery.FunctionKeyWeek.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCCore.IKString.EnrichKeyARCCoreClassMember'Implementing' -ITypeDescriber-.
ARCCore.StreamProcessorP.CurrentlyInitializingARCCoreEnumMemberSet to TRUE at initialization (signals for instance -ReceiveAndDistribute- that it can only queue messages, not process them).
ARCQuery.FunctionKeyWeek.SyntaxHelpARCQueryClassMember'Week()'
ARCCore.IKTypeARCCoreClassIndex key used when storing a collection of a given type, like 'Customer'.
ARCCore.StreamProcessorP.ClientUpdatePositionPathARCCoreEnumMemberComplete path to file containing -ClientUpdatePosition-.
ARCQuery.FunctionKeyYearARCQueryClassExtracts Year-component from field.
ARCCore.IKType.ToStringARCCoreClassMemberCaching is supposed to be useful because may be called quite often.
ARCCore.StreamProcessorP.ClientUpdatePositionARCCoreEnumMemberNote how this is stored both as -ClientUpdatePosition- (on the client side) and -ClientUpdatePosition- (on the server side).
ARCQuery.FunctionKeyYear.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCCore.ITypeDescriberARCCoreClassProvides a standardized mechanism for describing single-property values (like 'PhoneNumber' of 'Customer' for instance).
ARCCore.StreamProcessorP.IncomingConnectionsPortNoARCCoreEnumMemberIf not set, then class will not listen for incoming connections (meaning that our application is probably a -Client-).
ARCQuery.FunctionKeyYear.SyntaxHelpARCQueryClassMember'Year()'
ARCCore.ITypeDescriber.GetSyntaxHelpARCCoreClassMemberEnables explanation of syntax in different contexts from one source:
ARCCore.StreamProcessorP.UnderClosureARCCoreEnumMemberSet to TRUE if to be closed, whenever an exception occurs or when class goes out of scope
ARCQuery.FunctionKeyYearMonthARCQueryClassExtracts Year + Month component from field like 2020-06.
ARCCore.ParseResultARCCoreClassNOTE: Concept is very old, from the dark ages of AgoRapide's very first inception. There might be room for improvement.
ARCCore.StreamProcessorP.WriteToConsoleARCCoreEnumMemberIf true then incoming data (from other nodes will be written to console.
ARCQuery.FunctionKeyYearMonth.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCCore.ParseResult.ResultARCCoreClassMemberWill be null if ErrorResponse is set.
ARCCore.StreamProcessorP.TimestampARCCoreEnumMemberThe timestamp inserted at regular intervals in the -PropertyStream- according to -TimestampResolution-.
ARCQuery.FunctionKeyYearMonth.SyntaxHelpARCQueryClassMember'YearMonth()'
ARCCore.ParseResult.ErrorResponseARCCoreClassMemberWill be null if Result is set
ARCCore.StreamProcessorP.TimestampIsOldARCCoreEnumMemberA warning sent by -StreamProcessor- to -OutsideLocalReceiver- when it knows that data as served is out of date.
ARCQuery.FunctionKeyYearQuarterARCQueryClassExtracts Year + Quarter component from field like 2020Q1.
ARCCore.PKARCCoreClassPK = AgoRapide PropertyKey.
ARCCore.StreamProcessorP.TimestampResolutionARCCoreEnumMemberThe time interval between each timestamp update in the -PropertyStream-.
ARCQuery.FunctionKeyYearQuarter.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
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.StreamProcessorP.DoNotStoreLocallyARCCoreEnumMemberFor -Client-, incoming data (as received from a -Outgoing-) is possible to store BOTH to disk, AND to (normally) a -PRich-.
ARCQuery.FunctionKeyYearQuarter.SyntaxHelpARCQueryClassMember'YearQuarter()'
ARCCore.PK.TryGetVARCCoreClassMemberOnly type of PK, string or type of __enum is allowed to ask for (as TRequest generic type parameter).
ARCCore.StreamProcessorP.DoNotStoreLocalOriginLocallyARCCoreEnumMemberMeans 'do not store local origin locally but wait until it gets confirmed by core storage'.
ARCQuery.FunctionKeyYearWeekARCQueryClassExtract year and week number from field according to ISO 8601 like '2021-51'
ARCCore.PK.GetAARCCoreClassMemberConvenience method for easy access to -BasePKAttribute- with corresponding explaining exception if fails
ARCCore.StreamProcessorP.CacheDiskWritesARCCoreEnumMemberIf TRUE then will write the -PropertyStream- to disk in bigger chunks, thereby increasing performance.
ARCQuery.FunctionKeyYearWeek.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCCore.PK.TryGetAARCCoreClassMemberConvenience method for easy access to -BasePKAttribute-.
ARCCore.StreamProcessorP.CopyFileStructureFromCoreARCCoreEnumMemberIf TRUE, will copy the exact file structure (through information given in -ClientUpdatePosition-).
ARCQuery.FunctionKeyYearWeek.SyntaxHelpARCQueryClassMember'YearWeek()'
ARCCore.PK.ModifyCleanerAndValidatorAndParserForCardinalityARCCoreClassMemberCalled from -Initialize- after _cleaner and _validatorAndParser have been set.
ARCCore.StreamProcessorP.CountIncomingConnectionsARCCoreEnumMember 
ARCQuery.NewKeyARCQueryClassA function creating new keys (new fields) that can be used against all object types in AgoRapide (against all entities).
ARCCore.PK.ToStringARCCoreClassMemberCaching is supposed to be useful because may be called quite often.
ARCCore.StreamProcessorP.CountOutgoingConnectionsARCCoreEnumMember 
ARCQuery.NewKey.AddParserARCQueryClassMemberAdds an -ApplicationSpecificCode- parser.
ARCCore.PK.TryValidateAndParseARCCoreClassMemberParses the value according to specifications for this property key.
ARCCore.StreamProcessorP.CountOutsideLocalReceiverARCCoreEnumMemberCount of calls to -OutsideLocalReceiver-.
ARCQuery.NewKey.TryParseARCQueryClassMemberFind parsers from -Parsers- based on first word in query.
ARCCore.PK.TryCleanValidateAndParseARCCoreClassMemberCleans and parses the value according to specifications for this property key.
ARCCore.StreamProcessorP.CountReceiveLocalOriginARCCoreEnumMemberCount of -PropertyStreamLine- with -HasLocalOrigin-.
ARCQuery.NewKey.TryParseSingleWordARCQueryClassMemberRecommended parser to use for functions without parameters.
ARCCore.PK.PackParseResultForStorageInEntityObjectARCCoreClassMemberPacks result of parsing into a -IP--derived class, suitable for sending to -AddOrUpdateP-.
ARCCore.StreamProcessorP.CountReceiveNonLocalOriginARCCoreEnumMemberCount of -PropertyStreamLine- not with -HasLocalOrigin-.
ARCQuery.NewKey.TryGetPARCQueryClassMemberThe outwards facing executor, understanding use of -FunctionKeys-.
ARCCore.PK.PackObjectForStorageInEntityObjectARCCoreClassMemberSee -PackParseResultForStorageInEntityObject- for documentation.
ARCCore.StorageFilePARCCoreEnumDescribes class -StorageFile-.
ARCQuery.NewKey.TryGetPInternalARCQueryClassMemberThe internal executor, containing the specific functionality for how to evaluate the key.
ARCCore.PK.FromEnumARCCoreClassMemberReturns the corresponding -PK- instance from the given -PropertyKeyEnum-.
ARCCore.StorageFileP.FilenameARCCoreEnumMember 
ARCQuery.NewKey.ToStringARCQueryClassMemberThe ToString representation is the one relevant when used as key, like in -IK- or when selecting like 'SELECT {fieldName}'.

Generated 2025-12-07 02:13:26.744 UTC