Tag Parser  6.2.1
C++ library for reading and writing MP4 (iTunes), ID3, Vorbis, Opus, FLAC and Matroska tags
Public Member Functions | List of all members
Media::PositionInSet Class Reference

The PositionInSet class describes the position of an element in a set which consists of a certain number of elements. More...

#include <positioninset.h>

Public Member Functions

constexpr PositionInSet (int32 position=0, int32 total=0)
 Constructs a new Position in set of the specified element position and total element count. More...
 
template<typename StringType = std::string>
 PositionInSet (const StringType &numericString)
 Constructs a new Position in set from the specified numeric string. More...
 
constexpr int32 position () const
 Returns the element position of the current instance. More...
 
constexpr int32 total () const
 Returns the total element count of the current instance. More...
 
constexpr bool isNull () const
 Returns an indication whether both the element position and total element count is 0. More...
 
constexpr bool operator== (const PositionInSet &other) const
 Returns whether this instance equals other. More...
 
template<typename StringType = std::string>
StringType toString () const
 Returns the string representation of the current PositionInSet. More...
 

Detailed Description

The PositionInSet class describes the position of an element in a set which consists of a certain number of elements.

This class is used to parse and store values like "9/11" which are used by some tag formats to denote track positions.

Definition at line 20 of file positioninset.h.

Constructor & Destructor Documentation

◆ PositionInSet() [1/2]

constexpr Media::PositionInSet::PositionInSet ( int32  position = 0,
int32  total = 0 
)
inline

Constructs a new Position in set of the specified element position and total element count.

Parameters
position
total

Definition at line 67 of file positioninset.h.

◆ PositionInSet() [2/2]

template<typename StringType >
Media::PositionInSet::PositionInSet ( const StringType &  numericString)

Constructs a new Position in set from the specified numeric string.

Template Parameters
StringTypeThe type of the string (should be an instantiation of the basic_string class template).
Parameters
numericStringSpecifies the string containing the position and possibly the total element count (separated by "/").

Definition at line 47 of file positioninset.h.

Member Function Documentation

◆ isNull()

constexpr bool Media::PositionInSet::isNull ( ) const
inline

Returns an indication whether both the element position and total element count is 0.

Definition at line 91 of file positioninset.h.

◆ operator==()

constexpr bool Media::PositionInSet::operator== ( const PositionInSet other) const
inline

Returns whether this instance equals other.

Definition at line 99 of file positioninset.h.

◆ position()

constexpr int32 Media::PositionInSet::position ( ) const
inline

Returns the element position of the current instance.

Definition at line 75 of file positioninset.h.

◆ toString()

template<typename StringType >
StringType Media::PositionInSet::toString ( ) const

Returns the string representation of the current PositionInSet.

Definition at line 108 of file positioninset.h.

◆ total()

constexpr int32 Media::PositionInSet::total ( ) const
inline

Returns the total element count of the current instance.

Definition at line 83 of file positioninset.h.


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