Main Page | Modules | Class Hierarchy | Compound List | File List | Compound Members | File Members | Related Pages

DSIGKeyInfoList Class Reference
[Main Signature API]

#include <DSIGKeyInfoList.hpp>

Collaboration diagram for DSIGKeyInfoList:

Collaboration graph
[legend]
List of all members.

Detailed Description

Container class for KeyInfo elements.

The library stores KeyInfo lists using this class.


Public Types

typedef std::vector< DSIGKeyInfo * > KeyInfoListVectorType
typedef size_t size_type

Public Member Functions

Constructors and Destructors
 DSIGKeyInfoList (DSIGSignature *sig)
 Main constructor.

 ~DSIGKeyInfoList ()
 Destructor.

Public (API) functions
size_t getSize ()
 Get size of list.

DSIGKeyInfoitem (size_type index)
Manipulate the List
void addKeyInfo (DSIGKeyInfo *ref)
 Add an already created KeyInfo.

bool addXMLKeyInfo (DOMNode *ki)
 Read from DOM and create.

DSIGKeyInforemoveKeyInfo (size_type index)
void setParentSignature (DSIGSignature *sig)
 Set the owning signature.

void empty ()
 Clear out the list.

bool isEmpty ()
 Is the list empty?


Member Typedef Documentation

typedef std::vector<DSIGKeyInfo *> DSIGKeyInfoList::KeyInfoListVectorType
 

typedef size_t DSIGKeyInfoList::size_type
 


Constructor & Destructor Documentation

DSIGKeyInfoList::DSIGKeyInfoList DSIGSignature sig  ) 
 

Main constructor.

Main constructor called by DSIGSignature

Note:
Should only ever be created by a Signature class.
Parameters:
sig The owning signature

DSIGKeyInfoList::~DSIGKeyInfoList  ) 
 

Destructor.


Member Function Documentation

void DSIGKeyInfoList::addKeyInfo DSIGKeyInfo ref  ) 
 

Add an already created KeyInfo.

Adds a KeyInfo element that has already been built into the list.

Parameters:
ref The KeyInfo to add

bool DSIGKeyInfoList::addXMLKeyInfo DOMNode *  ki  ) 
 

Read from DOM and create.

Uses a DOMNode pointing to the start of the KeyInfo element to build a new KeyInfo and then add it to the list

Note:
This is an internal function and should not be called directly
Parameters:
ki Head of DOM structure with the KeyInfo
Returns:
true if successfully loaded

void DSIGKeyInfoList::empty  ) 
 

Clear out the list.

Removes all elements from the list

Note:
Deletes the items themselves as well as clearing the list.

size_t DSIGKeyInfoList::getSize  ) 
 

Get size of list.

Returns:
the number of elements in the list

bool DSIGKeyInfoList::isEmpty  ) 
 

Is the list empty?

Returns:
true Iff there are no elements in the list

DSIGKeyInfo* DSIGKeyInfoList::item size_type  index  ) 
 

DSIGKeyInfo* DSIGKeyInfoList::removeKeyInfo size_type  index  ) 
 

void DSIGKeyInfoList::setParentSignature DSIGSignature sig  )  [inline]
 

Set the owning signature.

Sets the signature owner of this element

Parameters:
sig The owner signature


The documentation for this class was generated from the following file:
Generated on Sun Aug 10 06:24:42 2003 for XML-Security-C by doxygen 1.3.2