///////////////////////////////////////////////////////////////////////////////
|
// Copyright (C) 2002-2016, Open Design Alliance (the "Alliance").
|
// All rights reserved.
|
//
|
// This software and its documentation and related materials are owned by
|
// the Alliance. The software may only be incorporated into application
|
// programs owned by members of the Alliance, subject to a signed
|
// Membership Agreement and Supplemental Software License Agreement with the
|
// Alliance. The structure and organization of this software are the valuable
|
// trade secrets of the Alliance and its suppliers. The software is also
|
// protected by copyright law and international treaty provisions. Application
|
// programs incorporating this software must include the following statement
|
// with their copyright notices:
|
//
|
// This application incorporates Teigha(R) software pursuant to a license
|
// agreement with Open Design Alliance.
|
// Teigha(R) Copyright (C) 2002-2016 by Open Design Alliance.
|
// All rights reserved.
|
//
|
// By use of this software, its documentation or related materials, you
|
// acknowledge and accept the above terms.
|
///////////////////////////////////////////////////////////////////////////////
|
|
|
|
|
#ifndef _ODDBLINETYPETABLE_INCLUDED
|
#define _ODDBLINETYPETABLE_INCLUDED
|
|
#include "TD_PackPush.h"
|
|
#include "DbSymbolTable.h"
|
|
class OdDbLinetypeTableRecord;
|
|
/** \details
|
<group OdDb_Classes>
|
|
This class implements bidirectional iterator for instances of the /linetype record/ object
|
within the /linetype table/ object.
|
|
Library: TD_Db
|
|
\sa
|
<link db_linetype_sample_table.html, Example of Working with the Linetype Table Object>
|
|
\sa
|
<link db_linetype_iterate.html, Iterating through Linetypes>
|
|
OdDbSymbolTableIterator class
|
*/
|
class TOOLKIT_EXPORT OdDbLinetypeTableIterator : public OdDbSymbolTableIterator
|
{
|
public:
|
ODRX_DECLARE_MEMBERS(OdDbLinetypeTableIterator);
|
|
protected:
|
/** \details
|
Builds an instance of the /linetype iterator/ object.
|
|
\remarks
|
Use the OdDbLinetypeTable::newIterator() method instead it.
|
*/
|
OdDbLinetypeTableIterator();
|
OdDbLinetypeTableIterator( OdDbSymbolTableIteratorImpl* pImpl );
|
};
|
|
/** \details
|
The typified smart pointer for the /linetype iterator/ object. This template class is specialization
|
of the OdSmartPtr class for the OdDbLinetypeTableIterator object.
|
|
\sa
|
<link smart_pointers.html, Working with Smart Pointers>
|
*/
|
typedef OdSmartPtr<OdDbLinetypeTableIterator> OdDbLinetypeTableIteratorPtr;
|
|
|
/** \details
|
<group OdDb_Classes>
|
|
This class implements the /linetype table/ object, which represents a container for storing
|
and accessing of /linetype record/ objects in the database. This class inherits the base
|
functionality of predefined tables.
|
|
\sa
|
TD_Db
|
|
\sa
|
<link db_linetype_sample_table.html, Example of Working with the Linetype Table Object>
|
|
<link db_linetype_sample_record.html, Example of Working with the Linetype Record Object>
|
|
\sa
|
<link db_linetype.html, Working with Linetypes>
|
|
OdDbLinetypeTableRecord class
|
*/
|
class TOOLKIT_EXPORT OdDbLinetypeTable : public OdDbSymbolTable
|
{
|
public:
|
ODDB_DECLARE_MEMBERS(OdDbLinetypeTable);
|
|
/** \details
|
Builds an instance of the /linetype table/ object.
|
|
Applications typically will not use this constructor, insofar as the database object
|
creates own instance of the linetype table. The /linetype table/ object exists in the
|
database a prior.
|
*/
|
OdDbLinetypeTable();
|
|
|
/** \details
|
Gets a /linetype record/ object from the /linetype table/ object. This method is inherited
|
from the OdDbSymbolTable class which is base class for all predefined tables. For more details,
|
see: OdDbSymbolTable::getAt() method.
|
*/
|
virtual OdDbObjectId getAt( const OdString& recordName,
|
bool getErasedRecord = false) const;
|
OdDbSymbolTableRecordPtr getAt( const OdString& recordName,
|
OdDb::OpenMode openMode,
|
bool getErasedRecord = false) const;
|
|
/** \details
|
Checks whether the /linetype table/ object contains the /linetype record/ object specified by
|
the name or Object ID. This method is inherited from the OdDbSymbolTable class which is base
|
class for all predefined tables. For more details, see: OdDbSymbolTable::has() method.
|
*/
|
bool has( const OdString& recordName ) const;
|
bool has( const OdDbObjectId& objectId ) const;
|
|
|
/** \details
|
Adds an instance of the /linetype record/ object in the container of the /linetype table/ object.
|
This method is inherited from the OdDbSymbolTable class which is base class for all predefined
|
tables. For more details, see: OdDbSymbolTable::add() method.
|
*/
|
virtual OdDbObjectId add( OdDbSymbolTableRecord* pRecord );
|
|
|
/** \details
|
Creates an instance of the /linetype iterator/ object which is the bidirectional iterator for
|
traversing through /linetype record/ objects in the container of the /linetype table/ object.
|
This method is inherited from the OdDbSymbolTable class which is base class for all predefined
|
tables. For more details, see: OdDbSymbolTable::newIterator() method.
|
*/
|
OdDbSymbolTableIteratorPtr newIterator(
|
bool atBeginning = true,
|
bool skipDeleted = true) const;
|
|
|
/** \details
|
Returns the Object ID of the predefined linetype record object assigned as "ByLayer" linetype
|
in the database.
|
|
\sa
|
<link db_linetype_collection.html, Organization of Linetypes>
|
|
OdDbDatabase::getLinetypeByLayerId(), OdDbDatabase::getLinetypeByBlockId(),
|
OdDbDatabase::getLinetypeContinuousId() methods
|
*/
|
const OdDbObjectId& getLinetypeByLayerId() const;
|
|
/** \details
|
Returns the Object ID of the predefined linetype record object assigned as "ByBlock" linetype
|
in the database.
|
|
\sa
|
<link db_linetype_collection.html, Organization of Linetypes>
|
|
OdDbDatabase::getLinetypeByLayerId(), OdDbDatabase::getLinetypeByBlockId(),
|
OdDbDatabase::getLinetypeContinuousId() methods
|
*/
|
const OdDbObjectId& getLinetypeByBlockId() const;
|
|
|
virtual OdResult subGetClassID( void* pClsid ) const;
|
|
virtual OdResult dwgInFields( OdDbDwgFiler* pFiler );
|
|
virtual void dwgOutFields( OdDbDwgFiler* pFiler ) const;
|
|
virtual void dxfOut( OdDbDxfFiler* pFiler ) const;
|
|
/*
|
virtual OdResult dxfInFields(OdDbDxfFiler* pFiler);
|
virtual void dxfOutFields(OdDbDxfFiler* pFiler) const;
|
*/
|
};
|
|
/** \details
|
The typified smart pointer for the /linetype table/ object. This template class is specialization
|
of the OdSmartPtr class for the OdDbLinetypeTable object.
|
|
\sa
|
<link smart_pointers.html, Working with Smart Pointers>
|
*/
|
typedef OdSmartPtr<OdDbLinetypeTable> OdDbLinetypeTablePtr;
|
|
#include "TD_PackPop.h"
|
|
#endif // _ODDBLINETYPETABLE_INCLUDED
|
