vrforces5.1.1/classref/available_formations_admin_8h_source.html

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

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

 ** All rights reserved.

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


 #pragma once


 #include "vrftasks/adminContent.h"

 #include <list>


 class DT_DLL_vrftasks DtAvailableFormationsAdmin : public DtAdminContent

 {

 public:


    DtAvailableFormationsAdmin();


    DtAvailableFormationsAdmin(const DtAvailableFormationsAdmin & orig);


    const DtAvailableFormationsAdmin & operator=(const

       DtAvailableFormationsAdmin & orig);


    virtual ~DtAvailableFormationsAdmin();


    static DtAdminContent* create();


    virtual bool init();


    virtual const DtAdminContentMessageType& type() const;


    virtual const std::list<DtString>& formationList() const;

    virtual std::list<DtString>& formationList();


    virtual void addFormation(const DtString& formationName);

    virtual void clearFormationList();


    virtual DtString currentFormation() const;

    virtual void setCurrentFormation(const DtString& formationName);


    virtual DtAdminContent * clone() const;


    virtual DtString stringRep() const;


    virtual int netRepSize() const;


    virtual bool setFromNet(const char* contentBuffer,

       unsigned contentSize);


    virtual bool setToNet();


 protected:

    std::list<DtString> myFormationList;

    DtString myCurrentFormation;

 };


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

DtAvailableFormationsAdmin::myCurrentFormation
DtString myCurrentFormation
Definition: availableFormationsAdmin.h:84

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.

DtAvailableFormationsAdmin
Admin content which contains the list of formation names that a particular aggregate entity has avail...
Definition: availableFormationsAdmin.h:21

DtVrfObjectMessageTypeTemplate
Definition: vrfObjectMessageTypeTemplate.h:24

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

DtAvailableFormationsAdmin::myFormationList
std::list< DtString > myFormationList
The list of available formation names.
Definition: availableFormationsAdmin.h:83

adminContent.h

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