PColourPair Class Reference

This class contains a pair of colour formats for conversion. More...

#include <vconvert.h>

Inheritance diagram for PColourPair:

Collaboration diagram for PColourPair:

Public Member Functions
	PColourPair (const PString &src, const PString &dst)
Comparison	Compare (const PObject &other) const
	Compare the two objects and return their relative rank. More...
const PString &	GetSrcColourFormat () const
	Get the source colour format. More...
const PString &	GetDstColourFormat () const
	Get the destination colour format. More...
Public Member Functions inherited from PObject
__inline unsigned	GetTraceContextIdentifier () const
	Get PTRACE context identifier. More...
__inline void	SetTraceContextIdentifier (unsigned id)
__inline void	SetTraceContextIdentifier (const PObject &obj)
__inline void	SetTraceContextIdentifier (const PObject *obj)
__inline void	CopyTraceContextIdentifier (PObject &obj) const
__inline void	CopyTraceContextIdentifier (PObject *obj) const
virtual	~PObject ()
__inline const char *	GetClass () const
__inline bool	IsClass (const char *name) const
__inline const PObject *	PTraceObjectInstance () const
virtual PObject *	Clone () const
	Create a copy of the class on the heap. More...
template<class CLS >
CLS *	CloneAs () const
	As for Clone() but converts to specified type. More...
virtual PINDEX	HashFunction () const
	This function yields a hash value required by the PDictionary class. More...
virtual Comparison	CompareObjectMemoryDirect (const PObject &obj) const
	Determine the byte wise comparison of two objects. More...
bool	operator== (const PObject &obj) const
	Compare the two objects. More...
bool	operator!= (const PObject &obj) const
	Compare the two objects. More...
bool	operator< (const PObject &obj) const
	Compare the two objects. More...
bool	operator> (const PObject &obj) const
	Compare the two objects. More...
bool	operator<= (const PObject &obj) const
	Compare the two objects. More...
bool	operator>= (const PObject &obj) const
	Compare the two objects. More...
virtual void	PrintOn (ostream &strm) const
	Output the contents of the object to the stream. More...
virtual void	ReadFrom (istream &strm)
	Input the contents of the object from the stream. More...

Protected Attributes
const PString	m_srcColourFormat
const PString	m_dstColourFormat
Protected Attributes inherited from PObject
unsigned	m_traceContextIdentifier

Additional Inherited Members
Public Types inherited from PObject
enum	Comparison { LessThan = -1, EqualTo = 0, GreaterThan = 1 }
	Result of the comparison operation performed by the Compare() function. More...
Static Public Member Functions inherited from PObject
static __inline void	CopyTraceContextIdentifier (PObject &to, const PObject &from)
static __inline void	CopyTraceContextIdentifier (PObject &to, const PObject *from)
static __inline void	CopyTraceContextIdentifier (PObject *to, const PObject &from)
static __inline void	CopyTraceContextIdentifier (PObject *to, const PObject *from)
static __inline const char *	Class ()
static __inline const PObject *	PTraceObjectInstance (const char *)
static __inline const PObject *	PTraceObjectInstance (const PObject *obj)
template<typename T >
static Comparison	Compare2 (T v1, T v2)
	Compare two types, returning Comparison type. More...
static Comparison	InternalCompareObjectMemoryDirect (const PObject *obj1, const PObject *obj2, PINDEX size)
	Internal function caled from CompareObjectMemoryDirect() More...
Protected Member Functions inherited from PObject
	PObject ()
	Constructor for PObject, made protected so cannot ever create one on its own. More...

Detailed Description

This class contains a pair of colour formats for conversion.

Constructor & Destructor Documentation

PColourPair::PColourPair ( const PString &  src, const PString &  dst  )

inline

Member Function Documentation

Comparison PColourPair::Compare ( const PObject &  obj ) const

virtual

Compare the two objects and return their relative rank.

This function is usually overridden by descendent classes to yield the ranking according to the semantics of the object.

The default function is to use the CompareObjectMemoryDirect() function to do a byte wise memory comparison of the two objects.

Returns

LessThan, EqualTo or GreaterThan according to the relative rank of the objects.

Reimplemented from PObject.

const PString& PColourPair::GetDstColourFormat ( ) const

inline

Get the destination colour format.

References m_dstColourFormat.

const PString& PColourPair::GetSrcColourFormat ( ) const

inline

Get the source colour format.

References m_srcColourFormat.

Member Data Documentation

const PString PColourPair::m_dstColourFormat

protected

Referenced by GetDstColourFormat().

const PString PColourPair::m_srcColourFormat

protected

Referenced by GetSrcColourFormat().

---

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

• vconvert.h