Main Page | Modules | Directories | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages | Search for 

RVC::CAD Class Reference

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

#include <rvc/cad.h>

Inheritance diagram for RVC::CAD:

Inheritance graph
[legend]
List of all members.

Public Types

typedef INT32 CADBLOCKNUM
enum  LINKTYPE {
  LINKTYPE_Internal = 0, LINKTYPE_MapInfo = 1, LINKTYPE_AtlasGIS = 2, LINKTYPE_Shapefile = 3,
  LINKTYPE_DGN = 5, LINKTYPE_DWG = 6, LINKTYPE_Edit = 1000
}

Public Member Functions

INT32 AddElement (const ELEMENT &Element)
 CAD (const RVC::CAD &obj)
 CAD ()
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)
CADBLOCKNUM GetCurrentBlock () const
LINKTYPE GetLinkType () const
ERRVALUE GetMakeParms (RVC::CAD::MAKEPARMS &MakeParms) const
INT32 GetNextElemID () const
INT32 GetNumBlocks () const
DEPRECATED ERRVALUE Link (const RVC::OBJECT &parent, const RVC::OBJECTNAME &name, const RVC::OBJECTDESC &desc, const LINKPARMS &LinkParms, const char *Source=0)
ERRVALUE Link (const RVC::OBJECT &parent, const RVC::DESCRIPTOR &Descriptor, const LINKPARMS &LinkParms)
ERRVALUE Make (const RVC::OBJITEM &ObjItem, const MAKEPARMS &MakeParms, const char *Source=0)
DEPRECATED ERRVALUE Make (const RVC::OBJECT &parent, const RVC::OBJECTNAME &name, const RVC::OBJECTDESC &desc, const MAKEPARMS &MakeParms, const char *Source=0)
ERRVALUE Make (const RVC::OBJECT &parent, const RVC::DESCRIPTOR &Descriptor, const MAKEPARMS &MakeParms)
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 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)
virtual ~CAD ()

Detailed Description

Manages RVC::OBJTYPE_CAD RVC objects.

The interface currently wraps the MfCAD functions.

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:

Definition at line 264 of file cad.h.

Member Typedef Documentation

typedef INT32 RVC::CAD::CADBLOCKNUM
 

Typedef for CAD block number type.

Definition at line 267 of file cad.h.

Member Enumeration Documentation

enum RVC::CAD::LINKTYPE
 

Enumeration values:
LINKTYPE_Internal 
LINKTYPE_MapInfo  Mapinfo .MIF format.
LINKTYPE_AtlasGIS  Atlas GIS 3.0 internal format.
LINKTYPE_Shapefile  Arc/Info Shapefile format.
LINKTYPE_DGN  MicroStation DGN format.
LINKTYPE_DWG  AutoCAD DWG format.
LINKTYPE_Edit 

Definition at line 269 of file cad.h.

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.

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

DEPRECATED ERRVALUE RVC::CAD::Link (  const RVC::OBJECT &  parent,
const RVC::OBJECTNAME &  name,
const RVC::OBJECTDESC &  desc,
const LINKPARMS &  LinkParms,
const char *  Source = 0
) 
 

Link CAD object to external file.

Deprecated:
Use the Link() method that takes a DESCRIPTOR
Parameters:
parent  Create a raster object

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

Link CAD object to external file.

Parameters:
parent  Create a raster object

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

Create a new CAD object.

Parameters:
ObjItem  Create a raster object

DEPRECATED ERRVALUE RVC::CAD::Make (  const RVC::OBJECT &  parent,
const RVC::OBJECTNAME &  name,
const RVC::OBJECTDESC &  desc,
const MAKEPARMS &  MakeParms,
const char *  Source = 0
) 
 

Create a new CAD object.

Deprecated:
Use the Make() method that takes a DESCRIPTOR
Parameters:
parent  Create a raster object

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

Create a new CAD object.

Parameters:
parent  Create a raster object

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

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

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::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:
Generated on Wed May 31 15:30:22 2006 for TNTsdk by  doxygen 1.3.8-20040913