fcml  1.2.2
Public Member Functions | Static Public Member Functions | List of all members
fcml::SegmentSelector Class Reference

Describes segment register. More...

#include <fcml_common.hpp>

Public Member Functions

 SegmentSelector ()
 Creates an empty segment selector instance. More...
 
 SegmentSelector (const Register &segmentSelector, bool isDefaultReg=FCML_TRUE)
 Creates a segment selector instance for given parameters. More...
 
bool operator== (const SegmentSelector &segmentSelector) const
 Checks if two segment selector are equal. More...
 
bool operator!= (const SegmentSelector &segmentSelector) const
 Checks if two segment selector are not equal. More...
 
 operator Register () const
 Casting operator. More...
 
SegmentSelectoroperator= (const SegmentSelector &reg)
 Copies one segment selector to another. More...
 
bool isDefaultReg () const
 Returns true if a register stored in the segment selector is the default one in the context the segment selector is used. More...
 
void setDefaultReg (bool isDefaultReg)
 Sets "default" flag for the segment selector. More...
 
const RegistergetSegmentSelector () const
 Gets constant segment register associated with the selector. More...
 
RegistergetSegmentSelector ()
 Gets segment register associated with the selector. More...
 
void setSegmentSelector (const Register &segmentSelector)
 Sets segment register for the selector. More...
 

Static Public Member Functions

static SegmentSelector seg (const Register &segmentSelector, bool isDefaultReg)
 Creates segment selector for the given register. More...
 

Detailed Description

Describes segment register.

Since
1.1.0

Constructor & Destructor Documentation

◆ SegmentSelector() [1/2]

fcml::SegmentSelector::SegmentSelector ( )
inline

Creates an empty segment selector instance.

Since
1.1.0

◆ SegmentSelector() [2/2]

fcml::SegmentSelector::SegmentSelector ( const Register segmentSelector,
bool  isDefaultReg = FCML_TRUE 
)
inline

Creates a segment selector instance for given parameters.

Parameters
segmentSelectorA segment register.
isDefaultRegInformation if the register is the default one.
Since
1.1.0

Member Function Documentation

◆ getSegmentSelector() [1/2]

const Register& fcml::SegmentSelector::getSegmentSelector ( ) const
inline

Gets constant segment register associated with the selector.

Returns
Constant segment register.
Since
1.1.0

◆ getSegmentSelector() [2/2]

Register& fcml::SegmentSelector::getSegmentSelector ( )
inline

Gets segment register associated with the selector.

Returns
Segment register.
Since
1.1.0

◆ isDefaultReg()

bool fcml::SegmentSelector::isDefaultReg ( ) const
inline

Returns true if a register stored in the segment selector is the default one in the context the segment selector is used.

Returns
True if register is the default one.
Since
1.1.0

◆ operator Register()

fcml::SegmentSelector::operator Register ( ) const
inline

Casting operator.

Returns
The segment register.
Since
1.1.0

◆ operator!=()

bool fcml::SegmentSelector::operator!= ( const SegmentSelector segmentSelector) const
inline

Checks if two segment selector are not equal.

Parameters
segmentSelectorThe source segment selector.
Returns
True if they are NOT equal.
Since
1.1.0

◆ operator=()

SegmentSelector& fcml::SegmentSelector::operator= ( const SegmentSelector reg)
inline

Copies one segment selector to another.

Parameters
regThe source segment selector.
Returns
The destination segment selector.
Since
1.1.0

◆ operator==()

bool fcml::SegmentSelector::operator== ( const SegmentSelector segmentSelector) const
inline

Checks if two segment selector are equal.

Parameters
segmentSelectorThe source segment selector.
Returns
True if they are equal.
Since
1.1.0

◆ seg()

static SegmentSelector fcml::SegmentSelector::seg ( const Register segmentSelector,
bool  isDefaultReg 
)
inlinestatic

Creates segment selector for the given register.

Parameters
segmentSelectorSegment register.
isDefaultRegTrue if the register is the default one in the given context.
Returns
Prepared segment selector.
Since
1.1.0

◆ setDefaultReg()

void fcml::SegmentSelector::setDefaultReg ( bool  isDefaultReg)
inline

Sets "default" flag for the segment selector.

Parameters
isDefaultRegTrue if the register is the default one in the given context.
Since
1.1.0

◆ setSegmentSelector()

void fcml::SegmentSelector::setSegmentSelector ( const Register segmentSelector)
inline

Sets segment register for the selector.

Parameters
segmentSelectorSegment register.
Since
1.1.0

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