SF2cute  0.1
Modern C++ Library for SoundFont 2
sf2cute::SFVersionTag Struct Reference

The SFVersionTag class represents a version tag. More...

#include <types.hpp>

Public Member Functions

 SFVersionTag () noexcept
 Constructs a new zero-valued SFVersionTag.
 
 SFVersionTag (uint16_t major, uint16_t minor) noexcept
 Constructs a new SFVersionTag using the specified version numbers. More...
 
std::string to_string () const
 Returns a string represents the version. More...
 

Public Attributes

uint16_t major
 Major version number.
 
uint16_t minor
 Minor version number.
 

Friends

bool operator== (const SFVersionTag &x, const SFVersionTag &y) noexcept
 Indicates a SFVersionTag object is "equal to" the other one. More...
 
bool operator!= (const SFVersionTag &x, const SFVersionTag &y) noexcept
 Indicates a SFVersionTag object is "not equal to" the other one. More...
 
bool operator< (const SFVersionTag &x, const SFVersionTag &y) noexcept
 Indicates a SFVersionTag object is "less than" the other one. More...
 
bool operator<= (const SFVersionTag &x, const SFVersionTag &y) noexcept
 Indicates a SFVersionTag object is "less than or equal to" the other one. More...
 
bool operator> (const SFVersionTag &x, const SFVersionTag &y) noexcept
 Indicates a SFVersionTag object is "greater than" the other one. More...
 
bool operator>= (const SFVersionTag &x, const SFVersionTag &y) noexcept
 Indicates a SFVersionTag object is "greater than or equal to" the other one. More...
 
std::ostream & operator<< (std::ostream &out, const SFVersionTag &version)
 Outputs the version number to the specified output stream. More...
 

Detailed Description

The SFVersionTag class represents a version tag.

Remarks
This class represents the official sfVersionTag type.
See also
"5.1 The ifil Sub-chunk". In SoundFont Technical Specification 2.04.

Constructor & Destructor Documentation

sf2cute::SFVersionTag::SFVersionTag ( uint16_t  major,
uint16_t  minor 
)
inlinenoexcept

Constructs a new SFVersionTag using the specified version numbers.

Parameters
majorthe major version number.
minorthe minor version number.

Member Function Documentation

std::string sf2cute::SFVersionTag::to_string ( ) const
inline

Returns a string represents the version.

Returns
a string representation of the version.

Friends And Related Function Documentation

bool operator!= ( const SFVersionTag x,
const SFVersionTag y 
)
friend

Indicates a SFVersionTag object is "not equal to" the other one.

Parameters
xthe first object to be compared.
ythe second object to be compared.
Returns
true if a SFVersionTag object is "not equal to" the other one.
bool operator< ( const SFVersionTag x,
const SFVersionTag y 
)
friend

Indicates a SFVersionTag object is "less than" the other one.

Parameters
xthe first object to be compared.
ythe second object to be compared.
Returns
true if a SFVersionTag object is "less than" the other one.
std::ostream& operator<< ( std::ostream &  out,
const SFVersionTag version 
)
friend

Outputs the version number to the specified output stream.

Parameters
outthe output stream.
versionthe version tag.
bool operator<= ( const SFVersionTag x,
const SFVersionTag y 
)
friend

Indicates a SFVersionTag object is "less than or equal to" the other one.

Parameters
xthe first object to be compared.
ythe second object to be compared.
Returns
true if a SFVersionTag object is "less than or equal to" the other one.
bool operator== ( const SFVersionTag x,
const SFVersionTag y 
)
friend

Indicates a SFVersionTag object is "equal to" the other one.

Parameters
xthe first object to be compared.
ythe second object to be compared.
Returns
true if a SFVersionTag object is "equal to" the other one.
bool operator> ( const SFVersionTag x,
const SFVersionTag y 
)
friend

Indicates a SFVersionTag object is "greater than" the other one.

Parameters
xthe first object to be compared.
ythe second object to be compared.
Returns
true if a SFVersionTag object is "greater than" the other one.
bool operator>= ( const SFVersionTag x,
const SFVersionTag y 
)
friend

Indicates a SFVersionTag object is "greater than or equal to" the other one.

Parameters
xthe first object to be compared.
ythe second object to be compared.
Returns
true if a SFVersionTag object is "greater than or equal to" the other one.

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