Class ClassCollection

Classes are grouped into ClassCollections.

Inheritance

System.Object

ClassCollection

Namespace: HAPI

Assembly: hugincs-9.1-netstandard2.0-x64.dll

Syntax

public class ClassCollection : Object

Remarks

Each class must belong to exactly one ClassCollection. A ClassCollection can be considered a closed world of interdependent Classes (i.e., Bayesian networks and influence diagrams). That is, each Class may contain instances of other Classes of the ClassCollection, but not of Classes of other ClassCollections.

Different operations are supported for ClassCollections:

• Creation and deletion
• Addition of Class objects specified in NET files
• Saving to a NET file
• Retrieval of the list of Class objects
• Retrieval of a Class object by its name

Constructors

ClassCollection()

Constructs a new (empty) ClassCollection.

Declaration

public ClassCollection()

Exceptions

Type	Condition
ExceptionHugin

ClassCollection(String)

Constructs a class collection by loading the corresponding Hugin Knowledge Base (HKB) file. The HKB file must contain a class collection.

Declaration

public ClassCollection(string hkbFileName)

Parameters

Type	Name	Description
System.String	hkbFileName	the name of the HKB file.

Exceptions

Type	Condition
ExceptionHugin

ClassCollection(String, String)

Constructs a class collection by loading the corresponding Hugin Knowledge Base (HKB) file. The HKB file must contain a class collection.

Declaration

public ClassCollection(string hkbFileName, string password)

Parameters

Type	Name	Description
System.String	hkbFileName	the name of the HKB file.
System.String	password	a password needed to load the file.

Exceptions

Type	Condition
ExceptionHugin

Methods

Delete()

Deletes this ClassCollection and all its Classs.

Declaration

public void Delete()

Exceptions

Type	Condition
ExceptionHugin

GetClassByName(String)

Returns the Class of this ClassCollection that has the given name. If no such class exists, null is returned.

Declaration

public Class GetClassByName(string name)

Parameters

Type	Name	Description
System.String	name	A string representing the name of a Class.

Returns

Type	Description
Class

Exceptions

Type	Condition
ExceptionHugin

GetMembers()

Returns a ClassList containing the Class members of this ClassCollection.

Declaration

public ClassList GetMembers()

Returns

Type	Description
ClassList

Exceptions

Type	Condition
ExceptionHugin

IsAlive()

Is this ClassCollection object alive?

Declaration

public bool IsAlive()

Returns

Type	Description
System.Boolean

ParseClasses(String)

Constructs one or more classes from a NET file or a NET description given as a string.

Declaration

public void ParseClasses(string netStringOrFileName)

Parameters

Type	Name	Description
System.String	netStringOrFileName	netStringOrFileName a string containing a NET description or the name of a NET file.

Remarks

This method uses a DefaultClassParseListener.

Exceptions

Type	Condition
ExceptionHugin

ParseClasses(String, ClassParseListener)

Constructs one or more classes from a NET file or a NET description given as a string.

Declaration

public void ParseClasses(string netStringOrFileName, ClassParseListener parseListener)

Parameters

Type	Name	Description
System.String	netStringOrFileName	a string containing a NET description or the name of a NET file
ClassParseListener	parseListener	a ClassParseListener.

Exceptions

Type	Condition
ExceptionHugin

SaveAsKB(String)

Saves this ClassCollection as a Hugin Knowledge Base (HKB) to a file.

Declaration

public void SaveAsKB(string fileName)

Parameters

Type	Name	Description
System.String	fileName	the name of the file to which the HKB is saved.

Exceptions

Type	Condition
ExceptionHugin

SaveAsKB(String, String)

Saves this ClassCollection as a Hugin Knowledge Base (HKB) to a file.

Declaration

public void SaveAsKB(string fileName, string password)

Parameters

Type	Name	Description
System.String	fileName	the name of the file to which the HKB is saved.
System.String	password	which, if non-null, will be needed upon reloading the file.

Exceptions

Type	Condition
ExceptionHugin

SaveAsNet(String)

Writes a NET description of the ClassCollection to a file.

Declaration

public void SaveAsNet(string fileName)

Parameters

Type	Name	Description
System.String	fileName	a string containing the name of the file.

Exceptions

Type	Condition
ExceptionHugin

ToNetString()

Creates a NET description of this ClassCollection.

Declaration

public string ToNetString()

Returns

Type	Description
System.String	A string containing the NET description.

Exceptions

Type	Condition
ExceptionHugin

ToString()

Returns a String of names of the member Classes of this ClassCollection.

Declaration

public string ToString()

Returns

Type	Description
System.String

Exceptions

Type	Condition
ExceptionHugin