PObjectType Class Reference

Detailed Description

The PObjectType class represents a type of object found in a video stream (can be Face, Person, Motion, etc); PObjectType instances are immutable (thread-safe).

Definition at line 26 of file PObjectType.h.

#include <PObjectType.h>

Member Enumeration Documentation

◆ EObjectType

All the available object types.

Enumerator
E_UNKNOWN 

Unknown object.

E_FACE 

Face.

E_PERSON 

Person.

E_MOTION 

Motion.

E_OTHER 

Other.

E_FACE_META_DATA 

Meta data about a face.

Definition at line 32 of file PObjectType.h.

Constructor & Destructor Documentation

◆ PObjectType() [1/2]

PObjectType::PObjectType ( EObjectType  objectType = E_UNKNOWN)
explicit

Constructs a PObjectType from EObjectType.

◆ PObjectType() [2/2]

PObjectType::PObjectType ( const PObjectType other)

Constructs a shared copy of other.

◆ ~PObjectType()

PObjectType::~PObjectType ( )
override

Destroys this object.

Member Function Documentation

◆ FromString()

static const PObjectType& PObjectType::FromString ( const PString objectType)
static

Constructs a PObjectType from a string; returns PObjectType::UNKNOWN if failure.

◆ GetName()

PString PObjectType::GetName ( ) const

Returns a type of this object as a string.

◆ GetType()

EObjectType PObjectType::GetType ( ) const

Returns the type of this object.

◆ IsFace()

bool PObjectType::IsFace ( ) const

Returns true if this object type is E_FACE, false otherwise.

◆ IsFaceMetaData()

bool PObjectType::IsFaceMetaData ( ) const

Returns true if this object type is E_FACE_META_DATA, false otherwise.

◆ IsMotion()

bool PObjectType::IsMotion ( ) const

Returns true if this object type is E_MOTION, false otherwise.

◆ IsPerson()

bool PObjectType::IsPerson ( ) const

Returns true if this object type is E_PERSON, false otherwise.

◆ IsUnknown()

bool PObjectType::IsUnknown ( ) const

Returns true if this object type is E_UNKNOWN or E_OTHER, false otherwise.

◆ operator!=()

bool PObjectType::operator!= ( const PObjectType other) const

Returns true if this object is different than other, false otherwise.

◆ operator=()

PObjectType& PObjectType::operator= ( const PObjectType other)

Performs a shared copy of other to this object.

◆ operator==()

bool PObjectType::operator== ( const PObjectType other) const

Returns true if this object is the same than other, false otherwise.

Member Data Documentation

◆ C_FACE

const PObjectType PObjectType::C_FACE
static

A constant holding the FACE object type.

Definition at line 122 of file PObjectType.h.

◆ C_FACE_META_DATA

const PObjectType PObjectType::C_FACE_META_DATA
static

A constant holding the FACE_META_DATA object type.

Definition at line 127 of file PObjectType.h.

◆ C_MOTION

const PObjectType PObjectType::C_MOTION
static

A constant holding the MOTION object type.

Definition at line 137 of file PObjectType.h.

◆ C_OTHER

const PObjectType PObjectType::C_OTHER
static

A constant holding the OTHER object type.

Definition at line 142 of file PObjectType.h.

◆ C_PERSON

const PObjectType PObjectType::C_PERSON
static

A constant holding the PERSON object type.

Definition at line 132 of file PObjectType.h.

◆ C_UNKNOWN

const PObjectType PObjectType::C_UNKNOWN
static

A constant holding the UNKNOWN object type.

Definition at line 117 of file PObjectType.h.