A class for storing arbitrary values in an object. More...

#include <ObjFW/ObjFW.h>

Inheritance diagram for OFValue:

Instance Methods
(instancetype)	- initWithBytes:objCType:
	Initializes an already allocated OFValue with the specified bytes of the specified type.

(void)	- getValue:size:
	Gets the value.

Instance Methods inherited from OFObject
(instancetype)	- init
	Initializes an already allocated object.

(nullable OFMethodSignature *)	- methodSignatureForSelector:
	Returns the method signature for the specified selector.

(void)	- dealloc
	Deallocates the object.

(void)	- performSelector:afterDelay:
	Performs the specified selector after the specified delay.

(void)	- performSelector:withObject:afterDelay:
	Performs the specified selector with the specified object after the specified delay.

(void)	- performSelector:withObject:withObject:afterDelay:
	Performs the specified selector with the specified objects after the specified delay.

(void)	- performSelector:withObject:withObject:withObject:afterDelay:
	Performs the specified selector with the specified objects after the specified delay.

(void)	- performSelector:withObject:withObject:withObject:withObject:afterDelay:
	Performs the specified selector with the specified objects after the specified delay.

(void)	- performSelector:onThread:waitUntilDone:
	Performs the specified selector on the specified thread.

(void)	- performSelector:onThread:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified object.

(void)	- performSelector:onThread:withObject:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified objects.

(void)	- performSelector:onThread:withObject:withObject:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified objects.

(void)	- performSelector:onThread:withObject:withObject:withObject:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified objects.

(void)	- performSelectorOnMainThread:waitUntilDone:
	Performs the specified selector on the main thread.

(void)	- performSelectorOnMainThread:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified object.

(void)	- performSelectorOnMainThread:withObject:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified objects.

(void)	- performSelectorOnMainThread:withObject:withObject:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified objects.

(void)	- performSelectorOnMainThread:withObject:withObject:withObject:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified objects.

(void)	- performSelector:onThread:afterDelay:
	Performs the specified selector on the specified thread after the specified delay.

(void)	- performSelector:onThread:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified object after the specified delay.

(void)	- performSelector:onThread:withObject:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified objects after the specified delay.

(void)	- performSelector:onThread:withObject:withObject:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified objects after the specified delay.

(void)	- performSelector:onThread:withObject:withObject:withObject:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified objects after the specified delay.

(nullable id)	- forwardingTargetForSelector:
	This method is called when resolveClassMethod: or resolveInstanceMethod: returned false. It should return a target to which the message should be forwarded.

(void)	- doesNotRecognizeSelector:
	Handles messages which are not understood by the receiver.

Instance Methods inherited from <OFObject>
(unsigned long)	- hash
	Returns a hash for the object.

(unsigned int)	- retainCount
	Returns the retain count.

(bool)	- isProxy
	Returns whether the object is a proxy object.

(bool)	- isKindOfClass:
	Returns a boolean whether the object is of the specified kind.

(bool)	- isMemberOfClass:
	Returns a boolean whether the object is a member of the specified class.

(bool)	- respondsToSelector:
	Returns a boolean whether the object responds to the specified selector.

(nullable IMP)	- methodForSelector:
	Returns the implementation for the specified selector.

(nullable id)	- performSelector:
	Performs the specified selector.

(nullable id)	- performSelector:withObject:
	Performs the specified selector with the specified object.

(nullable id)	- performSelector:withObject:withObject:
	Performs the specified selector with the specified objects.

(nullable id)	- performSelector:withObject:withObject:withObject:
	Performs the specified selector with the specified objects.

(nullable id)	- performSelector:withObject:withObject:withObject:withObject:
	Performs the specified selector with the specified objects.

(bool)	- isEqual:
	Checks two objects for equality.

(instancetype)	- retain
	Increases the retain count.

(void)	- release
	Decreases the retain count.

(instancetype)	- autorelease
	Adds the object to the topmost autorelease pool of the thread's autorelease pool stack.

