GAMS  1.4.0
gams::variables::Self Class Reference

A container for self referencing information. More...

#include <Self.h>

Public Member Functions

 Self ()
 Constructor. More...
 
 ~Self ()
 Destructor. More...
 
void init_vars (madara::knowledge::KnowledgeBase &knowledge, const madara::knowledge::KnowledgeRecord::Integer &id)
 Initializes variable containers. More...
 
void init_vars (madara::knowledge::KnowledgeBase &knowledge, const std::string &self_prefix)
 Initializes variable containers. More...
 
void init_vars (madara::knowledge::Variables &knowledge, const madara::knowledge::KnowledgeRecord::Integer &id)
 Initializes variable containers. More...
 
void operator= (const Self &agent)
 Assignment operator. More...
 

Public Attributes

Agent agent
 the agent-specific variables More...
 
madara::knowledge::containers::Integer id
 the id of this agent More...
 
madara::knowledge::containers::String prefix
 the id of this agent More...
 

Detailed Description

A container for self referencing information.

Definition at line 69 of file Self.h.

Constructor & Destructor Documentation

◆ Self()

gams::variables::Self::Self ( )

Constructor.

◆ ~Self()

gams::variables::Self::~Self ( )

Destructor.

Member Function Documentation

◆ init_vars() [1/3]

void gams::variables::Self::init_vars ( madara::knowledge::KnowledgeBase &  knowledge,
const madara::knowledge::KnowledgeRecord::Integer &  id 
)

Initializes variable containers.

Parameters
knowledgethe knowledge base that houses the variables
idnode identifier

◆ init_vars() [2/3]

void gams::variables::Self::init_vars ( madara::knowledge::KnowledgeBase &  knowledge,
const std::string &  self_prefix 
)

Initializes variable containers.

Parameters
knowledgethe knowledge base that houses the variables
self_prefixthe prefix of the agent's data in knowledge base

◆ init_vars() [3/3]

void gams::variables::Self::init_vars ( madara::knowledge::Variables &  knowledge,
const madara::knowledge::KnowledgeRecord::Integer &  id 
)

Initializes variable containers.

Parameters
knowledgethe variable context
idnode identifier

◆ operator=()

void gams::variables::Self::operator= ( const Self agent)

Assignment operator.

Parameters
agentagent to copy

Member Data Documentation

◆ agent

Agent gams::variables::Self::agent

the agent-specific variables

Definition at line 119 of file Self.h.

◆ id

madara::knowledge::containers::Integer gams::variables::Self::id

the id of this agent

Definition at line 113 of file Self.h.

◆ prefix

madara::knowledge::containers::String gams::variables::Self::prefix

the id of this agent

Definition at line 116 of file Self.h.


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