RVC::CAD Class Reference

Manages RVC::OBJTYPE_CAD RVC objects. More...

#include <rvc/cad.h>

Inheritance diagram for RVC::CAD:

[legend]

Classes
class	CONST_ELEMITERATOR
	Constant element iterator class. More...
class	DRAW
	CAD Interface class to filter CAD elements before drawing Inherits from CADELEMENT::DRAW. More...
class	LINKPARMS
class	MAKEPARMS
Public Types
typedef INT32	CADBLOCKNUM
typedef RVC::CADELEMENT	ELEMENT
enum	LINKTYPE { LINKTYPE_Internal = 0, LINKTYPE_MapInfo = 1, LINKTYPE_Shapefile = 3, LINKTYPE_DGN = 5, LINKTYPE_DWG = 6, LINKTYPE_Edit = 1000 }
Public Member Functions
	CAD (const RVC::CAD &obj)
	CAD ()
virtual	~CAD ()
INT32	AddElement (const ELEMENT &Element)
ERRVALUE	CopyBlock (CADBLOCKNUM DestBlockNum, CADBLOCKNUM SrcBlockNum)
ERRVALUE	DeleteElement (INT32 ElemNum)
ERRVALUE	DeleteLastElement ()
INT32	DrawBlock (DRAW &Draw, INT32 BlockNum=0, double MinChordDist=0.0, DIMENSION dim=DIMENSION_2D) const
int	DrawElement (DRAW &Draw, INT32 BlockNum, INT32 ElemNum, double MinChordDist=0.0, DIMENSION dim=DIMENSION_2D) const
CONST_ELEMITERATOR	ElementBegin () const
CONST_ELEMITERATOR	ElementEnd () const
ERRVALUE	EraseBlock (CADBLOCKNUM BlockNum)
ERRVALUE	GetBlockDescriptor (INT32 BlockNum, DESCRIPTOR &Descriptor)
CADBLOCKNUM	GetCurrentBlock () const
LINKTYPE	GetLinkType () const
ERRVALUE	GetMakeParms (RVC::CAD::MAKEPARMS &MakeParms) const
INT32	GetNextElemID () const
INT32	GetNumBlocks () const
ERRVALUE	Link (const RVC::OBJECT &parent, const RVC::DESCRIPTOR &Descriptor, const LINKPARMS &LinkParms, const CREDENTIALS *Credentials RVC_DEFAULT_CREDENTIALS)
ERRVALUE	Make (RVC::OBJITEM &ObjItem, const MAKEPARMS &MakeParms, const char Source=0, const CREDENTIALS Credentials=0)
ERRVALUE	Make (const RVC::OBJECT &parent, const RVC::DESCRIPTOR &Descriptor, const MAKEPARMS &MakeParms, const CREDENTIALS *Credentials RVC_DEFAULT_CREDENTIALS)
RVC::CAD &	operator= (const RVC::CAD &rhs)
ERRVALUE	ReadBlock (CADBLOCKNUM BlockNum, CADBLOCK &block, bool MakeCurrent=true) const
ERRVALUE	ReadElement (INT32 ElemNum, ELEMENT &Element, DIMENSION dim=DIMENSION_2D) const
ERRVALUE	ReadElement (ELEMENT &Element, DIMENSION dim=DIMENSION_2D) const
ERRVALUE	Rewind ()
ERRVALUE	SetBlockDescriptor (INT32 BlockNum, const DESCRIPTOR &Descriptor)
ERRVALUE	SetEditBlock (INT32 BlockNum)
ERRVALUE	SetNextElemID (INT32 NextElemID)
ERRVALUE	SetPointType (POINTTYPE PointType)
ERRVALUE	SortElement (INT32 ElemNum, bool SortToFront)
ERRVALUE	SortElements (const BITSET_UNOWNED &SortSet, bool SortToFront)
ERRVALUE	UpdateElement (INT32 ElemNum, const ELEMENT &Element)
ERRVALUE	UpdateExtentsFromInsertElements ()
ERRVALUE	WriteBlock (CADBLOCKNUM BlockNum, CADBLOCK &block, bool MakeCurrent=true)
ERRVALUE	WriteElement (INT32 ElemNum, const ELEMENT &Element)

