Ledger Class Reference


                    
                    
                    transactions

Array of all Transactions in this ledger

Declaration

Swift

public private(set) var transactions: [Transaction] { get }

Show on GitHub


                    
                    
                    errors

Errors from the ledger and the parsing

Returns ledgerErrors and parsingErrors Note: This property is computed, so please cache the result

Declaration

Swift

public var errors: [String] { get }

Show on GitHub


                    
                    
                    ledgerErrors

Errors which this ledger contains

This includes failed balances assertions, … Note: This property is computed, so please cache the result

Declaration

Swift

public var ledgerErrors: [String] { get }

Show on GitHub


                    
                    
                    parsingErrors

Errors while reading the ledger

This can be used by a parser to store errors which occurred while trying to fill in the ledger. The ledger itself will not put anything inside.

Declaration

Swift

public var parsingErrors: [String]

Show on GitHub


                    
                    
                    commodities

Array of all Commoditys in this ledger

Declaration

Swift

public var commodities: [Commodity] { get }

Show on GitHub


                    
                    
                    accounts

Array of all Accounts in this ledger

Declaration

Swift

public var accounts: [Account] { get }

Show on GitHub


                    
                    
                    tags

Array of all Tags in this ledger

Declaration

Swift

public var tags: [Tag] { get }

Show on GitHub


                    
                    
                    prices

Array of all Prices in this ledger

Declaration

Swift

public var prices: [Price] { get }

Show on GitHub


                    
                    
                    accountGroups

Array of the main AccountGroups (all five AccountTypes) in this ledger

Declaration

Swift

public var accountGroups: [AccountGroup] { get }

Show on GitHub


                    
                    
                    plugins

Array of all plugins

Declaration

Swift

public var plugins: [String]

Show on GitHub


                    
                    
                    option

Array of all options

Declaration

Swift

public var option: [Option]

Show on GitHub


                    
                    
                    events

Array of all events

Declaration

Swift

public var events: [Event]

Show on GitHub


                    
                    
                    custom

Array of all Custom directives

Declaration

Swift

public var custom: [Custom]

Show on GitHub


                    
                    
                    init()

Creates an empty ledger with the accountGroups set up

Declaration

Swift

public init()

Show on GitHub


                    
                    
                    add(_:)

Adds a Transcaction to the ledger

Declaration

Swift

public func add(_ transaction: Transaction)

Parameters


                                transaction

transaction to add

Show on GitHub


                    
                    
                    add(_:)

Adds an Account to the ledger

Throws

If the account already exists

Declaration

Swift

public func add(_ account: Account) throws

Parameters


                                account

account to add

Show on GitHub


                    
                    
                    add(_:)

Adds a Commodity to the ledger

Throws

If the commodity already exists

Declaration

Swift

public func add(_ commodity: Commodity) throws

Parameters


                                commodity

commodity to add

Show on GitHub


                    
                    
                    add(_:)

Adds a Price to the ledger

Throws

If the price already exists

Declaration

Swift

public func add(_ price: Price) throws

Parameters


                                price

Price to add

Show on GitHub


                    
                    
                    add(_:)

Adds a Balance to the ledger

Declaration

Swift

public func add(_ balance: Balance)

Parameters


                                balance

Balance to add

Show on GitHub


                    
                    
                    description

Retuns the ledger file for this ledger.

It consists of all Account and Transaction statements, but does not include errors

Declaration

Swift

public var description: String { get }

Show on GitHub


                    
                    
                    ==(_:_:)

Compares two Ledgers

Compared are the Accounts, Transactions, Commoditys, Tags, Events, Customs, as well options and plugins, but not the errors

Declaration

Swift

public static func == (lhs: Ledger, rhs: Ledger) -> Bool

Parameters

`lhs`	ledger one
`rhs`	ledger two

Return Value

true if they hold the same information, otherwise false

Show on GitHub