VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Attributes
DtIfFileOp Class Referenceabstract

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

Inheritance diagram for DtIfFileOp:
Inheritance graph
[legend]

Public Member Functions

 DtIfFileOp ()
 
 DtIfFileOp (const DtIfFileOp &orig)
 
const DtIfFileOpoperator= (const DtIfFileOp &orig)
 
virtual ~DtIfFileOp () override
 
virtual int type () const override=0
 
virtual DtSimInterfaceContentclone () const override=0
 
virtual const DtStringfileName () const
 
virtual void setFileName (const DtString &fileName)
 
virtual int fileOp () const
 
virtual void setFileOp (int fileOp)
 
virtual int netRepSize () const override
 
virtual bool setFromNet (const char *contentBuffer, unsigned contentSize) override
 
virtual bool setToNet () override
 
virtual void printDataToString (DtString &str) override
 
- 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
 

Constructor & Destructor Documentation

DtIfFileOp::DtIfFileOp ( )

default constructor

DtIfFileOp::DtIfFileOp ( const DtIfFileOp orig)

copy constructor

virtual DtIfFileOp::~DtIfFileOp ( )
overridevirtual

Member Function Documentation

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

assignment operator

virtual int DtIfFileOp::type ( ) const
overridepure virtual

Override this with the type of file message the operation is for, so the right manager can register a callback on it; use const ints found in messageTypes.h. Currently, one of DtOverlayOpMessageType, DtPlanOpMessageType, or DtOrderOfBattleOpMessageType.

Implements DtSimInterfaceContent.

Implemented in DtIfObjectParametersOp, DtIfOrderOfBattleOp, and DtIfPlanOp.

virtual DtSimInterfaceContent* DtIfFileOp::clone ( ) const
overridepure 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
overridevirtual

Reimplemented from DtSimInterfaceContent.

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

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfFileOp::setToNet ( )
overridevirtual

Reimplemented from DtSimInterfaceContent.

virtual void DtIfFileOp::printDataToString ( DtString str)
overridevirtual

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 Thu Oct 23 22:29:17 EDT 2025 from SVN revision 280951
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)