Ligature Member Details

Ligature Public Fields


Ligature Public Enumerations
LigatureColorChange
Encapsulates whether a Ligature may or must change Color under certain conditions
Remarks:

Members:

Name Value Description
MustChange 0 Change is Obligatory
MayChange 1 Change is permitted
MustNotChange 2 Change is not permitted
NotRelevant 3 Not relevant


Ligature Constructors
New
The Plain-Vanilla Constructor
Public Sub New()
Remarks:
Parameters:
New
Constructor used during an exact copy of a Graph, as in Insertion on Verso
Public Sub New(ByVal CopyLig As Ligature, ByVal MainCopyResult As ProtoGraph)
Remarks:
Parameters:
ByVal CopyLig As Ligature
ByVal MainCopyResult As ProtoGraph
New
This Constructor is used during a reconstruction from XML
Public Sub New(ByVal Nom As String, ByVal ScopeEG As ProtoGraph, ByVal LColor As Color, ByVal DotNames As String[], ByVal HookNames As String[])
Remarks:
Parameters:
ByVal Nom As String
ByVal ScopeEG As ProtoGraph
ByVal LColor As Color
ByVal DotNames As String[]
ByVal HookNames As String[]
New
Instantiates a Ligature during a Beta Reiteration
Public Sub New(ByVal HH As HookCollection, ByVal DColor As DotColor, ByVal BaseEG As ProtoGraph)
Remarks:
Parameters:
ByVal HH As HookCollection
ByVal DColor As DotColor
ByVal BaseEG As ProtoGraph
New
Instantiates a Ligature for a newly-scribed Dot
Public Sub New(ByVal FirstLI As Dot)
Remarks:
Parameters:
ByVal FirstLI As Dot


