Public Member Functions | List of all members
CoordinateSystemList Class Reference

CoordinateSystemList class is used to control the list of CoordinateSystem objects. It allows coordinate systems to be created, duplicated, and deleted.
The class can be called from Model class.
. More...

Public Member Functions

CoordinateSystemCreateCylindrical (String &name)
 Creates a cylindrical coordinate system. More...
 
CoordinateSystemCreateRectangular (String &name)
 Creates a rectangular coordinate system. More...
 
void DeleteCoordinateSystem (Variant &var)
 Deletes a coordinate system by specifying the name or index. More...
 
CoordinateSystemDuplicateCoordinateSystem (Variant &var)
 Duplicates a coordinate system by specifying the name or index of the coordinate system. More...
 
CoordinateSystemGetCoordinateSystem (Variant &var)
 Returns the settings of the coordinate system for the specified name or index. More...
 
bool IsValid ()
 Returns True if an object is valid. More...
 
int NumCoordinateSystems ()
 Returns the number of the coordinate systems as an integer. More...
 

Detailed Description

CoordinateSystemList class is used to control the list of CoordinateSystem objects. It allows coordinate systems to be created, duplicated, and deleted.
The class can be called from Model class.
.

Example of obtaining the class object:

app.GetModel(0).GetCoordinateSystemList()

Member Function Documentation

CoordinateSystem * CoordinateSystemList::CreateCylindrical ( String &  name)

Creates a cylindrical coordinate system.

Parameters
nameName of the coordinate system
Returns
CoordinateSystem object
CoordinateSystem * CoordinateSystemList::CreateRectangular ( String &  name)

Creates a rectangular coordinate system.

Parameters
nameName of the coordinate system
Returns
CoordinateSystem object
void CoordinateSystemList::DeleteCoordinateSystem ( Variant &  var)

Deletes a coordinate system by specifying the name or index.

Parameters
varCoordinate system name/Coordinate system index
CoordinateSystem * CoordinateSystemList::DuplicateCoordinateSystem ( Variant &  var)

Duplicates a coordinate system by specifying the name or index of the coordinate system.

Parameters
varCoordinate system name/Coordinate system index
Returns
CoordinateSystem object
CoordinateSystem * CoordinateSystemList::GetCoordinateSystem ( Variant &  var)

Returns the settings of the coordinate system for the specified name or index.

Parameters
varCoordinate system name/Coordinate system index
Returns
CoordinateSystem object
bool CoordinateSystemList::IsValid ( )

Returns True if an object is valid.

Returns
Whether or not the CoordinateSystemList objects in the list are valid
int CoordinateSystemList::NumCoordinateSystems ( )

Returns the number of the coordinate systems as an integer.

Returns
Number of the coordinate systems