GRE_SYSTEM Class Reference

GRE "system" container object. More...

#include <gre/system.h>

Inheritance diagram for GRE_SYSTEM:

[legend]List of all members.

Public Types
enum	AUTOOPEN { AUTOOPEN_None, AUTOOPEN_Layout, AUTOOPEN_Group, AUTOOPEN_Layer }
Static Public Member Functions
AUTOOPEN	GetAutoOpenList (MDLGPARENT dlgparent, const SIMPLE_ARRAY< const char * > &cmdparms, RVC::OBJITEMLIST &ObjItemList)
GRE_GROUP *	GetFirstGroup ()
GRE_LAYOUT *	GetFirstLayout ()
GRE_VIEW *	GetFirstView ()
CRITICALSECTION &	GetGroupCriticalSection ()
GRE_GROUP *	GetLastGroup ()
GRE_LAYOUT *	GetLastLayout ()
CRITICALSECTION &	GetLayoutCriticalSection ()
GRE_SYSTEM &	GetRef ()
NAMEDREGION_LIST &	GetRegionList ()
bool	GetReturnSerialReadErr ()
void *	GetRgnMgrHandle ()
CRITICALSECTION &	GetViewCriticalSection ()
bool	HasDoneWarningGeoMixed ()
void	Init ()
void	InitMFC ()
void	InitX (int numworkpixels=0)
void	RegisterLayoutLayerTypes ()
void	SetDoneWarningGeoMixed (bool set=true)
void	SetFirstGroup (GRE_GROUP *group)
void	SetFirstLayout (GRE_LAYOUT *layout)
void	SetFirstView (GRE_VIEW *view)
void	SetLastGroup (GRE_GROUP *group)
void	SetLastLayout (GRE_LAYOUT *layout)
void	SetReturnSerialReadErr (bool set=true)
void	Stop ()
void	StopMFC ()
void	StopX ()

---

Detailed Description

GRE "system" container object.

A single instance of this object is automatically created by the GRE system. This object is used as an implied container for all other top-level GRE (usually GRE_VIEWABLE) objects. This provides a convenient place to attach callbacks where notification is desired for all layouts and top-level groups.

Definition at line 56 of file system.h.

---

Member Enumeration Documentation

enum GRE_SYSTEM::AUTOOPEN

Enumeration values: AUTOOPEN_None  AUTOOPEN_Layout  AUTOOPEN_Group  AUTOOPEN_Layer  Definition at line 59 of file system.h.

---

Member Function Documentation

AUTOOPEN GRE_SYSTEM::GetAutoOpenList (  MDLGPARENT  dlgparent, const SIMPLE_ARRAY< const char * > &  cmdparms, RVC::OBJITEMLIST &  ObjItemList )  [static]

Get list of objects to auto-open via command line. Returns: Type of auto-open to be performed. Parameters: dlgparent  Parent for dialog if need to prompt user for anything cmdparms  Command-line parameters ObjItemList  Object item list returned

GRE_GROUP* GRE_SYSTEM::GetFirstGroup (   )  [inline, static]

Get reference to the first 'standalone' group To access this data you should get a lock on the group critical section. Definition at line 76 of file system.h.

GRE_LAYOUT* GRE_SYSTEM::GetFirstLayout (   )  [inline, static]

Get first layout in GRE system. To access this data you should get a lock on the layout critical section Definition at line 81 of file system.h.

GRE_VIEW* GRE_SYSTEM::GetFirstView (   )  [inline, static]

Get first view in GRE system. To access this data you should get a lock on the layout critical section Definition at line 86 of file system.h.

CRITICALSECTION& GRE_SYSTEM::GetGroupCriticalSection (   )  [inline, static]

Get reference to the 'standalone' group list critical section. Definition at line 100 of file system.h.

GRE_GROUP* GRE_SYSTEM::GetLastGroup (   )  [inline, static]

Get reference to the last 'standalone' group To access this data you should get a lock on the group critical section. Definition at line 91 of file system.h.

GRE_LAYOUT* GRE_SYSTEM::GetLastLayout (   )  [inline, static]

Get last layout in GRE system. To access this data you should get a lock on the layout critical section Definition at line 96 of file system.h.

CRITICALSECTION& GRE_SYSTEM::GetLayoutCriticalSection (   )  [inline, static]

Get reference to the layout list critical section. Definition at line 104 of file system.h.

