text: //
  // Copyright 2016 Pixar
  //
  // Licensed under the Apache License, Version 2.0 (the "Apache License")
  // with the following modification; you may not use this file except in
  // compliance with the Apache License and the following modification to it:
  // Section 6. Trademarks. is deleted and replaced with:
  //
  // 6. Trademarks. This License does not grant permission to use the trade
  //    names, trademarks, service marks, or product names of the Licensor
  //    and its affiliates, except as required to comply with Section 4(c) of
  //    the License and to reproduce the content of the NOTICE file.
  //
  // You may obtain a copy of the Apache License at
  //
  //     http://www.apache.org/licenses/LICENSE-2.0
  //
  // Unless required by applicable law or agreed to in writing, software
  // distributed under the Apache License with the above modification is
  // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  // KIND, either express or implied. See the Apache License for the specific
  // language governing permissions and limitations under the Apache License.
  //
  #ifndef USDCONTRIVED_GENERATED_SINGLEAPPLYAPI_H
  #define USDCONTRIVED_GENERATED_SINGLEAPPLYAPI_H
  
  /// \file usdContrived/singleApplyAPI.h
  
  #include "pxr/pxr.h"
  #include "pxr/usd/usdContrived/api.h"
  #include "pxr/usd/usd/aPISchemaBase.h"
  #include "pxr/usd/usd/prim.h"
  #include "pxr/usd/usd/stage.h"
  
  #include "pxr/base/vt/value.h"
  
  #include "pxr/base/gf/vec3d.h"
  #include "pxr/base/gf/vec3f.h"
  #include "pxr/base/gf/matrix4d.h"
  
  #include "pxr/base/tf/token.h"
  #include "pxr/base/tf/type.h"
  
  namespace foo {
  
  class SdfAssetPath;
  
  // -------------------------------------------------------------------------- //
  // SINGLEAPPLYAPI                                                             //
  // -------------------------------------------------------------------------- //
  
  /// \class UsdContrivedSingleApplyAPI
  ///
  ///
  class UsdContrivedSingleApplyAPI : public UsdAPISchemaBase
  {
  public:
      /// Compile time constant representing what kind of schema this class is.
      ///
      /// \sa UsdSchemaType
      static const UsdSchemaType schemaType = UsdSchemaType::SingleApplyAPI;
  
      /// Construct a UsdContrivedSingleApplyAPI on UsdPrim \p prim .
      /// Equivalent to UsdContrivedSingleApplyAPI::Get(prim.GetStage(), prim.GetPath())
      /// for a \em valid \p prim, but will not immediately throw an error for
      /// an invalid \p prim
      explicit UsdContrivedSingleApplyAPI(const UsdPrim& prim=UsdPrim())
          : UsdAPISchemaBase(prim)
      {
      }
  
      /// Construct a UsdContrivedSingleApplyAPI on the prim held by \p schemaObj .
      /// Should be preferred over UsdContrivedSingleApplyAPI(schemaObj.GetPrim()),
      /// as it preserves SchemaBase state.
      explicit UsdContrivedSingleApplyAPI(const UsdSchemaBase& schemaObj)
          : UsdAPISchemaBase(schemaObj)
      {
      }
  
      /// Destructor.
      USDCONTRIVED_API
      virtual ~UsdContrivedSingleApplyAPI();
  
      /// Return a vector of names of all pre-declared attributes for this schema
      /// class and all its ancestor classes.  Does not include attributes that
      /// may be authored by custom/extended methods of the schemas involved.
      USDCONTRIVED_API
      static const TfTokenVector &
      GetSchemaAttributeNames(bool includeInherited=true);
  
      /// Return a UsdContrivedSingleApplyAPI holding the prim adhering to this
      /// schema at \p path on \p stage.  If no prim exists at \p path on
      /// \p stage, or if the prim at that path does not adhere to this schema,
      /// return an invalid schema object.  This is shorthand for the following:
      ///
      /// \code
      /// UsdContrivedSingleApplyAPI(stage->GetPrimAtPath(path));
      /// \endcode
      ///
      USDCONTRIVED_API
      static UsdContrivedSingleApplyAPI
      Get(const UsdStagePtr &stage, const SdfPath &path);
  
  
      /// Applies this <b>single-apply</b> API schema to the given \p prim.
      /// This information is stored by adding "SingleApplyAPI" to the 
      /// token-valued, listOp metadata \em apiSchemas on the prim.
      /// 
      /// \return A valid UsdContrivedSingleApplyAPI object is returned upon success. 
      /// An invalid (or empty) UsdContrivedSingleApplyAPI object is returned upon 
      /// failure. See \ref UsdAPISchemaBase::_ApplyAPISchema() for conditions 
      /// resulting in failure. 
      /// 
      /// \sa UsdPrim::GetAppliedSchemas()
      /// \sa UsdPrim::HasAPI()
      ///
      USDCONTRIVED_API
      static UsdContrivedSingleApplyAPI 
      Apply(const UsdPrim &prim);
  
  protected:
      /// Returns the type of schema this class belongs to.
      ///
      /// \sa UsdSchemaType
      USDCONTRIVED_API
      virtual UsdSchemaType _GetSchemaType() const;
  
  private:
      // needs to invoke _GetStaticTfType.
      friend class UsdSchemaRegistry;
      USDCONTRIVED_API
      static const TfType &_GetStaticTfType();
  
      static bool _IsTypedSchema();
  
      // override SchemaBase virtuals.
      USDCONTRIVED_API
      virtual const TfType &_GetTfType() const;
  
  public:
      // ===================================================================== //
      // Feel free to add custom code below this line, it will be preserved by 
      // the code generator. 
      //
      // Just remember to: 
      //  - Close the class declaration with }; 
      //  - Close the namespace with }
      //  - Close the include guard with #endif
      // ===================================================================== //
      // --(BEGIN CUSTOM CODE)--
  };
  
  }
  
  #endif
  