DPCL Class Reference

Chapter 6. Class FunctionList

Class FunctionList defines an object that contains a list of functions that match a regular expression search pattern supplied to the SourceObj::bget_function_list or SourceObj::get_function_list function. An instance of FunctionList should contain a list of 0 or more FunctionId objects.

Constructors

Synopsis

#include <FunctionList.h>
FunctionList(void);
FunctionList(const FunctionList &oldobj);
 

Description

The default constructor creates a FunctionList object. This FunctionList object will initially contain no entries. Calling the get_count function will return 0.

The copy constructor uses the values contained in the oldobj to initialize the new (constructed) object.

See Also

FunctionId, SourceObj::bget_function_list, SourceObj::get_function_list

get_count

Synopsis

#include <FunctionList.h>
int get_count(void) const;

Description

Returns the number of entries (FunctionId objects) in this function list.

Return Values

Returns an integer indicating the number of entries (FunctionId objects) in this function list. If this FunctionId object was initialized by a default constructor, this function returns 0.

See Also

get_entry

get_entry

Synopsis

#include <FunctionList.h>
FunctionId get_entry(int index) const;

Parameters

index

the position or index of a particular entry (FunctionId object) in this function list.

Description

Returns the ith FunctionId object in this function list.

Return Values

Returns the ith FunctionId object if this index is valid. In other words, 0 <= i < get_count();.

See Also

get_count

operator=

Synopsis

#include <FunctionList.h>
FunctionList & operator=(const FunctionList &rhs);

Parameters

rhs

The right hand operand. This is the existing FunctionList object whose value you want to assign to the invoking FunctionList object.

Description

Assigns the value of the right hand operand (existing FunctionList object) to the invoking FunctionList object. The left operand is the invoking object.

For example,

FunctionList rhs, lhs:
.
.
.
lhs = rhs;

assigns the value of rhs to lhs. This yields a new copy of the FunctionList object.

Return Values

Returns a reference to the invoking FunctionList object (the left operand).