#include <videoio.h>

Inheritance diagram for PVideoControlInfo:

Collaboration diagram for PVideoControlInfo:

Public Member Functions
	P_DECLARE_STREAMABLE_ENUM (Types, Pan, Tilt, Zoom, Focus)

	PVideoControlInfo (Types type=EndTypes, int minimum=0, int maximum=100, int step=1, int reset=0)

virtual void	PrintOn (ostream &strm) const
	Output the contents of the object to the stream. More...

bool	IsValid () const

Types	GetType () const

int	GetStep () const

int	Reset ()

int	GetCurrent () const

int	SetCurrent (int current)

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	Compare (const PObject &obj) const
	Compare the two objects and return their relative rank. 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	ReadFrom (istream &strm)
	Input the contents of the object from the stream. More...

Protected Attributes
Types	m_type

int	m_minimum

int	m_maximum

int	m_step

int	m_reset

int	m_current

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...

Constructor & Destructor Documentation

PVideoControlInfo::PVideoControlInfo	(	Types	type = `EndTypes`,
		int	minimum = `0`,
		int	maximum = `100`,
		int	step = `1`,
		int	reset = `0`
	)

inline

Member Function Documentation

int PVideoControlInfo::GetCurrent ( ) const

inline

References m_current.

int PVideoControlInfo::GetStep ( ) const

inline

References m_step.

Types PVideoControlInfo::GetType ( ) const

inline

References m_type.

bool PVideoControlInfo::IsValid ( ) const

inline

References m_type.

PVideoControlInfo::P_DECLARE_STREAMABLE_ENUM	(	Types	,
		Pan	,
		Tilt	,
		Zoom	,
		Focus
	)

virtual void PVideoControlInfo::PrintOn ( ostream & strm ) const

virtual

Output the contents of the object to the stream.

The exact output is dependent on the exact semantics of the descendent class. This is primarily used by the standard operator<< function.

The default behaviour is to print the class name.

Reimplemented from PObject.

int PVideoControlInfo::Reset ( )

inline

References m_current, and m_reset.

int PVideoControlInfo::SetCurrent ( int current )

Member Data Documentation

int PVideoControlInfo::m_current

protected

Referenced by GetCurrent(), and Reset().

int PVideoControlInfo::m_maximum

protected

int PVideoControlInfo::m_minimum

protected

int PVideoControlInfo::m_reset

protected

Referenced by Reset().

int PVideoControlInfo::m_step

protected

Referenced by GetStep().

Types PVideoControlInfo::m_type

protected

Referenced by GetType(), and IsValid().

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

videoio.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation