Zen API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kBox Class Reference

Description

Represents an instance of a value type as an object.

kBox provides a simple way to represent a single value (e.g. k32s) using a kObject-derived class instance. This approach can sometimes be used to reduce duplicated effort when both reference types and value types must be supported.

kBox supports the kObject_Clone and kObject_Size methods.

kBox supports the kdat5 and kdat6 serialization protocols.

Inheritance diagram for kBox:
Inheritance graph

Public Member Functions

kStatus kBox_Allocate (kBox box, kType itemType)
 Reallocates the internal box item buffer. More...
 
kStatus kBox_Assign (kBox box, kBox source)
 Copies the value contained within the source box into this box. More...
 
kStatus kBox_Construct (kBox *box, kType itemType, kAlloc allocator)
 Constructs a kBox object. More...
 
void * kBox_Data (kBox box)
 Returns a pointer to the box item buffer. More...
 
kStatus kBox_Item (kBox box, void *item)
 Gets the box value. More...
 
kSize kBox_ItemSize (kBox box)
 Returns the box item size. More...
 
kType kBox_ItemType (kBox box)
 Returns the box item type. More...
 
kStatus kBox_SetItem (kBox box, const void *item)
 Sets the box value. More...
 
kStatus kBox_Zero (kBox box)
 Sets all box element bits to zero. More...
 
- Public Member Functions inherited from kObject
kAlloc kObject_Alloc (kObject object)
 Gets the memory allocator associated with this object. More...
 
kStatus kObject_Clone (kObject *object, kObject source, kAlloc allocator)
 Constructs a new object by copying an existing object, including any aggregated child elements. More...
 
kStatus kObject_Destroy (kObject object)
 Destroys the object. More...
 
kStatus kObject_Dispose (kObject object)
 Destroys the object and any aggregated child elements. More...
 
kBool kObject_Equals (kObject object, kObject other)
 Determines whether the object is equal to another object. More...
 
kBool kObject_HasForeignData (kObject object)
 Reports whether the object, including aggregated child elements, contains any foreign memory references. More...
 
kSize kObject_HashCode (kObject object)
 Gets a hash code representing the state of this object. More...
 
kBool kObject_Is (kObject object, kType type)
 Determines whether this object is an instance of the specified type. More...
 
kBool kObject_IsShared (kObject object)
 Reports whether the object is currently shared (reference count greater than one). More...
 
kStatus kObject_SetPool (kObject object, kObjectPool pool)
 Sets the object pool associated with this object. More...
 
kStatus kObject_Share (kObject object)
 Increments the reference count associated with this object. More...
 
kSize kObject_Size (kObject object)
 Estimates the memory consumed by this object, including any aggregated child elements. More...
 
kType kObject_Type (kObject object)
 Returns the type of the object. More...
 

Related

#define kBox_AsT(kBox_box, T)
 Gets the box value. More...
 
#define kBox_DataT(kBox_box, T)
 Returns a strongly-typed pointer to the box item buffer. More...
 
#define kBox_ItemT(kBox_box, TPtr_item)
 Gets the box value. More...
 
#define kBox_SetAsT(kBox_box, T_value, T)
 Sets the box value. More...
 
#define kBox_SetItemT(kBox_box, TPtr_item)
 Sets the box value. More...
 

Additional Inherited Members

- Protected Member Functions inherited from kObject
kStatus kObject_FreeMem (kObject object, void *mem)
 Protected method called by derived classes to free memory using the object's allocator. More...
 
kStatus kObject_FreeMemRef (kObject object, void *mem)
 Protected method called by derived classes to free memory (and reset the provided memory pointer to kNULL) using the object's allocator. More...
 
kStatus kObject_GetMem (kObject object, kSize size, void *mem)
 Protected method called by derived classes to allocate memory using the object's allocator. More...
 
kStatus kObject_GetMemZero (kObject object, kSize size, void *mem)
 Protected method called by derived classes to allocate and zero memory using the object's allocator. More...
 
kStatus kObject_Init (kObject object, kType type, kAlloc alloc)
 Protected method called by derived classes to initialize the kObject base class. More...
 
kStatus kObject_VDisposeItems (kObject object)
 Protected virtual method that destroys any aggregated child objects associated with a collection. More...
 
kBool kObject_VEquals (kObject object, kObject other)
 Protected virtual method that compares two objects for equality. More...
 
kBool kObject_VHasForeignData (kObject object)
 Protected virtual method that reports whether the object, including aggregated child elements, contains any foreign memory references. More...
 
kSize kObject_VHashCode (kObject object)
 Protected virtual method that calculates a hash code representing the object instance. More...
 
kStatus kObject_VInitClone (kObject object, kObject source, kAlloc allocator)
 Protected virtual method that clones (makes a deep copy of) the specified source object. More...
 
kStatus kObject_VRelease (kObject object)
 Protected virtual method that deallocates any resources owned by the object. More...
 
kSize kObject_VSize (kObject object)
 Protected virtual method that calculates the total size (in bytes) of the object instance. More...
 

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