vrforces5.2/classref/set_data_request_stmt_8h_source.html

 /*********************************************************************

 ** Copyright (c) 1999 MaK Technologies, Inc.

 ** All rights reserved.

 *********************************************************************/

 /*********************************************************************

 ** $RCSfile: setStmt.h,v $ $Revision: 1.17 $ $State: Exp $

 *********************************************************************/


 #ifndef DtSetDataRequestStmt_H_

 #define DtSetDataRequestStmt_H_


 class DtSetDataRequestStmt;


 #include "vrfplan/simStatement.h"

 #include <vlutil/vlNetTypes.h>

 #include "vrfplan/vrfplanDefines.h"


 const char DtSetDataRequestStmtTypeName[] = "Set";


 class DtSetDataRequest;


 class DT_DLL_vrfplan DtSetDataRequestStmt : public DtSimStatement

 {

 public:


    DtSetDataRequestStmt(DtReaderWriterRegistry* parentRegistry = NULL);


    DtSetDataRequestStmt(const DtSetDataRequestStmt& orig,

       DtReaderWriterRegistry* parentRegistry = NULL);


    virtual ~DtSetDataRequestStmt() override;


    DtSetDataRequestStmt& operator=(const DtSetDataRequestStmt& orig);


    virtual DtSimStatement* clone(DtReaderWriterRegistry* parentRegistry = NULL) const override;


    virtual int type() const override;


    virtual void execute(DtPlan& planContext) override;


    virtual DtString stringRep(int subBlockIndex = DtSR_STMT) const override;


    virtual DtSetDataRequest* setDataRequest() const;

    virtual void setSetDataRequest(DtSetDataRequest* arg);


    virtual void putSelf(std::string& fp, int indentLevel = 0, bool writeUnspecified = false,

       const DtFilename& path = DtReaderWriter::appPath()) override;


    virtual void getSelf(DtlObjPtr args, const DtReaderWriter::SearchPaths& searchPaths,

       const DtVariableBindingsList& variableBindings) override;


    virtual int netRepSize() const override;


    virtual bool setFromNet(const char* contentBuffer, unsigned contentSize) override;


    virtual bool setToNet() override;


    static DtSimStatement * creator(DtReaderWriterRegistry* parentRegistry = NULL);


 protected:


    DtSetDataRequest* mySetDataRequest;

 };


 #endif

DtSimStatement::clone
virtual DtSimStatement * clone(DtReaderWriterRegistry *parentRegistry=NULL) const =0
virtual copy constructor A typical clone function. It must be overridden by derived classes to return...

DtSimStatement::execute
virtual void execute(DtPlan &planContext)=0
Execute the current statement and make any changes to the Plan state as appropriate. Tells the statement to activate its own behavior. Each kind of statement implements this function differently. It is passed a reference to the executing DtPlan object as a �context of execution�.

DtReaderWriterRegistry
Definition: readerWriterRegistry.h:39

DtSetDataRequestStmtTypeName
const char DtSetDataRequestStmtTypeName[]
Definition: setDataRequestStmt.h:21

DtSetDataRequest
DtSetDataRequest is an abstract base class from which real setDataRequests can derive. It manages the read/write capability; derived classes need only use and register read/writatble data types for derived information.
Definition: setDataRequest.h:41

DtVariableBindingsList
std::list< const DtRwVariableBindings * > DtVariableBindingsList
Definition: readerWriterRegistry.h:29

DtReaderWriter::SearchPaths
std::vector< DtFilename > SearchPaths
Definition: readerWriter.h:92

DtSetDataRequestStmt
Instances of DtSetDataRequestStmt represent a single Set command.
Definition: setDataRequestStmt.h:30

DtSimStatement::setFromNet
virtual bool setFromNet(const char *contentBuffer, unsigned contentSize)
Extracts statement Id from buffer. First 16 bytes are a DtNetSimStatement structure. Derived class data should immediately follow this. Derived classes should call down to this one to make sure statement id gets set.

DtReaderWriter::getSelf
virtual void getSelf(DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
Top level to read itself from an input stream. searchPath is passed down to all DtReaderWriter member...

DtReaderWriter::putSelf
virtual void putSelf(std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
Top level call to write itself to file. If write unspecified is true, will write entries that are uns...

DtSimStatement::netRepSize
virtual int netRepSize() const
Returns sizeof(DtNetSimStatement). Derived classes should add this size to the size of their net repr...

DtPlan
class DtPlan:
Definition: plan.h:92

vrfplanDefines.h

DtSimStatement
class DtSimStatement:
Definition: simStatement.h:38

DtSimStatement::setToNet
virtual bool setToNet()
Casts myNetRep to DtNetSimStatement* and fills in structure. Derived classes should always call down ...

simStatement.h

DT_DLL_vrfplan
#define DT_DLL_vrfplan
This file is used to determine how to build.
Definition: vrfplanDefines.h:28

DtString

DtSimStatement::operator=
DtSimStatement & operator=(const DtSimStatement &orig)
Assignment operator (protected because this is an abstract base class).

DtSetDataRequestStmt::mySetDataRequest
DtSetDataRequest * mySetDataRequest
Definition: setDataRequestStmt.h:99

DtReaderWriter::appPath
static const DtFilename & appPath()
Gets the current working directory. The first time this accessor is called, it determines the current...

DtSimStatement::type
virtual int type() const =0
Returns the type of statement Type (defined in simStmtTypes.h)

DtSimStatement::stringRep
virtual DtString stringRep(int subBlockIndex=DtSR_STMT) const =0
Get a readable string representation of this statement.