#include <WsfInternalLinks.hpp>
Public Member Functions | |
| Addressee () | |
| Addressee (WsfStringId aNameId) | |
| Addressee (const Addressee &aSrc) | |
| Addressee & | operator= (const Addressee &aRhs) |
| ~Addressee ()=default | |
| bool | Activate (WsfPlatformPart *aPartPtr) |
| bool | Deactivate () |
Public Attributes | |
| WsfStringId | mNameId |
| WsfPlatformPart * | mPartPtr |
| bool | mIsActive |
Constructor & Destructor Documentation
◆ Addressee() [1/3]
| WsfInternalLinks::Addressee::Addressee | ( | ) |
References mIsActive, mNameId, and mPartPtr.
Referenced by Addressee(), and operator=().
◆ Addressee() [2/3]
| WsfInternalLinks::Addressee::Addressee | ( | WsfStringId | aNameId | ) |
◆ Addressee() [3/3]
| WsfInternalLinks::Addressee::Addressee | ( | const Addressee & | aSrc | ) |
Copy constructor. Copy the NameId, but do not copy any pointer attributes, as they will not likely be valid in the destination part. The destination part will complete its links at Initialization time.
References Addressee(), mIsActive, mNameId, and mPartPtr.
◆ ~Addressee()
|
default |
References Activate(), and Deactivate().
Member Function Documentation
◆ Activate()
| bool WsfInternalLinks::Addressee::Activate | ( | WsfPlatformPart * | aPartPtr | ) |
Attempt to activate a part name link, by (if needed) obtaining a pointer to the part.
- Parameters
-
aPartPtr A pointer to the desired part to link to.
- Returns
- "true" if the status of the link actually had to be changed to the requested status.
References WsfObject::GetNameId(), mIsActive, mNameId, and mPartPtr.
Referenced by ~Addressee().
◆ Deactivate()
| bool WsfInternalLinks::Addressee::Deactivate | ( | ) |
Deactivate a part name link.
- Returns
- "true" if the status of the link actually had to be changed to the requested status.
References mIsActive.
Referenced by ~Addressee().
◆ operator=()
| WsfInternalLinks::Addressee & WsfInternalLinks::Addressee::operator= | ( | const Addressee & | aRhs | ) |
Copy constructor. Copy the NameId, but do not copy any pointer attributes, as they will not likely be valid in the destination part. The destination part will complete its links at Initialization time.
References Addressee(), mIsActive, mNameId, and mPartPtr.
Member Data Documentation
◆ mIsActive
| bool WsfInternalLinks::Addressee::mIsActive |
Referenced by Activate(), Addressee(), Addressee(), Addressee(), Deactivate(), WsfInternalLinks::GetRecipientEntry(), and operator=().
◆ mNameId
| WsfStringId WsfInternalLinks::Addressee::mNameId |
Referenced by Activate(), Addressee(), Addressee(), Addressee(), and operator=().
◆ mPartPtr
| WsfPlatformPart* WsfInternalLinks::Addressee::mPartPtr |
Referenced by Activate(), Addressee(), Addressee(), Addressee(), WsfInternalLinks::GetRecipientEntry(), and operator=().
The documentation for this struct was generated from the following files: