CBotVar subclass for managing integer values (CBotTypInt) More...

#include <src/CBot/CBotVar/CBotVarInt.h>

Inheritance diagram for CBot::CBotVarInt:

[legend]

Public Member Functions
	CBotVarInt (const CBotToken &name)

void	SetValInt (int val, const std::string &s="") override
	Set value as an integer.

std::string	GetValString () const override
	Get value as string.

void	Copy (CBotVar *pSrc, bool bName=true) override
	Copy from another variable.

void	Neg () override
	-this

void	Inc () override
	++this

void	Dec () override
	–this

void	Not () override
	!this or ~this

void	SR (CBotVar left, CBotVar right) override
	left >>> right

bool	Save0State (std::ostream &ostr) override
	Save common variable header (name, type, etc.)

bool	Save1State (std::ostream &ostr) override
	Save variable data.

Public Member Functions inherited from CBot::CBotVarInteger< int, CBotTypInt >
	CBotVarInteger (const CBotToken &name)

CBotError	Modulo (CBotVar left, CBotVar right) override
	Modulo (remainder of division)

void	XOr (CBotVar left, CBotVar right) override
	left ^ right (also for boolean!)

void	And (CBotVar left, CBotVar right) override
	left && right or left & right

void	Or (CBotVar left, CBotVar right) override
	left \|\| right or left \| right

void	SL (CBotVar left, CBotVar right) override
	left << right

void	ASR (CBotVar left, CBotVar right) override
	left >> right

void	Not () override
	!this or ~this

Public Member Functions inherited from CBot::CBotVarNumber< T, type >
	CBotVarNumber (const CBotToken &name)

void	Mul (CBotVar left, CBotVar right) override
	Multiplication.

void	Power (CBotVar left, CBotVar right) override
	Power.

CBotError	Div (CBotVar left, CBotVar right) override
	Division.

CBotError	Modulo (CBotVar left, CBotVar right) override
	Modulo (remainder of division)

void	Add (CBotVar left, CBotVar right) override
	Addition.

void	Sub (CBotVar left, CBotVar right) override
	Subtraction.

void	Neg () override
	-this

void	Inc () override
	++this

void	Dec () override
	–this

bool	Lo (CBotVar left, CBotVar right) override
	left < right

bool	Hi (CBotVar left, CBotVar right) override
	left > right

bool	Ls (CBotVar left, CBotVar right) override
	left <= right

bool	Hs (CBotVar left, CBotVar right) override
	left >= right

Public Member Functions inherited from CBot::CBotVarNumberBase< T, type >
	CBotVarNumberBase (const CBotToken &name)

void	SetValByte (signed char val) override
	Set the value.

void	SetValShort (short val) override
	Set the value.

void	SetValChar (uint32_t val) override
	Set the value.

void	SetValInt (int val, const std::string &s="") override
	Set value as an integer.

void	SetValLong (long val) override
	Set the value.

void	SetValFloat (float val) override
	Set value as float.

void	SetValDouble (double val) override
	Set the value.

signed char	GetValByte () const override
	Set the value.

short	GetValShort () const override
	Set the value.

uint32_t	GetValChar () const override
	Set the value.

int	GetValInt () const override
	Get value as integer.

long	GetValLong () const override
	Set the value.

float	GetValFloat () const override
	Get value as float.

double	GetValDouble () const override
	Set the value.

bool	Eq (CBotVar left, CBotVar right) override
	left == right

bool	Ne (CBotVar left, CBotVar right) override
	left != right

Public Member Functions inherited from CBot::CBotVarValue< T, type >
	CBotVarValue (const CBotToken &name)
	Constructor. Do not call directly, use CBotVar::Create()

void	Copy (CBotVar *pSrc, bool bName=true) override
	Copy from another variable.

void	SetValString (const std::string &val) override
	Set value as string.

std::string	GetValString () const override
	Get value as string.

Public Member Functions inherited from CBot::CBotVar
const std::string &	GetName ()
	Returns the name of the variable.

void	SetName (const std::string &name)
	SetName Changes the name of the variable.

CBotToken *	GetToken ()
	Returns the CBotToken this variable is associated with.

CBotType	GetType (GetTypeMode mode=GetTypeMode::NORMAL) const
	GetType Returns the base type of the variable (CBotType)

CBotTypResult	GetTypResult (GetTypeMode mode=GetTypeMode::NORMAL)
	Returns the complete type of the variable (CBotTypResult)

void	SetType (CBotTypResult &type)
	Change type of this variable.

virtual void	SetClass (CBotClass *pClass)
	Set class this variable is instance of.

