LibOFX: OfxGenericContainer Class Reference

LibOFX

- Main Page
- Related Pages
- Namespaces
- Data Structures
- Files

- Data Structures
- Class Hierarchy
- Data Fields

Public Member Functions | Data Fields
OfxGenericContainer Class Reference

A generic container for an OFX SGML element. Every container inherits from OfxGenericContainer. More...

Inheritance diagram for OfxGenericContainer:

## Public Member Functions
| 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 void | add_attribute (const string identifier, const string value)
| Add data to a container object. More...
virtual int | gen_event ()
| Generate libofx.h events. More...
virtual int | add_to_main_tree ()
| Add this container to the main tree. More...
OfxGenericContainer * | getparent ()
| Returns the parent container object (the one representing the containing OFX SGML element)
| 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 void | add_attribute (const string identifier, const string value)
| Add data to a container object. More...
virtual int | gen_event ()
| Generate libofx.h events. More...
virtual int | add_to_main_tree ()
| Add this container to the main tree. More...
OfxGenericContainer * | getparent ()
| Returns the parent container object (the one representing the containing OFX SGML element)

## Data Fields
string | type
string | tag_identifier
OfxGenericContainer * | parentcontainer
LibofxContext * | libofx_context

## Detailed Description

A generic container for an OFX SGML element. Every container inherits from OfxGenericContainer.

A hierarchy of containers is built as the file is parsed. The supported OFX elements all have a matching container. The others are assigned a OfxDummyContainer, so every OFX element creates a container as the file is par Note however that containers are destroyed as soon as the corresponding SGML element is closed.

Definition at line 33 of file ofx_containers.hh.

## Member Function Documentation

void OfxGenericContainer::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

  identifier | The name of the data element
  value | The concatenated string of the data

Reimplemented in OfxInvestmentTransactionContainer, OfxInvestmentTransactionContainer, OfxBankTransactionContainer, OfxBankTransactionContainer, OfxTransactionContainer, OfxTransactionContainer, OfxSecurityContainer, OfxSecurityContainer, OfxAccountContainer, OfxAccountContainer, OfxStatementContainer, OfxStatementContainer, OfxBalanceContainer, OfxBalanceContainer, OfxStatusContainer, OfxStatusContainer, OfxPushUpContainer, OfxPushUpContainer, OfxDummyContainer, and OfxDummyContainer.

Definition at line 57 of file ofx_container_generic.cpp.

Referenced by OfxPushUpContainer::add_attribute(), OfxStatusContainer::add_attribute(), OfxBalanceContainer::add_attribute(), OfxStatementContainer::add_attribute(), OfxAccountContainer::add_attribute(), OfxSecurityContainer::add_attribute(), and OfxTransactionContainer::add_attribute().

virtual void OfxGenericContainer::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

  identifier | The name of the data element
  value | The concatenated string of the data

Reimplemented in OfxInvestmentTransactionContainer, OfxInvestmentTransactionContainer, OfxBankTransactionContainer, OfxBankTransactionContainer, OfxTransactionContainer, OfxTransactionContainer, OfxSecurityContainer, OfxSecurityContainer, OfxAccountContainer, OfxAccountContainer, OfxStatementContainer, OfxStatementContainer, OfxBalanceContainer, OfxBalanceContainer, OfxStatusContainer, OfxStatusContainer, OfxPushUpContainer, OfxPushUpContainer, OfxDummyContainer, and OfxDummyContainer.

virtual int OfxGenericContainer::add_to_main_tree | ( |  | ) |
| virtual

Add this container to the main tree.

add_to_main_treegen_event will add the container to the main trees stored int the OfxMainContainer.

Returns
  true if successfull, false otherwise.

Reimplemented in OfxTransactionContainer, OfxTransactionContainer, OfxSecurityContainer, OfxSecurityContainer, OfxAccountContainer, OfxAccountContainer, OfxStatementContainer, and OfxStatementContainer.

int OfxGenericContainer::add_to_main_tree | ( |  | ) |
| virtual

Add this container to the main tree.

add_to_main_treegen_event will add the container to the main trees stored int the OfxMainContainer.

Returns
  true if successfull, false otherwise.

Reimplemented in OfxTransactionContainer, OfxTransactionContainer, OfxSecurityContainer, OfxSecurityContainer, OfxAccountContainer, OfxAccountContainer, OfxStatementContainer, and OfxStatementContainer.

Definition at line 74 of file ofx_container_generic.cpp.

int OfxGenericContainer::gen_event | ( |  | ) |
| virtual

Generate libofx.h events.

gen_event will call the appropriate ofx_proc_XXX_cb defined in libofx.h if one is available.

Returns
  true if a callback function vas called, false otherwise.

Reimplemented in OfxMainContainer, OfxMainContainer, OfxTransactionContainer, OfxTransactionContainer, OfxSecurityContainer, OfxSecurityContainer, OfxAccountContainer, OfxAccountContainer, OfxStatementContainer, and OfxStatementContainer.

Definition at line 68 of file ofx_container_generic.cpp.

virtual int OfxGenericContainer::gen_event | ( |  | ) |
| virtual

Generate libofx.h events.

gen_event will call the appropriate ofx_proc_XXX_cb defined in libofx.h if one is available.

Returns
  true if a callback function vas called, false otherwise.

Reimplemented in OfxMainContainer, OfxMainContainer, OfxTransactionContainer, OfxTransactionContainer, OfxSecurityContainer, OfxSecurityContainer, OfxAccountContainer, OfxAccountContainer, OfxStatementContainer, and OfxStatementContainer.

## Field Documentation

string OfxGenericContainer::tag_identifier

The identifer of the creating tag

Definition at line 37 of file ofx_containers.hh.

Referenced by OfxDummyContainer::add_attribute().

string OfxGenericContainer::type

The type of the object, often == tag_identifier

Definition at line 36 of file ofx_containers.hh.

Referenced by add_attribute(), and OfxStatusContainer::add_attribute().

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

- ofx_containers.hh
- ofx_container_generic.cpp