A class that stores an ordered list of opaque resources that is used as a semantic grouping. More...

#include <omResourceGroup.h>

Public Member Functions
	ResourceGroup ()
	Create a new empty resource group. More...

	~ResourceGroup ()
	Destroy a resource group. More...

const OpaqueResource &	getParent () const
	Return a const reference to the resource that is the parent of the group. More...

void	setParent (const OpaqueResource &newParent)
	Set the resource that is the parent of the group. More...

Size	getResourceCount () const
	Return the number of resources there are in this resource group. More...

OpaqueResource &	getResource (Index resourceIndex)
	Return a reference to the resource at the specified index in this resource group. More...

const OpaqueResource &	getResource (Index resourceIndex) const
	Return a const reference to the resource at the specified index in this resource group. More...

Bool	addResource (const OpaqueResource &newResource)
	Add a new resource to the end of this resource group. More...

Bool	insertResource (Index resourceIndex, const OpaqueResource &newResource)
	Insert a new resource at the specified index within this resource group. More...

void	removeResource (Index resourceIndex)
	Remove the resource in this group at the specified index. More...

void	clearResources ()
	Remove all resources from this resource group. More...

Static Public Attributes
static const ResourceType	RESOURCE_TYPE
	The resource type for a resource group. More...

Detailed Description

A class that stores an ordered list of opaque resources that is used as a semantic grouping.

Constructor & Destructor Documentation

om::resources::ResourceGroup::ResourceGroup ( )

Create a new empty resource group.

om::resources::ResourceGroup::~ResourceGroup ( )

Destroy a resource group.

const OpaqueResource& om::resources::ResourceGroup::getParent ( ) const

inline

Return a const reference to the resource that is the parent of the group.

void om::resources::ResourceGroup::setParent ( const OpaqueResource & newParent )

inline

Set the resource that is the parent of the group.

Size om::resources::ResourceGroup::getResourceCount ( ) const

inline

Return the number of resources there are in this resource group.

OpaqueResource& om::resources::ResourceGroup::getResource ( Index resourceIndex )

inline

Return a reference to the resource at the specified index in this resource group.

const OpaqueResource& om::resources::ResourceGroup::getResource ( Index resourceIndex ) const

inline

Return a const reference to the resource at the specified index in this resource group.

Bool om::resources::ResourceGroup::addResource ( const OpaqueResource & newResource )

Add a new resource to the end of this resource group.

The method returns whether or not the resource was able to be added.

Bool om::resources::ResourceGroup::insertResource	(	Index	resourceIndex,
		const OpaqueResource &	newResource
	)

Insert a new resource at the specified index within this resource group.

The method returns whether or not the resource was able to be inserted.

void om::resources::ResourceGroup::removeResource ( Index resourceIndex )

Remove the resource in this group at the specified index.

void om::resources::ResourceGroup::clearResources ( )

Remove all resources from this resource group.

const ResourceType om::resources::ResourceGroup::RESOURCE_TYPE

static

The resource type for a resource group.

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