Nymph  v1.5.2
Flow-Based Data Processing Framework
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
KTExtensibleStructCore< XBaseType > Struct Template Referenceabstract

#include <KTExtensibleStruct.hh>

Inheritance diagram for KTExtensibleStructCore< XBaseType >:
Inheritance graph

Public Member Functions

 KTExtensibleStructCore (void)
 Default constructor. More...
 
 KTExtensibleStructCore (const KTExtensibleStructCore &)
 Copy constructor; duplicates the extended object. More...
 
virtual ~KTExtensibleStructCore ()
 
KTExtensibleStructCoreoperator= (const KTExtensibleStructCore &)
 Duplicates the extended object. More...
 
virtual void Clear (void)
 Removes extended fields. More...
 
template<class XStructType >
XStructType & Of (void)
 Returns a reference to the object of type XStructType; creates that object if it doesn't exist. More...
 
template<class XStructType >
const XStructType & Of (void) const
 Returns a const reference to the object of type XStructType; creates that object if it doesn't exist. More...
 
template<class XStructType >
bool Has (void) const
 Returns true if XStructType is or is below this object. More...
 
template<class XStructType >
XStructType * Detatch (void)
 Extracts object of type XStructType. More...
 
virtual KTExtensibleStructCoreClone (void) const =0
 Duplicates the extended object. More...
 
virtual void Pull (const KTExtensibleStructCore< XBaseType > &object)=0
 Duplicates object only. More...
 
KTExtensibleStructCoreNext () const
 Returns the pointer to the next field. More...
 
KTExtensibleStructCorePrev () const
 Returns the pointer to the previous field. More...
 
KTExtensibleStructCoreLast () const
 Returns the pointer to the last field. More...
 
KTExtensibleStructCoreFirst () const
 Returns the pointer to the first field. More...
 

Protected Member Functions

void SetPrevPtrInNext ()
 

Protected Attributes

KTExtensibleStructCorefNext
 
KTExtensibleStructCorefPrev
 

Detailed Description

template<class XBaseType>
struct Nymph::KTExtensibleStructCore< XBaseType >

Definition at line 22 of file KTExtensibleStruct.hh.

Constructor & Destructor Documentation

◆ KTExtensibleStructCore() [1/2]

Default constructor.

Definition at line 85 of file KTExtensibleStruct.hh.

◆ KTExtensibleStructCore() [2/2]

KTExtensibleStructCore ( const KTExtensibleStructCore< XBaseType > &  )

Copy constructor; duplicates the extended object.

Definition at line 92 of file KTExtensibleStruct.hh.

◆ ~KTExtensibleStructCore()

~KTExtensibleStructCore ( )
virtual

Definition at line 99 of file KTExtensibleStruct.hh.

Member Function Documentation

◆ Clear()

void Clear ( void  )
virtual

Removes extended fields.

Definition at line 113 of file KTExtensibleStruct.hh.

◆ Clone()

virtual KTExtensibleStructCore* Clone ( void  ) const
pure virtual

◆ Detatch()

XStructType * Detatch ( void  )
inline

Extracts object of type XStructType.

Definition at line 179 of file KTExtensibleStruct.hh.

◆ First()

KTExtensibleStructCore< XBaseType > * First ( ) const
inline

Returns the pointer to the first field.

Definition at line 221 of file KTExtensibleStruct.hh.

◆ Has()

bool Has ( void  ) const
inline

Returns true if XStructType is or is below this object.

Definition at line 161 of file KTExtensibleStruct.hh.

◆ Last()

KTExtensibleStructCore< XBaseType > * Last ( ) const
inline

Returns the pointer to the last field.

Definition at line 214 of file KTExtensibleStruct.hh.

◆ Next()

KTExtensibleStructCore< XBaseType > * Next ( ) const
inline

Returns the pointer to the next field.

Definition at line 202 of file KTExtensibleStruct.hh.

◆ Of() [1/2]

XStructType & Of ( void  )
inline

Returns a reference to the object of type XStructType; creates that object if it doesn't exist.

Definition at line 121 of file KTExtensibleStruct.hh.

◆ Of() [2/2]

const XStructType & Of ( void  ) const
inline

Returns a const reference to the object of type XStructType; creates that object if it doesn't exist.

Definition at line 140 of file KTExtensibleStruct.hh.

◆ operator=()

KTExtensibleStructCore< XBaseType > & operator= ( const KTExtensibleStructCore< XBaseType > &  )

Duplicates the extended object.

Definition at line 106 of file KTExtensibleStruct.hh.

◆ Prev()

KTExtensibleStructCore< XBaseType > * Prev ( ) const
inline

Returns the pointer to the previous field.

Definition at line 208 of file KTExtensibleStruct.hh.

◆ Pull()

virtual void Pull ( const KTExtensibleStructCore< XBaseType > &  object)
pure virtual

◆ SetPrevPtrInNext()

void SetPrevPtrInNext ( )
inlineprotected

Definition at line 228 of file KTExtensibleStruct.hh.

Member Data Documentation

◆ fNext

KTExtensibleStructCore* fNext
mutableprotected

Definition at line 56 of file KTExtensibleStruct.hh.

◆ fPrev

KTExtensibleStructCore* fPrev
mutableprotected

Definition at line 57 of file KTExtensibleStruct.hh.


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