vrforces5.0.2/classref/supply_list_response_admin_8h_source.html

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

 ** Copyright (c) 2019 MAK Technologies, Inc.

 ** All rights reserved.

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


 #pragma once


 #include <vrftasks/adminContent.h>

 #include <list>


 class DtEntityType;


 typedef std::vector<DtEntityType> DtSupplyVector;


 class DT_DLL_vrftasks DtSupplyListResponseAdmin : public DtAdminContent

 {

 public:


    DtSupplyListResponseAdmin();


    DtSupplyListResponseAdmin(const DtSupplyListResponseAdmin & orig);


    const DtSupplyListResponseAdmin & operator=(const

       DtSupplyListResponseAdmin & orig);


    virtual ~DtSupplyListResponseAdmin();


    static DtAdminContent* create();


    virtual bool init();


    virtual const DtAdminContentMessageType& type() const;


    virtual const DtSupplyVector& supplies() const;

    virtual DtSupplyVector& supplies();


    virtual void addSupply(const DtEntityType& type);

    virtual void clearSupplies();


    virtual DtAdminContent* clone() const;


    virtual DtString stringRep() const;


    virtual int netRepSize() const;


    virtual bool setFromNet(const char* contentBuffer,

                            unsigned contentSize);


    virtual bool setToNet();


 protected:

    DtSupplyVector mySupplies;

 };

DtAdminContent::setFromNet
virtual bool setFromNet(const char *contentBuffer, unsigned contentSize)
Sets the contents of this set request based on the network buffer. Base class does nothing and return...

DtAdminContent::netRepSize
virtual int netRepSize() const

DtSupplyVector
std::vector< DtEntityType > DtSupplyVector
Definition: supplyListResponseAdmin.h:16

DtSupplyListResponseAdmin
Admin content which contains the list of supplies on an entity. This is the response to the DtSupplyL...
Definition: supplyListResponseAdmin.h:22

DtAdminContent::clone
virtual DtAdminContent * clone() const =0
Make a copy of this content. Returns a pointer to a newly created copy of this class. Derived classes must override this function to create and return an instance of the derived type.

DtVrfObjectMessageTypeTemplate
Definition: vrfObjectMessageTypeTemplate.h:24

DtAdminContent::operator=
const DtAdminContent & operator=(const DtAdminContent &orig)
assignment operator; same as copy costructor.

adminContent.h

DtSupplyListResponseAdmin::mySupplies
DtSupplyVector mySupplies
The list of supplies.
Definition: supplyListResponseAdmin.h:79

DT_DLL_vrftasks
#define DT_DLL_vrftasks
This file is used to determine how to build.
Definition: vrftasksDefines.h:26

DtAdminContent::init
virtual bool init()
Base class init does nothing, but this will be called by create, in case any other deriving class nee...

DtAdminContent
DtAdminContent.
Definition: adminContent.h:23

DtAdminContent::type
virtual const DtAdminContentMessageType & type() const =0

DtAdminContent::setToNet
virtual bool setToNet()
Sets netRep buffer to the contents of this set request. Base class does nothing and returns true...

DtAdminContent::stringRep
virtual DtString stringRep() const =0
Get a readable string representation of this content. Derived classes must implement this function...

DtString