VR-Forces 4.10 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes | Friends
makVrv::DtChannelKeywordGridLines Class Reference
vrvCore

The base class for all channel keyword objects. More...

Inheritance diagram for makVrv::DtChannelKeywordGridLines:
Inheritance graph
[legend]

Public Member Functions

virtual ~DtChannelKeywordGridLines ()
 DTOR. More...
 
virtual void channelNameChanged (const std::string &displayName, const std::string &windowName, const std::string &channelName)
 Implementing objects use this method to respond to changes in the fully qualified name of their channel [display name / window name / channel name ]. More...
 
virtual void channelConfigurationChanged (const DtChannelConfiguration &config)
 Implementing objects use this method to respond to changes in channel configuration other than name, which is handled above. More...
 
virtual void windowConfigurationChanged (const DtWindowConfiguration &config)
 Implementing objects use this method to respond to changes in window configuration other than name, which is handled above. More...
 
- Public Member Functions inherited from makVrv::DtChannelKeywordObject
virtual ~DtChannelKeywordObject ()
 DTOR. More...
 

Protected Member Functions

virtual void slot_observerCreated (DtInputDriver *inputDriver, DtObserver *observer)
 Called when an observer is created, so that we can connect to an observer that didn't exist when the grid line object itself was created. More...
 
virtual void slot_observerToBeDestroyed (DtInputDriver *inputDriver, DtObserver *observer)
 Called when an observer is about to be destroyed, so we can disconnect from the observer mode changed signal and set myObserver to Null. More...
 
virtual void slot_observerModeChanged (DtObserver *observer, int newMode)
 Called when an observer's observer mode changes, so we can determine if we need to create or destroy a grid line object. More...
 
virtual void slot_observerModeSettingChanged (int mode, int setting)
 Called when an observer mode's setting changes; if its the mode our observer is using and the setting is DisplayGridLines, we may need to create or destroy a gridLineObject. More...
 
virtual void slot_observerModeIs2DChanged (int mode)
 Called when an observer mode's projection changes; if its the mode our observer is using and the current setting is DisplayGridLines, we may need to create or destroy a gridLineObject. More...
 
virtual void slot_coordinateSystemChanged (const std::string &, const std::string &)
 Called when the current coordinate system changes. More...
 
virtual void slot_northSouthColorChanged (float r, float g, float b, float a)
 Called when the GridLinesSettingsManager signals a change to the N/S gridline color. More...
 
virtual void slot_eastWestColorChanged (float r, float g, float b, float a)
 Called when the GridLinesSettingsManager signals a change to the E/W gridline color. More...
 
virtual void slot_minimalGridlineLabelsEnabled (bool isMinimalEnabled)
 Called when the GridLinesSettingsManager signals a change to the use of minimal gridline labels. More...
 
virtual void slot_autoSpacingSet (bool isAutoSpacingSet)
 Called when the GridLinesSettingsManager signals a change to autoSpacing. More...
 
virtual void slot_fixedSpacingAmountSet (makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits unit, double fixedSpacingAmount)
 Receives notification of changes to the spacing of a linear unit of measurement. More...
 
virtual void slot_fixedAngularSpacingAmountSet (makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits unit, double fixedAngularSpacingAmount)
 Receives notification of changes to the spacing of an angular unit of measurement. More...
 
virtual void slot_gridTypeSet (makArchives::DtDisplayUnitsSettingsRecord::CoordSys cs)
 Called when the GridLinesSettingsManager signals a change to the grid type. More...
 
virtual void slot_unitTypeSet (makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits unit)
 Called when the GridLinesSettingsManager signals a change to the unit type. More...
 
virtual void slot_angularUnitTypeSet (makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits unit)
 Called when the GridLinesSettingsManager signals a change to the unit type. More...
 
virtual void slot_minSpacingSet (int minSpacing)
 Called when the GridLinesSettingsManager signals a change to the min pixel spacing. More...
 
