XORDE  v1.0
eXtensible Operational Robotic Development Environment
Public Member Functions | Public Attributes | List of all members
ObjectDescription Class Reference

ONB Object description. More...

#include <objectdescription.h>

Inheritance diagram for ObjectDescription:
ObjectDescriptionHeaderV2

Public Member Functions

 ObjectDescription ()
 Constructs the description with invalid flags and uninitialized data.
 
 ObjectDescription (const QByteArray &ba)
 Constructs the description from serialized data.
 
bool isValid () const
 Test Object descriptor for validity. More...
 
QString flagString () const
 Create human-readable representation of flags.
 
void read (QByteArray &ba) const
 Serialize the descriptor to byte array. More...
 

Public Attributes

QString name
 Name of the object.
 
- Public Attributes inherited from ObjectDescriptionHeaderV2
unsigned char id
 Object ID.
 
unsigned char version: 4
 Version of the descriptor (current version = 2)
 
unsigned char _verid: 4
 Distinction of descriptor version >= 2 (must be equal to 0xF)
 
unsigned char group
 Object ID category.
 
unsigned char _reserve
 Not used, reserved for future.
 
unsigned char flags
 Access flags from Flags enum.
 
unsigned short extFlags
 Advanced flags (min max def) from ExtFlags enum.
 
unsigned char rType
 Type of the object to read (Type enum)
 
unsigned char wType
 Type of the object to write (Type enum)
 
unsigned short readSize
 Size of the object to read in bytes. More...
 
unsigned short writeSize
 Size of the object to write in bytes. More...
 

Detailed Description

ONB Object description.

Contains header and name of the Object.

Member Function Documentation

bool ObjectDescription::isValid ( ) const
inline

Test Object descriptor for validity.

Returns
true if the descriptor is valid.
void ObjectDescription::read ( QByteArray &  ba) const

Serialize the descriptor to byte array.

This implementation uses descriptor version 2.