CBotVar subclass for managing classes (CBotTypClass, CBotTypIntrinsic) More...

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

Inheritance diagram for CBot::CBotVarClass:

Public Member Functions
	CBotVarClass (const CBotToken &name, const CBotTypResult &type)
	Constructor. Do not call directly, use CBotVar::Create() More...

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

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

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

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

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

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

CBotVar *	GetItem (int n, bool bExtend) override
	Returns element of the array by index. More...

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

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

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

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

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

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

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

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

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

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

void	SetInit (InitType initType)
	Changes variable init status. More...

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

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

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

bool	IsNAN () const
	Checks if the variable is currently NAN. More...

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

bool	IsStatic ()
	Checks if the variable is static. More...

void	SetPrivate (ProtectionLevel mPrivate)
	Sets variable protection level. More...

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

ProtectionLevel	GetPrivate ()
	Get variable protection level. More...

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

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

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

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

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

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

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

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

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

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

	operator bool ()
	Set the value. More...

	operator signed char ()
	Set the value. More...

	operator short ()
	Set the value. More...

	operator uint32_t ()
	Set the value. More...

	operator int ()
	Set the value. More...

	operator long ()
	Set the value. More...

	operator float ()
	Set the value. More...

	operator double ()
	Set the value. More...

	operator std::string ()
	Set the value. More...

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

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

void	operator= (short x)
	Set the value. More...

void	operator= (uint32_t x)
	Set the value. More...

void	operator= (int x)
	Set the value. More...

void	operator= (long x)
	Set the value. More...

void	operator= (float x)
	Set the value. More...

void	operator= (double x)
	Set the value. More...

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

void	SetVal (CBotVar *var)
	Set the value. More...

virtual void	SetValByte (signed char val)
	Set the value. More...

virtual void	SetValShort (short val)
	Set the value. More...

virtual void	SetValChar (uint32_t val)
	Set the value. More...

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

virtual void	SetValLong (long val)
	Set the value. More...

virtual void	SetValFloat (float val)
	Set value as float. More...

virtual void	SetValDouble (double val)
	Set the value. More...

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

virtual signed char	GetValByte ()
	Set the value. More...

virtual short	GetValShort ()
	Set the value. More...

virtual uint32_t	GetValChar ()
	Set the value. More...

virtual int	GetValInt ()
	Get value as integer. More...

virtual long	GetValLong ()
	Set the value. More...

virtual float	GetValFloat ()
	Get value as float. More...

virtual double	GetValDouble ()
	Set the value. More...

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

virtual void	Add (CBotVar left, CBotVar right)
	Addition. More...

virtual void	Sub (CBotVar left, CBotVar right)
	Subtraction. More...

virtual void	Mul (CBotVar left, CBotVar right)
	Multiplication. More...

virtual CBotError	Div (CBotVar left, CBotVar right)
	Division. More...

virtual CBotError	Modulo (CBotVar left, CBotVar right)
	Modulo (remainder of division) More...

virtual void	Power (CBotVar left, CBotVar right)
	Power. More...

virtual bool	Lo (CBotVar left, CBotVar right)
	left < right More...

virtual bool	Hi (CBotVar left, CBotVar right)
	left > right More...

virtual bool	Ls (CBotVar left, CBotVar right)
	left <= right More...

virtual bool	Hs (CBotVar left, CBotVar right)
	left >= right More...

virtual void	And (CBotVar left, CBotVar right)
	left && right or left & right More...

virtual void	Or (CBotVar left, CBotVar right)
	left \|\| right or left \| right More...

virtual void	XOr (CBotVar left, CBotVar right)
	left ^ right (also for boolean!) More...

virtual void	Not ()
	!this or ~this More...

virtual void	ASR (CBotVar left, CBotVar right)
	left >> right More...

virtual void	SR (CBotVar left, CBotVar right)
	left >>> right More...

virtual void	SL (CBotVar left, CBotVar right)
	left << right More...

virtual void	Neg ()
	-this More...

virtual void	Inc ()
	++this More...

virtual void	Dec ()
	–this More...

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

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

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

Unique instance identifier
class	CBotVar
	List of all class instances - first. More...

class	CBotVarPointer
	List of all class instances - first. More...

void	SetIdent (long n) override
	List of all class instances - first. More...

bool	Eq (CBotVar left, CBotVar right) override
	List of all class instances - first. More...

bool	Ne (CBotVar left, CBotVar right) override
	List of all class instances - first. More...

void	ConstructorSet () override
	List of all class instances - first. More...

static CBotVarClass *	Find (long id)
	Finds a class instance by unique identifier. More...

Reference counter
void	IncrementUse ()
	Increment reference counter. More...

void	DecrementUse ()
	Decrement reference counter. More...

CBotVarClass *	GetPointer () override
	Increment reference counter. More...

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 , IS_NAN = 999 }
	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. More...

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

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

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

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

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

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

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

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

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

CBotTypResult	m_type
	Type of value. More...

InitType	m_binit
	Initialization status. More...

CBotVarClass *	m_pMyThis
	Corresponding this element (TODO: ?) More...

void *	m_pUserPtr
	User pointer if specified. More...

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

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

CBotInstr *	m_InitExpr
	Expression describing initial value. More...

CBotInstr *	m_LimExpr
	Expression describing array limit. More...

