#include <UT_Options.h>

Inheritance diagram for UT_OptionsRef:

Public Types
typedef UT_Options	value_type

Public Member Functions
SYS_FORCE_INLINE	UT_OptionsRef ()

SYS_FORCE_INLINE	UT_OptionsRef (const UT_Options *opt)
	Will make a shallow reference. More...

SYS_FORCE_INLINE	UT_OptionsRef (const UT_OptionsRef &s)
	Shares a reference with the source. More...

SYS_FORCE_INLINE	UT_OptionsRef (UT_OptionsRef &&s) noexcept
	Move constructor. Steals the working data from the original. More...

SYS_FORCE_INLINE	~UT_OptionsRef ()

bool	isUnique () const
	Returns true this object is the sole owner of the underlying options. More...

int	use_count () const

UT_OptionsRef &	operator= (const UT_OptionsRef &s)
	Shares a reference with the source. More...

SYS_FORCE_INLINE UT_OptionsRef &	operator= (UT_OptionsRef &&s)

SYS_FORCE_INLINE const UT_Options *	optionsOrNull () const

SYS_FORCE_INLINE const UT_Options *	options () const

bool	operator== (const UT_OptionsRef &s) const

bool	operator== (const UT_Options *b) const

bool	operator!= (const UT_OptionsRef &s) const

bool	operator!= (const UT_Options *s) const

bool	isEqual (const UT_OptionsRef &s, fpreal64 tol) const
	Comparison operator with a tolerance for float values. More...

SYS_FORCE_INLINE const UT_Options *	operator-> () const

SYS_FORCE_INLINE const UT_Options &	operator* () const

SYS_FORCE_INLINE void	swap (UT_OptionsRef &other)

SYS_FORCE_INLINE void	clear ()

bool	isEmpty () const

	operator bool () const

unsigned	hash () const

void	reference (const UT_Options *src)

int64	getMemoryUsage (bool inclusive) const

Static Public Member Functions
static const UT_Options &	emptyOptions ()

Friends
class	UT_OptionsHolder

void	swap (UT_OptionsRef &a, UT_OptionsRef &b)
	Friend specialization of std::swap() to use UT_OptionsRef::swap() More...

enum	UT_OptionsSentinelType { SENTINEL }

SYS_FORCE_INLINE	UT_OptionsRef (UT_OptionsSentinelType)

SYS_FORCE_INLINE bool	isSentinel () const

SYS_FORCE_INLINE void	makeSentinel ()

Detailed Description

A holder for a options, which caches the hash value. A UT_OptionsRef does not necessarily own the options, and it is therefore not safe to e.g. store a UT_OptionsRef in a container or member variable.

See Also: UT_OptionsHolder

Definition at line 778 of file UT_Options.h.

Member Typedef Documentation

typedef UT_Options UT_OptionsRef::value_type

Definition at line 781 of file UT_Options.h.

Member Enumeration Documentation

enum UT_OptionsRef::UT_OptionsSentinelType

Special sentinel value support

Enumerator
SENTINEL

Definition at line 823 of file UT_Options.h.

Constructor & Destructor Documentation

SYS_FORCE_INLINE UT_OptionsRef::UT_OptionsRef ( )

inline

Definition at line 784 of file UT_Options.h.

SYS_FORCE_INLINE UT_OptionsRef::UT_OptionsRef ( const UT_Options * opt )

inline

Will make a shallow reference.

Definition at line 791 of file UT_Options.h.

SYS_FORCE_INLINE UT_OptionsRef::UT_OptionsRef ( const UT_OptionsRef & s )

inline

Shares a reference with the source.

Definition at line 799 of file UT_Options.h.

SYS_FORCE_INLINE UT_OptionsRef::UT_OptionsRef ( UT_OptionsRef && s )

inlinenoexcept

Move constructor. Steals the working data from the original.

Definition at line 808 of file UT_Options.h.

SYS_FORCE_INLINE UT_OptionsRef::~UT_OptionsRef ( )

inline

Definition at line 817 of file UT_Options.h.

SYS_FORCE_INLINE UT_OptionsRef::UT_OptionsRef ( UT_OptionsSentinelType )

