Public Member Functions | Static Public Attributes | Private Attributes
rail::pick_and_place::graspdb::Entity Class Reference

An abstract database entity. More...

#include <Entity.h>

Inheritance diagram for rail::pick_and_place::graspdb::Entity:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 Entity (const uint32_t id=UNSET_ID, const time_t created=UNSET_TIME)
 Create a new Entity.
time_t getCreated () const
 Created timestamp value accessor.
uint32_t getID () const
 ID value accessor.
void setCreated (const time_t created)
 Created timestamp value mutator.
void setID (const uint32_t id)
 ID value mutator.

Static Public Attributes

static const uint32_t UNSET_ID = 0
static const time_t UNSET_TIME = 0

Private Attributes

time_t created_
uint32_t id_

Detailed Description

An abstract database entity.

An entity contains basic database entity information such as an ID and created timestamp.

Definition at line 31 of file Entity.h.


Constructor & Destructor Documentation

Entity::Entity ( const uint32_t  id = UNSET_ID,
const time_t  created = UNSET_TIME 
)

Create a new Entity.

Creates a new GraspDemonstration with the given values.

Parameters:
idThe unique ID of the database entity (defaults to 0).
createdThe created timestamp of the database entity (defaults to 0).

Definition at line 16 of file Entity.cpp.


Member Function Documentation

time_t Entity::getCreated ( ) const

Created timestamp value accessor.

Get the created timestamp value of this Entity.

Returns:
The created timestamp value.

Definition at line 32 of file Entity.cpp.

uint32_t Entity::getID ( ) const

ID value accessor.

Get the ID value of this Entity.

Returns:
The ID value.

Definition at line 22 of file Entity.cpp.

void Entity::setCreated ( const time_t  created)

Created timestamp value mutator.

Set the created timestamp value of this Entity.

Parameters:
createdThe new created timestamp value.

Definition at line 37 of file Entity.cpp.

void Entity::setID ( const uint32_t  id)

ID value mutator.

Set the ID value of this Entity.

Parameters:
idThe new ID value.

Definition at line 27 of file Entity.cpp.


Member Data Documentation

The created timestamp.

Definition at line 89 of file Entity.h.

The ID.

Definition at line 87 of file Entity.h.

The default value for an unset identifier (i.e., a demonstration not yet in the database).

Definition at line 35 of file Entity.h.

The default value for an unset timestamp (i.e., a demonstration not yet in the database).

Definition at line 37 of file Entity.h.


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


graspdb
Author(s): Russell Toris
autogenerated on Sun Mar 6 2016 11:38:59