[AI] Utility list for managing dynamic sequence (DS) objects, provides search and removal by pointer and state. More...

#include <mxdsobject.h>

Inheritance diagram for MxDSObjectList:

Collaboration diagram for MxDSObjectList:

Public Member Functions
MxDSObject *	FindAndErase (MxDSObject *p_action)
	[AI] Finds the matching object and removes it from the list. More...

MxDSObject *	Find (MxDSObject *p_action)
	[AI] Finds a matching object in the list without removing it. More...

Public Member Functions inherited from MxUtilityList< MxDSObject * >
MxBool	PopFront (MxDSObject * &p_obj)
	[AI] Removes and returns the first element of the list. More...

void	PushBack (MxDSObject * p_obj)
	[AI] Pushes a copy of the provided object to the back of the list. More...

void	Remove (MxDSObject * p_obj)
	[AI] Removes all matching objects from the list. More...

Detailed Description

[AI] Utility list for managing dynamic sequence (DS) objects, provides search and removal by pointer and state.

[AI] This is a utility list specifically containing pointers to MxDSObject instances. Used to look up and optionally erase matching DS action objects by their object and state identifiers. [AI]

See also: MxDSObject

Definition at line 18 of file mxdsobject.h.

Member Function Documentation

◆ Find()

MxDSObject * MxDSObjectList::Find ( MxDSObject * p_action )

inline

[AI] Finds a matching object in the list without removing it.

Parameters

p_action Pointer to the DS object to search for. [AI]

Returns: Pointer to the found object (if any), otherwise NULL. [AI]

Definition at line 28 of file mxdsobject.h.

◆ FindAndErase()

MxDSObject * MxDSObjectList::FindAndErase ( MxDSObject * p_action )

inline

[AI] Finds the matching object and removes it from the list.

Parameters

p_action Pointer to the DS object to find and erase. [AI]

Returns: Pointer to the found and erased object (if any), otherwise NULL. [AI]

Definition at line 23 of file mxdsobject.h.

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

Public Member Functions

Detailed Description

Member Function Documentation

◆ Find()

◆ FindAndErase()