FARGOS/VISTA Object Management Environment Core  ..
FARGOS/VISTA Object Management Environment Core Table of Contents
OMEprofileString< MAXLEN > Class Template Reference

Base type for system information represented as strings. More...

#include <OMEdebugInfo.h>

+ Inheritance diagram for OMEprofileString< MAXLEN >:

Public Member Functions

 OMEprofileString (const char *varName, const char *initVal, SharedMemoryVariableManager *mgr=&DEFAULT_sharedMemoryVariableManager)
 Initialize a profiling string, possibly with an initial value. More...
 
 OMEprofileString (const char *varName, SharedMemoryVariableNode *parentNode, const char *initVal=nullptr)
 Initialize a string with a constant value. More...
 
virtual ~OMEprofileString ()
 
virtual const char * getName (uint_fast32_t *retNameLen=nullptr) const override
 
virtual const OMEtype getValue () const override
 
OMEprofileString< MAXLEN > & operator= (const char *v)
 
virtual void setValue (const OMEtype &newV) override
 
- Public Member Functions inherited from OMEprofileRecord
 OMEprofileRecord ()
 
virtual ~OMEprofileRecord ()
 
- Public Member Functions inherited from SMV_StandaloneString< MAXLEN >
 SMV_StandaloneString (const char *varName, SharedMemoryVariableManager *mgr=&DEFAULT_sharedMemoryVariableManager)
 
 SMV_StandaloneString (const char *varName, SharedMemoryVariableNode *parentNode)
 
 operator const char * () const OME_ALWAYS_INLINE
 Cast operator for a shared memory string variable. More...
 
char * operator= (const char *val) OME_ALWAYS_INLINE
 Assignment operator into a shared memory string variable. More...
 
virtual void noteNowRegistered (SharedMemoryVariable_Record *newArea) override
 Extension mechanism to allow derived classes to be informed when they are about to be assigned storage; called at most once per lifetime of object. More...
 
- Public Member Functions inherited from SharedMemoryVariable
SharedMemoryVariableNodegetParentNode () const
 
SharedMemoryVariableManagergetVariableManager () const
 
unsigned int getType () const OME_ALWAYS_INLINE
 Return type of variable, see SharedMemoryVariableType. More...
 
unsigned int getMinLength () const OME_ALWAYS_INLINE
 Return minimum number of bytes required for variable record. More...
 
const char * getName (uint_fast32_t *retNameLen=nullptr) const OME_ALWAYS_INLINE
 Get variable name. More...
 
int setName (const char *newName)
 Set new variable name. More...
 
uint_fast32_t getFullName (char *bfr, uint_fast32_t bfrLen) const
 Get full path name of variable. More...
 
 SharedMemoryVariable (class SharedMemoryVariableManager *mgr, const char *varName, int varType, size_t length)
 Construct an shared memory variable and attach to the indicated manager for the collection of variables. More...
 
 SharedMemoryVariable (class SharedMemoryVariableNode *parentNode, const char *varName, int varType, size_t length)
 
virtual ~SharedMemoryVariable ()
 
void makeAliasFor (SharedMemoryVariable *v)
 

Additional Inherited Members

- Public Types inherited from SharedMemoryVariable
enum  SharedMemoryVariableType {
  SMV_TYPE_NONE =0, SMV_TYPE_UNSIGNED =1, SMV_TYPE_LARGE =2, SMV_TYPE_INT32 =4,
  SMV_TYPE_UINT32 =SMV_TYPE_INT32|SMV_TYPE_UNSIGNED, SMV_TYPE_INT64 =SMV_TYPE_INT32|SMV_TYPE_LARGE, SMV_TYPE_UINT64 =SMV_TYPE_INT64|SMV_TYPE_UNSIGNED, SMV_TYPE_FLOAT =8,
  SMV_TYPE_DOUBLE =SMV_TYPE_FLOAT|SMV_TYPE_LARGE, SMV_TYPE_FIXED =SMV_TYPE_FLOAT|SMV_TYPE_UNSIGNED, SMV_TYPE_TINY_STRING =16, SMV_TYPE_TINY_BINARY_STRING =SMV_TYPE_TINY_STRING|SMV_TYPE_UNSIGNED,
  SMV_TYPE_STRING =SMV_TYPE_TINY_STRING|SMV_TYPE_LARGE, SMV_TYPE_BINARY_STRING =SMV_TYPE_STRING|SMV_TYPE_UNSIGNED, SMV_TYPE_NAME_NODE =32
}
 
