vrforces5.1.1/classref/if_admin_sync_matrix_set_plan_request_8h_source.html

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

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

 ** All rights reserved.

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


 #pragma once


 #include "vrfmsgs/vrfmsgsDefines.h"


 #include <vrftasks/adminContent.h>


 class DtIfSyncMatrixPlan;


 class DT_DLL_vrfmsgs DtIfAdminSyncMatrixSetPlanRequest : public DtAdminContent

 {


 public:

    DtIfAdminSyncMatrixSetPlanRequest();


    DtIfAdminSyncMatrixSetPlanRequest(const DtIfAdminSyncMatrixSetPlanRequest & orig);


    const DtIfAdminSyncMatrixSetPlanRequest & operator=(const DtIfAdminSyncMatrixSetPlanRequest & orig);


    virtual ~DtIfAdminSyncMatrixSetPlanRequest();


    virtual const DtAdminContentMessageType& type() const;


    virtual DtAdminContent* clone() const;


    virtual const DtIfSyncMatrixPlan* plan() const;

    virtual void setPlan(const DtIfSyncMatrixPlan* plan);


    virtual int netRepSize() const;

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

    virtual bool setToNet();

    virtual DtString stringRep() const;


    static DtAdminContent* create();


 protected:

    DtIfSyncMatrixPlan* myPlan;

 };


 namespace DtBufferSerialize

 {

    DT_DLL_vrfmsgs int getSize(const DtIfSyncMatrixPlan* const&  messagePtr);

    DT_DLL_vrfmsgs char *encode(const DtIfSyncMatrixPlan* const& messagePtr, char *buffer);

    DT_DLL_vrfmsgs const char *decode(DtIfSyncMatrixPlan*& messagePtr, const char *buffer);

 }

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...

DtBufferSerialize::getSize
DT_DLL_readerWriter int getSize(const DtString &val)
The number of bytes required to encode the value.

DtAdminContent::netRepSize
virtual int netRepSize() const

DT_DLL_vrfmsgs
#define DT_DLL_vrfmsgs
This file is used to determine how to build.
Definition: vrfmsgsDefines.h:28

vrfmsgsDefines.h

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

DtIfAdminSyncMatrixSetPlanRequest
Admin content to request setting a plan to an object in a synchronization matrix phase. A DtIfSyncMatrixPlansStatus message is typically sent in response to this request.
Definition: ifAdminSyncMatrixSetPlanRequest.h:21

DtIfSyncMatrixPlan
class DtIfSyncMatrixPlan:
Definition: ifSyncMatrixPlan.h:27

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

adminContent.h

DtIfAdminSyncMatrixSetPlanRequest::myPlan
DtIfSyncMatrixPlan * myPlan
Definition: ifAdminSyncMatrixSetPlanRequest.h:54

DtBufferSerialize::encode
DT_DLL_readerWriter char * encode(const DtFilename &val, char *buffer)
Serializes the provided value val into buffer. buffer must have at least the number of bytes returned...

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...

DtBufferSerialize::decode
DT_DLL_readerWriter const char * decode(DtString &val, const char *buffer)
Decodes a value from buffer and places the result in val of the type specified by val...

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

DtString