GRE_SYSTEM& GRE_SYSTEM::GetRef (   )  [static]

Get reference to the single GRE_SYSTEM instance.

NAMEDREGION_LIST& GRE_SYSTEM::GetRegionList (   )  [inline, static]

Get shared region list. Returns: Reference to shared region list. This method is only available when compiling for WIN32_NATIVE. Definition at line 123 of file system.h.

bool GRE_SYSTEM::GetReturnSerialReadErr (   )  [inline, static]

Determine whether to return or continue on serial read error. Definition at line 116 of file system.h.

void* GRE_SYSTEM::GetRgnMgrHandle (   )  [inline, static]

Get "handle" for shared "region manager". This method is only available when compiling for X. Definition at line 130 of file system.h.

CRITICALSECTION& GRE_SYSTEM::GetViewCriticalSection (   )  [inline, static]

Get reference to the view list critical section. Definition at line 108 of file system.h.

bool GRE_SYSTEM::HasDoneWarningGeoMixed (   )  [inline, static]

Check if have displayed warning about mixing georef/ungeoref layers. Definition at line 135 of file system.h.

void GRE_SYSTEM::Init (   )  [static]

Initialize GRE system for non-interactive use. This will automatically register the standard geospatial layer types. At program exit, GRE_SYSTEM::Stop() should be called for proper cleanup.

void GRE_SYSTEM::InitMFC (   )  [static]

Initialize GRE system for interactive use in Microsoft Windows with MFC. This will automatically register the standard geospatial layer types. At program exit, GRE_SYSTEM::StopMFC() should be called for proper cleanup. This is only available when compiling for WIN32_NATIVE and WIN32_MFC.

void GRE_SYSTEM::InitX (  int  numworkpixels = 0  )  [static]

Initialize GRE system for interactive use in X Windows. This will automatically register the standard geospatial layer types. At program exit, GRE_SYSTEM::StopX() should be called for proper cleanup. This method is only available when compiling for X.

void GRE_SYSTEM::RegisterLayoutLayerTypes (   )  [static]

Register layout-specific layer types (text, scalebar, legend). By default only the standard geospatial layer are registered.

void GRE_SYSTEM::SetDoneWarningGeoMixed (  bool  set = true  )  [inline, static]

Set whether have displayed warning about mixing georef/ungeoref layers. Normally a warning dialog is displayed the first time a user attempts to place both georeferenced and non-georeferenced spatial objects in the same GRE_GROUP. In some processes, such as georeference editing, this is necessary, so this method is provided to avoid the unwanted warning dialog. Definition at line 174 of file system.h.

void GRE_SYSTEM::SetFirstGroup (  GRE_GROUP *  group  )  [inline, static]

Set reference to the first 'standalone' group To access this data you should get a lock on the group critical section. Definition at line 180 of file system.h.

void GRE_SYSTEM::SetFirstLayout (  GRE_LAYOUT *  layout  )  [inline, static]

Set reference to the first layout To access this data you should get a lock on the layout critical section. Definition at line 186 of file system.h.

void GRE_SYSTEM::SetFirstView (  GRE_VIEW *  view  )  [inline, static]

Set first view in GRE system. To access this data you should get a lock on the layout critical section Definition at line 192 of file system.h.

void GRE_SYSTEM::SetLastGroup (  GRE_GROUP *  group  )  [inline, static]

Set reference to the last 'standalone' group To access this data you should get a lock on the group critical section. Definition at line 198 of file system.h.

void GRE_SYSTEM::SetLastLayout (  GRE_LAYOUT *  layout  )  [inline, static]

Set reference to the last layout To access this data you should get a lock on the layout critical section. Definition at line 204 of file system.h.

void GRE_SYSTEM::SetReturnSerialReadErr (  bool  set = true  )  [inline, static]

Set whether to return serial read error or continue. Definition at line 209 of file system.h.

void GRE_SYSTEM::Stop (   )  [static]

Terminate GRE system at program exit. This method should only be called if GRE_SYSTEM::Init() was used.

void GRE_SYSTEM::StopMFC (   )  [static]

Terminate GRE system at program exit. This method should only be called if GRE_SYSTEM::InitMFC() was used.

void GRE_SYSTEM::StopX (   )  [static]

Terminate GRE system at program exit. This method should only be called if GRE_SYSTEM::InitX() was used.

---

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

• gre/system.h

---