UN_PortTypeRegistry.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:        UN_PortTypeRegistry.h ( UN Library, C++)
 *
 * COMMENTS:
 *      
 */

#ifndef __UN_PortTypeRegistry_h__
#define __UN_PortTypeRegistry_h__

#include "UN_API.h"
#include "UN_PortType.h"
#include "UN_TypeRegistry.h"
#include "UN_Utils.h"


// ============================================================================
/// A registry that maintains the set of port types.
/// 
class UN_API UN_PortTypeRegistry : public UN_TypeRegistry< UN_PortType >
{
public:
    using Base = UN_TypeRegistry< UN_PortType >;
    using PortTypeHandle = UT_UniquePtr<UN_PortType>;

    /// @{ Constructor and destructor
    UN_PortTypeRegistry();
    /// @}
   
    /// A set of additional characters that are legal in port type names.
    void setPortTypeNameSafeChars( const UT_StringRef &safe_chars )
    { 
        myPortTypeNameSafeChars = safe_chars; 
    }

    /// Returns true if the given port type name is valid in this category.
    bool isValidTypeName( const UT_StringRef &port_type_name ) const
    {
        return UN_Utils::isValidPortTypeName( 
                port_type_name, myPortTypeNameSafeChars );
    }

    /// Adds the given port type to the reigstry.
    bool addType( UN_PortTypeHandle port_type );

private:
    /// Extra characters that are legal in the port type names.
    /// Eg, Usd uses "[]" in type names to indicate arrays.
    UT_StringHolder     myPortTypeNameSafeChars;
};


#endif