virtual CBotClass *	GetClass ()
	Return class this variable is instance of.

void	SetInit (InitType initType)
	Changes variable init status.

InitType	GetInit () const
	Returns the current init state of the variable.

bool	IsUndefined () const
	Checks if the variable is currently "undefined".

bool	IsDefined () const
	Checks if the variable is currently "defined".

void	SetStatic (bool bStatic)
	Marks the variable as "static".

bool	IsStatic ()
	Checks if the variable is static.

void	SetPrivate (ProtectionLevel mPrivate)
	Sets variable protection level.

bool	IsPrivate (ProtectionLevel level=ProtectionLevel::Protected)
	Checks if the variable is accessible at the given protection level.

ProtectionLevel	GetPrivate ()
	Get variable protection level.

bool	IsElemOfClass (const std::string &name)
	Check if a variable belongs to a class with a given name.

virtual void	ConstructorSet ()
	Called after constructor has been called.

CBotVar *	GetStaticVar ()
	If this is a static class variable, return the static var from the class.

virtual void	Update (void *pUser)
	Call the class update function.

void	SetUniqNum (long n)
	Set unique identifier of this variable Note: For classes, this is unique within the class only - see CBotClass:AddItem.

long	GetUniqNum ()
	Return unique identifier of this variable Note: For classes, this is unique within the class only - see CBotClass:AddItem.

	CBotVar ()
	Constructor. Do not call directly, use CBotVar::Create()

	CBotVar (const CBotToken &name)
	Constructor. Do not call directly, use CBotVar::Create()

virtual	~CBotVar ()
	Destructor. Do not call directly, use CBotVar::Destroy()

virtual void	SetIdent (long UniqId)
	Associates an unique identifier to class instance.

void	SetUserPtr (void *pUser)
	Set a custom pointer associated with this variable.

void *	GetUserPtr ()
	Returns the custom pointer associated with this variable.

virtual CBotVar *	GetItem (const std::string &name)
	Returns class member by name.

virtual CBotVar *	GetItemRef (int nIdent)
	Returns class member by unique ID.

virtual CBotVar *	GetItem (int index, bool grow=false)
	Returns element of the array by index.

virtual CBotVar *	GetItemList ()
	Return all elements of this variable as a linked list. Works for both classes and arrays.

	operator bool ()
	Set the value.

	operator signed char ()
	Set the value.

	operator short ()
	Set the value.

	operator uint32_t ()
	Set the value.

	operator int ()
	Set the value.

	operator long ()
	Set the value.

	operator float ()
	Set the value.

	operator double ()
	Set the value.

	operator std::string ()
	Set the value.

void	operator= (const CBotVar &var)
	Set the value.

void	operator= (signed char x)
	Set the value.

void	operator= (short x)
	Set the value.

void	operator= (uint32_t x)
	Set the value.

void	operator= (int x)
	Set the value.

void	operator= (long x)
	Set the value.

void	operator= (float x)
	Set the value.

void	operator= (double x)
	Set the value.

void	operator= (const std::string &x)
	Set the value.

void	SetVal (CBotVar *var)
	Set the value.

virtual void	SetPointer (CBotVar *p)
	Set value for pointer types.

virtual CBotVarClass *	GetPointer ()
	Get value for pointer types.

Public Member Functions inherited from CBot::CBotLinkedList< CBotVar >
virtual	~CBotLinkedList ()
	Destructor. Be careful, destroys the whole linked list!

CBotVar *	GetNext ()
	Returns the next variable in the linked list.

void	AddNext (CBotVar *elem)
	Appends a new element at the end of the linked list.

Protected Member Functions
void	SetValue (int val) override

Protected Member Functions inherited from CBot::CBotVarValue< T, type >
virtual void	SetValue (T val)

Protected Attributes
std::string	m_defnum
	The name if given by DefineNum.

Protected Attributes inherited from CBot::CBotVarValue< T, type >
T	m_val
	The value.

Protected Attributes inherited from CBot::CBotVar
CBotToken *const	m_token
	The corresponding token, defines the variable name.

CBotTypResult	m_type
	Type of value.

InitType	m_binit
	Initialization status.

CBotVarClass *	m_pMyThis
	Corresponding this element (TODO: ?)

void *	m_pUserPtr
	User pointer if specified.

bool	m_bStatic
	true if the variable is static (for classes)

ProtectionLevel	m_mPrivate
	Element protection level - public, protected or private (for classes)

CBotInstr *	m_InitExpr
	Expression describing initial value.

CBotInstr *	m_LimExpr
	Expression describing array limit.

long	m_ident
	Identifier.

