fcml::Symbol Class Reference

Represents one named symbol with associated value. More...

#include <fcml_symbols.hpp>

Public Member Functions
	Symbol ()
	Creates an empty symbol. More...
	Symbol (const fcml_cstring &name, fcml_int64_t value)
	Creates a symbol instance for the given name and value. More...
	operator fcml_uint64_t () const
	Gets symbol value. More...
	operator fcml_int64_t () const
	Gets symbol value. More...
bool	isEmpty () const
	Gets true if symbol is empty. More...
const fcml_cstring &	getName () const
	Gets the symbol name. More...
fcml_uint64_t	getValue () const
	Gets the symbol value. More...
void	setName (const fcml_cstring &name)
	Sets a new symbol name. More...
void	setValue (fcml_uint64_t value)
	Sets a new symbol value. More...

Detailed Description

Represents one named symbol with associated value.

Since

1.1.0

Constructor & Destructor Documentation

Symbol() [1/2]

fcml::Symbol::Symbol ( )

inline

Creates an empty symbol.

Since

1.1.0

Symbol() [2/2]

fcml::Symbol::Symbol ( const fcml_cstring &  name, fcml_int64_t  value  )

inline

Creates a symbol instance for the given name and value.

Parameters

name	The symbol name.
value	The symbol value.

Since

1.1.0

Member Function Documentation

getName()

const fcml_cstring& fcml::Symbol::getName ( ) const

inline

Gets the symbol name.

Returns

The symbol name.

Since

1.1.0

getValue()

fcml_uint64_t fcml::Symbol::getValue ( ) const

inline

Gets the symbol value.

Returns

The symbol value.

Since

1.1.0

isEmpty()

bool fcml::Symbol::isEmpty ( ) const

inline

Gets true if symbol is empty.

Returns

True if symbol is empty.

Since

1.1.0

operator fcml_int64_t()

fcml::Symbol::operator fcml_int64_t ( ) const

inline

Gets symbol value.

Since

1.1.0

operator fcml_uint64_t()

fcml::Symbol::operator fcml_uint64_t ( ) const

inline

Gets symbol value.

Since

1.1.0

setName()

void fcml::Symbol::setName ( const fcml_cstring &  name )

inline

Sets a new symbol name.

Parameters

name	The symbol name.

Since

1.1.0

setValue()

void fcml::Symbol::setValue ( fcml_uint64_t  value )

inline

Sets a new symbol value.

Parameters

value

The symbol value.

Since

1.1.0

---

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

• include/fcml_symbols.hpp