Skip to main content

Config.CommonMapProperties

Class Config.CommonMapProperties [ System = 4 ]

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

Parameters​

DOMAIN​

Parameter DOMAIN = "%Utility";

Default Localization Domain

Properties​

Comments​

Property Comments As list Of CommentList;

Embedded comments in the CPF file.

CPFFile​

Property CPFFile As %String(MAXLEN = 255, MINLEN = 1) [ InitialExpression = {$p($zu(86),"*")}, Transient ];

CPF file which the object maps to.

CPFName​

Property CPFName As %String(MAXLEN = 255, MINLEN = 1) [ InitialExpression = {##Class(Config.CPF).GetName($p($zu(86),"*"))}, Internal, 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

Flags​

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.

Name​

Property Name As %String(MAXLEN = 128, MINLEN = 1) [ Required ];

Name of the mapping.

Namespace​

Property Namespace As %String(MAXLEN = 64, MINLEN = 1) [ Required ];

Namespace where the mapping is.

SectionHeader​

Property SectionHeader As %String(MAXLEN = 255, MINLEN = 1) [ Internal, Required ];

Set to the name of the class.

Methods​

CPFFileSet​

Method CPFFileSet(Val) As %Status [ Internal ]

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

NamespaceSet​

Method NamespaceSet(Val) As %Status [ Internal ]

Force the Namespace name to be uppercase.