LibOFX
OfxGenericContainer Class Reference

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

Inheritance diagram for OfxGenericContainer:
OfxAccountContainer OfxBalanceContainer OfxDummyContainer OfxInv401kContainer OfxMainContainer OfxPositionContainer OfxPushUpContainer OfxSecurityContainer OfxStatementContainer OfxStatusContainer OfxTransactionContainer

Public Member Functions

 OfxGenericContainer (LibofxContext *p_libofx_context)
 
 OfxGenericContainer (LibofxContext *p_libofx_context, OfxGenericContainer *para_parentcontainer)
 
 OfxGenericContainer (LibofxContext *p_libofx_context, OfxGenericContainer *para_parentcontainer, std::string para_tag_identifier)
 
virtual void add_attribute (const std::string identifier, const std::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...
 
OfxGenericContainergetparent ()
 Returns the parent container object (the one representing the containing OFX SGML element)
 

Data Fields

std::string type
 
std::string tag_identifier
 
OfxGenericContainerparentcontainer
 
LibofxContextlibofx_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 31 of file ofx_containers.hh.

Member Function Documentation

◆ add_attribute()

void OfxGenericContainer::add_attribute ( const std::string  identifier,
const std::string  value 
)
virtual

◆ add_to_main_tree()

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 successful, false otherwise.

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

Definition at line 74 of file ofx_container_generic.cpp.

◆ gen_event()

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, OfxTransactionContainer, OfxPositionContainer, OfxSecurityContainer, OfxAccountContainer, and OfxStatementContainer.

Definition at line 68 of file ofx_container_generic.cpp.

Field Documentation

◆ tag_identifier

std::string OfxGenericContainer::tag_identifier

◆ type

std::string OfxGenericContainer::type

The type of the object, often == tag_identifier

Definition at line 41 of file ofx_containers.hh.

Referenced by add_attribute(), OfxStatusContainer::add_attribute(), OFCApplication::endElement(), and OFXApplication::endElement().


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