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

DSIGReferenceList Class Reference
[Main Signature API]

Holds a list of reference elements. More...

#include <DSIGReferenceList.hpp>

List of all members.

Public Types

typedef std::vector< DSIGReference * > ReferenceListVectorType
typedef size_t size_type

Public Methods

Constructors and Destructors
 DSIGReferenceList ()
 Construct a list. More...

 ~DSIGReferenceList ()
 Destroy a list. More...

List manipulation
void addReference (DSIGReference *ref)
 Add a reference to the list. More...

DSIGReferenceremoveReference (size_type index)
 Remove a reference from the list. More...

DSIGReferenceitem (size_type index)
 Return a reference from the list. More...

size_type getSize ()
 Find the number of elements in the list. More...

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


Detailed Description

Holds a list of reference elements.

The library holds a Signature's list of references using this class. Manifest lists are similarly held. Developers can obtain the list from the Signature library using DSIGSignature::getReferenceList and then iterate through each reference.

The library also uses the List as the owner of the memory associated with References. So when a list is deleted, the references are deleted at the same time.


Member Typedef Documentation

typedef std::vector<DSIGReference *> DSIGReferenceList::ReferenceListVectorType
 

typedef size_t DSIGReferenceList::size_type
 


Constructor & Destructor Documentation

DSIGReferenceList::DSIGReferenceList  
 

Construct a list.

DSIGReferenceList::~DSIGReferenceList  
 

Destroy a list.

Standard destructor to close down the list.

Note:
Destroys the references as well as the list


Member Function Documentation

void DSIGReferenceList::addReference DSIGReference   ref
 

Add a reference to the list.

Appends the reference to the end of the list and takes ownership of associated memory.

bool DSIGReferenceList::empty  
 

Clear out the list.

Simply clears the list. Does not delete the reference elements themselves.

size_type DSIGReferenceList::getSize  
 

Find the number of elements in the list.

Returns:
The number of elements in the list

DSIGReference* DSIGReferenceList::item size_type    index
 

Return a reference from the list.

Gets the reference at point index in the list

Parameters:
index  The pointer into the list

DSIGReference* DSIGReferenceList::removeReference size_type    index
 

Remove a reference from the list.

Removes the reference at the index point and returns a pointer to the reference removed.

Note:
This also releases ownership. It is the responsibility of the caller to ensure the reference is deleted.
Note:
This does not currently delete the reference from the Signature
Parameters:
index  Point in the list to remove


The documentation for this class was generated from the following file:
Generated on Thu May 8 20:17:27 2003 for XML-Security-C by doxygen1.2.15