tgUnidirComprSprActuatorInfo.h

Go to the documentation of this file.

/*
 * Copyright © 2012, United States Government, as represented by the
 * Administrator of the National Aeronautics and Space Administration.
 * All rights reserved.
 * 
 * The NASA Tensegrity Robotics Toolkit (NTRT) v1 platform is licensed
 * under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * http://www.apache.org/licenses/LICENSE-2.0.
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 * either express or implied. See the License for the specific language
 * governing permissions and limitations under the License.
*/

#ifndef SRC_TGCREATOR_TG_UNIDIR_COMPR_SPR_ACTUATOR_INFO_H
#define SRC_TGCREATOR_TG_UNIDIR_COMPR_SPR_ACTUATOR_INFO_H

// This class inherits from tgCompressionSpringActuatorInfo
#include "tgCompressionSpringActuatorInfo.h"

// From the C++ standard library:
#include <string>

// By including the superclass, tgTags etc. are also included.
#include "core/tgUnidirComprSprActuator.h"

/* Forward declarations, needed in order to create
 * the actual compression spring object and also to 
 * reference its config.
 * TO-DO: why not just include tgBulletUnidirComprSpr.h? */
class tgBulletUnidirComprSpr;

class tgUnidirComprSprActuatorInfo : public tgCompressionSpringActuatorInfo
{
public:

    tgUnidirComprSprActuatorInfo(
                          const tgUnidirComprSprActuator::Config& config);

    tgUnidirComprSprActuatorInfo(
                   const tgUnidirComprSprActuator::Config& config,
                                   tgTags tags);

    tgUnidirComprSprActuatorInfo(
                                   const tgUnidirComprSprActuator::Config& config,
                                   const tgPair& pair);
    
    virtual ~tgUnidirComprSprActuatorInfo() {}

    virtual tgConnectorInfo* createConnectorInfo(const tgPair& pair);

    virtual void initConnector(tgWorld& world);

    virtual tgModel* createModel(tgWorld& world);

protected:    

    tgBulletUnidirComprSpr* createTgBulletUnidirComprSpr();

    void constructorAux();
    
private:

    // local copy of the config struct.
    tgUnidirComprSprActuator::Config m_config;
    
};


#endif