virtual void slot_xOffsetSet (makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits unit, double xOffset)
 Receives notification of changes to the x offset (in meters). More...
 
virtual void slot_yOffsetSet (makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits unit, double yOffset)
 Receives notification of changes to the y offset (in meters). More...
 
virtual void slot_longitudeOffsetSet (makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits unit, double lonOffset)
 Receives notification of changes to the x offset (in meters). More...
 
virtual void slot_latitudeOffsetSet (makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits unit, double latOffset)
 Receives notification of changes to the y offset (in meters). More...
 
virtual void slot_decimalPlacesSet (makArchives::DtDisplayUnitsSettingsRecord::CoordSys cs, makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits unit, unsigned int decimals)
 Receives notification of changes to decimal places for a linear unit. More...
 
virtual void slot_angularDecimalPlacesSet (makArchives::DtDisplayUnitsSettingsRecord::CoordSys cs, makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits unit, unsigned int decimals)
 Receives notification of changes to decimal places for an angular unit. More...
 
virtual void connectToObserver (DtObserver *observer)
 
virtual void connectToObserver (const std::string &observerName)
 
virtual void disconnectFromObserver ()
 
virtual void updateGridLinesState ()
 
virtual bool validateGridType ()
 Certain grid types can only be used with certain database coordinate system types Validate current grid type or change to a valid one. More...
 
virtual bool validateUnitType ()
 Certain unit types can only be used with certain grid types Validate current unit type or change to a valid one. More...
 
 DtChannelKeywordGridLines (DtDe &de, const std::string &keyword, const std::string &displayName, const std::string &windowName, const DtChannelConfiguration &channelConfig)
 CTOR. More...
 
makArchives::DtDisplayUnitsSettingsRecord::CoordSys defaultForCoordSys (const std::string &type)
 
bool currentUnits (makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits unit) const
 
bool currentUnits (makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits unit) const
 
- Protected Member Functions inherited from makVrv::DtChannelKeywordObject
 DtChannelKeywordObject (DtDe &de, const std::string &keyword, const std::string &displayName, const std::string &windowName, const DtChannelConfiguration &channelConfig)
 CTOR. More...
 

Protected Attributes

DtChannelGridLinesAgent * myGridLinesAgent
 
std::string myObserverName
 
DtObserver * myObserver
 
std::string myKeyword
 
std::string myDisplayName
 
std::string myWindowName
 
std::string myChannelName
 
DtSignalConnectionManager myConnections
 
makArchives::DtDisplayUnitsSettingsRecord::CoordSys myGridType
 
- Protected Attributes inherited from makVrv::DtChannelKeywordObject
DtDe & myDe
 

Friends

class DtChannelKeywordGridLinesCreator
 Only the creator can construct this object. More...
 

Detailed Description

The base class for all channel keyword objects.

Constructor & Destructor Documentation

virtual makVrv::DtChannelKeywordGridLines::~DtChannelKeywordGridLines ( )
virtual

DTOR.

makVrv::DtChannelKeywordGridLines::DtChannelKeywordGridLines ( DtDe &  de,
const std::string &  keyword,
const std::string &  displayName,
const std::string &  windowName,
const DtChannelConfiguration &  channelConfig 
)
protected

CTOR.

Member Function Documentation

virtual void makVrv::DtChannelKeywordGridLines::channelNameChanged ( const std::string &  displayName,
const std::string &  windowName,
const std::string &  channelName 
)
virtual

Implementing objects use this method to respond to changes in the fully qualified name of their channel [display name / window name / channel name ].

Implements makVrv::DtChannelKeywordObject.

virtual void makVrv::DtChannelKeywordGridLines::channelConfigurationChanged ( const DtChannelConfiguration &  config)
virtual

Implementing objects use this method to respond to changes in channel configuration other than name, which is handled above.

Implements makVrv::DtChannelKeywordObject.

virtual void makVrv::DtChannelKeywordGridLines::windowConfigurationChanged ( const DtWindowConfiguration &  config)
inlinevirtual