Detailed Description

Manages RVC::OBJTYPE_CAD RVC objects.

RVC Object Types that this class supports: RVC::OBJTYPE_CAD.

Default RVC Object Type for this class: RVC::OBJTYPE_CAD.

Valid parents for this class:

Member Typedef Documentation

typedef INT32 RVC::CAD::CADBLOCKNUM

Typedef for CAD block number type.

typedef RVC::CADELEMENT RVC::CAD::ELEMENT

Typedef for old CAD element signature.

Member Enumeration Documentation

enum RVC::CAD::LINKTYPE

Enumerator:

LINKTYPE_Internal
LINKTYPE_MapInfo	Mapinfo .MIF format.
LINKTYPE_Shapefile	Arc/Info Shapefile format.
LINKTYPE_DGN	MicroStation DGN format.
LINKTYPE_DWG	AutoCAD DWG format.
LINKTYPE_Edit

Constructor & Destructor Documentation

RVC::CAD::CAD ( )

Default constructor.

RVC::CAD::CAD ( const RVC::CAD & obj )

Copy constructor.

virtual RVC::CAD::~CAD ( ) [virtual]

Destructor.

Member Function Documentation

INT32 RVC::CAD::AddElement ( const ELEMENT & Element )

Add an element to the CAD object.

ERRVALUE RVC::CAD::CopyBlock	(	CADBLOCKNUM	DestBlockNum,
		CADBLOCKNUM	SrcBlockNum
	)

Copy a block inside a CAD object.

ERRVALUE RVC::CAD::DeleteElement ( INT32 ElemNum )

Delete the element specified. Only works if the GEOMETRIC::CAPABILITY_CanDeleteAnyElement is available.

ERRVALUE RVC::CAD::DeleteLastElement ( )

INT32 RVC::CAD::DrawBlock	(	DRAW &	Draw,
		INT32	BlockNum = `0`,
		double	MinChordDist = `0.0`,
		DIMENSION	dim = `DIMENSION_2D`
	)			const

Draws the block by calling the virtual draw routines.

Returns:: The number of elements drawn.

Parameters:

MinChordDist

Default is to use 5 of the Radius length

int RVC::CAD::DrawElement	(	DRAW &	Draw,
		INT32	BlockNum,
		INT32	ElemNum,
		double	MinChordDist = `0.0`,
		DIMENSION	dim = `DIMENSION_2D`
	)			const

Draws an element.

Returns > 0 if drawn, 0 if not, > 0 error.

Parameters:

	ElemNum	Element to draw
	MinChordDist	Default is to use 5 of the Radius length

CONST_ELEMITERATOR RVC::CAD::ElementBegin ( ) const

Obtain a constant iterator to the first CAD element in the current block.

Returns:: Constant iterator to first CAD element in the current block

CONST_ELEMITERATOR RVC::CAD::ElementEnd ( ) const

Obtain an iterator to the last+1 CAD element in the current block.

Returns:: Constant iterator to last+1 CAD element in the current block

ERRVALUE RVC::CAD::EraseBlock ( CADBLOCKNUM BlockNum )

Erase all elements from a block.

ERRVALUE RVC::CAD::GetBlockDescriptor	(	INT32	BlockNum,
		DESCRIPTOR &	Descriptor
	)

Get the DESCRIPTOR for a block.

CADBLOCKNUM RVC::CAD::GetCurrentBlock ( ) const

Get the current block number.

Returns:: Current block number

LINKTYPE RVC::CAD::GetLinkType ( ) const

Obtain the link type.

Returns:: RVCCAD::LINKTYPE

ERRVALUE RVC::CAD::GetMakeParms ( RVC::CAD::MAKEPARMS & MakeParms ) const

Get MAKEPARM values from current CAD object instance.

INT32 RVC::CAD::GetNextElemID ( ) const

Obtain next available element ID for element ID table.

Returns:: Next available Element ID

INT32 RVC::CAD::GetNumBlocks ( ) const

