Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [%SYS] >  [Config] >  [GenericMapProperties]
Private  Storage   

class Config.GenericMapProperties

This class contains properties which are included by classes which manipulate namespace mappings in the CPF file.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 7 1 1


Summary

Properties
CPFFile CPFName Comments Flags ID
Name SectionHeader

Methods
CPFFileSet

Subclasses
Config.MapMirrors Config.MapShadows

Parameters

• parameter DOMAIN = "%Utility";
Default Localization Domain

Properties

• property CPFFile as %String(MAXLEN=255,MINLEN=1) [ InitialExpression = $p($zu(86),"*"),Transient ];
CPF file which the object maps to.
• property CPFName as %String(MAXLEN=255,MINLEN=1) [ InitialExpression = ##Class(Config.CPF).GetName($p($zu(86),"*")),Required ];
Internal name of the CPF file.
This property should not be set directly. It is updated when the CPFFile property is set.
When the CPFFile property is set, the CPFFile name dictates what is set here as follows:
c:\abc\IRIS.cpf ---> IRIS
/abc/iris.cpf ---> iris
• property Comments as list of CommentList;
Embedded comments in the CPF file.
• property Flags as %Integer [ InitialExpression = 7,Transient ];
Flags governing how the object is processed when %Save() is called.
For normal operations, all bits should be set.
Bit $$$CPFSave - Save object to disk.
Bit $$$CPFWrite - Write CPF file from object.
Bit $$$CPFActivate - Activate object into memory if CPFFile is the same as what is currently active.
• property ID as %String(MAXLEN=64,MINLEN=1) [ Required ];
ID where the mapping is.
• property Name as %String(MAXLEN=128,MINLEN=1) [ Required ];
Name of the mapping.
• property SectionHeader as %String(MAXLEN=255,MINLEN=1) [ Required ];
Set to the name of the class.

Methods

• method CPFFileSet(Val) as %Status
When the CPF file gets set, convert the file to an internal name, and store it as part of the index.
Basically, this strips off the directory specification and the .CPF file extension, and uses the resulting name as part of the index. On windows and VMS, the name is uppercased, on unix it is not. For example:

c:\abc\IRIS.cpf ---> IRIS
/abc/iris.cpf ---> iris
NOTE: This is the same code which exists in Config.CommonProperties

Indices

•index (CPFNameSectionHeaderIDName on CPFName,SectionHeader,ID,Name) [IdKey,Unique];


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.