Ligature Public Properties
Color
BackColor of LIs in this Ligature; pairs with Name to identify this Ligature which is a quantified variable Category: Appearance
Public ReadOnly Property Color() As Color
Remarks:
IndexParameters:
Return Value:
Color
ConnectedAtomicGraphs
Collection of all AtomicGraphs in and Connected directly by this Ligature Category: Behavior
Public Property ConnectedAtomicGraphs() As AtomicGraphCollection
Remarks:
IndexParameters:
Return Value:
AtomicGraphCollection
ConnectedSpots
Array of Spots directly Connected to this Ligature Category: Behavior
Public Property ConnectedSpots() As SpotCollection
Remarks:
IndexParameters:
Return Value:
SpotCollection
ConnectionLineCount
The Number of shown Connections between LI's in this Ligature Category: Appearance
Public ReadOnly Property ConnectionLineCount() As Int32
Remarks:
IndexParameters:
Return Value:
Int32
Connections
Array of shown Connections between LI's in this Ligature Category: Appearance
Public Property Connections() As LigConnection[]
Remarks:
IndexParameters:
Return Value:
LigConnection[]
ConPen
Pen used to draw connections between Hooks Category: Appearance
Public Property ConPen() As Pen
Remarks:
IndexParameters:
Return Value:
Pen
CopiedFROM
When this Ligature is part of a Copy, refers to the Ligature which it copies Category: Description
Public Property CopiedFROM() As Ligature
Remarks:
IndexParameters:
Return Value:
Ligature
CopiedTO
When this Ligature is part of the SOURCE OF a Copy, refers to the most recent Ligature to which it is copied Category: Description
Public Property CopiedTO() As Ligature
Remarks:
IndexParameters:
Return Value:
Ligature
DotColor
Color information about this Ligature Category: Appearance
Public Property DotColor() As DotColor
Remarks:
IndexParameters:
Return Value:
DotColor
DotColorHEX
Hexadecimal of Color information about this Line of Identity Category: Appearance
Public ReadOnly Property DotColorHEX() As String
Remarks:
IndexParameters:
Return Value:
String
Dots
Array of Lines of Identity (Dots) belonging to this Ligature Category: Behavior
Public Property Dots() As DotCollection
Remarks:
IndexParameters:
Return Value:
DotCollection
FromXMLDotCount
When Recreating from XML, Count of Dots of this Ligature for later translation Category: Behavior
Public ReadOnly Property FromXMLDotCount() As Int32
Remarks:
IndexParameters:
Return Value:
Int32
FromXMLDotNames
When Recreating from XML, holds Names of Dots of this Ligature for later translation to References Category: Behavior
Public Property FromXMLDotNames() As String[]
Remarks:
IndexParameters:
Return Value:
String[]
FromXMLHookCount
When Recreating from XML, Count of Hooks of this Ligature for later translation Category: Behavior
Public ReadOnly Property FromXMLHookCount() As Int32
Remarks:
IndexParameters:
Return Value:
Int32
FromXMLHookNames
When Recreating from XML, holds Names of Hooks of this Ligature for later translation to References Category: Behavior
Public Property FromXMLHookNames() As String[]
Remarks:
IndexParameters:
Return Value:
String[]
Hooks
The Hooks on all the AtomicGraphs in this Ligature Category: Behavior
Public Property Hooks() As HookCollection
Remarks:
IndexParameters:
Return Value:
HookCollection
IndexCurrent
This Ligature's Index in its active Inventory Collection; this is subject to change Category: Behavior
Public Property IndexCurrent() As Int32
Remarks:
IndexParameters:
Return Value:
Int32
IndexFixed
Absolute Index of this Ligature in this Graph-construction; this Index does not change Category: Behavior
Public Property IndexFixed() As Int32
Remarks:
IndexParameters:
Return Value:
Int32
Inventory
Reference to the Inventory of Objects in this Graph-Construction Category: Behavior
Public Property Inventory() As Inventory
Remarks:
IndexParameters:
Return Value:
Inventory
IsExistentiallyQuantified
True iff the Scope.IsRecto = True Category: Behavior
Public ReadOnly Property IsExistentiallyQuantified() As Boolean
Remarks:
IndexParameters:
Return Value:
Boolean
IsInactive
"True" means that this Ligature is no longer active and functioning Category: Behavior
Public Property IsInactive() As Boolean
Remarks:
IndexParameters:
Return Value:
Boolean
IsUniversallyQuantified
True iff the Scope.IsRecto = False Category: Behavior
Public ReadOnly Property IsUniversallyQuantified() As Boolean
Remarks:
IndexParameters:
Return Value:
Boolean
MapsLigatureOnCopy
When this Ligature is part of a Copy, refers to the Ligature which it copies Category: Description
Public Property MapsLigatureOnCopy() As Ligature
Remarks:
IndexParameters:
Return Value:
Ligature
Name
Pairs with Color to identify this Ligature which is a quantified variable Category: Behavior
Public Property Name() As String
Remarks:
IndexParameters:
Return Value:
String
RootSA
Root Graph of this Graph Tree Category: Behavior
Public Property RootSA() As SheetOfAssertion
Remarks:
IndexParameters:
Return Value:
SheetOfAssertion
Scope
This EG is the GLB in the Graph-tree of all the Dots and Spots belonging to this Ligature Category: Behavior
Public Property Scope() As ProtoGraph
Remarks:
IndexParameters:
Return Value:
ProtoGraph
ScopeCore
The subset of Scope.Controls (or the single Dot) which include Hooks in this Ligature Category: Behavior
Public Property ScopeCore() As ProtoGraphCollection
Remarks:
IndexParameters:
Return Value:
ProtoGraphCollection
ScopeGraphs
The Array of all Graphs including Hooks of this Ligature Category: Behavior
Public ReadOnly Property ScopeGraphs() As ProtoGraphCollection
Remarks:
IndexParameters:
Return Value:
ProtoGraphCollection
ScopeName
The Text Name of the Scope of this Ligature Category: Behavior
Public ReadOnly Property ScopeName() As String
Remarks:
IndexParameters:
Return Value:
String


