Contains the 'groups' to which platform or platform part belongs. More...

#include <WsfGroupList.hpp>

Public Types
typedef std::vector< WsfStringId >	GroupList

Public Member Functions
	WsfGroupList ()
	WsfGroupList (const WsfGroupList &aSrc)
WsfGroupList &	operator= (const WsfGroupList &)=delete
	~WsfGroupList ()=default
const GroupList &	GetGroupList () const
bool	Initialize (WsfPlatform *aPlatformPtr)
bool	Initialize (WsfPlatformPart *aPlatformPartPtr)
bool	ProcessInput (UtInput &aInput, WsfPlatform *aPlatformPtr)
bool	ProcessInput (UtInput &aInput, WsfPlatformPart *aPlatformPartPtr)
void	LeaveAllGroups ()
	Leave all groups this platform/platform part is a member of.
void	JoinGroup (WsfGroup *aGroupPtr, size_t aPlatformIndex, unsigned int aPlatformPartId=0)
void	LeaveGroup (WsfGroup *aGroupPtr, size_t aPlatformIndex, unsigned int aPlatformPartId=0)
bool	IsGroupMember (WsfStringId aGroupId) const

Detailed Description

Contains the 'groups' to which platform or platform part belongs.

Member Typedef Documentation

◆ GroupList

typedef std::vector<WsfStringId> WsfGroupList::GroupList

Constructor & Destructor Documentation

◆ WsfGroupList() [1/2]

WsfGroupList::WsfGroupList ( )

Referenced by operator=(), and WsfGroupList().

◆ WsfGroupList() [2/2]

WsfGroupList::WsfGroupList ( const WsfGroupList & aSrc )

References WsfGroupList().

◆ ~WsfGroupList()

WsfGroupList::~WsfGroupList ( )

default

Member Function Documentation

◆ GetGroupList()

const GroupList & WsfGroupList::GetGroupList ( ) const

inline

Referenced by LeaveAllGroups().

◆ Initialize() [1/2]

bool WsfGroupList::Initialize ( WsfPlatform * aPlatformPtr )

References WsfPlatform::GetSimulation(), LeaveGroup(), and ok.

◆ Initialize() [2/2]

bool WsfGroupList::Initialize ( WsfPlatformPart * aPlatformPartPtr )

References WsfPlatformPart::GetSimulation(), LeaveGroup(), and ok.

◆ IsGroupMember()

bool WsfGroupList::IsGroupMember ( WsfStringId aGroupId ) const

Determine if the associated object is a member of the indicated group.

Parameters

aGroupId String ID number of the group to be checked.

Returns: 'true' if the object is a member of the indicated group or 'false' if not.

◆ JoinGroup()

void WsfGroupList::JoinGroup	(	WsfGroup *	aGroupPtr,
		size_t	aPlatformIndex,
		unsigned int	aPlatformPartId = 0 )

Add a platform/platform part to a group. This is the form called by the platform/platform part.

Parameters

aGroupPtr	Pointer to the group.
aPlatformIndex	The platform index.
aPlatformPartId	The unique ID of the platform part. The ID will be zero if it is a platform that is being added to the group.

References WsfGroup::JoinGroup(), and JoinGroup().

Referenced by JoinGroup().

◆ LeaveAllGroups()

void WsfGroupList::LeaveAllGroups ( )

Leave all groups this platform/platform part is a member of.

References GetGroupList(), and LeaveGroup().

◆ LeaveGroup()

void WsfGroupList::LeaveGroup	(	WsfGroup *	aGroupPtr,
		size_t	aPlatformIndex,
		unsigned int	aPlatformPartId = 0 )

Remove the a platform/platform part from group. This is the form called by the platform/platform part.

Parameters

aGroupPtr	Pointer to the group.
aPlatformIndex	The platform index.
aPlatformPartId	The unique ID of the platform part. The ID will be zero if it is a platform that is being removed from the group.

References WsfGroup::LeaveGroup(), and LeaveGroup().

Referenced by Initialize(), Initialize(), LeaveAllGroups(), and LeaveGroup().