Utility class for parsing a type ID that follows the NT type ID conventions. More...

#include "ntid.h"

Public Member Functions
	NTID (const std::string &id)

std::string	getFullName ()

std::string	getQualifiedName ()

std::string	getNamespace ()

std::string	getName ()

std::string	getVersion ()

std::string	getMajorVersionString ()

bool	hasMajorVersion ()

int	getMajorVersion ()

std::string	getMinorVersionString ()

bool	hasMinorVersion ()

int	getMinorVersion ()

Detailed Description

Utility class for parsing a type ID that follows the NT type ID conventions.

An NT type ID will be of the from

epics:nt/<type-name>:<Major>.<Minor>

e.g.

epics:nt/NTNDArray:1.2

Author: dgh

Definition at line 28 of file ntid.h.

Constructor & Destructor Documentation

epics::nt::NTID::NTID ( const std::string & id )

Creates an NTID from the specified type ID.

Parameters

id	the the ID to be parsed.

Returns: NTNDArray instance on success, null otherwise.

Definition at line 16 of file ntid.cpp.

     : fullName(id),
       qualifiedName(BAD_NAME),
       namespaceStr(BAD_NAME),
       name(BAD_NAME),
       version(BAD_NAME),
       nsSepIndex(std::string::npos),
       versionSepIndex(std::string::npos),
       nsQualified(false),
       hasVersion(false),
       endMajorIndex(0),
       majorVersionStr(BAD_NAME),
       majorVersionParsed(false),
       hasMajor(false),
       majorVersion(0),
 
       endMinorIndex(0),
       minorVersionStr(BAD_NAME),
       minorVersionParsed(false),
       hasMinor(false),
       minorVersion(0)
     {
         nsSepIndex = id.find('/');
         nsQualified = nsSepIndex != std::string::npos;
         size_t startIndex = nsQualified ? nsSepIndex+1 : 0;
         versionSepIndex = id.find(':', startIndex);
         hasVersion = versionSepIndex != std::string::npos;
     }

Member Function Documentation

std::string epics::nt::NTID::getFullName ( )

Returns the full name of the id, i.e. the original ID

For example above returns "epics:nt/NTNDArray:1.2".

Returns: the full name

Definition at line 45 of file ntid.cpp.

45 { return fullName; }

int epics::nt::NTID::getMajorVersion ( )

Returns the Major version as an integer.

For example above return 1.

Returns: the Major string

Definition at line 135 of file ntid.cpp.

     {
         // call hasMajorVersion() to calculate values
         hasMajorVersion();
         return majorVersion;
     }

std::string epics::nt::NTID::getMajorVersionString ( )

Returns the Major version as a string.

For example above return "1".

Returns: the Major string

Definition at line 100 of file ntid.cpp.

     {
         if (majorVersionStr == BAD_NAME)
         {
             if (hasVersion)
             {
                 endMajorIndex = fullName.find('.', versionSepIndex+1);
                 majorVersionStr = (endMajorIndex != std::string::npos)
                     ? fullName.substr(versionSepIndex+1, endMajorIndex-(versionSepIndex+1)) :
                       fullName.substr(versionSepIndex+1);
             }
             else
                 majorVersionStr = "";
         }
         return majorVersionStr;
     }

int epics::nt::NTID::getMinorVersion ( )

Returns the Minor version as an integer.

For example above return 1.

Returns: the Minor string

Definition at line 180 of file ntid.cpp.

     {
         // call hasMinorVersion() to calculate values
         hasMinorVersion();
         return minorVersion;
     }

std::string epics::nt::NTID::getMinorVersionString ( )

Returns the Major version as a string.

For example above return "1".

Returns: the Major string

Definition at line 143 of file ntid.cpp.

     {
         // call hasMinorVersion() to calculate start of minor
         getMajorVersionString();
         if (minorVersionStr == BAD_NAME)
         {
             if (hasVersion && endMajorIndex != std::string::npos)
             {
                 endMinorIndex = fullName.find('.', endMajorIndex+1);
                 minorVersionStr = (endMinorIndex != std::string::npos)
                     ? fullName.substr(endMajorIndex+1, endMinorIndex-(endMajorIndex+1)) :
                       fullName.substr(endMajorIndex+1);
             }
             else
                 minorVersionStr = "";
         }
         return minorVersionStr;
     }

std::string epics::nt::NTID::getName ( )

Returns the unqualified name, without namespace or version.

For example above return "NTNDArray".

Returns: the unqualified name

Definition at line 68 of file ntid.cpp.

     {
         if (name == BAD_NAME)
         {
             if (hasVersion)
             {
                 size_t startIndex = nsQualified ? nsSepIndex+1 : 0;
                 name = fullName.substr(startIndex, versionSepIndex);
             }
             else if (nsQualified)
             {
                 name = fullName.substr(nsSepIndex+1);
             }
             else
             {
                 name = fullName;
             }
         }
         return name;
     }

std::string epics::nt::NTID::getNamespace ( )

Returns the namespace

For example above return "epics:nt".

Returns: the namespace

Definition at line 58 of file ntid.cpp.

     {
         if (namespaceStr == BAD_NAME)
         {
             namespaceStr = nsQualified ?
                fullName.substr(0, nsSepIndex) : "";
         }
         return namespaceStr;
     }

std::string epics::nt::NTID::getQualifiedName ( )

Returns the fully qualified name including namespaces, but excluding version numbers.

For example above return "epics:nt/NTNDArray"

Returns: the fully qualified name

Definition at line 47 of file ntid.cpp.

     {
         if (qualifiedName == BAD_NAME)
         {
             qualifiedName = hasVersion ?
                 fullName.substr(0, versionSepIndex) : fullName;
         }
         return qualifiedName;
     }

std::string epics::nt::NTID::getVersion ( )

Returns the version as a string.

For example above return "NTNDArray".

Returns: the the version string

Definition at line 90 of file ntid.cpp.

     {
         if (version == BAD_NAME)
         {
             version = (hasVersion) ? fullName.substr(versionSepIndex+1) : "";
         }
         return version;
     }

bool epics::nt::NTID::hasMajorVersion ( )

Does the ID contain a major version and is it a number.

Returns: true if it contains a major version number

Definition at line 118 of file ntid.cpp.

     {
         if (hasVersion && !majorVersionParsed)
         {
             try {
                 using pvData::detail::parseToPOD;
                 uint32_t mv;
                 parseToPOD(getMajorVersionString(), &mv);
                 majorVersion = static_cast<int>(mv);
                 hasMajor = true;
             } catch (...) {}
             majorVersionParsed = true;
         }
         return hasMajor;
     }

bool epics::nt::NTID::hasMinorVersion ( )

Does the ID contain a minor version and is it a number.

Returns: true if it contains a minor version number

Definition at line 163 of file ntid.cpp.

     {
         if (hasVersion && !minorVersionParsed)
         {
             try {
                 using pvData::detail::parseToPOD;
                 uint32_t mv;
                 parseToPOD(getMinorVersionString(), &mv);
                 minorVersion = static_cast<int>(mv);
                 hasMinor = true;
             } catch (...) {}
             minorVersionParsed = true;
         }
         return hasMinor;
     }

The documentation for this class was generated from the following files:

modules/normativeTypes/src/pv/ntid.h
modules/normativeTypes/src/ntid.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation