fcml::FarPointer Class Reference

Describes far pointer. More...

#include <fcml_common.hpp>

Public Member Functions
	FarPointer ()
	Creates an far pointer instance.
	FarPointer (fcml_uint16_t segment, fcml_int16_t offset16)
	Creates an far pointer instance.
	FarPointer (fcml_uint16_t segment, fcml_int32_t offset32)
	Creates an far pointer instance.
bool	operator== (const FarPointer &fp) const
	Compares two far pointers.
bool	operator!= (const FarPointer &fp) const
	Compares two far pointers.
fcml_usize	getOffsetSize () const
	Gets offset size.
void	setOffsetSize (fcml_usize offsetSize)
	Sets offset size.
fcml_int16_t	getOffset16 () const
	Gets the 16-bit offset.
void	setOffset16 (fcml_int16_t offset16)
	Sets 16-bit offset.
fcml_int32_t	getOffset32 () const
	Gets 32-bit offset.
void	setOffset32 (fcml_int32_t offset32)
	Sets 32-bit offset.
fcml_uint16_t	getSegment () const
	Gets segment selector.
void	setSegment (fcml_uint16_t segment)
	Sets segment selector.

Static Public Member Functions
static FarPointer	off16 (fcml_uint16_t segment, fcml_int16_t offset)
	Creates FarPointer instance for 16 bit segment and 16-bit offset.
static FarPointer	off32 (fcml_uint16_t segment, fcml_int32_t offset)
	Creates FarPointer instance for 16 bit segment and 32-bit offset.

Detailed Description

Describes far pointer.

Since

1.1.0

Constructor & Destructor Documentation

FarPointer() [1/3]

fcml::FarPointer::FarPointer ( )

inline

Creates an far pointer instance.

Since

1.1.0

FarPointer() [2/3]

fcml::FarPointer::FarPointer ( fcml_uint16_t segment, fcml_int16_t offset16 )

inline

Creates an far pointer instance.

Parameters

segment	A segment selector.
offset16	A 16-bit offset in the given segment.

Since

1.1.0

FarPointer() [3/3]

fcml::FarPointer::FarPointer ( fcml_uint16_t segment, fcml_int32_t offset32 )

inline

Creates an far pointer instance.

Parameters

segment	A segment selector.
offset32	A 32-bit offset in the given segment.

Since

1.1.0

Member Function Documentation

getOffset16()

fcml_int16_t fcml::FarPointer::getOffset16 ( ) const

inline

Gets the 16-bit offset.

Returns

16-bit offset.

Since

1.1.0

getOffset32()

fcml_int32_t fcml::FarPointer::getOffset32 ( ) const

inline

Gets 32-bit offset.

Returns

32-bit offset.

Since

1.1.0

getOffsetSize()

fcml_usize fcml::FarPointer::getOffsetSize ( ) const

inline

Gets offset size.

Returns

Offset size.

Since

1.1.0

getSegment()

fcml_uint16_t fcml::FarPointer::getSegment ( ) const

inline

Gets segment selector.

Returns

16-bit segment selector.

Since

1.1.0

off16()

FarPointer fcml::FarPointer::off16 ( fcml_uint16_t segment, fcml_int16_t offset )

inlinestatic

Creates FarPointer instance for 16 bit segment and 16-bit offset.

Parameters

segment	Segment selector.
offset	16-bit address.

Returns

FarPointer instance.

Since

1.1.0

off32()

FarPointer fcml::FarPointer::off32 ( fcml_uint16_t segment, fcml_int32_t offset )

inlinestatic

Creates FarPointer instance for 16 bit segment and 32-bit offset.

Parameters

segment	Segment selector.
offset	32-bit address.

Returns

FarPointer instance.

operator!=()

bool fcml::FarPointer::operator!= ( const FarPointer & fp ) const

inline

Compares two far pointers.

Parameters

fp	The far pointer to be compared with the current one.

Returns

True if they are NOT equal.

Since

1.1.0

operator==()

bool fcml::FarPointer::operator== ( const FarPointer & fp ) const

inline

Compares two far pointers.

Parameters

fp	The far pointer to be compared with the current one.

Returns

True if they are equal.

Since

1.1.0

setOffset16()

void fcml::FarPointer::setOffset16 ( fcml_int16_t offset16 )

inline

Sets 16-bit offset.

Parameters

offset16

Sets 16-bit offset.

Since

1.1.0

setOffset32()

void fcml::FarPointer::setOffset32 ( fcml_int32_t offset32 )

inline

Sets 32-bit offset.

Parameters

offset32

Sets 32-bit offset.

Since

1.1.0

setOffsetSize()

void fcml::FarPointer::setOffsetSize ( fcml_usize offsetSize )

inline

Sets offset size.

Parameters

offsetSize

The new offset size to be set.

Since

1.1.0

setSegment()

void fcml::FarPointer::setSegment ( fcml_uint16_t segment )

inline

Sets segment selector.

Parameters

segment

Segment selector.

Since

1.1.0

---

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

• include/fcml_common.hpp