#include <Object.hpp>

Classes
struct	Emplace
	Emplace dummy type to pass type to Object emplacement constructor. More...

Public Member Functions
	Object (void)

	Object (const Object &obj)

	Object (Object &&obj) noexcept

template<typename ValueType , typename = Pothos::Util::disable_if_same<Object, ValueType>>
	Object (ValueType &&value)

template<typename ValueType , typename... Args>
	Object (Emplace< ValueType >, Args &&... args)

	Object (const char *)

	~Object (void)

Object &	operator= (const Object &rhs)

Object &	operator= (Object &&rhs)

	operator bool (void) const

bool	unique (void) const

const std::type_info &	type (void) const

template<typename ValueType >
const ValueType &	extract (void) const

template<typename ValueType >
ValueType &	ref (void)

template<typename ValueType >
ValueType	convert (void) const

template<typename ValueType >
	operator ValueType (void) const

Object	convert (const std::type_info &type) const

bool	canConvert (const std::type_info &type) const

std::ostream &	serialize (std::ostream &os) const

std::istream &	deserialize (std::istream &is)

int	compareTo (const Object &other) const

size_t	hashCode (void) const

std::string	toString (void) const

std::string	getTypeString (void) const

bool	equals (const Object &obj) const

bool	operator< (const Object &obj) const

bool	operator> (const Object &obj) const

Static Public Member Functions
template<typename ValueType >
static Object	make (ValueType &&value)

template<typename ValueType , typename... Args>
static Object	emplace (Args &&... args)

static bool	canConvert (const std::type_info &srcType, const std::type_info &dstType)

Public Attributes
Detail::ObjectContainer *	_impl
	Private implementation details. More...

Detailed Description

Object is a general type capable of storing arbitrary data types. When an Object instance is copied, the internal data is not copied. The internal data is only deleted when all Object copies are gone.

Making a new object: int MyValue = 42; Object foo(myValue);
Extracting an object (reference): const int &val = foo.extract<int>();
Converting an object (safe): const int long = foo.convert<long>();
Check if an object is null: myObj.null() or myObj == Object();
Check if an object is a type: myObj.type() == typeid(someType);

Constructor & Destructor Documentation

◆ Object() [1/6]

Pothos::Object::Object ( void )

Create a null Object.

◆ Object() [2/6]

Pothos::Object::Object ( const Object & obj )

Copy constructor for Object – does not copy the internal data. Both obj and the resulting Object will point to the same data.

Parameters

obj	another Object

◆ Object() [3/6]

Pothos::Object::Object ( Object && obj )

inlinenoexcept

Move constructor for Object. The contents of obj will be moved to the new Object.

Parameters

obj	another Object

◆ Object() [4/6]

template<typename ValueType , typename >

Pothos::Object::Object ( ValueType && value )

explicit

Create a new Object from an an arbitrary value.

Parameters

value the data to store internally

◆ Object() [5/6]

template<typename ValueType , typename... Args>

Pothos::Object::Object	(	Emplace< ValueType >	,
		Args &&...	args
	)

explicit

Create a new Object given a type and constructor arguments. The first argument uses the Emplace dummy to specify the type.

Parameters

args	the constructor arguments for type ValueType

◆ Object() [6/6]

Pothos::Object::Object ( const char * s )

inlineexplicit

Create an Object of type std::string from a C-style string.

◆ ~Object()

Pothos::Object::~Object ( void )

Destructor for Object. If this Object holds the only copy of the internal data, then the internal data will be deleted in the destructor.

Member Function Documentation

◆ canConvert() [1/2]

bool Pothos::Object::canConvert ( const std::type_info & type ) const

Is the conversion of this Object to specified type possible?

Parameters

type	the desired typeid in question

Returns: true if the conversion is possible.

◆ canConvert() [2/2]

static bool Pothos::Object::canConvert	(	const std::type_info &	srcType,
		const std::type_info &	dstType
	)

static

Is the conversion from source type to destination type possible?

Parameters

srcType	the type of the conversion input
dstType	the type of the conversion output

Returns: true if the conversion is possible.

◆ compareTo()

int Pothos::Object::compareTo ( const Object & other ) const

Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Exceptions

ObjectCompareError when the compare isnt possible

Parameters

other the other proxy object to compare against

Returns: an int representing less than, equal to, or greater than

◆ convert() [1/2]

template<typename ValueType >

ValueType Pothos::Object::convert ( void ) const

Convert performs a safe conversion that respects the value when an exact type conversion is not required or wanted. For example, the object may contain an int, we want a long.

Exceptions

ObjectConvertError if object cannot be safe casted

Returns: a value that represents the internal data

◆ convert() [2/2]

Object Pothos::Object::convert ( const std::type_info & type ) const

Convert to a new Object that will be of the type specified.

Exceptions

ObjectConvertError if object cannot be safe casted

Parameters

type	the desired type held by the output Object

Returns: a new Object that can be extracted to type

◆ deserialize()

std::istream& Pothos::Object::deserialize ( std::istream & is )

Deserialize the stream into the contents of this Object. Only make this call on a null object.