long	m_ident
	Identifier. More...

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

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

Detailed Description

CBotVar subclass for managing classes (CBotTypClass, CBotTypIntrinsic)

Constructor & Destructor Documentation

◆ CBotVarClass()

CBot::CBotVarClass::CBotVarClass	(	const CBotToken &	name,
		const CBotTypResult &	type
	)

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

◆ ~CBotVarClass()

CBot::CBotVarClass::~CBotVarClass ( )

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

Member Function Documentation

◆ Copy()

void CBot::CBotVarClass::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.

◆ SetClass()

void CBot::CBotVarClass::SetClass ( CBotClass * pClass )

overridevirtual

Set class this variable is instance of.

Used by instance variables, NOT class members

Reimplemented from CBot::CBotVar.

◆ GetClass()

CBotClass * CBot::CBotVarClass::GetClass ( )

overridevirtual

Return class this variable is instance of.

Used by instance variables, NOT class members

Reimplemented from CBot::CBotVar.

◆ GetItem() [1/2]

CBotVar * CBot::CBotVarClass::GetItem ( const std::string & name )

overridevirtual

Returns class member by name.

Parameters

name	Name of member to get

Returns: CBotVar representing the class member

Reimplemented from CBot::CBotVar.

◆ GetItemRef()

CBotVar * CBot::CBotVarClass::GetItemRef ( int nIdent )

overridevirtual

Returns class member by unique ID.

Parameters

nIdent Unique ID of the class member to return

Returns: CBotVar representing the class member

See also: GetUniqNum()

Reimplemented from CBot::CBotVar.

◆ GetItem() [2/2]

CBotVar * CBot::CBotVarClass::GetItem	(	int	index,
		bool	grow
	)

overridevirtual

Returns element of the array by index.

TODO: Appears to be also implemented in CBotVarClass, but I'm not sure what is it used for there. Looks like CBotVarArray stores data internally in CBotVarClass or something like that. Needs futher investigation.

Parameters

index	Index of the element to get
grow	true to grow the array automatically if the index is out of range

Returns: CBotVar representing the array element, or nullptr on error (for example going out of range)

Reimplemented from CBot::CBotVar.

◆ GetItemList()

CBotVar * CBot::CBotVarClass::GetItemList ( )

overridevirtual

Return all elements of this variable as a linked list. Works for both classes and arrays.

Returns: CBotVar representing the first object in the linked list. Use CBotVar::GetNext() to access next ones.

Reimplemented from CBot::CBotVar.

◆ GetValString()

std::string CBot::CBotVarClass::GetValString ( )

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.

◆ Save1State()

bool CBot::CBotVarClass::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.

◆ Update()

void CBot::CBotVarClass::Update ( void * pUser )

overridevirtual

Call the class update function.

Parameters

pUser User pointer to pass to the update function

See also: CBotClass::SetUpdateFunc()

Reimplemented from CBot::CBotVar.

◆ IncrementUse()

void CBot::CBotVarClass::IncrementUse ( )

Increment reference counter.

◆ DecrementUse()

void CBot::CBotVarClass::DecrementUse ( )

Decrement reference counter.

◆ GetPointer()

CBotVarClass * CBot::CBotVarClass::GetPointer ( )

overridevirtual

Increment reference counter.

Reimplemented from CBot::CBotVar.

◆ SetIdent()

void CBot::CBotVarClass::SetIdent ( long n )

overridevirtual

List of all class instances - first.

Reimplemented from CBot::CBotVar.

◆ Find()

CBotVarClass * CBot::CBotVarClass::Find ( long id )

static

Finds a class instance by unique identifier.

Parameters

id	Identifier to find

Returns: Found class instance

◆ Eq()

bool CBot::CBotVarClass::Eq	(	CBotVar *	left,
		CBotVar *	right
	)

overridevirtual

List of all class instances - first.

Reimplemented from CBot::CBotVar.

◆ Ne()

bool CBot::CBotVarClass::Ne	(	CBotVar *	left,
		CBotVar *	right
	)

overridevirtual

List of all class instances - first.

Reimplemented from CBot::CBotVar.

◆ ConstructorSet()

void CBot::CBotVarClass::ConstructorSet ( )

overridevirtual

List of all class instances - first.

Reimplemented from CBot::CBotVar.

Friends And Related Function Documentation

◆ CBotVar

friend class CBotVar

friend

List of all class instances - first.

◆ CBotVarPointer

friend class CBotVarPointer

friend

List of all class instances - first.

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

src/CBot/CBotVar/CBotVarClass.h
src/CBot/CBotVar/CBotVarClass.cpp

Public Member Functions

Unique instance identifier

Reference counter

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CBotVarClass()

◆ ~CBotVarClass()

Member Function Documentation

◆ Copy()

◆ SetClass()

◆ GetClass()

◆ GetItem() [1/2]

◆ GetItemRef()

◆ GetItem() [2/2]

◆ GetItemList()

◆ GetValString()

◆ Save1State()

◆ Update()

◆ IncrementUse()

◆ DecrementUse()

◆ GetPointer()

◆ SetIdent()

◆ Find()

◆ Eq()

◆ Ne()

◆ ConstructorSet()

Friends And Related Function Documentation

◆ CBotVar

◆ CBotVarPointer