Hopsan: Component Library Development

hopsan::Component::addReadPort

Port * addReadPort(const HString &rPortName, const HString &rNodeType, const HString &rDescription="", const Port::RequireConnectionEnumT reqConnect=Port::Required)

Add a ReadPort with description to the component.

Definition: Component.cpp:948

hopsan::ClassFactory

Template class for automatic object instantiation by key-value.

Definition: ClassFactory.hpp:50

hopsan::Component::deconfigure

virtual void deconfigure()

Deconfigure a component, use this to cleanup and memory/resource allocations you have made in configu...

Definition: Component.cpp:1725

hopsan::ClassFactory::registerCreatorFunction

void registerCreatorFunction(const _Key &rIdKey, CreatorFunctionT classCreator)

Used to register creator functions.

Definition: ClassFactory.hpp:68

hopsan::Component::addInputVariable

Port * addInputVariable(const HString &rName, const HString &rDescription, const HString &rQuantityOrUnit, const double defaultValue, double **ppNodeData=0)

Add an inputVariable (Scalar signal ReadPort)

Definition: Component.cpp:1343

hopsan::Component::addPowerMultiPort

Port * addPowerMultiPort(const HString &rPortName, const HString &rNodeType, const HString &rDescription="", const Port::RequireConnectionEnumT reqConnect=Port::Required)

Add a PowerMultiPort with description to the component.

Definition: Component.cpp:921

hopsan::Component::simulateOneTimestep

virtual void simulateOneTimestep()

Simulates one time step. This component must be overloaded en each component.

Definition: Component.cpp:325

hopsan::Component::addConditionalConstant

void addConditionalConstant(const HString &rName, const HString &rDescription, std::vector< HString > &rConditions, int &rData)

Add (register) a conditional constant parameter to the component.

Definition: Component.cpp:492

hopsan::Component::addReadMultiPort

Port * addReadMultiPort(const HString &rPortName, const HString &rNodeType, const HString &rDescription="", const Port::RequireConnectionEnumT reqConnect=Port::Required)

Add a ReadMultiPort with description to the component.

Definition: Component.cpp:934

hopsan::Component::configure

virtual void configure()

Configures a component by setting up ports, variables, constants and other resources.

Definition: Component.cpp:1704

hopsan::Component::addPowerPort

Port * addPowerPort(const HString &rPortName, const HString &rNodeType, const HString &rDescription="", const Port::RequireConnectionEnumT reqConnect=Port::Required)

Add a PowerPort with description to the component.

Definition: Component.cpp:908

hopsan::Component::addOutputVariable

Port * addOutputVariable(const HString &rName, const HString &rDescription, const HString &rQuantityOrUnit, double **ppNodeData=0)

Add an outputVariable (Scalar signal WritePort) without default value.

Definition: Component.cpp:1375

hopsan::Port::RequireConnectionEnumT

RequireConnectionEnumT

This enum specifies the RequiredConnection enums.

Definition: Port.h:65

hopsan::Component::addConstant

void addConstant(const HString &rName, const HString &rDescription, const HString &rUnit, double &rData)

Add (register) a constant parameter to the component.

Definition: Component.cpp:460

hopsan::Component::finalize

virtual void finalize()

Optional function that is called after every simulation, can be used to clean up memory allocation ma...

Definition: Component.cpp:333

hopsan::Component::addWritePort

Port * addWritePort(const HString &rPortName, const HString &rNodeType, const HString &rDescription="", const Port::RequireConnectionEnumT reqConnect=Port::Required)

Add a WritePort with description to the component.

Definition: Component.cpp:962

hopsan::Component::initialize

virtual void initialize()

The initialize function must be overloaded in each component, it is used to initialize the component ...

Definition: Component.cpp:314

hopsan::Component::Component

Component()

Component base class Constructor.

Definition: Component.cpp:70