Ligature Public Methods
AddAllHookEventHandlers
Adds EventHandlers for all Hooks of this Ligature
Public Sub AddAllHookEventHandlers()
Remarks:
Parameters:
Return Value:
Void
AddEventHandlersForHook
Adds EventHandlers for a given Hook for events monitored in this Ligature
Public Sub AddEventHandlersForHook(ByVal H As Hook)
Remarks:
Parameters:
ByVal H As Hook
Return Value:
Void
BreakVisibleConnection
Overload; This breaks a visible connection between Hooks given a reference to the Connection
Public Sub BreakVisibleConnection(ByVal VisiCon As LigConnection)
Remarks:
Parameters:
ByVal VisiCon As LigConnection
Return Value:
Void
BreakVisibleConnection
Overload; This eliminates the visible connection between 2 so-connected Hooks in this Ligature
Public Sub BreakVisibleConnection(ByVal H1 As Hook, ByVal H2 As Hook)
Remarks:
Parameters:
ByVal H1 As Hook
ByVal H2 As Hook
Return Value:
Void
ClaimAtomForHook
Assures that the Atom to which a given Hook belongs is part of this Ligature
Public Sub ClaimAtomForHook(ByVal H As Hook)
Remarks:
Parameters:
ByVal H As Hook
Return Value:
Void
ClaimHooks
Adds the Hooks of HH to this Ligature, then Claims them and thier Atoms, changing their Properties appropriately
Public Sub ClaimHooks(ByVal HH As HookCollection)
Remarks:
Parameters:
ByVal HH As HookCollection
Return Value:
Void
ClaimHooks
Registers this Ligature as Ligature for all its Hooks, and assures that their Atoms are in this Ligature
Public Sub ClaimHooks()
Remarks:
Parameters:
Return Value:
Void
CorrectHookConnectionCollections
Checks each Hook in this Ligature to be sure its extant Connections include it as a Connection; if Connections Collection includes a Hook NOT in this Lig, removes that reference
Public Sub CorrectHookConnectionCollections()
Remarks:
Parameters:
Return Value:
Void
DeleteAllVisibleConnections
Deletes all visible connections between Hooks in this Ligature
Public Sub DeleteAllVisibleConnections()
Remarks:
Parameters:
Return Value:
Void
DrawHookConnections
Used within a Paint Event Handler to draw the visible connections of this Ligature
Public Sub DrawHookConnections(ByVal GraphInWhich As ContainerGraph, ByVal e As PaintEventArgs)
Remarks:
Parameters:
ByVal GraphInWhich As ContainerGraph
ByVal e As PaintEventArgs
Return Value:
Void
DrawHookConnections
Public Sub DrawHookConnections(ByVal GraphInWhich As ContainerGraph)
Remarks:
Parameters:
ByVal GraphInWhich As ContainerGraph
Return Value:
Void
DrawSVGHookConnectionsLig
Supplies XML code for visible Hook Connections in an SVG graphic
Public Function DrawSVGHookConnectionsLig(ByVal GraphInWhich As ContainerGraph) As String
Remarks:
Parameters:
ByVal GraphInWhich As ContainerGraph
Return Value:
String
EncapsulateScope
Returns a Collection of Graphs containing all Hooks in this Ligature; if this Array were placed on a ConjunctiveEG, that Graph would become the Scope of this Ligature, and if any member of this Array could be left outside that ConjunctiveEG, it would NO LONGER be the Scope
Public Function EncapsulateScope() As ProtoGraphCollection
Remarks:
Parameters:
Return Value:
ProtoGraphCollection
GetCurrentInventoryLigaturesIndex
Reads current Index of this Object in the Inventory; this may differ from IndexFixed, which is the Index in CutsHistoric
Public Function GetCurrentInventoryLigaturesIndex() As Int32
Remarks:
Parameters:
Return Value:
Int32
GetHooksForContainer
Returns Collection of Hooks belonging to this Ligature and in Dots located immediately on the area of a given ContainerGraph
Public Function GetHooksForContainer(ByVal CGraph As ContainerGraph) As HookCollection
Remarks:
Parameters:
ByVal CGraph As ContainerGraph
Return Value:
HookCollection
GetScopeCore
Computes and returns the ScopeCore of this Ligature
Public Function GetScopeCore() As ProtoGraphCollection
Remarks:
Parameters:
Return Value:
ProtoGraphCollection
GetScopeCoreIn
Computes and passes the ScopeCore of this Ligature in a ProtoGraph G; if Ligature has Hooks outside G, it is a Collection whose only member is G and Function Returns False (else True); if non-comparable, Returns False and passes empty ProtoGraphCollection
Public Function GetScopeCoreIn(ByVal G As ProtoGraph, ByRef ScopeCoreIn As ProtoGraphCollection) As Boolean
Remarks:
Parameters:
ByVal G As ProtoGraph
ByRef ScopeCoreIn As ProtoGraphCollection
Return Value:
Boolean
GetScopeIn
Computes and passes the Scope of this Ligature in a ProtoGraph G; if Ligature has Hooks outside G, it is G, Function Returns False (else True); if non-comparable, Returns Nothing
Public Function GetScopeIn(ByVal G As ProtoGraph, ByRef ScopeIn As ProtoGraph) As Boolean
Remarks:
Parameters:
ByVal G As ProtoGraph
ByRef ScopeIn As ProtoGraph
Return Value:
Boolean
HookArrayToString
Produces a String describing a Hook Array
Public Shared Function HookArrayToString(ByVal H As Hook[]) As String
Remarks:
Parameters:
ByVal H As Hook[]
Return Value:
String
HookColorChangeOnReitFor
Where Reiteree is being Reiterated, this tests whether this Ligature's Hooks in the Copy must change color, may change color, or must remain the same color (or is irrelevant)
Public Function HookColorChangeOnReitFor(ByVal Reiteree As ProtoGraph) As LigatureColorChange
Remarks:
Parameters:
ByVal Reiteree As ProtoGraph
Return Value:
LigatureColorChange
HooksAlreadyHaveConnectionHere
Tests whether 2 given Hooks already are shown as visibly connected in this Ligarure
Public Function HooksAlreadyHaveConnectionHere(ByVal H1 As Hook, ByVal H2 As Hook) As Boolean
Remarks:
Parameters:
ByVal H1 As Hook
ByVal H2 As Hook
Return Value:
Boolean
IncludesHook
Returns True iff a given Hook belongs to this Ligature
Public Function IncludesHook(ByVal H As Hook) As Boolean
Remarks:
Parameters:
ByVal H As Hook
Return Value:
Boolean
JoinLigatures
Overload; Merges a second Ligature with a given Ligature
Public Shared Function JoinLigatures(ByRef Lig1 As Ligature, ByVal Lig2 As Ligature) As Ligature
Remarks:
Parameters:
ByRef Lig1 As Ligature
ByVal Lig2 As Ligature
Return Value:
Ligature
JoinLigatures
Overload; Merges a second Ligature with this Ligature
Public Function JoinLigatures(ByVal Lig2 As Ligature) As Ligature
Remarks:
Parameters:
ByVal Lig2 As Ligature
Return Value:
Ligature
SetAllElementsColor
Sets the Color of all Dots and Hooks belonging to this Ligature to its Color
Public Sub SetAllElementsColor()
Remarks:
Parameters:
Return Value:
Void
SetScope
Runs SetScope on a given Ligature, computing Scope (which is GLB of the Atoms in that Ligature in the Graph-Tree) and ScopeCore of that Ligature
Public Shared Function SetScope(ByVal Lig As Ligature) As ProtoGraph
Remarks:
Parameters:
ByVal Lig As Ligature
Return Value:
ProtoGraph
SetScope
Computes Scope (which is GLB of the Atoms in this Ligature in the Graph-Tree) and ScopeCore of this Ligature
Public Function SetScope() As ProtoGraph
Remarks:
Parameters:
Return Value:
ProtoGraph
ShowLineConnectionsX
This is diagnostic; for visible connection matters, see ContainerGraph_Paint, for a start
Public Sub ShowLineConnectionsX()
Remarks:
Parameters:
Return Value:
Void
ToString
Returns a String (on one Line) Representing the Ligature
Public Overrides Function ToString() As String
Remarks:
Parameters:
Return Value:
String
UpdateConnectedSpots
Updates the ConnectedSpots Collection for this Ligature
Public Function UpdateConnectedSpots() As SpotCollection
Remarks:
Parameters:
Return Value:
SpotCollection
UpdateConnectedSpots
Updates the ConnectedSpots Collection for a given Ligature
Public Shared Function UpdateConnectedSpots(ByVal ForLig As Ligature) As SpotCollection
Remarks:
Parameters:
ByVal ForLig As Ligature
Return Value:
SpotCollection
UpdateConnectionsBetweenHooks
Updates list of Visible Connections between Hooks of this Ligature
Public Sub UpdateConnectionsBetweenHooks()
Remarks:
Parameters:
Return Value:
Void
XMLElement
Generates an XML element for this Ligature
Public Function XMLElement() As String
Remarks:
Parameters:
Return Value:
String


Ligature Public Events
DotRemoved
Occurs when a Dot is removed from this Ligature.
Public Event DotRemoved(ByVal sender As Object, ByVal Removee As Dot, ByVal NewLICount As Int32)
Event Data:
The event handler receives arguments of Type Object, Dot and Integer
EventHandler Parameters:
ByVal sender As Object
ByVal Removee As Dot
ByVal NewLICount As Int32

ScopeChanged
Occurs when the Scope of this Ligature changes.
Public Event ScopeChanged(ByVal sender As Object, ByVal NewScope As ProtoGraph)
Event Data:
The event handler receives arguments of Type Object and ProtoGraph
EventHandler Parameters:
ByVal sender As Object
ByVal NewScope As ProtoGraph