(instancetype)	- self
	Returns the receiver.

(bool)	- allowsWeakReference
	Returns whether the object allows a weak reference.

(bool)	- retainWeakReference
	Retain a weak reference to this object.

Instance Methods inherited from <OFCopying>
(id)	- copy
	Copies the object.

Class Methods
(instancetype)	+ valueWithBytes:objCType:
	Creates a new, autorelease OFValue with the specified bytes of the specified type.

(instancetype)	+ valueWithPointer:
	Creates a new, autoreleased OFValue containing the specified pointer.

(instancetype)	+ valueWithNonretainedObject:
	Creates a new, autoreleased OFValue containing the specified non-retained object.

(instancetype)	+ valueWithRange:
	Creates a new, autoreleased OFValue containing the specified range.

(instancetype)	+ valueWithPoint:
	Creates a new, autoreleased OFValue containing the specified point.

(instancetype)	+ valueWithSize:
	Creates a new, autoreleased OFValue containing the specified size.

(instancetype)	+ valueWithRect:
	Creates a new, autoreleased OFValue containing the specified rectangle.

(instancetype)	+ valueWithVector3D:
	Creates a new, autoreleased OFValue containing the specified 3D vector.

(instancetype)	+ valueWithVector4D:
	Creates a new, autoreleased OFValue containing the specified 4D vector.

Class Methods inherited from OFObject
(void)	+ load
	A method which is called once when the class is loaded into the runtime.

(void)	+ unload
	A method which is called when the class is unloaded from the runtime.

(void)	+ initialize
	A method which is called the moment before the first call to the class is being made.

(instancetype)	+ alloc
	Allocates memory for an instance of the class and sets up the memory pool for the object.

(Class)	+ class
	Returns the class.

(OFString *)	+ className
	Returns the name of the class as a string.

(bool)	+ isSubclassOfClass:
	Returns a boolean whether the class is a subclass of the specified class.

(nullable Class)	+ superclass
	Returns the superclass of the class.

(bool)	+ instancesRespondToSelector:
	Checks whether instances of the class respond to a given selector.

(bool)	+ conformsToProtocol:
	Checks whether the class conforms to a given protocol.

(nullable IMP)	+ instanceMethodForSelector:
	Returns the implementation of the instance method for the specified selector.

(nullable OFMethodSignature *)	+ instanceMethodSignatureForSelector:
	Returns the method signature of the instance method for the specified selector.

(OFString *)	+ description
	Returns a description for the class, which is usually the class name.

(nullable IMP)	+ replaceClassMethod:withMethodFromClass:
	Replaces a class method with a class method from another class.

(nullable IMP)	+ replaceInstanceMethod:withMethodFromClass:
	Replaces an instance method with an instance method from another class.

(void)	+ inheritMethodsFromClass:
	Adds all methods from the specified class to the class that is the receiver.

(bool)	+ resolveClassMethod:
	Try to resolve the specified class method.

(bool)	+ resolveInstanceMethod:
	Try to resolve the specified instance method.

(id)	+ copy
	Returns the class.

Properties
const char *	objCType
	The ObjC type encoding of the value.

void *	pointerValue
	The value as a pointer to void.

id	nonretainedObjectValue
	The value as a non-retained object.

OFRange	rangeValue
	The value as an OFRange.

OFPoint	pointValue
	The value as an OFPoint.

OFSize	sizeValue
	The value as an OFSize.

OFRect	rectValue
	The value as an OFRect.

OFVector3D	vector3DValue
	The value as an OFVector3D.

OFVector4D	vector4DValue
	The value as an OFVector4D.

Properties inherited from OFObject
OFString *	className
	The name of the object's class.

OFString *	description
	A description for the object.

Detailed Description

A class for storing arbitrary values in an object.

Method Documentation

◆ getValue:size:

- (void) getValue:		(void *)	value
size:		(size_t)	size

Gets the value.

