Software Customisation
Reference Manual
Summary of Objects, Members and Methods
:
Object Type Details
: PLATFORMGRID
PLATFORMGRID
PLATFORMGRID object is used for filling PLTFRM element with certain grid pattern.
Name
Result
Purpose
ASSIGN(PLATFORMGRID)
NO RESULT
Copies content of a PLATFORMGRID object into current instance
GRIDANGLE()
REAL
Returns the used grid angle value
GRIDANGLE(REAL)
NO RESULT
Sets grid angle value
GRIDPOINT(REAL1, REAL2)
NO RESULT
Returns position of the intersection of gridlines: X (identified by given index - REAL1) and Y (identified by given index -REAL2)
GRIDPOSITION()
POSITION
Returns the grid's origin
GRIDXSPACINGS()
ARRAY
Returns the grid's spacing pattern along X axe
GRIDXSPACINGS(ARRAY)
NO RESULT
Sets the grid's spacing pattern along X axe
GRIDXYPOSITION()
XYPOSITION
Returns position of grid's origin
GRIDXYPOSITION(XYPOSITION)
NO RESULT
Sets the position of grid
GRIDXYSIZE()
REAL ARRAY
Returns the size of rectangle which contains the grid
GRIDYSPACINGS()
REAL ARRAY
Returns the grid's spacing pattern along Y axe
GRIDYSPACINGS(ARRAY)
NO RESULT
Sets the grid's spacing pattern along Y axe
GROSSAREA()
REAL
Returns the gross area of the grid
NETAREA()
REAL
Returns the net area of the grid
ORIENTATION()
ORIENTATION
Returns the platform's orientation
ORIENTATION(ORIENTATION)
NO RESULT
Sets the platform's orientation for given value
PLANE()
PLANE
Return the plane definition of platform grid. This is equivalent of PLANE method on PROFILE object
PLATFORMGRID()
PLATFORMGRID
Create a platformgrid object.
PLATFORMGRID(DBREF)
PLATFORMGRID
Creates a platformgrid from DBREF. DBREF must be PLTGRD or INTFRM element. The outer boundary is created from owning PLTFRM routing path (RPATH). Inner boundaries are created from PLOPEN elements
POSITION()
POSITION
Returns position of the platform
POSITION(POSITION)
NO RESULT
Sets the grid's position
XYSIZE()
ARRAY
Returns the size of rectangle (limits) which contains the grid in platform coordinate system
Methods that are performing operations on grid boundaries
Name
Result
Purpose
ADDINNERBOUNDARY(PROFILE)
NO RESULT
Adds new inner boundary to the grid
CLEARINNERBOUNDARY()
NO RESULT
Deletes all inner boundaries
INNERBOUNDARIES()
PROFILE ARRAY
Returns array of inner boundaries profiles
INNERBOUNDARIES(ARRAY)
NO RESULT
Replaces the inner boundaries
INNERBOUNDARY(REAL)
PROFILE
Returns the profile of the inner boundary
NUMBEROFINNERBOUNDARIES()
REAL
Returns the number of grid's inner boundaries
OUTERBOUNDARY()
PROFILE
Returns the outer boundary profile
Methods that return information about grids cells
Each cell is identified by index of two REAL.
Name
Result
Purpose
CELLORIENTATION(REAL1, REAL2)
ORIENTATION
Returns an orientation of cell identified by given index.
CELLPOSITION(REAL1, REAL2)
POSITION
Returns a position of cell identified by given index
CELLPROFILE(REAL1, REAL2)
PROFILE
Returns a profile of cell identified by given index
CELLSIZE(REAL1, REAL2)
REAL ARRAY
Returns the size of cell identified by given index (before trimming)
CELLXYPOSITION(REAL1, REAL2)
POSITION
Returns position of the cell identified by given index
ISCELLTRIMMED(REAL1, REAL2)
BOOL
Returns true if cell is trimmed
ISCELLUNTRIMMED(REAL1, REAL2)
BOOL
Returns true if cell is untrimmed
ISCELLWITHIN(REAL1, REAL2)
BOOL
Returns true if cell is within grid
LISTOFTRIMMEDCELLS()
ARRAY
Returns indices of all trimmed cells
LISTOFTRIMMEDCELLS(REAL)
ARRAY
Returns indices of all trimmed cells which area is greater than given REAL value
LISTOFUNTRIMMEDCELLS()
ARRAY
Returns indices of all untrimmed cells
TOTALNUMBEROFCELLS()
REAL
Returns a number of cells inside grid
TRIMMEDCELLSIZE(REAL1, REAL2)
ARRAY
Returns the size of rectangle which contains the cell identified by given index
Methods that return information of gridlines
Lines are returned as ARRAY which first element is REAL representing line number and the second is array of LINE objects.
Name
Result
Purpose
XGRIDLINES()
ARRAY
Returns array of grid's x-lines
XGRIDLINES(REAL)
ARRAY
Returns array of grid's x-lines of given index
YGRIDLINES()
ARRAY
Returns array of grid's y-lines
YGRIDLINES(REAL)
ARRAY
Returns array of grid's y-lines of given index
1974 to current year.
AVEVA Solutions Limited and its subsidiaries. All rights reserved.