Implementing objects use this method to respond to changes in window configuration other than name, which is handled above.

Implements makVrv::DtChannelKeywordObject.

virtual void makVrv::DtChannelKeywordGridLines::slot_observerCreated ( DtInputDriver *  inputDriver,
DtObserver *  observer 
)
protectedvirtual

Called when an observer is created, so that we can connect to an observer that didn't exist when the grid line object itself was created.

virtual void makVrv::DtChannelKeywordGridLines::slot_observerToBeDestroyed ( DtInputDriver *  inputDriver,
DtObserver *  observer 
)
protectedvirtual

Called when an observer is about to be destroyed, so we can disconnect from the observer mode changed signal and set myObserver to Null.

virtual void makVrv::DtChannelKeywordGridLines::slot_observerModeChanged ( DtObserver *  observer,
int  newMode 
)
protectedvirtual

Called when an observer's observer mode changes, so we can determine if we need to create or destroy a grid line object.

virtual void makVrv::DtChannelKeywordGridLines::slot_observerModeSettingChanged ( int  mode,
int  setting 
)
protectedvirtual

Called when an observer mode's setting changes; if its the mode our observer is using and the setting is DisplayGridLines, we may need to create or destroy a gridLineObject.

virtual void makVrv::DtChannelKeywordGridLines::slot_observerModeIs2DChanged ( int  mode)
protectedvirtual

Called when an observer mode's projection changes; if its the mode our observer is using and the current setting is DisplayGridLines, we may need to create or destroy a gridLineObject.

virtual void makVrv::DtChannelKeywordGridLines::slot_coordinateSystemChanged ( const std::string &  ,
const std::string &   
)
protectedvirtual

Called when the current coordinate system changes.

virtual void makVrv::DtChannelKeywordGridLines::slot_northSouthColorChanged ( float  r,
float  g,
float  b,
float  a 
)
protectedvirtual

Called when the GridLinesSettingsManager signals a change to the N/S gridline color.

virtual void makVrv::DtChannelKeywordGridLines::slot_eastWestColorChanged ( float  r,
float  g,
float  b,
float  a 
)
protectedvirtual

Called when the GridLinesSettingsManager signals a change to the E/W gridline color.

virtual void makVrv::DtChannelKeywordGridLines::slot_minimalGridlineLabelsEnabled ( bool  isMinimalEnabled)
protectedvirtual

Called when the GridLinesSettingsManager signals a change to the use of minimal gridline labels.

virtual void makVrv::DtChannelKeywordGridLines::slot_autoSpacingSet ( bool  isAutoSpacingSet)
protectedvirtual

Called when the GridLinesSettingsManager signals a change to autoSpacing.

virtual void makVrv::DtChannelKeywordGridLines::slot_fixedSpacingAmountSet ( makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits  unit,
double  fixedSpacingAmount 
)
protectedvirtual

Receives notification of changes to the spacing of a linear unit of measurement.

virtual void makVrv::DtChannelKeywordGridLines::slot_fixedAngularSpacingAmountSet ( makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits  unit,
double  fixedAngularSpacingAmount 
)
protectedvirtual

Receives notification of changes to the spacing of an angular unit of measurement.

virtual void makVrv::DtChannelKeywordGridLines::slot_gridTypeSet ( makArchives::DtDisplayUnitsSettingsRecord::CoordSys  cs)
protectedvirtual

Called when the GridLinesSettingsManager signals a change to the grid type.

virtual void makVrv::DtChannelKeywordGridLines::slot_unitTypeSet ( makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits  unit)
protectedvirtual

Called when the GridLinesSettingsManager signals a change to the unit type.

virtual void makVrv::DtChannelKeywordGridLines::slot_angularUnitTypeSet ( makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits  unit)
protectedvirtual

Called when the GridLinesSettingsManager signals a change to the unit type.

virtual void makVrv::DtChannelKeywordGridLines::slot_minSpacingSet ( int  minSpacing)
protectedvirtual

