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

Instruction condition. More...

#include <fcml_common.hpp>

Public Types

enum  ConditionType {
  CONDITION_O = FCML_CONDITION_O,
  CONDITION_B = FCML_CONDITION_B,
  CONDITION_E = FCML_CONDITION_E,
  CONDITION_BE = FCML_CONDITION_BE,
  CONDITION_S = FCML_CONDITION_S,
  CONDITION_P = FCML_CONDITION_P,
  CONDITION_L = FCML_CONDITION_L,
  CONDITION_LE = FCML_CONDITION_LE
}
 See fcml_st_condition for more details. More...
 

Public Member Functions

 Condition ()
 Creates an empty condition. More...
 
 Condition (ConditionType type, bool negation=false)
 Creates a condition for given parameters. More...
 
bool isO () const
 Gets true the condition is of a given type. More...
 
bool isNO () const
 Gets true the condition is of a given type. More...
 
bool isB () const
 Gets true the condition is of a given type. More...
 
bool isNB () const
 Gets true the condition is of a given type. More...
 
bool isNAE () const
 Gets true the condition is of a given type. More...
 
bool isAE () const
 Gets true the condition is of a given type. More...
 
bool isC () const
 Gets true the condition is of a given type. More...
 
bool isNC () const
 Gets true the condition is of a given type. More...
 
bool isE () const
 Gets true the condition is of a given type. More...
 
bool isZ () const
 Gets true the condition is of a given type. More...
 
bool isNE () const
 Gets true the condition is of a given type. More...
 
bool isNZ () const
 Gets true the condition is of a given type. More...
 
bool isBE () const
 Gets true the condition is of a given type. More...
 
bool isNA () const
 Gets true the condition is of a given type. More...
 
bool isNBE () const
 Gets true the condition is of a given type. More...
 
bool isA () const
 Gets true the condition is of a given type. More...
 
bool isS () const
 Gets true the condition is of a given type. More...
 
bool isNS () const
 Gets true the condition is of a given type. More...
 
bool isP () const
 Gets true the condition is of a given type. More...
 
bool isPE () const
 Gets true the condition is of a given type. More...
 
bool isNP () const
 Gets true the condition is of a given type. More...
 
bool isPO () const
 Gets true the condition is of a given type. More...
 
bool isL () const
 Gets true the condition is of a given type. More...
 
bool isNGE () const
 Gets true the condition is of a given type. More...
 
bool isNL () const
 Gets true the condition is of a given type. More...
 
bool isGE () const
 Gets true the condition is of a given type. More...
 
bool isLE () const
 Gets true the condition is of a given type. More...
 
bool isNG () const
 Gets true the condition is of a given type. More...
 
bool isNLE () const
 Gets true the condition is of a given type. More...
 
bool isG () const
 Gets true the condition is of a given type. More...
 
bool operator== (const Condition &cond) const
 Checks if two condition are equal. More...
 
bool operator!= (const Condition &cond) const
 Checks if two condition are equal. More...
 
ConditionType getConditionType () const
 Gets a type of the condition. More...
 
ConditionsetConditionType (ConditionType conditionType)
 Sets condition type. More...
 
bool isNegation () const
 Returns true if condition is negated. More...
 
ConditionsetNegation (bool isNegation)
 Sets negation flag for the condition. More...
 

Static Public Member Functions

static const Condition O ()
 Factory method which creates a condition of a given type. More...
 
static const Condition NO ()
 Factory method which creates a condition of a given type. More...
 
static const Condition B ()
 Factory method which creates a condition of a given type. More...
 
static const Condition NB ()
 Factory method which creates a condition of a given type. More...
 
static const Condition NAE ()
 Factory method which creates a condition of a given type. More...
 
static const Condition AE ()
 Factory method which creates a condition of a given type. More...
 
static const Condition C ()
 Factory method which creates a condition of a given type. More...
 
static const Condition NC ()
 Factory method which creates a condition of a given type. More...
 
static const Condition E ()
 Factory method which creates a condition of a given type. More...
 
static const Condition Z ()
 Factory method which creates a condition of a given type. More...
 
static const Condition NE ()
 Factory method which creates a condition of a given type. More...
 
static const Condition NZ ()
 Factory method which creates a condition of a given type. More...
 
static const Condition BE ()
 Factory method which creates a condition of a given type. More...
 
static const Condition NA ()
 Factory method which creates a condition of a given type. More...
 
static const Condition NBE ()
 Factory method which creates a condition of a given type. More...
 
static const Condition A ()
 Factory method which creates a condition of a given type. More...
 
static const Condition S ()
 Factory method which creates a condition of a given type. More...
 
