IChecking

Defines the public contract for the Checking class, exposing entry management (add, clone, append), key lookup, and property retrieval for diagnostic messages tagged with severity scopes. Also hosts project-wide enumerations for CheckingScope, CheckingValue, and ProjectError.

Elements

Name #

Name of the checking object

Signature:

Public Property Get Name() As String

Read-only metadata properties. Returns the checking title as the object name.

Returns: String. The checking title.

Heading #

Title or subtitle of the checking object

Signature:

Public Property Get Heading(Optional ByVal subtitle As Boolean = False) As String

Returns the subtitle when the flag is True, otherwise returns the title.

Parameters:

  • subtitle: Optional Boolean. When True, returns the subtitle. Defaults to False.

Returns: String. The title or subtitle.

Length #

Total number of entries in the checking

Signature:

Public Property Get Length() As Long

Returns the count of diagnostic messages stored.

Returns: Long. Number of entries.

Keys

ListOfKeys #

Get the list of keys in the checking

Signature:

Public Property Get ListOfKeys() As BetterArray

Key enumeration and lookup. Returns a clone of the internal keys array. Returns an empty BetterArray when no entries have been added.

Returns: BetterArray. Clone of stored keys.

KeyExists #

Test whether a key is present in the checking

Signature:

Public Property Get KeyExists(ByVal keyName As String) As Boolean

Returns True when the specified key exists in the entries.

Parameters:

  • keyName: String. Key to search for.

Returns: Boolean. True when the key is found.

InputOutput

Add #

Add a new entry to the checking

Signature:

Public Sub Add(ByVal keyName As String, ByVal label As String, _
                Optional ByVal scope As Byte = checkingNote)

Adding, retrieving, cloning, and appending diagnostic entries. Adds a key, label, and scope to the checking. Keys must be unique.

Parameters:

  • keyName: String. Unique identifier for the entry.
  • label: String. Diagnostic message for the entry.
  • scope: Optional Byte. Severity scope. Defaults to checkingNote.

ValueOf #

Retrieve a property of one specific key

Signature:

Public Property Get ValueOf(ByVal keyName As String, Optional ByVal retrievedValue As Byte = 1) As String

Returns the label, type descriptor, or colour string depending on the retrievedValue selector.

Parameters:

  • keyName: String. Key from which to retrieve values.
  • retrievedValue: Optional Byte. CheckingValue enum selector. Defaults to checkingLabel.

Returns: String. The requested property value.

Clone #

Return an independent copy of the current checking object

Signature:

Public Function Clone() As IChecking

Creates a deep copy with the same title, subtitle, and all entries.

Returns: IChecking. Independent clone.

Append #

Add entries from another checking to the current one

Signature:

Public Sub Append(ByVal checks As IChecking)

Merges all entries from the supplied checking into this one.

Parameters:

  • checks: IChecking. Source checking to merge from.