MAK Data Logger API Documentation for DIS
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes
MAKLogger::DtDisDescriptor Class Reference

Instances of DtDisDescriptor provide mappings between Pdu descriptors and PduKind enumerators in DIS. More...

+ Collaboration diagram for MAKLogger::DtDisDescriptor:

Public Types

typedef DtU32 PduKind
typedef DtMultiKeyMap< PduKind,
DtString, DtPduDescriptor * > 
PduDescriptorMap
typedef PduDescriptorMap::iterator iterator
typedef
PduDescriptorMap::const_iterator 
const_iterator

Public Member Functions

virtual ~DtDisDescriptor ()
 Default constructor, call via create.
void addPduDesc (const DtPduDescriptor &desc)
 Add a copy of an existing pdu descriptor, the kind must be unique.
virtual DtPduDescriptoraddPduKind (const DtString &name, PduKind kind, int enIdOff, int typeOff)
 Define (add to the current DIS description) a new Pdu kind.
virtual int setFromSerialForm (const void *p)
 Initialize by reading the DIS description from a "serialized-form" buffer.
virtual char * serialize (int *pSize=0) const
 Obtain a copy of the current DIS description in serialized form.
int count () const
 Get the total number of Pdu kinds in the DIS description.
virtual bool equivalent (const DtDisDescriptor &rhs) const
 Returns true if the DIS description 'other' is equivalent to this one.
virtual void setFilterByPduKind (const DtPduSubsMap *map)
 Set the current "Filter-By-PduKind" Map.
virtual void setFilterAllPduKinds ()
virtual void setFilterNoPduKinds ()
virtual void clear ()
 Clear all pdus (deallocates memory for DtPduDescriptions).
void registerAlias (const DtString &alias, PduKind kind)
 Register an alias string (stored as a lower case string) with a given pdu kind.
void unregisterAlias (const DtString &alias)
 Unregister an alias string (stored as a lower case string).
virtual DtPduDescriptorpduDesc (PduKind kind)
 Return the Pdu Kind descriptor for the Pdu corresponding to PduKind 'pk'.
virtual const DtPduDescriptorpduDesc (PduKind kind) const
 Return the Pdu Kind descriptor for the Pdu corresponding to PduKind 'pk'.
virtual DtPduDescriptorpduDesc (const DtString &name)
 Return the Pdu Kind descriptor for a Pdu kind name.
virtual const DtPduDescriptorpduDesc (const DtString &name) const
 Return the Pdu Kind descriptor for a Pdu kind name.
iterator begin ()
 Get pdu descriptor iterators at beginning.
const_iterator begin () const
 Get pdu descriptor iterators at beginning.
iterator end ()
 Get pdu descriptor iterators at end.
const_iterator end () const
 Get pdu descriptor iterators at end.

Static Public Member Functions

static void addKnownPdus (DtDisDescriptor *dsc)

Protected Types

typedef std::map< DtString,
PduKind
AliasMap

Protected Member Functions

virtual int unserialize (const char *bfr)
 Internal implementation of unserialize.
virtual void initFromSource (const DtDisDescriptor &src)
 Internal implementation of copy source.

Protected Attributes

PduDescriptorMap myPdus
AliasMap myAliases

Detailed Description

Instances of DtDisDescriptor provide mappings between Pdu descriptors and PduKind enumerators in DIS.

Member Typedef Documentation

typedef std::map<DtString,PduKind> MAKLogger::DtDisDescriptor::AliasMap
protected

Constructor & Destructor Documentation

virtual MAKLogger::DtDisDescriptor::~DtDisDescriptor ( )
virtual

Default constructor, call via create.

Copy constructor and assignment operator. (both must still be defined) Destructor

Member Function Documentation

static void MAKLogger::DtDisDescriptor::addKnownPdus ( DtDisDescriptor dsc)
static
void MAKLogger::DtDisDescriptor::addPduDesc ( const DtPduDescriptor desc)

Add a copy of an existing pdu descriptor, the kind must be unique.

virtual DtPduDescriptor* MAKLogger::DtDisDescriptor::addPduKind ( const DtString &  name,
PduKind  kind,
int  enIdOff,
int  typeOff 
)
virtual

