Generated from ./src/trbasic.cpp with ROBODoc v4.0.2 on Sun May 25 16:39:22 2003

Anvil/TrBasic

NAME

  Transaction Basic class

USAGE

  #include "trbasic.h"
  TrBasic *t = new TrBasic();

AUTHOR

  Joseph M. Robertson, jmr, jmrobert5@mchsi.com

COPYRIGHT

 (c) 2001 by Joseph M. Robertson

CREATION DATE

  6/17/01

HISTORY



Anvil/TrBasic::Amount

NAME

  Amount - the dollar amount of the transaction.

SYNOPSIS

  float TrBasic::Amount()
  void TrBasic::Amount(float value)

PURPOSE

  Use to get/set the dollar amount of the transaction.

Anvil/TrBasic::Void

NAME

  Void

SYNOPSIS

  void TrBasic::Void()

PURPOSE

  Convenience method to void a transaction.
  Sets status to 'x', ammount to 0.00 and payee to **VOID**

Anvil/TrBasic::Number

NAME

  Number

SYNOPSIS

  long TrBasic::Number()
  void TrBasic::Number(long value)

PURPOSE

  Use to get/set the check number for the transaction.

Anvil/TrBasic::Address

NAME

  Address

SYNOPSIS

  string TrBasic::Address()
  void TrBasic::Address(string value)

PURPOSE

  Use to get/set the address member of the transaction.

Anvil/TrBasic::Category

NAME

  Category

SYNOPSIS

  string TrBasic::Category()
  void TrBasic::Category(string value)

PURPOSE

  Use to get/set the category name member of the transaction.

Anvil/TrBasic::Balance

NAME

  Balance

SYNOPSIS

  float TrBasic::Balance()
  void TrBasic::Balance(float value)

PURPOSE

  Use to get/set the balance. Transactions as a linked list or vector
  can be used to track the account balance.

Anvil/TrBasic::VSplit

NAME

  VSplit

SYNOPSIS

  vector<Split> TrBasic::VSplit()
  void TrBasic::VSplit(vector<Split> vsplit)

PURPOSE

  Use to get/set the vector of splits that are optional to a transaction.
  Splits are a way to subdivide the details of a transaction.

Anvil/TrBasic::Print()

NAME

  Print

SYNOPSIS

  string TrBasic::Print()

PURPOSE

  Use to get a formatted string of the transaction.
  This is a verbose version.

Anvil/TrBasic::Print_Rec()

NAME

  Print_Rec

SYNOPSIS

  string TrBasic::Print_Rec()

PURPOSE

  Use to print out a string format of the transaction data.
  This is a short format, pipe delimited string.

Anvil/TrBasic::Field()

NAME

  Field

SYNOPSIS

  string TrBasic::Field(int index)

PURPOSE

  Use to get a piece of member data from a transaction.
  0 = id         6 = memo
  1 = date       7 = address (could contain linefeeds)
  2 = number     8 = category
  3 = status     9 = split  (pipe delimited string)
  4 = amount         amount|memo|category...
  5 = payee      10 = balance

Anvil/TrBasic::ReBalance

NAME

  ReBalance

SYNOPSIS

  void TrBasic::ReBalance()

PURPOSE

  Used to recalculate the transaction balance when used in a list or vector.

NOTES

  Private method.