MezzanineEngine 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Protected Attributes | List of all members
Mezzanine::ObjectSettingGroup Class Reference

A class that store's a collection of SettingSets that can be applied together. More...

#include <objectsettings.h>

+ Inheritance diagram for Mezzanine::ObjectSettingGroup:
+ Collaboration diagram for Mezzanine::ObjectSettingGroup:

Public Member Functions

 ObjectSettingGroup (const String &Name)
 Class constructor. More...
 
virtual ~ObjectSettingGroup ()
 Class destructor.
 
void _MarkUpdated ()
 Marks this container and relevant parent containers as updated. More...
 
void _SetOptionalFile (ObjectSettingFile *File)
 Sets the file this group will be saved to. More...
 
ObjectSettingFileGetOptionalFile () const
 Gets the Setting file instance this group will be saved to. More...
 
const StringGetOptionalFileName () const
 Gets the file name this group will be saved to. More...
 
- Public Member Functions inherited from Mezzanine::ObjectSettingSetContainer
 ObjectSettingSetContainer (const String &Name)
 Class constructor. More...
 
virtual ~ObjectSettingSetContainer ()
 Class destructor.
 
virtual void AddChildObjectSettingSet (ObjectSettingSet *ToBeAdded)
 Adds a SettingSet as a child of this container. More...
 
virtual ObjectSettingSetCreateChildObjectSettingSet (const String &Name)
 Creates a new SettingSet as a child of this container. More...
 
void DestroyAllObjectSettingSets ()
 Destroys all child Sub-Sets of this container.
 
void DestroyChildObjectSettingSet (const String &Name)
 Destroys a Sub-Set of this container. More...
 
ObjectSettingSetGetChildObjectSettingSet (const String &Name, UInt16 Which=0) const
 Gets a Sub-Set of this container by name. More...
 
ObjectSettingSetGetChildObjectSettingSet (const Whole &Index) const
 Gets a Sub-Set of this container by index. More...
 
ConstStringGetName () const
 Gets the name of this container. More...
 
virtual void RemoveChildObjectSettingSet (ObjectSettingSet *ToBeRemoved)
 Removes a Sub-Set of this container. More...
 
void SetName (const String &Name)
 Sets the name of this container. More...
 
SubSetIterator SubSetBegin ()
 Gets an iterator to the first subset of settings in this set.
 
ConstSubSetIterator SubSetBegin () const
 Gets a const iterator to the first subset of settings in this set.
 
SubSetIterator SubSetEnd ()
 Gets an iterator to one passed the last subset of settings in this set.
 
ConstSubSetIterator SubSetEnd () const
 Gets a const iterator to one passed the last subset of settings in this set.
 

Protected Attributes

ObjectSettingFileOptionalFile
 A pointer to the ObjectSettingFile instance this setting group will be saved to. More...
 
- Protected Attributes inherited from Mezzanine::ObjectSettingSetContainer
String ContainerName
 The name of this container. More...
 
SubSetVector SubSets
 A container of ObjectSettingSet instances owned by this container. More...
 

Additional Inherited Members

- Public Types inherited from Mezzanine::ObjectSettingSetContainer
typedef
SubSetVector::const_iterator 
ConstSubSetIterator
 Const Iterator type for ObjectSettingSet instances stored by this class.
 
typedef SubSetVector::iterator SubSetIterator
 Iterator type for ObjectSettingSet instances stored by this class.
 
typedef std::vector
< ObjectSettingSet * > 
SubSetVector
 Basic container type for ObjectSettingSet storage by this class.
 

Detailed Description

A class that store's a collection of SettingSets that can be applied together.

Definition at line 222 of file objectsettings.h.

Constructor & Destructor Documentation

Mezzanine::ObjectSettingGroup::ObjectSettingGroup ( const String Name)

Class constructor.

Parameters
NameThe name to be given to this group.

Definition at line 213 of file objectsettings.cpp.

Member Function Documentation

void Mezzanine::ObjectSettingGroup::_MarkUpdated ( )
virtual

Marks this container and relevant parent containers as updated.

Implements Mezzanine::ObjectSettingSetContainer.

Definition at line 233 of file objectsettings.cpp.

void Mezzanine::ObjectSettingGroup::_SetOptionalFile ( ObjectSettingFile File)

Sets the file this group will be saved to.

Parameters
FileThe file this group should be saved to when saving the configuration.

Definition at line 239 of file objectsettings.cpp.

ObjectSettingFile * Mezzanine::ObjectSettingGroup::GetOptionalFile ( ) const

Gets the Setting file instance this group will be saved to.

Returns
Returns a pointer to the setting file this group belongs to.

Definition at line 224 of file objectsettings.cpp.

const String & Mezzanine::ObjectSettingGroup::GetOptionalFileName ( ) const

Gets the file name this group will be saved to.

Returns
Returns a const reference to the currently set file name. String will be empty if this is not set.

Definition at line 227 of file objectsettings.cpp.

Member Data Documentation

ObjectSettingFile* Mezzanine::ObjectSettingGroup::OptionalFile
protected

A pointer to the ObjectSettingFile instance this setting group will be saved to.

Definition at line 227 of file objectsettings.h.


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