Obtain the number of blocks in this CAD object.

Returns:: Number of blocks

ERRVALUE RVC::CAD::Link	(	const RVC::OBJECT &	parent,
		const RVC::DESCRIPTOR &	Descriptor,
		const LINKPARMS &	LinkParms,
		const CREDENTIALS *Credentials	RVC_DEFAULT_CREDENTIALS
	)

Link CAD object to external file.

Parameters:

	parent	Create a raster object
	RVC_DEFAULT_CREDENTIALS	User credentials passed in, NULL for default behavior

ERRVALUE RVC::CAD::Make	(	RVC::OBJITEM &	ObjItem,
		const MAKEPARMS &	MakeParms,
		const char *	Source = `0`,
		const CREDENTIALS *	Credentials = `0`
	)

Create a new CAD object.

Parameters:

	ObjItem	Parent object and DESCRIPTOR of object to create, new location RETURNED
	Credentials	User credentials passed in, NULL for default behavior

ERRVALUE RVC::CAD::Make	(	const RVC::OBJECT &	parent,
		const RVC::DESCRIPTOR &	Descriptor,
		const MAKEPARMS &	MakeParms,
		const CREDENTIALS *Credentials	RVC_DEFAULT_CREDENTIALS
	)

Create a new CAD object.

Parameters:

	parent	Create a raster object
	RVC_DEFAULT_CREDENTIALS	User credentials passed in, NULL for default behavior

RVC::CAD& RVC::CAD::operator= ( const RVC::CAD & rhs )

Assignment, will close and re-open object if possible.

Reimplemented from RVC::GEOMETRIC.

ERRVALUE RVC::CAD::ReadBlock	(	CADBLOCKNUM	BlockNum,
		CADBLOCK &	block,
		bool	MakeCurrent = `true`
	)			const

Read the block information.

Parameters:

MakeCurrent

Make current block

ERRVALUE RVC::CAD::ReadElement	(	INT32	ElemNum,
		ELEMENT &	Element,
		DIMENSION	dim = `DIMENSION_2D`
	)			const

Read specific CAD element in the current block.

ERRVALUE RVC::CAD::ReadElement	(	ELEMENT &	Element,
		DIMENSION	dim = `DIMENSION_2D`
	)			const

Read next CAD element in the sequence in the current block.

ERRVALUE RVC::CAD::Rewind ( )

Rewind CAD object block reading to the begining.

ERRVALUE RVC::CAD::SetBlockDescriptor	(	INT32	BlockNum,
		const DESCRIPTOR &	Descriptor
	)

Set the DESCRIPTOR for a block.

ERRVALUE RVC::CAD::SetEditBlock ( INT32 BlockNum )

ERRVALUE RVC::CAD::SetNextElemID ( INT32 NextElemID )

Set next available element ID for element ID table.

ERRVALUE RVC::CAD::SetPointType ( POINTTYPE PointType )

Set CAD object point coordinate type.

ERRVALUE RVC::CAD::SortElement	(	INT32	ElemNum,
		bool	SortToFront
	)

Change the drawing order of an element in the CAD object.

ERRVALUE RVC::CAD::SortElements	(	const BITSET_UNOWNED &	SortSet,
		bool	SortToFront
	)

Change the drawing order of the set of elements in the CAD object.

ERRVALUE RVC::CAD::UpdateElement	(	INT32	ElemNum,
		const ELEMENT &	Element
	)

Update element information (in CADELEMOPT section).

ERRVALUE RVC::CAD::UpdateExtentsFromInsertElements ( )

ERRVALUE RVC::CAD::WriteBlock	(	CADBLOCKNUM	BlockNum,
		CADBLOCK &	block,
		bool	MakeCurrent = `true`
	)

Write the block information.

Parameters:

MakeCurrent

Make current block

ERRVALUE RVC::CAD::WriteElement	(	INT32	ElemNum,
		const ELEMENT &	Element
	)

Write element information, only valid if linktype == LINKTYPE_Edit.

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

rvc/cad.h

RVC::CAD Class Reference

Classes

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation