LibOFX
OfxBalanceContainer Class Reference

Represents the <BALANCE>, <INVBAL> or <INV401KBAL> OFX SGML entity. More...

#include <ofx_containers.hh>

Inheritance diagram for OfxBalanceContainer:
OfxGenericContainer

Public Member Functions

 OfxBalanceContainer (LibofxContext *p_libofx_context, OfxGenericContainer *para_parentcontainer, string para_tag_identifier)
 
void add_attribute (const string identifier, const string value)
 Add data to a container object.
 
- Public Member Functions inherited from OfxGenericContainer
 OfxGenericContainer (LibofxContext *p_libofx_context)
 
 OfxGenericContainer (LibofxContext *p_libofx_context, OfxGenericContainer *para_parentcontainer)
 
 OfxGenericContainer (LibofxContext *p_libofx_context, OfxGenericContainer *para_parentcontainer, string para_tag_identifier)
 
virtual int gen_event ()
 Generate libofx.h events.
 
virtual int add_to_main_tree ()
 Add this container to the main tree.
 
OfxGenericContainergetparent ()
 Returns the parent container object (the one representing the containing OFX SGML element)
 

Data Fields

double amount
 
bool amount_valid
 
time_t date
 
bool date_valid
 
double margin_balance
 
bool margin_balance_valid
 
double short_balance
 
bool short_balance_valid
 
double buying_power
 
bool buying_power_valid
 
- Data Fields inherited from OfxGenericContainer
string type
 
string tag_identifier
 
OfxGenericContainerparentcontainer
 
LibofxContextlibofx_context
 

Detailed Description

Represents the <BALANCE>, <INVBAL> or <INV401KBAL> OFX SGML entity.

OfxBalanceContainer is an auxiliary container (there is no matching data object in libofx.h)

Definition at line 121 of file ofx_containers.hh.

Constructor & Destructor Documentation

◆ OfxBalanceContainer()

OfxBalanceContainer::OfxBalanceContainer ( LibofxContext p_libofx_context,
OfxGenericContainer para_parentcontainer,
string  para_tag_identifier 
)

Definition at line 145 of file ofx_containers_misc.cpp.

◆ ~OfxBalanceContainer()

OfxBalanceContainer::~OfxBalanceContainer ( )

Definition at line 156 of file ofx_containers_misc.cpp.

Member Function Documentation

◆ add_attribute()

void OfxBalanceContainer::add_attribute ( const string  identifier,
const string  value 
)
virtual

Add data to a container object.

Must be called once completed parsing an OFX SGML data element. The parent container should know what to do with it.

Parameters
identifierThe name of the data element
valueThe concatenated string of the data

Reimplemented from OfxGenericContainer.

Definition at line 167 of file ofx_containers_misc.cpp.

Field Documentation

◆ amount

double OfxBalanceContainer::amount

Interpretation depends on balance_type

Definition at line 128 of file ofx_containers.hh.

Referenced by add_attribute().

◆ amount_valid

bool OfxBalanceContainer::amount_valid

Definition at line 129 of file ofx_containers.hh.

◆ buying_power

double OfxBalanceContainer::buying_power

Definition at line 142 of file ofx_containers.hh.

◆ buying_power_valid

bool OfxBalanceContainer::buying_power_valid

Definition at line 143 of file ofx_containers.hh.

◆ date

time_t OfxBalanceContainer::date

Effective date of the given balance

Definition at line 130 of file ofx_containers.hh.

Referenced by add_attribute().

◆ date_valid

bool OfxBalanceContainer::date_valid

<INVBAL><MARGINBALANCE>

Definition at line 131 of file ofx_containers.hh.

◆ margin_balance

double OfxBalanceContainer::margin_balance

Definition at line 134 of file ofx_containers.hh.

◆ margin_balance_valid

bool OfxBalanceContainer::margin_balance_valid

<INVBAL><SHORTBALANCE>

Definition at line 135 of file ofx_containers.hh.

◆ short_balance

double OfxBalanceContainer::short_balance

Definition at line 138 of file ofx_containers.hh.

◆ short_balance_valid

bool OfxBalanceContainer::short_balance_valid

<INVBAL><BUYPOWER>

Definition at line 139 of file ofx_containers.hh.


The documentation for this class was generated from the following files: