designpatternexamples/general/_mediator___group_8h_source.html

#pragma once

#ifndef __MEDIATOR_GROUP_H__

#define __MEDIATOR_GROUP_H__


#include "helpers/stringlist.h"


typedef struct

{

    const char* Name;


    StringList Users;

} Group;


//-----------------------------------------------------------------------------


Group* Group_Create(const char* groupName);


void Group_Destroy(Group* group);


bool Group_AddUser(Group* group, const char* userName);


int Group_FindUser(Group* group, const char* userName);


void Group_RemoveUser(Group* group, int removeIndex);


bool Group_GetAllUsers(Group* group, StringList* users);


#endif // __MEDIATOR_GROUP_H__


Group_Destroy
void Group_Destroy(Group *group)
Release the memory of the specified Group object. After this function returns, the pointer to the Gro...
Definition: Mediator_Group.c:34

Group_FindUser
int Group_FindUser(Group *group, const char *userName)
Search the specified group for the specified user.
Definition: Mediator_Group.c:60

Group_RemoveUser
void Group_RemoveUser(Group *group, int removeIndex)
Remove a user from the specified group. Does nothing if the user is not in the group.
Definition: Mediator_Group.c:75

Group_AddUser
bool Group_AddUser(Group *group, const char *userName)
Add a user to the specified group. Does nothing if the user is already in the group.
Definition: Mediator_Group.c:46

Group_Create
Group * Group_Create(const char *groupName)
Create a new Group object with the specified name.
Definition: Mediator_Group.c:14

Group_GetAllUsers
bool Group_GetAllUsers(Group *group, StringList *users)
Retrieve the names of all users in the group.
Definition: Mediator_Group.c:87

StringList
std::vector< std::string > StringList
Typedef for a vector of std::string.
Definition: lusplus/helpers/stringlist.h:16

Group
Represents a single group. A group has a name and zero or more users. Users are tracked by name.
Definition: Mediator_Group.h:18

Group::Users
StringList Users
The list of users in this group.
Definition: Mediator_Group.h:27

Group::Name
const char * Name
Name of this group.
Definition: Mediator_Group.h:22