co_cdh.h File Reference

Include file for Cdh Class definition handler. More...

#include <limits.h>
#include "pwr_class.h"
#include "co_math.h"

Go to the source code of this file.

Classes
struct	cdh_mOid
	Internal representatin of object identity. More...
struct	cdh_mRid
	Internal representation of reference identity. More...
struct	cdh_mVid
	Internal representations of volume identity. More...
struct	cdh_mNid
	Internal representation of node identity. More...
struct	cdh_mClassObjid
	Internal representation of $ClassDef object identity. More...
struct	cdh_mCid
	Internal represention of class identity. More...
struct	cdh_mTypeObjid
	Internal representation of $TypeDef object identity. More...
struct	cdh_mTid
	Internal representation of type identity. More...
union	cdh_uOid
	Type for representions of object identity. More...
union	cdh_uRid
	Type for representations of reference identity. More...
union	cdh_uTid
	Type for representation of type identity. More...
union	cdh_uVid
	Type for representation of volume identity. More...
union	cdh_uNid
	Type for representation of node identity. More...
union	cdh_uId
	Union for identities. More...
union	cdh_uPackName
	Pack name. More...
struct	cdh_sObjName
	Object name struct. More...
struct	cdh_sFamily
	Family struct. More...
union	cdh_mParseName
	Parse name mask. More...
union	cdh_mName
	Name string format description. More...
struct	cdh_sParseName
	Parse name struct. More...

Macros
#define	cdh_CidToVid(cid)   ((cid) >> 16)
	Get volme identity for class identity.
#define	cdh_TidToVid(tid)   ((tid) >> 16)
	Get volume identity for type identity.
#define	cdh_cixToCid(Vid, Cix)   (0 + ((Vid) << 16) + ((Cix) << 3))
	Get class identity for class index.
#define	cdh_cidToCix(Cid)   (((Cid) >> 3) & 0xfff)
	Get class index from class identity.
#define	cdh_tixToTid(Vid, Tyg, Tix)    (0 + ((Vid) << 16) + (1 << 15) + ((Tyg) << 11) + (Tix))
	Get type identity for type index.
#define	cdh_cixToOix(Cix, Bix, Aix)    (0 + (1 << 31) + ((Cix) << 18) + ((Bix) << 15) + (Aix))
	Get object index for class index.
#define	cdh_tixToOix(Tyg, Tix)    (0 + (1 << 31) + (1 << 30) + ((Tyg) << 26) + ((Tix) << 15))
	Get object index for type index.
#define	cdh_oixToBix(Oix)   ((pwr_eBix)(((Oix) >> 15) & 7))
	Get object index for body index.
#define	cdh_oixToCix(Oix)   (((Oix) >> 18) & 0xfff)
	Get class index for object index.
#define	cdh_oixToAix(Oix)   ((Oix)&0xfff)
	Get attribute index for object index.
#define	cdh_cidToBid(Cid, Bix)   ((Cid) & (Bix))
	Get bodyid from classid.
#define	cdh_bidToBix(Bid)   ((Bid)&7)
	Get bix from bodyid.
#define	cdh_tidIsCid(Tid)   (((Tid) & (1 << 15)) == 0)
	Check if type id is a class id.
#define	cdh_cUserVolMin    (0 + ((pwr_tVolumeId)0 << 24) + (1 << 16) + (1 << 8) + 1)
	Smallest value of volume identity for user volumes.
#define	cdh_cUserVolMax    (0 + ((pwr_tVolumeId)0 << 24) + (254 << 16) + (254 << 8) + 254)
	Largest value of volume identity for user volumes.
#define	cdh_cManufactClassVolMin    (0 + ((pwr_tVolumeId)0 << 24) + (0 << 16) + (250 << 8) + 0)
	Smallest value of volume identity for manufacturer classvolumes.
#define	cdh_cManufactClassVolMax    (0 + ((pwr_tVolumeId)0 << 24) + (0 << 16) + (254 << 8) + 254)
	Largest value of volume identity for manufacturer classvolumes.
#define	cdh_cUserClassVolMin    (0 + ((pwr_tVolumeId)0 << 24) + (0 << 16) + (2 << 8) + 1)
	Smallest value of volume identity for user classvolumes.
#define	cdh_cUserClassVolMax    (0 + ((pwr_tVolumeId)0 << 24) + (0 << 16) + (249 << 8) + 254)
	Largest value of volume identity for user classvolumes.
#define	cdh_cSystemClassVolMin    (0 + ((pwr_tVolumeId)0 << 24) + (0 << 16) + (0 << 8) + 1)
	Smallest value of volume identity for system classvolumes.
#define	cdh_cSystemClassVolMax    (0 + ((pwr_tVolumeId)0 << 24) + (0 << 16) + (1 << 8) + 254)
	Largest value of volume identity for system classvolumes.

Typedefs
typedef cdh_mOid	cdh_mObjid
	Internal representation of object identity.
typedef cdh_mRid	cdh_mRefId
	Internal representation of reference identity.
typedef cdh_mVid	cdh_mVolumeId
	Internal representation of volume identity.
typedef cdh_mNid	cdh_mNodeId
	Internal representation of node identity.
typedef cdh_mCid	cdh_mClassId
	Internal representation of class identity.
typedef cdh_mTid	cdh_mTypeId
	Internal representation of type identity.
typedef cdh_uOid	cdh_uObjid
	Type for representations of object identity.
typedef cdh_uRid	cdh_uRefId
	Type for representation of reference identity.
typedef cdh_uTid	cdh_uTypeId
	Type for representation of type identity.
