Public Member Functions | List of all members
Reader Class Referenceabstract

Reader class implements base interface for input data reading. More...

#include <Reader.h>

Inheritance diagram for Reader:
Inheritance graph
[legend]

Public Member Functions

virtual ReaderClone () const =0
 Abstract method for cloning inheritors objects. Implementations of this method should create copy of object in memmory and return pointer to copy. More...
 
virtual bool GetAgents (std::vector< Agent * > &agents, const int &numThreshold)=0
 Abstract method. Should creates object for all agents. More...
 
virtual bool GetEnvironmentOptions (EnvironmentOptions **envOpt)=0
 Abstract method. Should creates object with algorithms and environment parameters. More...
 
virtual bool GetMap (Map **map)=0
 Abstract method. Should creates object with static environment data. More...
 
virtual bool ReadData ()=0
 Abstract method. Should starts input data reading from file or from another source. More...
 
virtual ~Reader ()
 Reader virtual destructor. More...
 

Detailed Description

Reader class implements base interface for input data reading.

Definition at line 21 of file Reader.h.

Constructor & Destructor Documentation

virtual Reader::~Reader ( )
inlinevirtual

Reader virtual destructor.

Definition at line 27 of file Reader.h.

Member Function Documentation

virtual Reader* Reader::Clone ( ) const
pure virtual

Abstract method for cloning inheritors objects. Implementations of this method should create copy of object in memmory and return pointer to copy.

Returns
Pointer to copy of object

Implemented in XMLReader.

virtual bool Reader::GetAgents ( std::vector< Agent * > &  agents,
const int &  numThreshold 
)
pure virtual

Abstract method. Should creates object for all agents.

Parameters
[out]agentsVector of all agents of system. Objects in vector contain full information about each agent.
[in]numThresholdMaximum number of agents in system.
Returns
Success of objects creating and transfer process.

Implemented in XMLReader.

virtual bool Reader::GetEnvironmentOptions ( EnvironmentOptions **  envOpt)
pure virtual

Abstract method. Should creates object with algorithms and environment parameters.

Parameters
[out]envOptAlgorithms and environment parameters.
Returns
Success of object creating and transfer process.

Implemented in XMLReader.

virtual bool Reader::GetMap ( Map **  map)
pure virtual

Abstract method. Should creates object with static environment data.

Parameters
[out]mapStatic environment data
Returns
Success of object creating and transfer process.

Implemented in XMLReader.

virtual bool Reader::ReadData ( )
pure virtual

Abstract method. Should starts input data reading from file or from another source.

Returns
Success of data reading.

Implemented in XMLReader.


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


ORCAStar
Author(s): Stepan Drgachev
autogenerated on Wed Jul 15 2020 16:13:14