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

DSIGKeyInfoList Class Reference
[Main Signature API]

Container class for KeyInfo elements. More...

#include <DSIGKeyInfoList.hpp>

Collaboration diagram for DSIGKeyInfoList:

Collaboration graph
[legend]
List of all members.

Public Types

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

Public Methods

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

 ~DSIGKeyInfoList ()
 Destructor. More...

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

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

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

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

void empty ()
 Clear out the list. More...

bool isEmpty ()
 Is the list empty? More...


Detailed Description

Container class for KeyInfo elements.

The library stores KeyInfo lists using this class.


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 Sat Jan 11 20:35:04 2003 for XML-Security-C by doxygen1.2.15