typedef cdh_uVid	cdh_uVolumeId
	Type for represenation of volume identity.
typedef cdh_uNid	cdh_uNodeId
	Type for representation of node idenity.

Enumerations
enum	cdh_eId { }
	Enumeration for identities. More...

Functions
int	cdh_ObjidCompare (pwr_tOid Object_1, pwr_tOid Object_2)
	Compare two object identities. More...
int	cdh_ObjidIsEqual (pwr_tOid Object_1, pwr_tOid Object_2)
	Test if two object identities are equal. More...
int	cdh_ObjidIsNotEqual (pwr_tOid Object_1, pwr_tOid Object_2)
	Test if two object identities are different. More...
int	cdh_ObjidIsNull (pwr_tOid Object)
	Test if object identity is null. More...
int	cdh_ObjidIsNotNull (pwr_tOid Object)
	Test if object identity is not null. More...
pwr_tCid	cdh_ClassObjidToId (pwr_tOid Object)
	Convert Objid to ClassId. More...
pwr_tOid	cdh_ClassIdToObjid (pwr_tCid Class)
	Convert ClassId to Objid. More...
pwr_tTid	cdh_TypeObjidToId (pwr_tOid Object)
	Convert Objid to TypeId. More...
int	cdh_TypeIdToIndex (pwr_tTid Type)
	Convert TypeId to index.
pwr_tOid	cdh_TypeIdToObjid (pwr_tTid Type)
	Convert TypeId to Objid.
pwr_sAttrRef	cdh_ObjidToAref (pwr_tObjid Objid)
	Converts an objid to an attrref.
pwr_tStatus	cdh_AttrValueToString (pwr_eType Type, void *Value, char *String, int MaxSize)
	Converts an attribute given in internal binary format to a text string.
pwr_tStatus	cdh_StringToAttrValue (pwr_eType Type, const char *String, void *Value)
void	cdh_MaskToBinaryString (unsigned int mask, int noofbits, char *str)
pwr_tStatus	cdh_StringToClassId (const char *s, pwr_tCid *cid)
	Convert ClassId string to id. More...
pwr_tStatus	cdh_StringToTypeId (const char *s, pwr_tTid *tid)
	Convert TypeId string to id. More...
pwr_tStatus	cdh_StringToVolumeId (const char *s, pwr_tVid *tid)
	Convert VolumeId string to id. More...
pwr_tStatus	cdh_StringToObjectIx (const char *s, pwr_tOix *oix)
	Converts ObjectIx string to index. More...
pwr_tStatus	cdh_StringToObjid (const char *s, pwr_tOid *oid)
	Convert Objid string to id. More...
pwr_tStatus	cdh_StringToAref (const char *s, pwr_tAttrRef *aref)
	Convert AttrRef string to id. More...
void	cdh_ClassIdToString (char *s, int size, pwr_tCid cid, int prefix)
	Converts a class identifier, 'cid' to a string. More...
void	cdh_ObjectIxToString (char *s, int size, pwr_tOix oix, int prefix)
	Converts a object index, 'oix' to a string. More...
void	cdh_OidToString (char *s, int size, pwr_tOid oid, int prefix)
	Converts a object identifier, 'oid' to a string. More...
char *	cdh_ObjidToString (pwr_tOid oid, int prefix)
	Converts a object identifier, 'oid' to a string. More...
char *	cdh_ObjidToFnString (char *s, pwr_tOid oid)
	Converts a object identifier, 'oid' to a filename string. More...
void	cdh_ArefToString (char *s, int size, pwr_sAttrRef *aref, int prefix)
	Converts an attribute reference , 'aref' to a string. More...
char *	cdh_AttrRefToString (pwr_sAttrRef *aref, int prefix)
	Converts an attribute reference , 'aref' to a string. More...
char *	cdh_NodeIdToString (char *s, pwr_tNid nid, int prefix, int suffix)
	Converts a volume identifier, 'vid' to a string. More...
void	cdh_TypeIdToString (char *s, int size, pwr_tTid tid, int prefix)
	Converts a type identifier, 'tid' to a string. More...
char *	cdh_VolumeIdToString (char *s, int size, pwr_tVid vid, int prefix, int suffix)
	Converts a volume identifier, 'vid' to a string. More...
char *	cdh_VolumeIdToFnString (char *s, int size, pwr_tVolumeId vid)
	Converts a volume identifier, 'vid' to a filename string. More...
void	cdh_SubidToString (char *s, int size, pwr_tSubid sid, int prefix)
	Converts a subscription identifier, 'sid' to a string. More...
void	cdh_DlidToString (char *s, int size, pwr_tDlid did, int prefix)
	Converts a direct link identifier, 'did' to a string. More...
char *	cdh_Low (const char *s)
	Convert string to lower case. More...
char *	cdh_OpSysToStr (pwr_mOpSys opsys)
	Convert operating system to string. More...
char *	cdh_OpSysToDirStr (pwr_mOpSys opsys)
	Convert operating system to directory string. More...
char *	cdh_StringToObjectName (char *t, const char *s)
	Convert string to valid object name. More...
pwr_tStatus	cdh_NextObjectName (char *t, const char *s)
	Create an similar objectname from another object name. More...
void	cdh_CutNameSegments (char *outname, char *name, int segments)
	Cut the leading segments of an object name. More...
pwr_tUInt32	cdh_AttrSize (pwr_sParInfo *info)
	Get attribute size. More...
pwr_tUInt32	cdh_AttrElemSize (pwr_sParInfo *info)
	Get attribute array element size. More...

Detailed Description

Include file for Cdh Class definition handler.

Definition in file co_cdh.h.