summaryrefslogtreecommitdiff
path: root/indra/llinventory/llcategory.h
diff options
context:
space:
mode:
authorJames Cook <james@lindenlab.com>2007-01-02 08:33:20 +0000
committerJames Cook <james@lindenlab.com>2007-01-02 08:33:20 +0000
commit420b91db29485df39fd6e724e782c449158811cb (patch)
treeb471a94563af914d3ed3edd3e856d21cb1b69945 /indra/llinventory/llcategory.h
Print done when done.
Diffstat (limited to 'indra/llinventory/llcategory.h')
-rw-r--r--indra/llinventory/llcategory.h80
1 files changed, 80 insertions, 0 deletions
diff --git a/indra/llinventory/llcategory.h b/indra/llinventory/llcategory.h
new file mode 100644
index 0000000000..a28b707d93
--- /dev/null
+++ b/indra/llinventory/llcategory.h
@@ -0,0 +1,80 @@
+/**
+ * @file llcategory.h
+ * @brief LLCategory class header file.
+ *
+ * Copyright (c) 2002-$CurrentYear$, Linden Research, Inc.
+ * $License$
+ */
+
+#ifndef LL_LLCATEGORY_H
+#define LL_LLCATEGORY_H
+
+//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+// Class LLCategory
+//
+// An instance of the LLCategory class represents a particular
+// category in a hierarchical classification system. For now, it is 4
+// levels deep with 255 (minus 1) possible values at each level. If a
+// non zero value is found at level 4, that is the leaf category,
+// otherwise, it is the first level that has a 0 in the next depth
+// level.
+//
+// To output the names of all top level categories, you could do the
+// following:
+//
+// S32 count = LLCategory::none.getSubCategoryCount();
+// for(S32 i = 0; i < count; i++)
+// {
+// llinfos << none.getSubCategory(i).lookupNmae() << llendl;
+// }
+//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+class LLMessageSystem;
+
+class LLCategory
+{
+public:
+ // Nice default static const.
+ static const LLCategory none;
+
+ // construction. Since this is really a POD type, destruction,
+ // copy, and assignment are handled by the compiler.
+ LLCategory();
+ explicit LLCategory(U32 value) { init(value); }
+
+ // methods
+ void init(U32 value);
+ U32 getU32() const;
+ S32 getSubCategoryCount() const;
+
+ // This method will return a category that is the nth
+ // subcategory. If you're already at the bottom of the hierarchy,
+ // then the method will return a copy of this.
+ LLCategory getSubCategory(U8 n) const;
+
+ // This method will return the name of the leaf category type
+ const char* lookupName() const;
+
+ // This method will return the full hierarchy name in an easily
+ // interpreted (TOP)|(SUB1)|(SUB2) format. *NOTE: not implemented
+ // because we don't have anything but top level categories at the
+ // moment.
+ //const char* lookupFullName() const;
+
+ // message serialization
+ void packMessage(LLMessageSystem* msg) const;
+ void unpackMessage(LLMessageSystem* msg, const char* block);
+ void unpackMultiMessage(LLMessageSystem* msg, const char* block,
+ S32 block_num);
+protected:
+ enum
+ {
+ CATEGORY_TOP = 0,
+ CATEGORY_DEPTH = 4,
+ };
+
+ U8 mData[CATEGORY_DEPTH];
+};
+
+
+#endif // LL_LLCATEGORY_H