Parameters

value	The buffer to copy the value into
size	The size of the value

Exceptions

OFOutOfRangeException The specified size does not match the value

◆ initWithBytes:objCType:

- (instancetype) initWithBytes:		(const void *)	bytes
objCType:		(const char *)	objCType

Initializes an already allocated OFValue with the specified bytes of the specified type.

Parameters

bytes	The bytes containing the value
objCType	The ObjC type encoding for the value

Returns: An initialized OFValue

◆ valueWithBytes:objCType:

+ (instancetype) valueWithBytes:		(const void *)	bytes
objCType:		(const char *)	objCType

Creates a new, autorelease OFValue with the specified bytes of the specified type.

Parameters

bytes	The bytes containing the value
objCType	The ObjC type encoding for the value

Returns: A new, autoreleased OFValue

◆ valueWithNonretainedObject:

+ (instancetype) valueWithNonretainedObject: (id) object

Creates a new, autoreleased OFValue containing the specified non-retained object.

The object is not retained, which makes this useful for storing objects in collections without retaining them.

Parameters

object The object the OFValue should contain without retaining it

Returns: A new, autoreleased OFValue

Reimplemented in OFNumber.

◆ valueWithPoint:

+ (instancetype) valueWithPoint: (OFPoint) point

Creates a new, autoreleased OFValue containing the specified point.

Parameters

point The point the OFValue should contain

Returns: A new, autoreleased OFValue

Reimplemented in OFNumber.

◆ valueWithPointer:

+ (instancetype) valueWithPointer: (const void *) pointer

Creates a new, autoreleased OFValue containing the specified pointer.

Only the raw value of the pointer is stored and no data will be copied.

Parameters

pointer The pointer the OFValue should contain

Returns: A new, autoreleased OFValue

Reimplemented in OFNumber.

◆ valueWithRange:

+ (instancetype) valueWithRange: (OFRange) range

Creates a new, autoreleased OFValue containing the specified range.

Parameters

range The range the OFValue should contain

Returns: A new, autoreleased OFValue

Reimplemented in OFNumber.

◆ valueWithRect:

+ (instancetype) valueWithRect: (OFRect) rect

Creates a new, autoreleased OFValue containing the specified rectangle.

Parameters

rect	The rectangle the OFValue should contain

Returns: A new, autoreleased OFValue

Reimplemented in OFNumber.

◆ valueWithSize:

+ (instancetype) valueWithSize: (OFSize) size

Creates a new, autoreleased OFValue containing the specified size.

Parameters

size	The size the OFValue should contain

Returns: A new, autoreleased OFValue

Reimplemented in OFNumber.

◆ valueWithVector3D:

+ (instancetype) valueWithVector3D: (OFVector3D) vector3D

Creates a new, autoreleased OFValue containing the specified 3D vector.

Parameters

vector3D The 3D vector the OFValue should contain

Returns: A new, autoreleased OFValue

◆ valueWithVector4D:

+ (instancetype) valueWithVector4D: (OFVector4D) vector4D

Creates a new, autoreleased OFValue containing the specified 4D vector.

Parameters

vector4D The 4D vector the OFValue should contain

Returns: A new, autoreleased OFValue

OFOutOfRangeException The value is not OFVector4D-sized

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

src/OFValue.h
src/OFValue.m

Instance Methods

Class Methods

Properties

Detailed Description

Method Documentation

◆ getValue:size:

◆ initWithBytes:objCType:

◆ valueWithBytes:objCType:

◆ valueWithNonretainedObject:

◆ valueWithPoint:

◆ valueWithPointer:

◆ valueWithRange:

◆ valueWithRect:

◆ valueWithSize:

◆ valueWithVector3D:

◆ valueWithVector4D:

Property Documentation

◆ nonretainedObjectValue

◆ pointerValue

◆ pointValue

◆ rangeValue

◆ rectValue

◆ sizeValue

◆ vector3DValue

◆ vector4DValue