wsf::ExternalLinks::ExternalLink Class Reference

#include <WsfExternalLinks.hpp>

Collaboration diagram for wsf::ExternalLinks::ExternalLink:

Classes
struct	CommPairHash
struct	CommandHash

Public Types
using	AddressSet = std::unordered_set<Address>
using	WsfStringSet = std::unordered_set<WsfStringId>
using	CommandSet = std::unordered_set<CommandChainTarget, CommandHash>
using	CommSet = std::unordered_set<CommPair, CommPairHash>

Public Member Functions
	ExternalLink ()=default
virtual	~ExternalLink ()=default

Add/Remove methods
WsfStringId	mXmtrName {}
AddressSet	mAddressRecipients {}
WsfStringSet	mGroups {}
CommandSet	mCommandRecipients {}
CommSet	mCommRecipients {}
ExternalLinks *	mParentPtr {nullptr}
bool	AddAddressRecipient (const Address &aAddress)
bool	AddGroupRecipient (WsfStringId aGroupName)
bool	AddCommandRecipient (const CommandChainTarget &aCommandChainTarget)
bool	AddCommRecipient (const CommPair &aCommPair)
bool	RemoveAddressRecipient (const Address &aAddress)
bool	RemoveGroupRecipient (WsfStringId aGroupName)
bool	RemoveCommandRecipient (const CommandChainTarget &aCommandChainTarget)
bool	RemoveCommRecipient (const CommPair &aCommPair)
void	DeleteAllRecipients ()
AddressVec	GetRecipients (bool aNotify=false) const
comm::Comm *	GetXmtr () const
size_t	GetRecipientCount () const
WsfStringId	GetXmtrName () const
void	SetXmtrName (WsfStringId aXmtrName)
void	SetParent (ExternalLinks *aParentPtr)

Member Typedef Documentation

AddressSet

using wsf::ExternalLinks::ExternalLink::AddressSet = std::unordered_set<Address>

CommandSet

using wsf::ExternalLinks::ExternalLink::CommandSet = std::unordered_set<CommandChainTarget, CommandHash>

CommSet

using wsf::ExternalLinks::ExternalLink::CommSet = std::unordered_set<CommPair, CommPairHash>

WsfStringSet

using wsf::ExternalLinks::ExternalLink::WsfStringSet = std::unordered_set<WsfStringId>

Constructor & Destructor Documentation

ExternalLink()

wsf::ExternalLinks::ExternalLink::ExternalLink ( )

default

~ExternalLink()

virtual wsf::ExternalLinks::ExternalLink::~ExternalLink ( )

virtualdefault

References AddAddressRecipient(), AddCommandRecipient(), AddCommRecipient(), AddGroupRecipient(), DeleteAllRecipients(), GetRecipientCount(), GetRecipients(), GetXmtr(), RemoveAddressRecipient(), RemoveCommandRecipient(), RemoveCommRecipient(), and RemoveGroupRecipient().

Member Function Documentation

AddAddressRecipient()

bool wsf::ExternalLinks::ExternalLink::AddAddressRecipient

(

const Address &

aAddress

)

References mAddressRecipients.

Referenced by wsf::ExternalLinks::AddRecipient(), and ~ExternalLink().

AddCommandRecipient()

bool wsf::ExternalLinks::ExternalLink::AddCommandRecipient

(

const CommandChainTarget &

aCommandChainTarget

)

References mCommandRecipients.

Referenced by wsf::ExternalLinks::AddRecipient(), and ~ExternalLink().

AddCommRecipient()

bool wsf::ExternalLinks::ExternalLink::AddCommRecipient

(

const CommPair &

aCommPair

)

References mCommRecipients.

Referenced by wsf::ExternalLinks::AddRecipient(), and ~ExternalLink().

AddGroupRecipient()

bool wsf::ExternalLinks::ExternalLink::AddGroupRecipient

(

WsfStringId

aGroupName

)

References mGroups.

Referenced by wsf::ExternalLinks::AddRecipient(), and ~ExternalLink().

DeleteAllRecipients()

void wsf::ExternalLinks::ExternalLink::DeleteAllRecipients

(

)

References mAddressRecipients, mCommandRecipients, mCommRecipients, and mGroups.

Referenced by ~ExternalLink().

GetRecipientCount()

size_t wsf::ExternalLinks::ExternalLink::GetRecipientCount

(

)

const

References wsf::ExternalLinks::cCOMMANDER, wsf::ExternalLinks::cPEERS, wsf::ExternalLinks::cSUBORDINATES, groupPtr, mAddressRecipients, mCommandRecipients, mCommRecipients, mGroups, and mParentPtr.