static const Condition NS ()
 Factory method which creates a condition of a given type. More...
 
static const Condition P ()
 Factory method which creates a condition of a given type. More...
 
static const Condition PE ()
 Factory method which creates a condition of a given type. More...
 
static const Condition NP ()
 Factory method which creates a condition of a given type. More...
 
static const Condition PO ()
 Factory method which creates a condition of a given type. More...
 
static const Condition L ()
 Factory method which creates a condition of a given type. More...
 
static const Condition NGE ()
 Factory method which creates a condition of a given type. More...
 
static const Condition NL ()
 Factory method which creates a condition of a given type. More...
 
static const Condition GE ()
 Factory method which creates a condition of a given type. More...
 
static const Condition LE ()
 Factory method which creates a condition of a given type. More...
 
static const Condition NG ()
 Factory method which creates a condition of a given type. More...
 
static const Condition NLE ()
 Factory method which creates a condition of a given type. More...
 
static const Condition G ()
 Factory method which creates a condition of a given type. More...
 

Detailed Description

Instruction condition.

It's counterpart to the fcml_st_condition structure.

Since
1.1.0

Member Enumeration Documentation

◆ ConditionType

See fcml_st_condition for more details.

Since
1.1.0
Enumerator
CONDITION_O 

0 Overflow

CONDITION_B 

1 Below

CONDITION_E 

2 Equal

CONDITION_BE 

3 Below or equal

CONDITION_S 

4 Sign

CONDITION_P 

5 Parity

CONDITION_L 

6 Less than

CONDITION_LE 

7 Less than or equal to

Constructor & Destructor Documentation

◆ Condition() [1/2]

fcml::Condition::Condition ( )
inline

Creates an empty condition.

Since
1.1.0

◆ Condition() [2/2]

fcml::Condition::Condition ( ConditionType  type,
bool  negation = false 
)
inline

Creates a condition for given parameters.

Parameters
typeA condition type.
negationTrue in order to negate condition.
Since
1.1.0

Member Function Documentation

◆ A()

static const Condition fcml::Condition::A ( )
inlinestatic

Factory method which creates a condition of a given type.

Returns
The condition with a type described by the method name.
Since
1.1.0

◆ AE()

static const Condition fcml::Condition::AE ( )
inlinestatic

Factory method which creates a condition of a given type.

Returns
The condition with a type described by the method name.
Since
1.1.0

◆ B()

static const Condition fcml::Condition::B ( )
inlinestatic

Factory method which creates a condition of a given type.

Returns
The condition with a type described by the method name.
Since
1.1.0

◆ BE()

static const Condition fcml::Condition::BE ( )
inlinestatic

Factory method which creates a condition of a given type.

Returns
The condition with a type described by the method name.
Since
1.1.0

◆ C()

static const Condition fcml::Condition::C ( )
inlinestatic

Factory method which creates a condition of a given type.

Returns
The condition with a type described by the method name.
Since
1.1.0

◆ E()

static const Condition fcml::Condition::E ( )
inlinestatic

Factory method which creates a condition of a given type.

Returns
The condition with a type described by the method name.
Since
1.1.0

◆ G()

static const Condition fcml::Condition::G ( )
inlinestatic

Factory method which creates a condition of a given type.

Returns
The condition with a type described by the method name.
Since
1.1.0

◆ GE()

static const Condition fcml::Condition::GE ( )
inlinestatic

Factory method which creates a condition of a given type.

Returns
The condition with a type described by the method name.
Since
1.1.0

◆ getConditionType()

ConditionType fcml::Condition::getConditionType ( ) const
inline

Gets a type of the condition.

Returns
The type of the condition.
Since
1.1.0

◆ isA()

bool fcml::Condition::isA ( ) const
inline

Gets true the condition is of a given type.

Returns
True the condition is of a given type.
Since
1.1.0

◆ isAE()

bool fcml::Condition::isAE ( ) const
inline

Gets true the condition is of a given type.

Returns
True the condition is of a given type.
Since
1.1.0

◆ isB()

bool fcml::Condition::isB ( ) const
inline

Gets true the condition is of a given type.

Returns
True the condition is of a given type.
Since
1.1.0

◆ isBE()

bool fcml::Condition::isBE ( ) const
inline

Gets true the condition is of a given type.

Returns
True the condition is of a given type.
Since
1.1.0

◆ isC()

bool fcml::Condition::isC ( ) const
inline

Gets true the condition is of a given type.

Returns
True the condition is of a given type.
Since
1.1.0

◆ isE()

bool fcml::Condition::isE ( ) const
inline

Gets true the condition is of a given type.

Returns
True the condition is of a given type.
Since
1.1.0

