OMPF::ompfSettings Class Reference

#include <ompfSettings.h>

Public Member Functions

uint8 getTypeIDSize () const
 
uint8 getChunkIDSize () const
 
uint8 getChunkSizeSize () const
 
uint8 getCustomDataSizeSize () const
 
uint8 getStringSizeSize () const
 
uint8 getMajorVersion () const
 
uint8 getMinorVersion () const
 
uint8 getPatchVersion () const
 
uint32 getVersion () const
 
bool setTypeIDSize (uint8 typeIDSize)
 
bool setChunkIDSize (uint8 chunkIDSize)
 
bool setChunkSizeSize (uint8 chunkSizeSize)
 
bool setCustomDataSizeSize (uint8 size)
 
bool setStringSizeSize (uint8 size)
 

Detailed Description

structure that contains all the settings defined for a specified ompf file in focus

Member Function Documentation

◆ getChunkIDSize()

uint8 OMPF::ompfSettings::getChunkIDSize ( ) const
Returns
chunk id size

◆ getChunkSizeSize()

uint8 OMPF::ompfSettings::getChunkSizeSize ( ) const
Returns
chunk size size

◆ getCustomDataSizeSize()

uint8 OMPF::ompfSettings::getCustomDataSizeSize ( ) const
Returns
custom data size size

◆ getMajorVersion()

uint8 OMPF::ompfSettings::getMajorVersion ( ) const
Returns
major version of ompf

◆ getMinorVersion()

uint8 OMPF::ompfSettings::getMinorVersion ( ) const
Returns
minor version of ompf

◆ getPatchVersion()

uint8 OMPF::ompfSettings::getPatchVersion ( ) const
Returns
patch version of ompf

◆ getStringSizeSize()

uint8 OMPF::ompfSettings::getStringSizeSize ( ) const
Returns
string size size

◆ getTypeIDSize()

uint8 OMPF::ompfSettings::getTypeIDSize ( ) const
Returns
type ID size

◆ getVersion()

uint32 OMPF::ompfSettings::getVersion ( ) const
Returns
major minor and patch version encoded in a 32 bit integer

◆ setChunkIDSize()

bool OMPF::ompfSettings::setChunkIDSize ( uint8  chunkIDSize)

sets chunk id size

Parameters
chunkIDSizethe chunk id size
Returns
false if invalid/unsupported size

◆ setChunkSizeSize()

bool OMPF::ompfSettings::setChunkSizeSize ( uint8  chunkSizeSize)

sets chunk size size

Parameters
chunkSizeSizethe chunk size size
Returns
false if invalid/unsupported size

◆ setCustomDataSizeSize()

bool OMPF::ompfSettings::setCustomDataSizeSize ( uint8  size)

sets custom data size size

Parameters
sizethe custom data size size
Returns
false if invalid/unsupported size

◆ setStringSizeSize()

bool OMPF::ompfSettings::setStringSizeSize ( uint8  size)

sets string size size

Parameters
sizethe string size size
Returns
false if invalid/unsupported size

◆ setTypeIDSize()

bool OMPF::ompfSettings::setTypeIDSize ( uint8  typeIDSize)

sets type id size

Parameters
typeIDSizethe type id size
Returns
false if invalid/unsupported size

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