enum  { SMV_DISPLAY_NAME =1, SMV_DISPLAY_VALUE =2, SMV_DISPLAY_TYPE =4, SMV_DISPLAY_EQUALS =8 }
 
- Static Public Member Functions inherited from OMEprofileRecord
static OMEarraylistDefinedCounters ()
 Get a list of all available information variables. More...
 
static OMEassocgetCounters ()
 Get a snapshot of all counters. More...
 
static const OMEtype getValueOfCounter (const char *name) NONNULL_PARAMETERS(1)
 Return the value of an named variable. More...
 
template<typename STREAMTYPE >
static STREAMTYPE & outputCounters (STREAMTYPE &o)
 Write a counter's value to an output stream. More...
 
- Static Public Member Functions inherited from SharedMemoryVariable
static const char * typeName (unsigned int t) OME_CONST_FUNCTION
 Return type as text string. More...
 
- Static Protected Member Functions inherited from OMEprofileRecord
static void addToList (OMEprofileRecord *rec)
 
static void removeFromList (OMEprofileRecord *recToRemove)
 
- Protected Attributes inherited from OMEprofileRecord
OMEprofileRecordnext
 
- Protected Attributes inherited from SMV_StandaloneString< MAXLEN >
union {
   SharedMemoryVariable::SharedMemoryVariable_Record   initialCopy
 
   char   reservedSpace [MAXLEN+sizeof(SharedMemoryVariable::SharedMemoryVariable_Record)]
 
space
 
- Protected Attributes inherited from SharedMemoryVariable
SharedMemoryVariable_RecorddataPointer
 
class SharedMemoryVariableNodeparentNodeRecord
 
class SharedMemoryVariableManagervariableManager
 
const char * variableName
 
uint32_t minLength
 
unsigned char dataType
 
unsigned char registered
 
unsigned char _pad1 [2]
 
- Static Protected Attributes inherited from OMEprofileRecord
static OMEprofileRecordstartOfList
 
- Static Protected Attributes inherited from SharedMemoryVariable
static SharedMemoryVariable_Record unallocated_data
 

Detailed Description

template<size_t MAXLEN>
class OMEprofileString< MAXLEN >

Base type for system information represented as strings.

Constructor & Destructor Documentation

◆ OMEprofileString() [1/2]

template<size_t MAXLEN>
OMEprofileString< MAXLEN >::OMEprofileString ( const char *  varName,
const char *  initVal,
SharedMemoryVariableManager mgr = &DEFAULT_sharedMemoryVariableManager 
)
inlineexplicit

Initialize a profiling string, possibly with an initial value.

Parameters
varNameis a pointer to a null-terminated C string that identifies the name of the variable.
initValprovides the initial value of the variable.
mgrpoints to the manager of the shared memory segment used to export the variable.

◆ OMEprofileString() [2/2]

template<size_t MAXLEN>
OMEprofileString< MAXLEN >::OMEprofileString ( const char *  varName,
SharedMemoryVariableNode parentNode,
const char *  initVal = nullptr 
)
inlineexplicit

Initialize a string with a constant value.

Parameters
varNameis a pointer to a null-terminated C string that identifies the name of the variable.
parentNodepoints to the parent node used to name the variable.
initValprovides the initial value of the variable.

◆ ~OMEprofileString()

template<size_t MAXLEN>
virtual OMEprofileString< MAXLEN >::~OMEprofileString ( )
inlinevirtual

Member Function Documentation

◆ getName()

template<size_t MAXLEN>
virtual const char* OMEprofileString< MAXLEN >::getName ( uint_fast32_t *  retNameLen = nullptr) const
inlineoverridevirtual

Implements OMEprofileRecord.

◆ getValue()

template<size_t MAXLEN>
virtual const OMEtype OMEprofileString< MAXLEN >::getValue ( ) const
inlineoverridevirtual

Implements OMEprofileRecord.

◆ operator=()

template<size_t MAXLEN>
OMEprofileString<MAXLEN>& OMEprofileString< MAXLEN >::operator= ( const char *  v)
inline

◆ setValue()

template<size_t MAXLEN>
virtual void OMEprofileString< MAXLEN >::setValue ( const OMEtype newV)
inlineoverridevirtual

Implements OMEprofileRecord.


The documentation for this class was generated from the following file:
Generated: Fri Jul 31 2020 18:19:16
Support Information