◆ isG()

bool fcml::Condition::isG ( ) const
inline

Gets true the condition is of a given type.

Returns
True the condition is of a given type.
Since
1.1.0

◆ isGE()

bool fcml::Condition::isGE ( ) const
inline

Gets true the condition is of a given type.

Returns
True the condition is of a given type.
Since
1.1.0

◆ isL()

bool fcml::Condition::isL ( ) const
inline

Gets true the condition is of a given type.

Returns
True the condition is of a given type.
Since
1.1.0

◆ isLE()

bool fcml::Condition::isLE ( ) const
inline

Gets true the condition is of a given type.

Returns
True the condition is of a given type.
Since
1.1.0

◆ isNA()

bool fcml::Condition::isNA ( ) const
inline

Gets true the condition is of a given type.

Returns
True the condition is of a given type.
Since
1.1.0

◆ isNAE()

bool fcml::Condition::isNAE ( ) const
inline

Gets true the condition is of a given type.

Returns
True the condition is of a given type.
Since
1.1.0

◆ isNB()

bool fcml::Condition::isNB ( ) const
inline

Gets true the condition is of a given type.

Returns
True the condition is of a given type.
Since
1.1.0

◆ isNBE()

bool fcml::Condition::isNBE ( ) const
inline

Gets true the condition is of a given type.

Returns
True the condition is of a given type.
Since
1.1.0

◆ isNC()

bool fcml::Condition::isNC ( ) const
inline

Gets true the condition is of a given type.

Returns
True the condition is of a given type.
Since
1.1.0

◆ isNE()

bool fcml::Condition::isNE ( ) const
inline

Gets true the condition is of a given type.

Returns
True the condition is of a given type.
Since
1.1.0

◆ isNegation()

bool fcml::Condition::isNegation ( ) const
inline

Returns true if condition is negated.

Returns
True if condition is negated.
Since
1.1.0

◆ isNG()

bool fcml::Condition::isNG ( ) const
inline

Gets true the condition is of a given type.

Returns
True the condition is of a given type.
Since
1.1.0

◆ isNGE()

bool fcml::Condition::isNGE ( ) const
inline

Gets true the condition is of a given type.

Returns
True the condition is of a given type.
Since
1.1.0

◆ isNL()

bool fcml::Condition::isNL ( ) const
inline

Gets true the condition is of a given type.

Returns
True the condition is of a given type.
Since
1.1.0

◆ isNLE()

bool fcml::Condition::isNLE ( ) const
inline

Gets true the condition is of a given type.

Returns
True the condition is of a given type.
Since
1.1.0

◆ isNO()

bool fcml::Condition::isNO ( ) const
inline

Gets true the condition is of a given type.

Returns
True the condition is of a given type.
Since
1.1.0

◆ isNP()

bool fcml::Condition::isNP ( ) const
inline

Gets true the condition is of a given type.

Returns
True the condition is of a given type.
Since
1.1.0

◆ isNS()

bool fcml::Condition::isNS ( ) const
inline

Gets true the condition is of a given type.

Returns
True the condition is of a given type.
Since
1.1.0

◆ isNZ()

bool fcml::Condition::isNZ ( ) const
inline

Gets true the condition is of a given type.

Returns
True the condition is of a given type.
Since
1.1.0

◆ isO()

bool fcml::Condition::isO ( ) const
inline

Gets true the condition is of a given type.

Returns
True the condition is of a given type.
Since
1.1.0

◆ isP()

bool fcml::Condition::isP ( ) const
inline

Gets true the condition is of a given type.

Returns
True the condition is of a given type.
Since
1.1.0

◆ isPE()

bool fcml::Condition::isPE ( ) const
inline

Gets true the condition is of a given type.

Returns
True the condition is of a given type.
Since
1.1.0

◆ isPO()

bool fcml::Condition::isPO ( ) const
inline

Gets true the condition is of a given type.

Returns
True the condition is of a given type.
Since
1.1.0

◆ isS()

bool fcml::Condition::isS ( ) const
inline

Gets true the condition is of a given type.

Returns
True the condition is of a given type.
Since
1.1.0

◆ isZ()

bool fcml::Condition::isZ ( ) const
inline

Gets true the condition is of a given type.

Returns
True the condition is of a given type.
Since
1.1.0

◆ L()

static const Condition fcml::Condition::L ( )
inlinestatic

Factory method which creates a condition of a given type.

Returns
The condition with a type described by the method name.
Since
1.1.0

◆ LE()

static const Condition fcml::Condition::LE ( )
inlinestatic

Factory method which creates a condition of a given type.

Returns
The condition with a type described by the method name.
Since
1.1.0