Called when the GridLinesSettingsManager signals a change to the min pixel spacing.

virtual void makVrv::DtChannelKeywordGridLines::slot_xOffsetSet ( makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits  unit,
double  xOffset 
)
protectedvirtual

Receives notification of changes to the x offset (in meters).

virtual void makVrv::DtChannelKeywordGridLines::slot_yOffsetSet ( makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits  unit,
double  yOffset 
)
protectedvirtual

Receives notification of changes to the y offset (in meters).

virtual void makVrv::DtChannelKeywordGridLines::slot_longitudeOffsetSet ( makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits  unit,
double  lonOffset 
)
protectedvirtual

Receives notification of changes to the x offset (in meters).

virtual void makVrv::DtChannelKeywordGridLines::slot_latitudeOffsetSet ( makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits  unit,
double  latOffset 
)
protectedvirtual

Receives notification of changes to the y offset (in meters).

virtual void makVrv::DtChannelKeywordGridLines::slot_decimalPlacesSet ( makArchives::DtDisplayUnitsSettingsRecord::CoordSys  cs,
makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits  unit,
unsigned int  decimals 
)
protectedvirtual

Receives notification of changes to decimal places for a linear unit.

virtual void makVrv::DtChannelKeywordGridLines::slot_angularDecimalPlacesSet ( makArchives::DtDisplayUnitsSettingsRecord::CoordSys  cs,
makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits  unit,
unsigned int  decimals 
)
protectedvirtual

Receives notification of changes to decimal places for an angular unit.

virtual void makVrv::DtChannelKeywordGridLines::connectToObserver ( DtObserver *  observer)
protectedvirtual
virtual void makVrv::DtChannelKeywordGridLines::connectToObserver ( const std::string &  observerName)
protectedvirtual
virtual void makVrv::DtChannelKeywordGridLines::disconnectFromObserver ( )
protectedvirtual
virtual void makVrv::DtChannelKeywordGridLines::updateGridLinesState ( )
protectedvirtual
virtual bool makVrv::DtChannelKeywordGridLines::validateGridType ( )
protectedvirtual

Certain grid types can only be used with certain database coordinate system types Validate current grid type or change to a valid one.

Returns false if neither is possible

virtual bool makVrv::DtChannelKeywordGridLines::validateUnitType ( )
protectedvirtual

Certain unit types can only be used with certain grid types Validate current unit type or change to a valid one.

Returns false if neither is possible

makArchives::DtDisplayUnitsSettingsRecord::CoordSys makVrv::DtChannelKeywordGridLines::defaultForCoordSys ( const std::string &  type)
protected
bool makVrv::DtChannelKeywordGridLines::currentUnits ( makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits  unit) const
protected
bool makVrv::DtChannelKeywordGridLines::currentUnits ( makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits  unit) const
protected

Friends And Related Function Documentation

friend class DtChannelKeywordGridLinesCreator
friend

Only the creator can construct this object.

Member Data Documentation

DtChannelGridLinesAgent* makVrv::DtChannelKeywordGridLines::myGridLinesAgent
protected
std::string makVrv::DtChannelKeywordGridLines::myObserverName
protected
DtObserver* makVrv::DtChannelKeywordGridLines::myObserver
protected
std::string makVrv::DtChannelKeywordGridLines::myKeyword
protected
std::string makVrv::DtChannelKeywordGridLines::myDisplayName
protected
std::string makVrv::DtChannelKeywordGridLines::myWindowName
protected
std::string makVrv::DtChannelKeywordGridLines::myChannelName
protected
DtSignalConnectionManager makVrv::DtChannelKeywordGridLines::myConnections
protected
makArchives::DtDisplayUnitsSettingsRecord::CoordSys makVrv::DtChannelKeywordGridLines::myGridType
protected
The documentation for this class was generated from the following file:
Document ID: Generated on Tue Sep 21 17:42:52 EDT 2021 from SVN revision 234861
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)