INIReader Class

Reader for data stored in the "Karamba.ini"-file. It is implemented as a Singleton.

Inheritance Hierarchy

SystemObject
Karamba.UtilitiesINIReader

Namespace: Karamba.Utilities
Assembly: KarambaCommon (in KarambaCommon.dll) Version: 2.2.0.4 (2.2.0.4)

Syntax

C++

Copy

public class INIReader

Public Class INIReader

public ref class INIReader

type INIReader =  class end

The INIReader type exposes the following members.

Properties

	Name	Description
	Values	Gets or sets the key/value-pairs of the ini-reader.

Top

Methods

	Name	Description
	asBool(String)	return value associated to a key as a bool. Throws an exception if key could not be found.
	asBool(String, Boolean)	return value associated to a key as a bool.
	asColor(String)	return a color associated with a key.
	asColor(String, Color)	Return a color associated with a key.
	asColorList(String)	return a list of colors associated with a key.
	asColorList(String, ListColor)	return a list of colors associated with a key.
	asCustomUnitsList	Returns a list of tuples of strings where the first string is the physical unit to be replaced, the second item the unit to be used instead consistency of units is not checked.
	asDouble(String)	return value associated to a key as an double. Throws an exception if key could not be found.
	asDouble(String, Double)	return value associated to a key as an double.
	asDoubleList	return values associated to a key as a list of doubles.
	asInt(String)	return value associated to a key as an int. Throws an exception if key could not be found.
	asInt(String, Int32)	return value associated to a key as an int.
	asString(String)	return value associated to a key as a string. Throws an exception if key could not be found.
	asString(String, String)	return value associated to a key as a string.
	ClearSingleton	remove the INIReader singleton so that it can be re-instantiated.
	Contents	Get the contents of the read initialization file as one string.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Instance	Get instance of the "ini"-reader singleton and load the "ini"-file from the standard GH-path where karamba resides.
	Instance(String)	Get instance of the "ini"-reader singleton and load the "ini"-file from the given path if not already done.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	readValues	Scans through lines of text and extract key/value pairs.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Fields

	Name	Description
	default_limit_parallel	default limit value of the cosine of the angle between two lines to count as parallel.
	warning	if the file could not be opened the warning contains hints.

Top

Reference

Karamba.Utilities Namespace