◆ NA()

static const Condition fcml::Condition::NA ( )
inlinestatic

Factory method which creates a condition of a given type.

Returns
The condition with a type described by the method name.
Since
1.1.0

◆ NAE()

static const Condition fcml::Condition::NAE ( )
inlinestatic

Factory method which creates a condition of a given type.

Returns
The condition with a type described by the method name.
Since
1.1.0

◆ NB()

static const Condition fcml::Condition::NB ( )
inlinestatic

Factory method which creates a condition of a given type.

Returns
The condition with a type described by the method name.
Since
1.1.0

◆ NBE()

static const Condition fcml::Condition::NBE ( )
inlinestatic

Factory method which creates a condition of a given type.

Returns
The condition with a type described by the method name.
Since
1.1.0

◆ NC()

static const Condition fcml::Condition::NC ( )
inlinestatic

Factory method which creates a condition of a given type.

Returns
The condition with a type described by the method name.
Since
1.1.0

◆ NE()

static const Condition fcml::Condition::NE ( )
inlinestatic

Factory method which creates a condition of a given type.

Returns
The condition with a type described by the method name.
Since
1.1.0

◆ NG()

static const Condition fcml::Condition::NG ( )
inlinestatic

Factory method which creates a condition of a given type.

Returns
The condition with a type described by the method name.
Since
1.1.0

◆ NGE()

static const Condition fcml::Condition::NGE ( )
inlinestatic

Factory method which creates a condition of a given type.

Returns
The condition with a type described by the method name.
Since
1.1.0

◆ NL()

static const Condition fcml::Condition::NL ( )
inlinestatic

Factory method which creates a condition of a given type.

Returns
The condition with a type described by the method name.
Since
1.1.0

◆ NLE()

static const Condition fcml::Condition::NLE ( )
inlinestatic

Factory method which creates a condition of a given type.

Returns
The condition with a type described by the method name.
Since
1.1.0

◆ NO()

static const Condition fcml::Condition::NO ( )
inlinestatic

Factory method which creates a condition of a given type.

Returns
The condition with a type described by the method name.
Since
1.1.0

◆ NP()

static const Condition fcml::Condition::NP ( )
inlinestatic

Factory method which creates a condition of a given type.

Returns
The condition with a type described by the method name.
Since
1.1.0

◆ NS()

static const Condition fcml::Condition::NS ( )
inlinestatic

Factory method which creates a condition of a given type.

Returns
The condition with a type described by the method name.
Since
1.1.0

◆ NZ()

static const Condition fcml::Condition::NZ ( )
inlinestatic

Factory method which creates a condition of a given type.

Returns
The condition with a type described by the method name.
Since
1.1.0

◆ O()

static const Condition fcml::Condition::O ( )
inlinestatic

Factory method which creates a condition of a given type.

Returns
The condition with a type described by the method name.
Since
1.1.0

◆ operator!=()

bool fcml::Condition::operator!= ( const Condition cond) const
inline

Checks if two condition are equal.

Parameters
condThe condition to be compared to the current one.
Returns
True if they are NOT equal.
Since
1.1.0

◆ operator==()

bool fcml::Condition::operator== ( const Condition cond) const
inline

Checks if two condition are equal.

Parameters
condThe condition to be compared to the current one.
Returns
True if they are equal.
Since
1.1.0

◆ P()

static const Condition fcml::Condition::P ( )
inlinestatic

Factory method which creates a condition of a given type.

Returns
The condition with a type described by the method name.
Since
1.1.0

◆ PE()

static const Condition fcml::Condition::PE ( )
inlinestatic

Factory method which creates a condition of a given type.

Returns
The condition with a type described by the method name.
Since
1.1.0

◆ PO()

static const Condition fcml::Condition::PO ( )
inlinestatic

Factory method which creates a condition of a given type.

Returns
The condition with a type described by the method name.
Since
1.1.0

◆ S()

static const Condition fcml::Condition::S ( )
inlinestatic

Factory method which creates a condition of a given type.

Returns
The condition with a type described by the method name.
Since
1.1.0

◆ setConditionType()

Condition& fcml::Condition::setConditionType ( ConditionType  conditionType)
inline

Sets condition type.

Parameters
conditionTypeThe condition type to be set.
Since
1.1.0

◆ setNegation()

Condition& fcml::Condition::setNegation ( bool  isNegation)
inline

Sets negation flag for the condition.

Parameters
isNegationThe negation flag.
Since
1.1.0

◆ Z()

static const Condition fcml::Condition::Z ( )
inlinestatic

Factory method which creates a condition of a given type.

Returns
The condition with a type described by the method name.
Since
1.1.0

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