ioEffectRecord.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 2013 VT MAK
** All rights reserved.
*********************************************************************/

#pragma once


#include <vl/standardVariableRecord.h>
#include <vl/packets/ioEffectRecordP.h>
#include <vlpi/disEnums.h>
#include "vlutil/vlMachineTypes.h"


class DT_DLL_VL DtIoEffectRecord : public DtStandardVariableRecord
{
public:
   DtIoEffectRecord();

   DtIoEffectRecord(DtIOStatus status, DtIOLinkType linkType, DtIOEffect effect, unsigned int effectDutyCycle,
      unsigned int effectDuration, DtIOProcess process);

   DtIoEffectRecord(const DtIoEffectRecord& orig);

   DtIoEffectRecord(const DtNetIoEffectRecord& orig);

   DtIoEffectRecord(void* ptr, unsigned int length);

   virtual DtIoEffectRecord& operator=(const DtIoEffectRecord& other);

   virtual DtStandardVariableRecord& operator=( const DtStandardVariableRecord& record);

   virtual bool operator==(const DtIoEffectRecord& other);

   virtual bool operator==(const DtStandardVariableRecord& other);

   virtual unsigned int recordType() const;
   virtual void setRecordType( unsigned int recordType );

   virtual unsigned int recordLength() const;
   virtual void setRecordLength( unsigned int recordLength );

   virtual DtIOStatus ioStatus() const;
   virtual void setIoStatus( DtIOStatus ioStatus );

   virtual DtIOLinkType ioLinkType() const;
   virtual void setIoLinkType( DtIOLinkType ioLinkType );

   virtual DtIOEffect ioEffect() const;
   virtual void setIoEffect( DtIOEffect ioEffect );

   virtual unsigned int ioEffectDutyCycle() const;
   virtual void setIoEffectDutyCycle( unsigned int ioEffectDutyCycle );

   virtual unsigned int ioEffectDuration() const;
   virtual void setIoEffectDuration( unsigned int ioEffectDuration );

   virtual DtIOProcess ioProcess() const;
   virtual void setIoProcess( DtIOProcess ioProcess );

   virtual void printDataToStream(std::ostream& stream) const;

   virtual void writeRecord(void * addr) const;

   virtual void setFromNet( const void* netRecord, unsigned int length, DtStandardVariableRetCode* retCode = NULL);

   static DtStandardVariableRecord* create(void* addr, unsigned int length);

   virtual unsigned int unpaddedNetsize() const;

   virtual unsigned int netSize() const;

   virtual DtStandardVariableRecord* clone() const;

protected:

   DtNetIoEffectRecord myIoEffectRecord;
};