annotatorcomm::FirmwareVersion Class Reference

#include <FirmwareVersion.h>

List of all members.

Public Member Functions

 FirmwareVersion (int major, int minor, int micro, int nano)
int getMajor () const
int getMinor () const
int getMicro () const
int getNano () const
string toString () const


Detailed Description

FirmwareVersion represents the firmware of a particular microchip. Versions are represented by four ordered integers named major, minor, micro, and nano respectively.

Changes between major version numbers indicate a complete overhaul. Extensive changes to design, implementation, and API are to be expected. They are typically neither forward nor backware compatible.

Changes between minor version numbers indicate feature additions, non-trivial underbelly adjustments, and clarifications of ambiguity. They are typically backward but not forward compatible.

Changes between micro version numbers indicate bugs fixes and clarifications of minor ambiguity. They are typically forward and backware compatible.

Changes between nano version numbers indicate custom firmware requirements have been added. Compatibility is dependent on the customizations.

Definition at line 41 of file FirmwareVersion.h.


Constructor & Destructor Documentation

annotatorcomm::FirmwareVersion::FirmwareVersion ( int  major,
int  minor,
int  micro,
int  nano 
)

Construct a FirmwareVersion.

Parameters:
major version major
minor version minor
micro version micro
nano version nano


Member Function Documentation

int annotatorcomm::FirmwareVersion::getMajor (  )  const

Get the version major number.

Returns:
version major

int annotatorcomm::FirmwareVersion::getMicro (  )  const

Get the version micro number.

Returns:
version micro

int annotatorcomm::FirmwareVersion::getMinor (  )  const

Get the version minor number.

Returns:
version minor

int annotatorcomm::FirmwareVersion::getNano (  )  const

Get the version nano number.

Returns:
version nano

string annotatorcomm::FirmwareVersion::toString (  )  const

Get the human readable form of the version.

Returns:
human readable version format


The documentation for this class was generated from the following file:
Generated on Tue Aug 1 11:14:11 2006 for libAnnotatorComm by  doxygen 1.4.7