Referenced by ~ExternalLink().

GetRecipients()

ExternalLinks::AddressVec wsf::ExternalLinks::ExternalLink::GetRecipients

(

bool

aNotify = false

)

const

Note

Do not use these calls prior to simulation pending start. They require full initialization of the comm framework to resolve addressing.

Add recipients identified by an address.

Validate addresses with network manager. Exclude any addresses that are not resolved. Allow any address that is an interface, broadcast, or multicast.

Add recipients identified by a group.

We only allow platform parts, specifically comms.

Add recipients identified by command chains

Add recipients identified by platform-name comm-name pair

References wsf::ExternalLinks::cCOMMANDER, wsf::ExternalLinks::cPEERS, wsf::ExternalLinks::cSUBORDINATES, groupPtr, mAddressRecipients, mCommandRecipients, mCommRecipients, mGroups, mParentPtr, and platformPtr.

Referenced by getLinkedAndReachablePlatformParts(), and ~ExternalLink().

GetXmtr()

comm::Comm * wsf::ExternalLinks::ExternalLink::GetXmtr

(

)

const

References GetXmtrName(), mParentPtr, and platformPtr.

Referenced by getLinkedAndReachablePlatformParts(), and ~ExternalLink().

GetXmtrName()

WsfStringId wsf::ExternalLinks::ExternalLink::GetXmtrName ( ) const

inline

References mXmtrName.

Referenced by wsf::ExternalLinks::FindLink(), and GetXmtr().

RemoveAddressRecipient()

bool wsf::ExternalLinks::ExternalLink::RemoveAddressRecipient

(

const Address &

aAddress

)

References mAddressRecipients.

Referenced by ~ExternalLink().

RemoveCommandRecipient()

bool wsf::ExternalLinks::ExternalLink::RemoveCommandRecipient

(

const CommandChainTarget &

aCommandChainTarget

)

References mCommandRecipients.

Referenced by ~ExternalLink().

RemoveCommRecipient()

bool wsf::ExternalLinks::ExternalLink::RemoveCommRecipient

(

const CommPair &

aCommPair

)

References mCommRecipients.

Referenced by ~ExternalLink().

RemoveGroupRecipient()

bool wsf::ExternalLinks::ExternalLink::RemoveGroupRecipient

(

WsfStringId

aGroupName

)

References mGroups.

Referenced by ~ExternalLink().

SetParent()

void wsf::ExternalLinks::ExternalLink::SetParent ( ExternalLinks * aParentPtr )

inline

References wsf::ExternalLinks::ExternalLinks(), and mParentPtr.

SetXmtrName()

void wsf::ExternalLinks::ExternalLink::SetXmtrName ( WsfStringId aXmtrName )

inline

References mXmtrName.

Referenced by wsf::ExternalLinks::AddRecipient(), wsf::ExternalLinks::AddRecipient(), wsf::ExternalLinks::AddRecipient(), and wsf::ExternalLinks::AddRecipient().

Member Data Documentation

mAddressRecipients

AddressSet wsf::ExternalLinks::ExternalLink::mAddressRecipients {}

protected

Referenced by AddAddressRecipient(), DeleteAllRecipients(), GetRecipientCount(), GetRecipients(), and RemoveAddressRecipient().

mCommandRecipients

CommandSet wsf::ExternalLinks::ExternalLink::mCommandRecipients {}

protected

Referenced by AddCommandRecipient(), DeleteAllRecipients(), GetRecipientCount(), GetRecipients(), and RemoveCommandRecipient().

mCommRecipients

CommSet wsf::ExternalLinks::ExternalLink::mCommRecipients {}

protected

Referenced by AddCommRecipient(), DeleteAllRecipients(), GetRecipientCount(), GetRecipients(), and RemoveCommRecipient().

mGroups

WsfStringSet wsf::ExternalLinks::ExternalLink::mGroups {}

protected

Referenced by AddGroupRecipient(), DeleteAllRecipients(), GetRecipientCount(), GetRecipients(), and RemoveGroupRecipient().

mParentPtr

ExternalLinks* wsf::ExternalLinks::ExternalLink::mParentPtr {nullptr}

protected

Referenced by GetRecipientCount(), GetRecipients(), GetXmtr(), and SetParent().

mXmtrName

WsfStringId wsf::ExternalLinks::ExternalLink::mXmtrName {}

protected

Referenced by GetXmtrName(), and SetXmtrName().

---

The documentation for this class was generated from the following files:

• WsfExternalLinks.hpp
• WsfExternalLinks.cpp