MeVisLab Toolbox Reference
ml::omFlags Class Reference

Managed special flags of information address components. More...

#include <ObjMgr/mlObjMgrObject.h>

Public Types

enum  NetCommMode { NC_DEFAULT = 0 , NC_COMMUNICATE , NC_CONCEAL , NUM_NET_COMM_MODE_TYPES }
 Network communication modes. More...
 

Public Member Functions

 omFlags ()
 
void markPrivate (bool trueOrFalse)
 Content changes do not generate an event if an address component has been marked private. More...
 
void markPersistent (bool trueOrFalse)
 An information item is stored (saved) in a file if all address components have been marked persistent. More...
 
void setNetCommMode (NetCommMode netCommMode)
 Sets the network (TCP/IP) communication mode of the address component. More...
 
bool isPrivate () const
 Retrieve whether or not an address component has been marked private. More...
 
bool isPersistent () const
 Retrieve whether or not an address component has been marked persistent. More...
 
NetCommMode getNetCommMode () const
 Retrieve network communication mode of the address component. More...
 
bool isDefault () const
 Returns 'true' if none of the set/mark methods has been called. More...
 

Static Public Attributes

static const char * NetCommModeStrings [NUM_NET_COMM_MODE_TYPES]
 Define strings for all network communication modes. These can be used for enum fields. More...
 

Protected Attributes

bool _isDefault
 
bool _isPrivate
 
bool _isPersistent
 
NetCommMode _netCommMode
 

Detailed Description

Managed special flags of information address components.

Definition at line 27 of file mlObjMgrFlags.h.

Member Enumeration Documentation

◆ NetCommMode

Network communication modes.

Enumerator
NC_DEFAULT 
NC_COMMUNICATE 
NC_CONCEAL 
NUM_NET_COMM_MODE_TYPES 

Definition at line 32 of file mlObjMgrFlags.h.

Constructor & Destructor Documentation

◆ omFlags()

ml::omFlags::omFlags ( )
inline

Definition at line 52 of file mlObjMgrFlags.h.

Member Function Documentation

◆ getNetCommMode()

NetCommMode ml::omFlags::getNetCommMode ( ) const
inline

Retrieve network communication mode of the address component.

Definition at line 80 of file mlObjMgrFlags.h.

◆ isDefault()

bool ml::omFlags::isDefault ( ) const
inline

Returns 'true' if none of the set/mark methods has been called.

Definition at line 85 of file mlObjMgrFlags.h.

◆ isPersistent()

bool ml::omFlags::isPersistent ( ) const
inline

Retrieve whether or not an address component has been marked persistent.

Definition at line 76 of file mlObjMgrFlags.h.

◆ isPrivate()

bool ml::omFlags::isPrivate ( ) const
inline

Retrieve whether or not an address component has been marked private.

Definition at line 72 of file mlObjMgrFlags.h.

◆ markPersistent()

void ml::omFlags::markPersistent ( bool  trueOrFalse)
inline

An information item is stored (saved) in a file if all address components have been marked persistent.

Definition at line 61 of file mlObjMgrFlags.h.

◆ markPrivate()

void ml::omFlags::markPrivate ( bool  trueOrFalse)
inline

Content changes do not generate an event if an address component has been marked private.

Definition at line 56 of file mlObjMgrFlags.h.

◆ setNetCommMode()

void ml::omFlags::setNetCommMode ( NetCommMode  netCommMode)
inline

Sets the network (TCP/IP) communication mode of the address component.

Definition at line 66 of file mlObjMgrFlags.h.

Member Data Documentation

◆ _isDefault

bool ml::omFlags::_isDefault
protected

Definition at line 44 of file mlObjMgrFlags.h.

◆ _isPersistent

bool ml::omFlags::_isPersistent
protected

Definition at line 47 of file mlObjMgrFlags.h.

◆ _isPrivate

bool ml::omFlags::_isPrivate
protected

Definition at line 46 of file mlObjMgrFlags.h.

◆ _netCommMode

NetCommMode ml::omFlags::_netCommMode
protected

Definition at line 48 of file mlObjMgrFlags.h.

◆ NetCommModeStrings

const char* ml::omFlags::NetCommModeStrings[NUM_NET_COMM_MODE_TYPES]
static

Define strings for all network communication modes. These can be used for enum fields.

Definition at line 40 of file mlObjMgrFlags.h.


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