OpenMW
Public Types | Public Member Functions | Static Public Member Functions | Private Attributes
CSMWorld::UniversalId Class Reference

#include <universalid.hpp>

List of all members.

Public Types

enum  Class {
  Class_None = 0, Class_Record, Class_RefRecord, Class_SubRecord,
  Class_RecordList, Class_Collection, Class_Transient, Class_NonRecord
}
enum  ArgumentType { ArgumentType_None, ArgumentType_Id, ArgumentType_Index }
enum  Type {
  Type_None = 0, Type_Globals, Type_Global, Type_VerificationResults,
  Type_Gmsts, Type_Gmst, Type_Skills, Type_Skill,
  Type_Classes, Type_Class, Type_Factions, Type_Faction,
  Type_Races, Type_Race, Type_Sounds, Type_Sound,
  Type_Scripts, Type_Script, Type_Regions, Type_Region,
  Type_Birthsigns, Type_Birthsign, Type_Spells, Type_Spell,
  Type_Cells, Type_Cell, Type_Referenceables, Type_Referenceable,
  Type_Activator, Type_Potion, Type_Apparatus, Type_Armor,
  Type_Book, Type_Clothing, Type_Container, Type_Creature,
  Type_Door, Type_Ingredient, Type_CreatureLevelledList, Type_ItemLevelledList,
  Type_Light, Type_Lockpick, Type_Miscellaneous, Type_Npc,
  Type_Probe, Type_Repair, Type_Static, Type_Weapon,
  Type_References, Type_Reference, Type_RegionMap, Type_Filter,
  Type_Filters, Type_Topics, Type_Topic, Type_Journals,
  Type_Journal, Type_TopicInfos, Type_TopicInfo, Type_JournalInfos,
  Type_JournalInfo, Type_Scene
}
enum  { NumberOfTypes = Type_Scene+1 }

Public Member Functions

 UniversalId (const std::string &universalId)
 UniversalId (Type type=Type_None)
 UniversalId (Type type, const std::string &id)
 Using a type for a non-ID-argument UniversalId will throw an exception.
 UniversalId (Type type, int index)
 Using a type for a non-index-argument UniversalId will throw an exception.
Class getClass () const
ArgumentType getArgumentType () const
Type getType () const
const std::string & getId () const
 Calling this function for a non-ID type will throw an exception.
int getIndex () const
 Calling this function for a non-index type will throw an exception.
bool isEqual (const UniversalId &universalId) const
bool isLess (const UniversalId &universalId) const
std::string getTypeName () const
std::string toString () const
std::string getIcon () const
 Will return an empty string, if no icon is available.

Static Public Member Functions

static std::vector< TypelistReferenceableTypes ()

Private Attributes

Class mClass
ArgumentType mArgumentType
Type mType
std::string mId
int mIndex

Member Enumeration Documentation

anonymous enum
Enumerator:
NumberOfTypes 
Enumerator:
ArgumentType_None 
ArgumentType_Id 
ArgumentType_Index 
Enumerator:
Class_None 
Class_Record 
Class_RefRecord 
Class_SubRecord 
Class_RecordList 
Class_Collection 
Class_Transient 
Class_NonRecord 
Enumerator:
Type_None 
Type_Globals 
Type_Global 
Type_VerificationResults 
Type_Gmsts 
Type_Gmst 
Type_Skills 
Type_Skill 
Type_Classes 
Type_Class 
Type_Factions 
Type_Faction 
Type_Races 
Type_Race 
Type_Sounds 
Type_Sound 
Type_Scripts 
Type_Script 
Type_Regions 
Type_Region 
Type_Birthsigns 
Type_Birthsign 
Type_Spells 
Type_Spell 
Type_Cells 
Type_Cell 
Type_Referenceables 
Type_Referenceable 
Type_Activator 
Type_Potion 
Type_Apparatus 
Type_Armor 
Type_Book 
Type_Clothing 
Type_Container 
Type_Creature 
Type_Door 
Type_Ingredient 
Type_CreatureLevelledList 
Type_ItemLevelledList 
Type_Light 
Type_Lockpick 
Type_Miscellaneous 
Type_Npc 
Type_Probe 
Type_Repair 
Type_Static 
Type_Weapon 
Type_References 
Type_Reference 
Type_RegionMap 
Type_Filter 
Type_Filters 
Type_Topics 
Type_Topic 
Type_Journals 
Type_Journal 
Type_TopicInfos 
Type_TopicInfo 
Type_JournalInfos 
Type_JournalInfo 
Type_Scene 

Constructor & Destructor Documentation

CSMWorld::UniversalId::UniversalId ( const std::string &  universalId)
CSMWorld::UniversalId::UniversalId ( Type  type,
const std::string &  id 
)

Using a type for a non-ID-argument UniversalId will throw an exception.

CSMWorld::UniversalId::UniversalId ( Type  type,
int  index 
)

Using a type for a non-index-argument UniversalId will throw an exception.


Member Function Documentation

std::string CSMWorld::UniversalId::getIcon ( ) const

Will return an empty string, if no icon is available.

const std::string & CSMWorld::UniversalId::getId ( ) const

Calling this function for a non-ID type will throw an exception.

Calling this function for a non-index type will throw an exception.

std::string CSMWorld::UniversalId::getTypeName ( ) const
bool CSMWorld::UniversalId::isEqual ( const UniversalId universalId) const
bool CSMWorld::UniversalId::isLess ( const UniversalId universalId) const
std::string CSMWorld::UniversalId::toString ( ) const

Member Data Documentation

std::string CSMWorld::UniversalId::mId [private]

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