CPKIFNameAndKeyWithScore Class Reference
#include <PKIFNameAndKeyWithScore.h>
Detailed Description
The CPKIFNameAndKeyWithScore class is a simple wrapper around an IPKIFNameAndKeyPtr object that provides state information used by CPKIFReversePathBuilder.TSP-enforcing: No
Definition at line 29 of file PKIFNameAndKeyWithScore.h.
Public Member Functions | |
| CPKIFNameAndKeyWithScore (IPKIFNameAndKeyPtr &nameAndKey) | |
| ~CPKIFNameAndKeyWithScore () | |
| int | GetScore () const |
| void | AddToScore (int additionalPoints) |
| void | ClearScore () |
| void | SetIgnore () |
| void | ClearIgnore () |
| bool | GetIgnore () const |
| void | SetNameIgnore () |
| void | ClearNameIgnore () |
| IPKIFNameAndKeyPtr | GetNameAndKey () const |
| bool | operator== (const IPKIFNameAndKey &rhs) const |
| bool | operator== (const CPKIFNameAndKeyWithScore &rhs) const |
Constructor & Destructor Documentation
| CPKIFNameAndKeyWithScore::CPKIFNameAndKeyWithScore | ( | IPKIFNameAndKeyPtr & | nameAndKey | ) |
Interface: Subsystem
copy constructor
- Returns:
- None
- Parameters:
-
nameAndKey [in] A reference to a pointer to IPKIFNameAndKeyPtr object
Definition at line 20 of file PKIFNameAndKeyWithScore.cpp.
References CPKIFNameAndKeyWithScore().
Referenced by CPKIFNameAndKeyWithScore().
| CPKIFNameAndKeyWithScore::~CPKIFNameAndKeyWithScore | ( | ) |
Interface: Subsystem
default destructor
- Returns:
- None
Definition at line 36 of file PKIFNameAndKeyWithScore.cpp.
Member Function Documentation
| int CPKIFNameAndKeyWithScore::GetScore | ( | ) | const |
Interface: Subsystem
Helper function that returns score
- Returns:
- Integer value representing score
Definition at line 46 of file PKIFNameAndKeyWithScore.cpp.
| void CPKIFNameAndKeyWithScore::AddToScore | ( | int | additionalPoints | ) |
Interface: Subsystem
Helper function that adds a value to the score kept by the class.
- Returns:
- None
- Parameters:
-
additionalPoints [in] Integer value representing how many additional points will be addes to the score
Definition at line 57 of file PKIFNameAndKeyWithScore.cpp.
| void CPKIFNameAndKeyWithScore::ClearScore | ( | ) |
Interface: Subsystem
Helper function clears the score kept by the class.
- Returns:
- None
Definition at line 70 of file PKIFNameAndKeyWithScore.cpp.
| void CPKIFNameAndKeyWithScore::SetIgnore | ( | ) |
Interface: Subsystem
Helper function that sets the ignore value
- Returns:
- None
Definition at line 83 of file PKIFNameAndKeyWithScore.cpp.
| void CPKIFNameAndKeyWithScore::ClearIgnore | ( | ) |
Interface: Subsystem
Helper function that clears the ignore value
- Returns:
- None
Definition at line 94 of file PKIFNameAndKeyWithScore.cpp.
| bool CPKIFNameAndKeyWithScore::GetIgnore | ( | ) | const |
Interface: Subsystem
Helper function that returns the ignore value
- Returns:
- Boolean value representing ignore
Definition at line 105 of file PKIFNameAndKeyWithScore.cpp.
| void CPKIFNameAndKeyWithScore::SetNameIgnore | ( | ) |
Interface: Subsystem
Helper function that sets the name ignore value
- Returns:
- None
Definition at line 116 of file PKIFNameAndKeyWithScore.cpp.
| void CPKIFNameAndKeyWithScore::ClearNameIgnore | ( | ) |
Interface: Subsystem
Helper function that clears the name ignore value
- Returns:
- None
Definition at line 127 of file PKIFNameAndKeyWithScore.cpp.
| IPKIFNameAndKeyPtr CPKIFNameAndKeyWithScore::GetNameAndKey | ( | ) | const |
Interface: Subsystem
Helper function that returns a smart pointer to NameAndKey value
- Returns:
- A smart pointer to NameAndKey object
Definition at line 138 of file PKIFNameAndKeyWithScore.cpp.
Referenced by operator==().
| bool CPKIFNameAndKeyWithScore::operator== | ( | const IPKIFNameAndKey & | rhs | ) | const |
Interface: Subsystem
Equality operator that compares two name and key values
- Returns:
- True if two values are equal false otherwise
- Parameters:
-
rhs [in] A refernce to name and key object
Definition at line 149 of file PKIFNameAndKeyWithScore.cpp.
References IPKIFNameAndKey::GetKey(), GetNameAndKey(), and IPKIFNameAndKey::GetSubjectName().
| bool CPKIFNameAndKeyWithScore::operator== | ( | const CPKIFNameAndKeyWithScore & | rhs | ) | const |
Interface: Subsystem
Equality operator that compares two name and key w/ score values
- Returns:
- True if two values are equal false otherwise
- Parameters:
-
rhs [in] A refernce to name and key w/score object
Definition at line 175 of file PKIFNameAndKeyWithScore.cpp.
References GetNameAndKey().
The documentation for this class was generated from the following files:
