GRE::LAYER_RASTER::DISPPARM::IOPARM Struct Reference

#include <gre/lrraster.h>

List of all members.

Public Member Functions
	IOPARM (const IOPARM &rhs)
	IOPARM ()
	~IOPARM ()
bool	CanContrast () const
void	ClearContrast ()
void	ClearGeoreference ()
INT32	GetBand () const
UINT32	GetCellType () const
UINT8	GetComponentComplex () const
const CONTRASTPARM &	GetContrastParm () const
CONTRASTPARM &	GetContrastParmInternal ()
UINT16	GetNumBits () const
INT32	GetNumColumns () const
INT32	GetNumRows () const
NUMTYPE	GetNumType () const
RVC::OBJITEM &	GetObjItem ()
const RVC::OBJITEM &	GetObjItem () const
RVC::OBJECTNAME &	GetObjNameContrast ()
const RVC::OBJECTNAME &	GetObjNameContrast () const
const RVC::OBJECTNAME &	GetObjNameGeoreference () const
ERRVALUE	GetRange (DOUBLE_RANGE &range) const
const STAT_UNIVARIATE &	GetStats () const
bool	IsConstant () const
bool	NeedContrast (UINT8 dispmode) const
void	OnSerialRead ()
IOPARM &	operator= (const IOPARM &rhs)
void	SetBand (INT32 band)
void	SetComponentComplex (UINT8 ComponentComplex)
void	SetComponentNum (INT8 ComponentNum)
void	SetContrast (const RVC::OBJECTNAME &ObjNameContrast)
void	SetContrastDefault (UINT8 dispmode)
void	SetContrastParm (const CONTRASTPARM &ContrastParm)
void	SetDataTipDefault (bool force)
void	SetDimensions (INT32 NumColumns, INT32 NumRows)
void	SetGeoreference (const RVC::OBJECTNAME &ObjNameGeoref)
ERRVALUE	SetObjItem (const RVC::OBJITEM &ObjItem, bool UpdateSaved)
void	SetSaveObjItem (const RVC::OBJITEM &ObjItem)
ERRVALUE	SetupImageStage (SPATMOD::IMAGE::STAGE_AUTOPTR &StagePtr, const SPATMOD::GEOREFERENCE *pGeoreference, const GRE::LAYER_RASTER::COMMONPARM *pCommonParm, int component, bool UseValidity=true) const
void	UpdateSaveInfo () const
ERRVALUE	Validate (UINT8 dispmode)
ERRVALUE	ValidateContrast (UINT8 dispmode)
ERRVALUE	ValidateDataTip ()
ERRVALUE	ValidateObjItem ()
Static Public Member Functions
static const SERIALIZERITEM *	SerialGetItemDef ()
static const SERIALIZERITEM *	SerialGetItemDefMask ()
static ERRVALUE	SerializerCB (SERIALIZER &, const SERIALIZERITEM *, void *, SERIALIZERITEM::ACTION)
Public Attributes
INT32	Band
DATATIPPARMS	DataTip
bool	DoContrast
bool	DoShading
RVC::OBJECTNAME	m_ObjNameGeoref
SHADEPARM	shadeparm

---

Constructor & Destructor Documentation

GRE::LAYER_RASTER::DISPPARM::IOPARM::IOPARM

(

)

GRE::LAYER_RASTER::DISPPARM::IOPARM::IOPARM

(

const IOPARM &

rhs

)

[inline]

GRE::LAYER_RASTER::DISPPARM::IOPARM::~IOPARM

(

)

---

Member Function Documentation

bool GRE::LAYER_RASTER::DISPPARM::IOPARM::CanContrast

(

)

const

Determine if can do contrast enhancement.

void GRE::LAYER_RASTER::DISPPARM::IOPARM::ClearContrast

(

)

Clear contrast settings.

void GRE::LAYER_RASTER::DISPPARM::IOPARM::ClearGeoreference

(

)

[inline]

Clear georeference.

INT32 GRE::LAYER_RASTER::DISPPARM::IOPARM::GetBand

(

)

const [inline]

UINT32 GRE::LAYER_RASTER::DISPPARM::IOPARM::GetCellType

(

)

const [inline]

Get RVC::IMAGE::CELLTYPE.

UINT8 GRE::LAYER_RASTER::DISPPARM::IOPARM::GetComponentComplex

(

)

const [inline]

Get component for complex raster.

const CONTRASTPARM& GRE::LAYER_RASTER::DISPPARM::IOPARM::GetContrastParm

(

)

const [inline]

Get contrast parameters.

CONTRASTPARM& GRE::LAYER_RASTER::DISPPARM::IOPARM::GetContrastParmInternal

(

)

[inline]

Get contrast parameters (non-const).

For internal layer implementation only.

UINT16 GRE::LAYER_RASTER::DISPPARM::IOPARM::GetNumBits

(

)

const

Get number of bits per pixel.

INT32 GRE::LAYER_RASTER::DISPPARM::IOPARM::GetNumColumns

(

)

const [inline]

Get number of image columns.

INT32 GRE::LAYER_RASTER::DISPPARM::IOPARM::GetNumRows

(

)

const [inline]

Get number of image rows.

NUMTYPE GRE::LAYER_RASTER::DISPPARM::IOPARM::GetNumType

(

)

const

RVC::OBJITEM& GRE::LAYER_RASTER::DISPPARM::IOPARM::GetObjItem

(

)

[inline]

Get currently set OBJITEM.

const RVC::OBJITEM& GRE::LAYER_RASTER::DISPPARM::IOPARM::GetObjItem

(

)

const [inline]

Get currently set OBJITEM.

RVC::OBJECTNAME& GRE::LAYER_RASTER::DISPPARM::IOPARM::GetObjNameContrast

(

)

[inline]

Get name of contrast subobject.

const RVC::OBJECTNAME& GRE::LAYER_RASTER::DISPPARM::IOPARM::GetObjNameContrast

(

)

const [inline]

Get name of contrast subobject.

const RVC::OBJECTNAME& GRE::LAYER_RASTER::DISPPARM::IOPARM::GetObjNameGeoreference

(

)

const [inline]

Get name of georeference subobject.

ERRVALUE GRE::LAYER_RASTER::DISPPARM::IOPARM::GetRange

(

DOUBLE_RANGE &

range

)

const

Get cell value range.

const STAT_UNIVARIATE& GRE::LAYER_RASTER::DISPPARM::IOPARM::GetStats

(

)

const [inline]

Get statistics for component.

bool GRE::LAYER_RASTER::DISPPARM::IOPARM::IsConstant

(

)

const [inline]

Determine if is constant-value image.

bool GRE::LAYER_RASTER::DISPPARM::IOPARM::NeedContrast

(

UINT8

dispmode

)

const

Determine if need contrast enhancement.

void GRE::LAYER_RASTER::DISPPARM::IOPARM::OnSerialRead

(

)

IOPARM& GRE::LAYER_RASTER::DISPPARM::IOPARM::operator=

(

const IOPARM &

rhs

)

[inline]

Assignment.

static const SERIALIZERITEM* GRE::LAYER_RASTER::DISPPARM::IOPARM::SerialGetItemDef

(

)

[static]

static const SERIALIZERITEM* GRE::LAYER_RASTER::DISPPARM::IOPARM::SerialGetItemDefMask

(

)

[static]

static ERRVALUE GRE::LAYER_RASTER::DISPPARM::IOPARM::SerializerCB	(	SERIALIZER &	,
		const SERIALIZERITEM *	,
		void *	,
		SERIALIZERITEM::ACTION
	)			[static]

void GRE::LAYER_RASTER::DISPPARM::IOPARM::SetBand

(

INT32

band

)

[inline]

void GRE::LAYER_RASTER::DISPPARM::IOPARM::SetComponentComplex

(

UINT8

ComponentComplex

)

[inline]

Set component for complex raster.

void GRE::LAYER_RASTER::DISPPARM::IOPARM::SetComponentNum

(

INT8

ComponentNum

)

[inline]

void GRE::LAYER_RASTER::DISPPARM::IOPARM::SetContrast

(

const RVC::OBJECTNAME &

ObjNameContrast

)

Set contrast to use specified object.

void GRE::LAYER_RASTER::DISPPARM::IOPARM::SetContrastDefault

(

UINT8

dispmode

)

Set contrast to use default settings.

void GRE::LAYER_RASTER::DISPPARM::IOPARM::SetContrastParm

(

const CONTRASTPARM &

ContrastParm

)

Set contrast parameters.

void GRE::LAYER_RASTER::DISPPARM::IOPARM::SetDataTipDefault

(

bool

force

)

Set DataTip to use default settings.

void GRE::LAYER_RASTER::DISPPARM::IOPARM::SetDimensions	(	INT32	NumColumns,
		INT32	NumRows
	)			[inline]

Set dimensions of "constant" image.

Primarily for internal use only.

void GRE::LAYER_RASTER::DISPPARM::IOPARM::SetGeoreference

(

const RVC::OBJECTNAME &

ObjNameGeoref

)

[inline]

ERRVALUE GRE::LAYER_RASTER::DISPPARM::IOPARM::SetObjItem	(	const RVC::OBJITEM &	ObjItem,
		bool	UpdateSaved
	)

Set OBJITEM.

If item is unassigned then will set as "constant", otherwise it must refer to an "image" object or error will be returned.

void GRE::LAYER_RASTER::DISPPARM::IOPARM::SetSaveObjItem

(

const RVC::OBJITEM &

ObjItem

)

Set OBJITEM to actually save with serialization.

Used when "editing" in temporary workspace. If not used then will save normal objitem.

ERRVALUE GRE::LAYER_RASTER::DISPPARM::IOPARM::SetupImageStage	(	SPATMOD::IMAGE::STAGE_AUTOPTR &	StagePtr,
		const SPATMOD::GEOREFERENCE *	pGeoreference,
		const GRE::LAYER_RASTER::COMMONPARM *	pCommonParm,
		int	component,
		bool	UseValidity = true
	)			const

void GRE::LAYER_RASTER::DISPPARM::IOPARM::UpdateSaveInfo

(

)

const

ERRVALUE GRE::LAYER_RASTER::DISPPARM::IOPARM::Validate

(

UINT8

dispmode

)

Validate settings.

Checks if various object-dependent settings are valid. Invalid settings will be fixed if possible or an error will be returned if not.

ERRVALUE GRE::LAYER_RASTER::DISPPARM::IOPARM::ValidateContrast

(

UINT8

dispmode

)

Validate contrast settings.

Invalid settings will be fixed if possible or an error will be returned if not.

ERRVALUE GRE::LAYER_RASTER::DISPPARM::IOPARM::ValidateDataTip

(

)

Validate datatip settings.

Invalid settings will be fixed if possible or an error will be returned if not.

ERRVALUE GRE::LAYER_RASTER::DISPPARM::IOPARM::ValidateObjItem

(

)

Validate objitem settings.

---

Member Data Documentation

INT32 GRE::LAYER_RASTER::DISPPARM::IOPARM::Band

Band number for hyperspectral set.

DATATIPPARMS GRE::LAYER_RASTER::DISPPARM::IOPARM::DataTip

DataTip parameters.

bool GRE::LAYER_RASTER::DISPPARM::IOPARM::DoContrast

Perform contrasting on this raster, set by OpenRast.

bool GRE::LAYER_RASTER::DISPPARM::IOPARM::DoShading

Perform relief shading on this raster.

RVC::OBJECTNAME GRE::LAYER_RASTER::DISPPARM::IOPARM::m_ObjNameGeoref

SHADEPARM GRE::LAYER_RASTER::DISPPARM::IOPARM::shadeparm

Relief shading parameters for this raster.

---

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

• gre/lrraster.h