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

125 items

DocFragIdAssemblyDocFragTypeDescription.FirstLine()
ARCCore.ClassAttributePARCCoreEnumDescribes class -ClassAttribute-.
ARCCore.ARComponents.ARAClientARCCoreEnumMemberA template application for a -Client- (linking to -ARCCore-).
ARCCore.StreamProcessorP.LocalStorageFolderARCCoreEnumMemberThe local path to which new properties are stored. Should NOT end with any trailing DirectorySeparatorChar
ARCCore.ClassAttributeP.AssemblyNameARCCoreEnumMemberThe assembly in which this class resides.
ARCCore.ARComponents.ARCDocARCCoreEnumMemberA library supporting documentation and demonstrating usage of AgoRapide.
ARCCore.StreamProcessorP.IndividualStorageFileSizeARCCoreEnumMemberMax size (in bytes) for a single storage file before a new file is created by call to -StreamProcessor.CreateNewStorageFile-.
ARCCore.PKLogAttributeP.TimeIntervalARCCoreEnumMemberSpecifies a certain time interval for which the property's value shall be sent over the -PropertyStream-.
ARCCore.PConcurrentPARCCoreEnumDescribes class -PConcurrent-.
ARCCore.StreamProcessorP.TimestampResolutionARCCoreEnumMemberThe time interval between each timestamp update in the -PropertyStream-.
ARCCore.PKRelAttributePARCCoreEnumDescribes class -PKRelAttribute-.
ARCCore.PConcurrentP.HeartbeatARCCoreEnumMember 
ARCCore.StreamProcessorP.DoNotStoreLocallyARCCoreEnumMemberFor -Client-, incoming data (as received from a -Outgoing-) is possible to store BOTH to disk, AND to (normally) a -PRich-.
ARCCore.PKRelAttributeP.ForeignEntityARCCoreEnumMemberThe type of foreign entity that this property points to.
ARCCore.ActualConnectionPARCCoreEnumDescribes class -ActualConnection-.
ARCCore.StreamProcessorP.DoNotStoreLocalOriginLocallyARCCoreEnumMemberMeans 'do not store local origin locally but wait until it gets confirmed by core storage'.
ARCCore.PKRelAttributeP.OppositeTermARCCoreEnumMemberExample: For 'Employee', the key 'SupervisorId' where the supervisor is another 'Employee', will have another meaning "as seen from" the Supervisor, namely "Subordinates" or similar.
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.
ARCCore.StreamProcessorP.CacheDiskWritesARCCoreEnumMemberIf TRUE then will write the -PropertyStream- to disk in bigger chunks, thereby increasing performance.
ARCCore.PKRelAttributeP.EnforceReferentialIntegrityARCCoreEnumMemberIf TRUE then referential integrity will be enforced by -TryStore-.
ARCCore.ActualConnectionP.ConnectionInstructionARCCoreEnumMemberOnly relevant when we are an -Outgoing-.
ARCCore.StreamProcessorP.CopyFileStructureFromCoreARCCoreEnumMemberIf TRUE, will copy the exact file structure (through information given in -ClientUpdatePosition-).
ARCCore.PKTypeAttributePARCCoreEnumDescribes class -PKTypeAttribute-.
ARCCore.ActualConnectionP.ConnectionDirectionARCCoreEnumMember 
ARCCore.StreamProcessorP.CountIncomingConnectionsARCCoreEnumMember 
ARCCore.PKTypeAttributeP.TypeARCCoreEnumMemberThe type of this Property.
ARCCore.ActualConnectionP.CountReceiveMessageARCCoreEnumMember 
ARCCore.StreamProcessorP.CountOutgoingConnectionsARCCoreEnumMember 
ARCCore.PKTypeAttributeP.DefaultValueARCCoreEnumMemberThe default value.
ARCCore.ActualConnectionP.CountSendMessageARCCoreEnumMember 
ARCCore.StreamProcessorP.CountOutsideLocalReceiverARCCoreEnumMemberCount of calls to -OutsideLocalReceiver-.
ARCCore.PKTypeAttributeP.CardinalityARCCoreEnumMemberDescribes how multiple instances of a property is supposed to be handled.
ARCCore.ActualConnectionP.ClientUpdatePositionARCCoreEnumMemberNote how this is stored both as -ClientUpdatePosition- (on the client side) and -ClientUpdatePosition- (on the server side).
ARCCore.DataTransferDirectionARCCoreEnumDirection for transfer of data.
ARCCore.PKTypeAttributeP.IsObligatoryARCCoreEnumMemberTrue means value is obligatory.
ARCCore.ActualConnectionP.SubscriptionAsRequestedByClientARCCoreEnumMemberOriginates from -Subscription-.
ARCCore.DataTransferDirection.SendARCCoreEnumMemberLike -Client- sending in-application generated properties to -ArmDB- / -CoreDB- or -ArmDB- sending data received over an incoming connection to -CoreDB-.
ARCCore.PKTypeAttributeP.BoilerplateCodePropertiesARCCoreEnumMemberAutomatically generated boilerplate code that implements traditional setters and getters for this key.
ARCCore.ActualConnectionP.ClosingReasonARCCoreEnumMemberReason why this connection was closed
ARCCore.DataTransferDirection.ReceiveARCCoreEnumMemberLike -Client- receiving data from an upstream -ArmDB- / -CoreDB- or -ArmDB- receiving data from an upstream -CoreDB-.
ARCCore.PPARCCoreEnumDescribes meta data for any class (property) implementing -IP-.
ARCCore.ActualConnectionP.IsErrorConditionARCCoreEnumMemberSome kind of error condition has occured regarding data going back and forth, but the TCP/IP connection itself is probably sound.
ARCCore.TPropertyKeyEnumARCCoreEnumPlaceholder for any enum type suitable as generic type parameter for -PExact-.
ARCCore.PP.CreatedARCCoreEnumMemberTimestamp when property was created in database.
ARCCore.ActualConnectionP.ErrorConditionDataARCCoreEnumMemberDetailed explanation about -IsErrorCondition-
Assembly ARCDoc AssemblyA library supporting documentation and demonstrating usage of AgoRapide.
ARCCore.PP.CidARCCoreEnumMemberCreator id (entity which created this property).
ARCCore.ActualConnectionP.UnderClosureARCCoreEnumMemberSet to TRUE if to be closed and reinitialized.
ARCDoc.AppleARCDocClassThe most 'standard' way of implementing an entity-class in AgoRapide, by just inheriting -PRich-.
ARCCore.PP.ValueARCCoreEnumMemberThe actual value.
ARCCore.ActualConnectionP.MonkeyWrenchARCCoreEnumMember 
ARCDoc.Apple.AddNameARCDocClassMemberConvenience method, not obligatory.
ARCCore.PP.ValidARCCoreEnumMemberTimestamp when property was last known to be (still) valid
ARCCore.ActualConnectionP.PartnerIPAddressARCCoreEnumMemberTODO: Use more strongly typing for this.
ARCDoc.Apple.GetNameARCDocClassMemberConvenience method, not obligatory.
ARCDoc.DocFrag.ToHTMLSimpleSingleARCDocClassMemberAlternative ('override') to -ToHTMLSimpleSingle-.
ARCDoc.DemonstratorARCDocClassDemonstrates various concepts from -ARCCore-, especially -PropertyAccess-.
ARCDoc.Orange.StorageARCDocClassMemberUses int-value of -__enum- minus 1 as index.
ARCDoc.DocFrag.TryGetPARCDocClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.Demonstrator.DemonstratePropertyAccessAppleARCDocClassMemberDemonstrates use of -PropertyAccess- through the -Apple- class.
ARCDoc.SomeAppComponentARCDocClassDemonstrates how also your actual application classes, not only your data classes, should implement -IP-.
ARCDoc.DocFrag.TryGetVARCDocClassMemberNote 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).
ARCDoc.Demonstrator.DemonstratePropertyAccessOrangeARCDocClassMemberDemonstrates use of -PropertyAccess- through the -Orange- class.
ARCDoc.SomeAppComponent.MethodCARCDocClassMemberNote structured format in logging.
ARCDoc.DocFrag.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCDoc.Demonstrator.DemonstratePropertyAccessBananaARCDocClassMemberDemonstrates use of -PropertyAccess- through the -Banana- class.
ARCDoc.SomeAppComponent.MethodDARCDocClassMemberSame as MethodC- but returns data ('Func<string>()' instead of 'Action()')
ARCDoc.DocFragCollectionARCDocClassContains a collection of -DocFrag- objects.
ARCDoc.Demonstrator.DemonstrateITypeDescriberARCDocClassMemberDemonstrates use of -ITypeDescriber- for describing single-property values.
ARCDoc.SomeAppComponent.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCDoc.DocFragCollection.CreateARCDocClassMemberCreates documentation fragments (-DocFrag-) for all possible -BaseAttribute- elements found in the given assemblies.
ARCDoc.Demonstrator.DemonstratePRichHierarchicalStorageARCDocClassMemberDemonstrates use of -PRich-, how it receives -PropertyStream--lines and builds up a strongly typed hierarchical object storage.
ARCDoc.DocFragARCDocClassDocFrag = Document fragment.
ARCDoc.DocFragCollection.TryGetPARCDocClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.Demonstrator.DemonstratePropertyStreamARCDocClassMemberDemonstrates use of -PropertyStream- by generating local data (documentation data) and writing locally to console.
ARCDoc.DocFrag.Create Overload1ARCDocClassMemberCreates a -DocFrag- object representing an assembly or a namespace.
ARCDoc.DocFragCollection.TryGetVARCDocClassMemberNote 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).
ARCDoc.Demonstrator.DemonstrateBareBonesClientARCDocClassMemberDemonstrates adding -PropertyStream--lines to -CoreDB- without using ANY AgoRapide component, only standard TCP/IP functionality in .NET.
ARCDoc.DocFrag.Create Overload2ARCDocClassMemberCreates a -DocFrag- object representing a class, class member, enum or enum member.
ARCCore.ConnectionInstructionPARCCoreEnumDescribes class -ConnectionInstruction-.
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.
ARCCore.ConnectionInstructionP.ServerHostNameARCCoreEnumMemberThe host (DNS or IP-address) for which to connect.
ARCCore.ConnectionInstructionP.ServerPortNoARCCoreEnumMemberThe port number for which to connect.
ARCCore.ConnectionInstructionP.ConnectionIdARCCoreEnumMemberUsually a combination of -ClientId-, -ServerHostName- and -ServerPortNo-.
ARCCore.ConnectionInstructionP.DataTransferDirectionARCCoreEnumMember 
ARCCore.ConnectionInstructionP.SubscriptionARCCoreEnumMemberThe actual subscripton. This is what the connecting party / (downstream) client would send over its TCP/IP connection to the (upstream) server.
ARCCore.ConnectionInstructionP.MultipleConnectionUsageARCCoreEnumMember 
ARCCore.StreamProcessorP.CurrentlyInitializingARCCoreEnumMemberSet to TRUE at initialization (signals for instance -ReceiveAndDistribute- that it can only queue messages, not process them).
ARCCore.StreamProcessorP.ClientUpdatePositionPathARCCoreEnumMemberComplete path to file containing -ClientUpdatePosition-.
ARCCore.StreamProcessorP.ClientUpdatePositionARCCoreEnumMemberNote how this is stored both as -ClientUpdatePosition- (on the client side) and -ClientUpdatePosition- (on the server side).
ARCCore.StreamProcessorP.IncomingConnectionsPortNoARCCoreEnumMemberIf not set, then class will not listen for incoming connections (meaning that our application is probably a -Client-).
ARCCore.StreamProcessorP.UnderClosureARCCoreEnumMemberSet to TRUE if to be closed, whenever an exception occurs or when class goes out of scope
ARCCore.StreamProcessorP.WriteToConsoleARCCoreEnumMemberIf true then incoming data (from other nodes will be written to console.
ARCCore.StreamProcessorP.TimestampARCCoreEnumMemberThe timestamp inserted at regular intervals in the -PropertyStream- according to -TimestampResolution-.
ARCCore.StreamProcessorP.TimestampIsOldARCCoreEnumMemberA warning sent by -StreamProcessor- to -OutsideLocalReceiver- when it knows that data as served is out of date.
ARCCore.StreamProcessorP.CountReceiveLocalOriginARCCoreEnumMemberCount of -PropertyStreamLine- with -HasLocalOrigin-.
ARCCore.StreamProcessorP.CountReceiveNonLocalOriginARCCoreEnumMemberCount of -PropertyStreamLine- not with -HasLocalOrigin-.
ARCCore.StorageFilePARCCoreEnumDescribes class -StorageFile-.
ARCCore.StorageFileP.FilenameARCCoreEnumMember 
ARCCore.StorageFileP.HashARCCoreEnumMemberHash of storage file. Not implemented as of Apr 2020. It is envisaged to store hash-value as last line in storage file. In this case the hash must be the hash of the file excluding the last line
ARCCore.ConnectionDirectionARCCoreEnumThe concept of who took the initiative for the connections (who asked to open the TCP/IP session).
ARCCore.ConnectionDirection.IncomingARCCoreEnumMemberConnectionInstruction will not be set for these.
ARCCore.ConnectionDirection.OutgoingARCCoreEnumMemberThere would normally exist two live outgoing connection at a given point in time for -Client- / -ArmDB-:
ARCDoc.Apple.TryGetNameARCDocClassMemberConvenience method, not obligatory.
ARCDoc.Apple.TryGetPARCDocClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.Apple.TryGetVARCDocClassMemberNote 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).
ARCDoc.Apple.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCDoc.Apple.NameARCDocClassMemberConvenience method, not obligatory.
ARCDoc.BananaARCDocClassImplements -IP- directly and uses traditional property storage for optimum -MemoryConsumption- efficiency.
ARCDoc.Banana.NameARCDocClassMemberAnnotated as nullable in order to keep flexibility of -PropertyAccess-, including what happens if values are not set (TryGetP etc)
ARCDoc.Banana.ColourARCDocClassMemberAnnotated as nullable in order to keep flexibility of -PropertyAccess-, including what happens if values are not set (TryGetP etc)
ARCDoc.DocLink.LinkWordHTMLWithHyphensARCDocClassMember-LinkWordHTML- with '-' (minus sign / hyphen) prepended and appended.
ARCDoc.DocLink.LinkWordHTMLBeforeLtARCDocClassMemberIf -LinkWordHTML contains '<' (really '&lt;') (for generic types, like 'PValue<TValue>') then this will contain the part before '<' like 'PValue'.
ARCDoc.DocLink.LinkWordHTMLBeforeLtWithHyphensARCDocClassMember-LinkWordHTMLBeforeLt- with '-' (minus sign / hyphen) prepended and appended.
ARCDoc.DocLink.AHrefEndPartARCDocClassMember'Filename.Encoded + "> + LinkWordHTML + </a>'
ARCDoc.DocLinkCollectionARCDocClassContains a collection of -DocLink- objects.
ARCDoc.DocLinkCollection.CreateARCDocClassMemberNotes all locations and their positions in the hierarchical directory structure.
ARCDoc.DocLinkCollection.InsertLinks Overload1ARCDocClassMemberDoes -LinkInsertionInDocumentation- on the given HTML content.
ARCDoc.DocLinkCollection.InsertLinks Overload2ARCDocClassMemberSee overload with 'contentLocation' as parameter for documentation.
ARCDoc.DocLinkResolutionCollectionARCDocClassContains a collection of -DocLinkResolution- objects.
ARCDoc.DocLinkResolutionCollection.TryGetPARCDocClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.DocLinkResolutionCollection.TryGetVARCDocClassMemberNote 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).
ARCDoc.DocLinkResolutionCollection.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCDoc.DocumentatorARCDocClassGeneral class for documenting AgoRapide and also your own -ApplicationSpecificCode-.
ARCDoc.Documentator.CreateAndInsertARCDocClassMemberCreates an instance of -Documentator- with a natural hierarchical representation of documentation attributes found in the given assemblies.
ARCDoc.Documentator.ToHTMLSimpleSingleARCDocClassMemberAlternative ('override') to -ToHTMLSimpleSingle-.

Generated 2025-08-08 18:44:30.935 UTC