fcml  1.1.3
Public Member Functions | Static Public Member Functions | List of all members
fcml::FarPointer Class Reference

Describes far pointer. More...

#include <fcml_common.hpp>

Public Member Functions

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

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. More...
 
static FarPointer off32 (fcml_uint16_t segment, fcml_int32_t offset)
 Creates FarPointer instance for 16 bit segment and 32-bit offset. More...
 

Detailed Description

Describes far pointer.

Since
1.1.0

Constructor & Destructor Documentation

fcml::FarPointer::FarPointer ( )
inline

Creates an far pointer instance.

Since
1.1.0
fcml::FarPointer::FarPointer ( fcml_uint16_t  segment,
fcml_int16_t  offset16 
)
inline

Creates an far pointer instance.

Parameters
segmentA segment selector.
offset16A 16-bit offset in the given segment.
Since
1.1.0
fcml::FarPointer::FarPointer ( fcml_uint16_t  segment,
fcml_int32_t  offset32 
)
inline

Creates an far pointer instance.

Parameters
segmentA segment selector.
offset32A 32-bit offset in the given segment.
Since
1.1.0

Member Function Documentation

fcml_int16_t fcml::FarPointer::getOffset16 ( ) const
inline

Gets the 16-bit offset.

Returns
16-bit offset.
Since
1.1.0
fcml_int32_t fcml::FarPointer::getOffset32 ( ) const
inline

Gets 32-bit offset.

Returns
32-bit offset.
Since
1.1.0
fcml_usize fcml::FarPointer::getOffsetSize ( ) const
inline

Gets offset size.

Returns
Offset size.
Since
1.1.0
fcml_uint16_t fcml::FarPointer::getSegment ( ) const
inline

Gets segment selector.

Returns
16-bit segment selector.
Since
1.1.0
static 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
segmentSegment selector.
offset16-bit address.
Returns
FarPointer instance.
Since
1.1.0
static 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
segmentSegment selector.
offset32-bit address.
Returns
FarPointer instance.
bool fcml::FarPointer::operator!= ( const FarPointer fp) const
inline

Compares two far pointers.

Parameters
fpThe far pointer to be compared with the current one.
Returns
True if they are NOT equal.
Since
1.1.0
bool fcml::FarPointer::operator== ( const FarPointer fp) const
inline

Compares two far pointers.

Parameters
fpThe far pointer to be compared with the current one.
Returns
True if they are equal.
Since
1.1.0
void fcml::FarPointer::setOffset16 ( fcml_int16_t  offset16)
inline

Sets 16-bit offset.

Parameters
offset16Sets 16-bit offset.
Since
1.1.0
void fcml::FarPointer::setOffset32 ( fcml_int32_t  offset32)
inline

Sets 32-bit offset.

Parameters
offset32Sets 32-bit offset.
Since
1.1.0
void fcml::FarPointer::setOffsetSize ( fcml_usize  offsetSize)
inline

Sets offset size.

Parameters
offsetSizeThe new offset size to be set.
Since
1.1.0
void fcml::FarPointer::setSegment ( fcml_uint16_t  segment)
inline

Sets segment selector.

Parameters
segmentSegment selector.
Since
1.1.0

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