Define (add to the current DIS description) a new Pdu kind.

iterator MAKLogger::DtDisDescriptor::begin ( )

Get pdu descriptor iterators at beginning.

To be used in for(iterator i = begin();i != end();++i) to access DtPduDescriptor via i->second.

const_iterator MAKLogger::DtDisDescriptor::begin ( ) const

Get pdu descriptor iterators at beginning.

To be used in for(iterator i = begin();i != end();++i) to access DtPduDescriptor via i->second.

virtual void MAKLogger::DtDisDescriptor::clear ( )
virtual

Clear all pdus (deallocates memory for DtPduDescriptions).

int MAKLogger::DtDisDescriptor::count ( ) const

Get the total number of Pdu kinds in the DIS description.

iterator MAKLogger::DtDisDescriptor::end ( )

Get pdu descriptor iterators at end.

To be used in for(iterator i = begin();i != end();++i) to access DtPduDescriptor via i->second.

const_iterator MAKLogger::DtDisDescriptor::end ( ) const

Get pdu descriptor iterators at end.

To be used in for(iterator i = begin();i != end();++i) to access DtPduDescriptor via i->second.

virtual bool MAKLogger::DtDisDescriptor::equivalent ( const DtDisDescriptor rhs) const
virtual

Returns true if the DIS description 'other' is equivalent to this one.

virtual void MAKLogger::DtDisDescriptor::initFromSource ( const DtDisDescriptor src)
protectedvirtual

Internal implementation of copy source.

virtual DtPduDescriptor* MAKLogger::DtDisDescriptor::pduDesc ( PduKind  kind)
virtual

Return the Pdu Kind descriptor for the Pdu corresponding to PduKind 'pk'.

virtual const DtPduDescriptor* MAKLogger::DtDisDescriptor::pduDesc ( PduKind  kind) const
virtual

Return the Pdu Kind descriptor for the Pdu corresponding to PduKind 'pk'.

virtual DtPduDescriptor* MAKLogger::DtDisDescriptor::pduDesc ( const DtString &  name)
virtual

Return the Pdu Kind descriptor for a Pdu kind name.

The name is converted to lowercase and looked up against the list of aliases. If a pdu kind is not found, the actual name is looked up against all pdukinds added.

virtual const DtPduDescriptor* MAKLogger::DtDisDescriptor::pduDesc ( const DtString &  name) const
virtual

Return the Pdu Kind descriptor for a Pdu kind name.

The name is converted to lowercase and looked up against the list of aliases. If a pdu kind is not found, the actual name is looked up against all pdukinds added.

void MAKLogger::DtDisDescriptor::registerAlias ( const DtString &  alias,
PduKind  kind 
)

Register an alias string (stored as a lower case string) with a given pdu kind.

virtual char* MAKLogger::DtDisDescriptor::serialize ( int *  pSize = 0) const
virtual

Obtain a copy of the current DIS description in serialized form.

virtual void MAKLogger::DtDisDescriptor::setFilterAllPduKinds ( )
virtual
virtual void MAKLogger::DtDisDescriptor::setFilterByPduKind ( const DtPduSubsMap map)
virtual

Set the current "Filter-By-PduKind" Map.

virtual void MAKLogger::DtDisDescriptor::setFilterNoPduKinds ( )
virtual
virtual int MAKLogger::DtDisDescriptor::setFromSerialForm ( const void *  p)
virtual

Initialize by reading the DIS description from a "serialized-form" buffer.

void MAKLogger::DtDisDescriptor::unregisterAlias ( const DtString &  alias)

Unregister an alias string (stored as a lower case string).

virtual int MAKLogger::DtDisDescriptor::unserialize ( const char *  bfr)
protectedvirtual

Internal implementation of unserialize.

Returns
The number of bytes read.

Member Data Documentation

AliasMap MAKLogger::DtDisDescriptor::myAliases
protected
PduDescriptorMap MAKLogger::DtDisDescriptor::myPdus
protected

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

Document ID: Generated on Tue Aug 1 09:00:26 EDT 2017 from SVN revision 179128
Copyright © 2017 VT MÄK. All Rights Reserved (www.mak.com)