cop::Elem Class Reference

basic class for all entries in the SignatureDB More...

#include <Elem.h>

Inheritance diagram for cop::Elem:

List of all members.

Public Member Functions
virtual unsigned long	date () const
virtual Elem *	Duplicate (bool bStaticCopy=true)
	Elem ()
	Elem (ObjectID_t id)
virtual void	Evaluate (const double eval, const double weight)
virtual PerceptionPrimitiveID_t	GetLastPerceptionPrimitive ()
virtual std::string	GetNodeName () const
virtual ElemType_t	GetType () const
XMLTag *	Save (bool full_pose=false)
void	SetFullPose (bool fullPose)
virtual void	SetLastPerceptionPrimitive (PerceptionPrimitiveID_t id)
void	SetTimeStamp (unsigned long timestamp)
virtual void	Show (Sensor *)
void	Touch ()
virtual	~Elem ()
Static Public Member Functions
static Elem *	ElemFactory (XMLTag *tag)
Public Attributes
ObjectID_t	m_ID
Static Public Attributes
static ObjectID_t	m_LastID = 0
Protected Types
typedef boost::mutex::scoped_lock	ElemWriteLock
Protected Member Functions
virtual void	SaveTo (XMLTag *)
virtual void	SetData (XMLTag *data)
Protected Attributes
bool	m_fullPose
boost::mutex	m_mutexElems
Private Attributes
PerceptionPrimitiveID_t	m_creator
unsigned long	m_timestamp

---

Detailed Description

basic class for all entries in the SignatureDB

class Elem Nodename: XML_NODE_ELEMENT "Elem" Prototype for Descriptor, Class and Signature Properties: XML_PROPERTY_ELEMID "ElemID" a unique id, same id means same semantic

Definition at line 60 of file Elem.h.

---

Member Typedef Documentation

typedef boost::mutex::scoped_lock cop::Elem::ElemWriteLock [protected]

Definition at line 158 of file Elem.h.

---

Constructor & Destructor Documentation

Elem::Elem

(

)

Constructor that creates a new element

Definition at line 46 of file Elem.cpp.

Elem::Elem

(

ObjectID_t

id

)

Constructor that restores an certain element

Definition at line 53 of file Elem.cpp.

Elem::~Elem

(

)

[virtual]

Empty Destructor

Definition at line 154 of file Elem.cpp.

---

Member Function Documentation

virtual unsigned long cop::Elem::date

(

)

const [inline, virtual]

Age of the newest information carried by this element

Definition at line 123 of file Elem.h.

Elem * Elem::Duplicate

(

bool

bStaticCopy = true

)

[virtual]

Duplicates an elem (only possible for elems that can be constructed with ElemFactory or that have overriden this member)

Reimplemented in cop::Signature, and cop::Class.

Definition at line 135 of file Elem.cpp.

Elem * Elem::ElemFactory

(

XMLTag *

tag

)

[static]

Can Creates most of the possible elements, returns null if the node name was not known

Parameters:

tag	xmltag that has an name of an elem, see ElemType.h for the possible elements

Returns:

a inheritation of elem.

Exceptions:

char*

with an error message in case of failure

Definition at line 85 of file Elem.cpp.

virtual void cop::Elem::Evaluate	(	const double	eval,
		const double	weight
	)		[inline, virtual]

Reimplemented in cop::Signature, and cop::Descriptor.

Definition at line 143 of file Elem.h.

virtual PerceptionPrimitiveID_t cop::Elem::GetLastPerceptionPrimitive

(

)

[inline, virtual]

Get the vision primitive that created this elem

Definition at line 119 of file Elem.h.

virtual std::string cop::Elem::GetNodeName

(

)

const [inline, virtual]

returns the name that a will be used in the xml. This should be replaced by any derivative of Elem

Reimplemented in cop::Descriptor, cop::Signature, cop::Class, cop::NamedDescriptor< Content >, and cop::Object.

Definition at line 102 of file Elem.h.

virtual ElemType_t cop::Elem::GetType

(

)

const [inline, virtual]

Returns the type which is used for checkign for certain descriptor types, should be overwritten by any derivative of Elem

Reimplemented in cop::NamedDescriptor< Content >.

Definition at line 107 of file Elem.h.

XMLTag * Elem::Save

(

bool

full_pose = false

)

Save the current element, the function will call SaveTo().

Parameters:

full_pose

if set to true poses will not be saved as jlo reference but as a matrix

Definition at line 159 of file Elem.cpp.

virtual void cop::Elem::SaveTo

(

XMLTag *

)

[inline, protected, virtual]

Overwrite to save additional data, will be called during saving

Reimplemented in cop::Descriptor, cop::Signature, cop::Class, and cop::Object.

Definition at line 150 of file Elem.h.

void Elem::SetData

(

XMLTag *

data

)

[protected, virtual]

Overwrite to set additional data on creation, will be called directly after creation

Reimplemented in cop::Descriptor, cop::Signature, cop::Class, and cop::Object.

Definition at line 62 of file Elem.cpp.

void cop::Elem::SetFullPose

(

bool

fullPose

)

[inline]

Definition at line 133 of file Elem.h.

virtual void cop::Elem::SetLastPerceptionPrimitive

(

PerceptionPrimitiveID_t

id

)

[inline, virtual]

Set the vision primitive that created this elem

Definition at line 115 of file Elem.h.

void cop::Elem::SetTimeStamp

(

unsigned long

timestamp

)

[inline]

Definition at line 128 of file Elem.h.

virtual void cop::Elem::Show

(

Sensor *

)

[inline, virtual]

Shows the current Element relative to the given Camera

Reimplemented in cop::Signature.

Definition at line 111 of file Elem.h.

void Elem::Touch

(

)

Definition at line 147 of file Elem.cpp.

---

Member Data Documentation

PerceptionPrimitiveID_t cop::Elem::m_creator [private]

Definition at line 163 of file Elem.h.

bool cop::Elem::m_fullPose [protected]

Definition at line 156 of file Elem.h.

ObjectID_t cop::Elem::m_ID

Definition at line 82 of file Elem.h.

ObjectID_t Elem::m_LastID = 0 [static]

Definition at line 79 of file Elem.h.

boost::mutex cop::Elem::m_mutexElems [protected]

Definition at line 159 of file Elem.h.

unsigned long cop::Elem::m_timestamp [private]

Definition at line 162 of file Elem.h.

---

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

• Elem.h
• Elem.cpp