ChunkDescription Class Reference

#include <ChunkProducer.h>

Public Member Functions
	ChunkDescription ()

Public Attributes
std::string	_name
std::string	_type
ChunkAttributeList	_attributes
RuleDefinition *	_rule
unsigned int	_packetLength

Detailed Description

A Chunk Description. A chunk has a name and a list of attributes it produces.

Constructor & Destructor Documentation

ChunkDescription ( )

inline

Constructor

Member Data Documentation

ChunkAttributeList _attributes

The list of attributes that this chunk produces

std::string _name

The name of this chunk. It will be used as the rootname for its attributes

unsigned int _packetLength

(Optional). The length of the packet/chunk. If this is set to a value other than zero, then it means one of two things.

1. If this Chunk is part of a producer that sends messages, this is the length of the message that will be sent
2. If this Chunk is part of a producer that receives messages, the length of the chunk will be validated on reception and must match this value

RuleDefinition* _rule

Rule for determining that this chunk is present

std::string _type

The 'type' of this chunk (optional). Can be used by chunk producers for whatever purpose

---

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

• ChunkProducer.h