Class EsentShapeInstanceCursor

Provides a table of instantiations of shapes at specific tranformations

Inheritance

System.Object

EsentCursor

EsentShapeInstanceCursor

Implements

System.IDisposable

Inherited Members

EsentCursor.TransactionBatchSize

EsentCursor.Instance

EsentCursor.Sesid

EsentCursor.DbId

EsentCursor.Table

EsentCursor.Model

EsentCursor.GlobalsTable

EsentCursor.GlobalsTableName

EsentCursor.EntityCountColumnName

EsentCursor.GeometryCountColumnName

EsentCursor.FlushColumnName

EsentCursor.EntityCountColumn

EsentCursor.GeometryCountColumn

EsentCursor.FlushColumn

EsentCursor.IfcHeaderColumn

EsentCursor.VersionColumnName

EsentCursor.Version

EsentCursor.Session

EsentCursor.LockObject

EsentCursor.ReadOnly

EsentCursor.CreateGlobalsTable(JET_SESID, JET_DBID)

EsentCursor.BeginLazyTransaction()

EsentCursor.BeginReadOnlyTransaction()

EsentCursor.Dispose(Boolean)

EsentCursor.Dispose()

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Xbim.IO.Esent

Assembly: Xbim.IO.Esent.dll

Syntax

public class EsentShapeInstanceCursor : EsentCursor, IDisposable

Constructors

| Improve this Doc View Source

EsentShapeInstanceCursor(EsentModel, String)

Declaration

public EsentShapeInstanceCursor(EsentModel model, string database)

Parameters

Type	Name	Description
EsentModel	model
System.String	database

| Improve this Doc View Source

EsentShapeInstanceCursor(EsentModel, String, OpenDatabaseGrbit)

Declaration

public EsentShapeInstanceCursor(EsentModel model, string database, OpenDatabaseGrbit mode)

Parameters

Type	Name	Description
EsentModel	model
System.String	database
Microsoft.Isam.Esent.Interop.OpenDatabaseGrbit	mode

Fields

| Improve this Doc View Source

InstanceTableName

shape geometry table name

Declaration

public static string InstanceTableName

Field Value

Type	Description
System.String

Methods

| Improve this Doc View Source

AddInstance(Int32, Int32, Int32, Int16, Int32, XbimGeometryRepresentationType, Byte[])

Adds a shape instanceData to the database table

Declaration

public int AddInstance(int ctxtId, int shapeLabel, int styleLabel, short typeId, int productLabel, XbimGeometryRepresentationType repType, byte[] transform)

Parameters

Type	Name	Description
System.Int32	ctxtId
System.Int32	shapeLabel
System.Int32	styleLabel
System.Int16	typeId
System.Int32	productLabel
XbimGeometryRepresentationType	repType
System.Byte[]	transform

Returns

Type	Description
System.Int32

| Improve this Doc View Source

AddInstance(IXbimShapeInstanceData)

Declaration

public int AddInstance(IXbimShapeInstanceData instanceData)

Parameters

Type	Name	Description
IXbimShapeInstanceData	instanceData

Returns

Type	Description
System.Int32

| Improve this Doc View Source

SkipSurfaceStyes(Int32)

Skips all instances of skipstlye and returns in the next SurfaceStyle

Declaration

public int SkipSurfaceStyes(int skipStyle)

Parameters

Type	Name	Description
System.Int32	skipStyle

Returns

Type	Description
System.Int32

| Improve this Doc View Source

TryMoveFirstProductType(Int32, out Int16)

Returns the first product type in the specified context

Declaration

public bool TryMoveFirstProductType(int context, out short productType)

Parameters

Type	Name	Description
System.Int32	context
System.Int16	productType

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

TryMoveFirstSurfaceStyle(Int32, out Int32, out Int16)

Returns the first surface style in the specified context, -1 if no styles exists

Declaration

public bool TryMoveFirstSurfaceStyle(int context, out int surfaceStyle, out short productType)

Parameters

Type	Name	Description
System.Int32	context
System.Int32	surfaceStyle
System.Int16	productType

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

TryMoveNextProductType(out Int16)

Returns the next product type in the specified context, assumes TryMoveFirstSurfaceStyle was the last call on this cursor

Declaration

public bool TryMoveNextProductType(out short productType)

Parameters

Type	Name	Description
System.Int16	productType

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

TryMoveNextShapeInstance(ref IXbimShapeInstanceData)

Moves the cursor to the next shape instanceData that meets the criteria of the previous TrySeek call

Declaration

public bool TryMoveNextShapeInstance(ref IXbimShapeInstanceData si)

Parameters

Type	Name	Description
IXbimShapeInstanceData	si

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

TryMoveNextSurfaceStyle(out Int32, out Int16)

Returns the next surface style in the specified context, assumes TryMoveFirstSurfaceStyle was the last call on this cursor

Declaration

public bool TryMoveNextSurfaceStyle(out int surfaceStyle, out short productType)

Parameters

Type	Name	Description
System.Int32	surfaceStyle
System.Int16	productType

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

TrySeekProductType(Int16, ref IXbimShapeInstanceData)

Declaration

public bool TrySeekProductType(short productType, ref IXbimShapeInstanceData shapeInstance)

Parameters

Type	Name	Description
System.Int16	productType
IXbimShapeInstanceData	shapeInstance

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

TrySeekShapeInstance(Int32, ref IXbimShapeInstanceData)

xbimShapeInstanceData will contain the first shape instanceData in the specified context

Declaration

public bool TrySeekShapeInstance(int context, ref IXbimShapeInstanceData si)

Parameters

Type	Name	Description
System.Int32	context
IXbimShapeInstanceData	si

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

TrySeekShapeInstanceOfGeometry(Int32, ref IXbimShapeInstanceData)

xbimShapeInstanceData will contain the first shape instanceData of the specified product label

Declaration

public bool TrySeekShapeInstanceOfGeometry(int shapeGeometryLabel, ref IXbimShapeInstanceData si)

Parameters

Type	Name	Description
System.Int32	shapeGeometryLabel
IXbimShapeInstanceData	si

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

TrySeekShapeInstanceOfProduct(Int32)

Return whether the product has any instances

Declaration

public bool TrySeekShapeInstanceOfProduct(int product)

Parameters

Type	Name	Description
System.Int32	product

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

TrySeekShapeInstanceOfProduct(Int32, ref IXbimShapeInstanceData)

xbimShapeInstanceData will contain the first shape instanceData of the specified product label

Declaration

public bool TrySeekShapeInstanceOfProduct(int product, ref IXbimShapeInstanceData si)

Parameters

Type	Name	Description
System.Int32	product
IXbimShapeInstanceData	si

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

TrySeekSurfaceStyle(Int32, Int32, ref IXbimShapeInstanceData)

Declaration

public bool TrySeekSurfaceStyle(int context, int surfaceStyle, ref IXbimShapeInstanceData shapeInstance)

Parameters

Type	Name	Description
System.Int32	context
System.Int32	surfaceStyle
IXbimShapeInstanceData	shapeInstance

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

UpdateCount(Int32)

Update the count of geometry entities in the globals table. This is done with EscrowUpdate so that there won't be any write conflicts.

Declaration

protected override void UpdateCount(int delta)

Parameters

Type	Name	Description
System.Int32	delta	The delta to apply to the count.

Overrides

EsentCursor.UpdateCount(Int32)

Implements

System.IDisposable