ParameterGroupNode Struct Reference

A datatype for storing a ParameterGroup on a LinkedList. More...

#include <parameter_group.h>

Inheritance diagram for ParameterGroupNode:
[legend]
Collaboration diagram for ParameterGroupNode:
[legend]

Public Member Functions

ParameterGroupNodeAllocateParameterGroupNode (ParameterGroup *group_p)
 Allocate a ParameterGroupNode that will take ownership of a given ParameterGroup. More...
 
void FreeParameterGroupNode (ListItem *node_p)
 Free a given ParameterGroupNode. More...
 

Data Fields

ListItem pgn_node
 The base list node. More...
 
ParameterGrouppgn_param_group_p
 Pointer to the associated ParameterGroup. More...
 
- Data Fields inherited from ListItem
ListItemln_prev_p
 A pointer to the previous ListItem. More...
 
ListItemln_next_p
 A pointer to the next ListItem. More...
 

Detailed Description

A datatype for storing a ParameterGroup on a LinkedList.

Member Function Documentation

◆ AllocateParameterGroupNode()

ParameterGroupNode * AllocateParameterGroupNode ( ParameterGroup group_p)

Allocate a ParameterGroupNode that will take ownership of a given ParameterGroup.

Parameters
group_pThe ParameterGroup that the ParameterGroupNode will reference.
Returns
The new ParameterGroupNode or NULL upon error.

◆ FreeParameterGroupNode()

void FreeParameterGroupNode ( ListItem node_p)

Free a given ParameterGroupNode.

This will also free the associated ParameterGroup.

Parameters
node_pThe ParameterGroupNode to free.

Field Documentation

◆ pgn_node

ListItem pgn_node

The base list node.

◆ pgn_param_group_p

ParameterGroup* pgn_param_group_p

Pointer to the associated ParameterGroup.


The documentation for this struct was generated from the following file: