Voyant API 0.2.1
Loading...
Searching...
No Matches
Classes | Enumerations
voyant_version_wrapper.hpp File Reference
#include "../capnp_wrapper.h"
#include "header.capnp.h"
#include <cstdint>
#include <string>

Go to the source code of this file.

Classes

class  VoyantVersionWrapper
 Wrapper for VoyantVersion messages. More...
 

Enumerations

enum class  VersionComponent : uint8_t {
  Unknown = 0x0 , Proto = 0x1 , Api = 0x2 , Firmware = 0x3 ,
  Hdl = 0x4
}
 Component type for a version, stored in bits 7-4 of the flags field. More...
 
enum class  VersionStatus : uint8_t {
  Unknown = 0x0 , Development = 0x1 , Alpha = 0x2 , Beta = 0x3 ,
  ReleaseCandidate = 0x4 , Stable = 0x5 , Deprecated = 0x6 , Legacy = 0x7
}
 Version status, stored in bits 3-0 of the flags field. More...
 

Enumeration Type Documentation

◆ VersionComponent

enum class VersionComponent : uint8_t
strong

Component type for a version, stored in bits 7-4 of the flags field.

Enumerator
Unknown 

Unknown component type (default)

Proto 

Protocol definitions and message formats.

Api 

Application interface software components.

Firmware 

Device embedded software.

Hdl 

Hardware configuration for the FPGA.

◆ VersionStatus

enum class VersionStatus : uint8_t
strong

Version status, stored in bits 3-0 of the flags field.

Ordered from least to most stable, with 0 being Unknown.

Enumerator
Unknown 

Unknown version status (default)

Development 

Development version - Not for external use.

Alpha 

Alpha version - Early testing phase.

Beta 

Beta version - Feature complete but in testing.

ReleaseCandidate 

Release Candidate - Final testing.

Stable 

Stable version - Production-ready.

Deprecated 

Deprecated version - Maintained but scheduled for removal.

Legacy 

Legacy version - No longer maintained.