Exceptions

ObjectSerializeError if the type is not registered

Parameters

is	the input stream holding serialized data

Returns: a reference to the input stream

◆ emplace()

template<typename ValueType , typename... Args>

Object Pothos::Object::emplace ( Args &&... args )

static

Create an object with emplacement construction. The make method allows users to pass an explicit type, and an arbitrary number of constructor arguments which will be forwarded to the type T constructor.

Template Parameters

ValueType the internal type held by the new Object

Parameters

args	the constructor arguments for type ValueType

Returns: a new Object of type T constructed from args

◆ equals()

bool Pothos::Object::equals ( const Object & obj ) const

Value-based equality operator. When supported, the implementation uses the compareTo() method. Otherwise, the hash codes are compared for checking equality.

◆ extract()

template<typename ValueType >

const ValueType & Pothos::Object::extract ( void ) const

Get a const reference to the internal data. The requested cast type must exactly match the type().

Exceptions

ObjectConvertError if object type != ValueType

Returns: a const reference to the internal data

◆ getTypeString()

std::string Pothos::Object::getTypeString ( void ) const

Get a printable string representing the type held by this Object.

◆ hashCode()

size_t Pothos::Object::hashCode ( void ) const

Get a hash code for the contained object. The hash code should be identical for equivalent objects.

◆ make()

template<typename ValueType >

Object Pothos::Object::make ( ValueType && value )

static

Create an object where type can be explicitly specified. The make method allows users to pass an explicit type, which is not possible using the templated constructor. Also, the make method can create an Object containing another object; which is not possible with constructors because the copy constructor.

Parameters

value a value of arbitrary type to put in an Object

Returns: a new Object containing a copy of the specified value

◆ operator bool()

Pothos::Object::operator bool ( void ) const

explicit

Does the object hold a value?

Returns: true if the container is non-empty

◆ operator ValueType()

template<typename ValueType >

Pothos::Object::operator ValueType ( void ) const

Templated conversion operator to assign Object to a target type.

Exceptions

ObjectConvertError if object cannot be safe casted

◆ operator<()

bool Pothos::Object::operator< ( const Object & obj ) const

Less than comparable operator. When supported, the implementation uses the compareTo() method. Otherwise, the hash codes are compared for sorting purposes.

◆ operator=() [1/2]

Object& Pothos::Object::operator= ( const Object & rhs )

Object copy assignment. This Object will store a copy of the internal data in rhs. The old internal data will be released, and deleted if last.

Parameters

rhs	another Object

◆ operator=() [2/2]

Object& Pothos::Object::operator= ( Object && rhs )

Object move assignment. The contents of rhs will be moved to this Object. The old internal data will be released, and deleted if last.

Parameters

rhs	another Object

◆ operator>()

bool Pothos::Object::operator> ( const Object & obj ) const

Greater than comparable operator. When supported, the implementation uses the compareTo() method. Otherwise, the hash codes are compared for sorting purposes.

◆ ref()

template<typename ValueType >

ValueType & Pothos::Object::ref ( void )

Get a non-const reference to the internal data. The requested cast type must exactly match the type(). The Object must be unique and have only one reference.

Note: The Object container class is usually immutable unless the caller has sole ownership of the object. Typical use cases for mutability might include object initialization, object de-serialization, and rvalue m when object is a return value.

Exceptions

ObjectConvertError	if object type != ValueType
ObjectConvertError	if multiple reference counts

Returns: a non-const reference the internal data

◆ serialize()

std::ostream& Pothos::Object::serialize ( std::ostream & os ) const

Serialize the contents of the object into a stream.

Exceptions

ObjectSerializeError if the type is not registered

Parameters

os	the output stream for the serialized data

Returns: a reference to the output stream

◆ toString()

std::string Pothos::Object::toString ( void ) const

Get a printable string representation for this Object. The string formatting depends upon the contained value.

◆ type()

const std::type_info & Pothos::Object::type ( void ) const

inline

Get the type of the internal data. The call returns typeid(NullObject) if the Object is null.

◆ unique()

bool Pothos::Object::unique ( void ) const

Is the Object unique?

Returns: true if this is the only reference

Member Data Documentation

◆ _impl

Detail::ObjectContainer* Pothos::Object::_impl

Private implementation details.

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

include/Pothos/Object/Object.hpp
include/Pothos/Object/ObjectImpl.hpp

Classes

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Object() [1/6]

◆ Object() [2/6]

◆ Object() [3/6]

◆ Object() [4/6]

◆ Object() [5/6]

◆ Object() [6/6]

◆ ~Object()

Member Function Documentation

◆ canConvert() [1/2]

◆ canConvert() [2/2]

◆ compareTo()

◆ convert() [1/2]

◆ convert() [2/2]

◆ deserialize()

◆ emplace()

◆ equals()

◆ extract()

◆ getTypeString()

◆ hashCode()

◆ make()

◆ operator bool()

◆ operator ValueType()

◆ operator<()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator>()

◆ ref()

◆ serialize()

◆ toString()

◆ type()

◆ unique()

Member Data Documentation

◆ _impl