inlineexplicit

Special sentinel value support

Definition at line 826 of file UT_Options.h.

Member Function Documentation

SYS_FORCE_INLINE void UT_OptionsRef::clear ( )

inline

Definition at line 976 of file UT_Options.h.

static const UT_Options& UT_OptionsRef::emptyOptions ( )

inlinestatic

Definition at line 1030 of file UT_Options.h.

int64 UT_OptionsRef::getMemoryUsage ( bool inclusive ) const

inline

Definition at line 1020 of file UT_Options.h.

unsigned UT_OptionsRef::hash ( ) const

inline

Definition at line 995 of file UT_Options.h.

bool UT_OptionsRef::isEmpty ( ) const

inline

Definition at line 981 of file UT_Options.h.

bool UT_OptionsRef::isEqual	(	const UT_OptionsRef &	s,
		fpreal64	tol
	)		const

Comparison operator with a tolerance for float values.

SYS_FORCE_INLINE bool UT_OptionsRef::isSentinel ( ) const

inline

Special sentinel value support

Definition at line 833 of file UT_Options.h.

bool UT_OptionsRef::isUnique ( ) const

inline

Returns true this object is the sole owner of the underlying options.

Definition at line 848 of file UT_Options.h.

SYS_FORCE_INLINE void UT_OptionsRef::makeSentinel ( )

inline

Special sentinel value support

Definition at line 839 of file UT_Options.h.

UT_OptionsRef::operator bool ( ) const

inlineexplicit

Definition at line 993 of file UT_Options.h.

bool UT_OptionsRef::operator!= ( const UT_OptionsRef & s ) const

inline

Definition at line 953 of file UT_Options.h.

bool UT_OptionsRef::operator!= ( const UT_Options * s ) const

inline

Definition at line 955 of file UT_Options.h.

SYS_FORCE_INLINE const UT_Options& UT_OptionsRef::operator* ( ) const

inline

Definition at line 962 of file UT_Options.h.

SYS_FORCE_INLINE const UT_Options* UT_OptionsRef::operator-> ( ) const

inline

Definition at line 961 of file UT_Options.h.

UT_OptionsRef& UT_OptionsRef::operator= ( const UT_OptionsRef & s )

inline

Shares a reference with the source.

Definition at line 872 of file UT_Options.h.

SYS_FORCE_INLINE UT_OptionsRef& UT_OptionsRef::operator= ( UT_OptionsRef && s )

inline

Move the contents of about-to-be-destructed options s to this string.

Definition at line 884 of file UT_Options.h.

bool UT_OptionsRef::operator== ( const UT_OptionsRef & s ) const

inline

Definition at line 908 of file UT_Options.h.

bool UT_OptionsRef::operator== ( const UT_Options * b ) const

inline

Definition at line 934 of file UT_Options.h.

SYS_FORCE_INLINE const UT_Options* UT_OptionsRef::options ( ) const

inline

Definition at line 900 of file UT_Options.h.

SYS_FORCE_INLINE const UT_Options* UT_OptionsRef::optionsOrNull ( ) const

inline

Definition at line 892 of file UT_Options.h.

void UT_OptionsRef::reference ( const UT_Options * src )

inline

Make a light weight reference to the source. Caller must make sure src lives for the duration of this object, and any objects value copied from this!

Definition at line 1014 of file UT_Options.h.

SYS_FORCE_INLINE void UT_OptionsRef::swap ( UT_OptionsRef & other )

inline

Definition at line 965 of file UT_Options.h.

int UT_OptionsRef::use_count ( ) const

inline

Returns the shared ptr use count. 0 if not a shared pointer. (null or soft ref)

Definition at line 862 of file UT_Options.h.

Friends And Related Function Documentation

void swap	(	UT_OptionsRef &	a,
		UT_OptionsRef &	b
	)

friend

Friend specialization of std::swap() to use UT_OptionsRef::swap()

Definition at line 973 of file UT_Options.h.

friend class UT_OptionsHolder

friend

Definition at line 1068 of file UT_Options.h.

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

UT/UT_Options.h

Public Types

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation