VR-Link API Documentation for DIS
List of all members | Public Member Functions | Protected Types | Protected Attributes
DtPduEncoderFactory Class Reference

Instances of DtPduEncoderFactory are used to create Encoders which know how to decode an DIS message (or network representation) into a repository (or host representation). More...

+ Collaboration diagram for DtPduEncoderFactory:

Public Member Functions

 DtPduEncoderFactory ()
 constructor
virtual ~DtPduEncoderFactory ()
 destructor
 DtPduEncoderFactory (const DtPduEncoderFactory &orig)
 copy constructor Copies across added Encoder creation functions.
DtPduEncoderFactoryoperator= (const DtPduEncoderFactory &orig)
 assignment operator Copies across added Encoder creation functions.
virtual DtPduEncodercreateEncoder (DtPduKind hand)
 Create a Encoder for the specified interaction class.
virtual DtPduEncoderaddEncoder (DtPduKind hand, DtPduEncoder *encoder)
 Add a Encoder prototype to the factory.
virtual void addDefaultEncoders (DtExerciseConn *exConn, int disVersion)
 Add all encoders for your specific version of DIS.
virtual DtPduEncoderencoder (DtPduKind hand)
 Returns the Encoder prototype associated with handle by a previous call to addEncoder.

Protected Types

typedef std::map< DtPduKind,
DtPduEncoder * > 
PduHandleToEncoderMap
 A list that maps class handles (DtIntHashKeys) to DtInteractionEncoder pointers.

Protected Attributes

PduHandleToEncoderMap myProtos

Detailed Description

Instances of DtPduEncoderFactory are used to create Encoders which know how to decode an DIS message (or network representation) into a repository (or host representation).

Member Typedef Documentation

A list that maps class handles (DtIntHashKeys) to DtInteractionEncoder pointers.

Constructor & Destructor Documentation

DtPduEncoderFactory::DtPduEncoderFactory ( )

constructor

virtual DtPduEncoderFactory::~DtPduEncoderFactory ( )
virtual

destructor

DtPduEncoderFactory::DtPduEncoderFactory ( const DtPduEncoderFactory orig)

copy constructor Copies across added Encoder creation functions.

Member Function Documentation

virtual void DtPduEncoderFactory::addDefaultEncoders ( DtExerciseConn exConn,
int  disVersion 
)
virtual

Add all encoders for your specific version of DIS.

virtual DtPduEncoder* DtPduEncoderFactory::addEncoder ( DtPduKind  hand,
DtPduEncoder encoder 
)
virtual

Add a Encoder prototype to the factory.

The Encoder prototype will be cloned by createEncoder when called for the appropriate handle. Caller deletes the Encoder, but AFTER the Encoder factory no longer needs it. Returns any previous Encoder which was replaced by the add.

virtual DtPduEncoder* DtPduEncoderFactory::createEncoder ( DtPduKind  hand)
virtual

Create a Encoder for the specified interaction class.

Note: Caller is responsible for deleting. Returns NULL if Encoder creation function is not in the factory.

virtual DtPduEncoder* DtPduEncoderFactory::encoder ( DtPduKind  hand)
virtual

Returns the Encoder prototype associated with handle by a previous call to addEncoder.

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

assignment operator Copies across added Encoder creation functions.

Member Data Documentation

PduHandleToEncoderMap DtPduEncoderFactory::myProtos
protected

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

Document ID: Generated on Wed Oct 23 22:25:48 EDT 2013 from SVN revision 132765
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)