Protected Attributes inherited from CBot::CBotLinkedList< CBotVar >
CBotVar *	m_next

Friends
class	CBotVar

Additional Inherited Members
Public Types inherited from CBot::CBotVar
enum class	GetTypeMode { NORMAL = 0 , CLASS_AS_POINTER = 1 , CLASS_AS_INTRINSIC = 2 }
	Mode for GetType() and GetTypResult() More...

enum class	InitType : int { UNDEF = 0 , DEF = 1 , IS_POINTER = 2 }
	Variable initialization status. More...

enum class	ProtectionLevel { Public = 0 , ReadOnly = 1 , Protected = 2 , Private = 3 }
	Class member protection level (public/protected/private) More...

Static Public Member Functions inherited from CBot::CBotVar
static long	NextUniqNum ()
	Generate next unique identifier.

static bool	RestoreState (std::istream &istr, CBotVar *&pVar)
	Restore variable.

static CBotVar *	Create (const std::string &name, CBotTypResult type)
	Creates a new variable from a type described by CBotTypResult.

static CBotVar *	Create (const std::string &name, CBotClass *pClass)
	Creates a new variable of a given class type.

static CBotVar *	Create (const CBotToken &name, CBotType type)
	Creates a new variable of a given type.

static CBotVar *	Create (const CBotToken &name, CBotTypResult type)
	Create a new variable of a given type described by CBotTypResult.

static CBotVar *	Create (const std::string &name, CBotType type, CBotClass *pClass)
	Create a new variable of a given type of given class instance.

static CBotVar *	Create (CBotVar *pVar)
	Create a new variable of the same type and name as another one.

static void	Destroy (CBotVar *var)
	Destroy a variable.

Static Protected Attributes inherited from CBot::CBotVar
static long	m_identcpt = 0
	TODO: ?

Detailed Description

CBotVar subclass for managing integer values (CBotTypInt)

Member Function Documentation

◆ SetValInt()

void CBot::CBotVarInt::SetValInt	(	int	val,
		const std::string &	name = `""`
	)

overridevirtual

Set value as an integer.

This one should be used for boolean values, too

Parameters

val	New value
name	Used when you assign a constant value - makes the value appear as "name" instead of number in the debugger

Reimplemented from CBot::CBotVar.

◆ GetValString()

std::string CBot::CBotVarInt::GetValString ( ) const

overridevirtual

Get value as string.

This one is supported by most types of variables.

Automatically converts the value to string if needed.

Returns: Current value

Reimplemented from CBot::CBotVar.

◆ Copy()

void CBot::CBotVarInt::Copy	(	CBotVar *	pSrc,
		bool	bName = `true`
	)

overridevirtual

Copy from another variable.

Parameters

pSrc	Variable to copy from
bName	true if you want to also copy the name

Reimplemented from CBot::CBotVar.

◆ Neg()

void CBot::CBotVarInt::Neg ( )

overridevirtual

-this

Reimplemented from CBot::CBotVar.

◆ Inc()

void CBot::CBotVarInt::Inc ( )

overridevirtual

++this

Reimplemented from CBot::CBotVar.

◆ Dec()

void CBot::CBotVarInt::Dec ( )

overridevirtual

–this

Reimplemented from CBot::CBotVar.

◆ Not()

void CBot::CBotVarInt::Not ( )

overridevirtual

!this or ~this

Reimplemented from CBot::CBotVar.

◆ SR()

void CBot::CBotVarInt::SR	(	CBotVar *	left,
		CBotVar *	right
	)

overridevirtual

left >>> right

This is unsigned shift to right

Reimplemented from CBot::CBotVar.

◆ Save0State()

bool CBot::CBotVarInt::Save0State ( std::ostream & ostr )

overridevirtual

Save common variable header (name, type, etc.)

Parameters

ostr	Output stream

Returns: false on write error

Reimplemented from CBot::CBotVar.

◆ Save1State()

bool CBot::CBotVarInt::Save1State ( std::ostream & ostr )

overridevirtual

Save variable data.

Overriden in child classes

Parameters

ostr	Output stream

Returns: false on write error

Reimplemented from CBot::CBotVar.

Member Data Documentation

◆ m_defnum

std::string CBot::CBotVarInt::m_defnum

protected

The name if given by DefineNum.

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

src/CBot/CBotVar/CBotVarInt.h
src/CBot/CBotVar/CBotVarInt.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ SetValInt()

◆ GetValString()

◆ Copy()

◆ Neg()

◆ Inc()

◆ Dec()

◆ Not()

◆ SR()

◆ Save0State()

◆ Save1State()

Member Data Documentation

◆ m_defnum