VR-Forces Development_Version Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Attributes
DtIfFileOp Class Reference

DtIfFileOp is the base class of the content portion of file operation messages. More...

Inheritance diagram for DtIfFileOp:
Inheritance graph
[legend]

Public Member Functions

 DtIfFileOp ()
 default constructor
 DtIfFileOp (const DtIfFileOp &orig)
 copy constructor
const DtIfFileOpoperator= (const DtIfFileOp &orig)
 assignment operator
virtual ~DtIfFileOp ()
virtual int type () const =0
 Override this with the type of file message name the operation is for, so the right manager can register a callback on it; use const strings found in msgTypes.h.
virtual DtSimInterfaceContentclone () const =0
virtual const DtStringfileName () const
 Name of the file to operate on.
virtual void setFileName (const DtString &fileName)
virtual int fileOp () const
 The I/O type of the operation (DtReadFileOpType/DtWriteFileOpType).
virtual void setFileOp (int fileOp)
virtual int netRepSize () const
virtual bool setFromNet (const char *contentBuffer, unsigned contentSize)
virtual bool setToNet ()
virtual void printDataToString (DtString &str)
- Public Member Functions inherited from DtSimInterfaceContent
virtual ~DtSimInterfaceContent ()
virtual bool update (const DtSimInterfaceContent *data)
virtual charnetRep ()
virtual void printContentType (DtString &str)
virtual void setUseSessionId (bool yesNo)
virtual bool useSessionId () const

Protected Attributes

DtString myFileName
int myFileOp
- Protected Attributes inherited from DtSimInterfaceContent
charmyNetRep
bool myUseSessionId

Additional Inherited Members

- Static Public Member Functions inherited from DtSimInterfaceContent
static DtSimInterfaceContentcreateInterfaceContent (int type)
static void addInterfaceContentCreatorFcn (int type, DtInterfaceContentCreatorFcn fcn)
static void setFactory (DtInterfaceContentFactory *factory)
static DtInterfaceContentFactoryfactory ()
static void registerContentTypePrinter (DtSimInterfaceContentTypePrinterFcn printFcn)
- Protected Member Functions inherited from DtSimInterfaceContent
 DtSimInterfaceContent ()
 DtSimInterfaceContent (const DtSimInterfaceContent &orig)
const DtSimInterfaceContentoperator= (const DtSimInterfaceContent &orig)
virtual charcreateNetworkBuffer ()
- Static Protected Attributes inherited from DtSimInterfaceContent
static DtInterfaceContentFactorymyFactory
static
DtSimInterfaceContentTypePrinterFcn 
theContentTypePrinterFcn

Detailed Description

DtIfFileOp is the base class of the content portion of file operation messages.

Messages derived from this class are typically only sent from front-end to the back-end.

Content-Type: Not applicable.

Parameters: fileName - A DtString that is the filename associated with this opera- tion.

fileOp - A DtString that is the file I/O operation to perform, read (DtReadFileOpType) or write (DtWriteFileOpType).

Constructor & Destructor Documentation

DtIfFileOp::DtIfFileOp ( )

default constructor

DtIfFileOp::DtIfFileOp ( const DtIfFileOp orig)

copy constructor

virtual DtIfFileOp::~DtIfFileOp ( )
virtual

Member Function Documentation

const DtIfFileOp& DtIfFileOp::operator= ( const DtIfFileOp orig)

assignment operator

virtual int DtIfFileOp::type ( ) const
pure virtual

Override this with the type of file message name the operation is for, so the right manager can register a callback on it; use const strings found in msgTypes.h.

Currently, one of DtOverlayOpMessageName, DtPlanOpMessageName, or DtOrderOfBattleOpMessageName.

Implements DtSimInterfaceContent.

Implemented in DtIfObjectParametersOp, DtIfOrderOfBattleOp, DtIfPlanOp, and DtIfOverlayOp.

virtual DtSimInterfaceContent* DtIfFileOp::clone ( ) const
pure virtual
virtual const DtString& DtIfFileOp::fileName ( ) const
virtual

Name of the file to operate on.

virtual void DtIfFileOp::setFileName ( const DtString fileName)
virtual
virtual int DtIfFileOp::fileOp ( ) const
virtual

The I/O type of the operation (DtReadFileOpType/DtWriteFileOpType).

virtual void DtIfFileOp::setFileOp ( int  fileOp)
virtual
virtual int DtIfFileOp::netRepSize ( ) const
virtual

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfFileOp::setFromNet ( const char contentBuffer,
unsigned  contentSize 
)
virtual

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfFileOp::setToNet ( )
virtual

Reimplemented from DtSimInterfaceContent.

virtual void DtIfFileOp::printDataToString ( DtString str)
virtual

Reimplemented from DtSimInterfaceContent.

Member Data Documentation

DtString DtIfFileOp::myFileName
protected
int DtIfFileOp::myFileOp
protected

The documentation for this class was generated from the following file:

Document ID: Generated on Mon Jul 4 01:00:18 EDT 2016 from SVN revision 166489
Copyright © 2005-2015 VT MÄK. All Rights Reserved (www.mak.com)