Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Public Attributes | Private Attributes | List of all members
Abstract Class Reference

Abstract Alias. More...

Inheritance diagram for Abstract:
Set Universe

Abstract Alias.

Use subclasses to create a GAMS Alias, see subclass help.

See also
alias.Set, alias.Universe

Public Member Functions

function copy (in obj, in varargin)
 (Abstract) Copies symbol to destination container
 
function equals (in obj, in symbol)
 Checks equivalence with other symbol.
 
function isValid (in obj, in varargin)
 (Abstract) Checks correctness of alias
 
function getUELs (in obj, in varargin)
 (Abstract) Returns the UELs used in this symbol
 
function removeUELs (in obj, in varargin)
 (Abstract) Removes UELs from the symbol
 
function renameUELs (in obj, in uels)
 (Abstract) Renames UELs in the symbol
 
function lowerUELs (in obj)
 (Abstract) Converts UELs to lower case
 
function upperUELs (in obj)
 (Abstract) Converts UELs to lower case
 

Static Public Member Functions

static function describe (in symbols)
 Returns an overview over all aliases given.
 

Public Attributes

Property container
 Container the symbol is stored in.
 
Property name
 Alias name.
 
Property alias_with
 (Abstract) Aliased symbol
 
Property description
 (Abstract) Aliased GAMS Set description
 
Property is_singleton
 (Abstract) Indicator if aliased GAMS Set is singleton
 
Property dimension
 (Abstract) Aliased GAMS Set dimension (in [0,20])
 
Property size
 (Abstract) Aliased GAMS Set Shape (length == dimension)
 
Property domain
 (Abstract) Aliased GAMS Set domain (length == dimension)
 
Property domain_labels
 (Abstract) Expected domain labels in records
 
Property domain_forwarding
 (Abstract) Enables domain forwarding in aliased symbol
 
Property records
 (Abstract) Storage of aliased Set records
 
Property modified
 Flag to indicate modification.
 

Private Attributes

Property domain_names
 (Abstract) Aliased GAMS Set domain names
 
Property domain_type
 (Abstract) Specifies if domains are stored 'relaxed' or 'regular'
 
Property format
 (Abstract) Records format of aliased Set records
 

Member Function Documentation

◆ copy()

function copy ( in  obj,
in  varargin 
)

(Abstract) Copies symbol to destination container

If destination container does not have a symbol equal to the aliased symbol, an error is raised.

Required Arguments:

  1. destination (Container): Destination container

Optional Arguments:

  1. overwrite (bool): Overwrites symbol with same name in destination if true. Default: false.

◆ describe()

static function describe ( in  symbols)
static

Returns an overview over all aliases given.

See Symbol Overview for more information.

Required Arguments:

  1. symbols (list): List of aliases to include.

The overview is in form of a table listing for each symbol its main characteristics and some statistics.

◆ equals()

function equals ( in  obj,
in  symbol 
)

Checks equivalence with other symbol.

Note
A symbol is always linked to a container. This method does not check equivalence of the linked containers.

Required Arguments:

  1. symbol (any): Other symbol

◆ isValid()

function isValid ( in  obj,
in  varargin 
)

(Abstract) Checks correctness of alias

Optional Arguments:

  1. verbose (logical): If true, the reason for an invalid symbol is printed
  2. force (logical): If true, forces reevaluation of validity (resets cache)

Member Data Documentation

◆ modified

Property modified

Flag to indicate modification.

If the symbol has been modified since last reset of flag (false), this flag will be true.