org.eclipse.efm.symbex/src/fml/infrastructure/Channel.h

/*******************************************************************************
 * Copyright (c) 2016 CEA LIST.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Created on: 26 févr. 2011
 *
 * Contributors:
 *  Arnault Lapitre (CEA LIST) arnault.lapitre@cea.fr
 *   - Initial API and implementation
 ******************************************************************************/

#ifndef CHANNEL_H_
#define CHANNEL_H_

#include <fml/common/PropertyElement.h>

#include <fml/infrastructure/ComProtocol.h>


namespace sep
{

class BF;
class Machine;
class Modifier;
class ObjectElement;
class PropertyPart;


class Channel :
		public PropertyElement,
		public ComProtocol,
		AVM_INJECT_INSTANCE_COUNTER_CLASS( Channel )
{

	AVM_DECLARE_CLONABLE_CLASS( Channel )


protected:
	/**
	 * ATTRIBUTES
	 */
	PropertyPart * mContents;

public:

	/**
	 * CONSTRUCTOR
	 * Default
	 */
	Channel(const PropertyPart & aPropertyPart, const std::string & aNameID,
			const Modifier & aModifier = Modifier::PROPERTY_INOUT_DIRECTION);


	/**
	 * DESTRUCTOR
	 */
	virtual ~Channel()
	{
		//!! NOTHING
	}


	/**
	 * GETTER
	 * the container
	 */
	virtual Machine * getContainerMachine() const ;


	/**
	 * GETTER - SETTER
	 * mContents
	 */
	inline PropertyPart * getContents() const
	{
		return( mContents );
	}

	bool hasContents() const;

	inline void setContents(PropertyPart * aContents)
	{
		mContents = aContents;
	}


	/**
	 * GETTER - SETTER
	 * mContents
	 * Signals
	 */
	void appendSignal(const Modifier & aModifier, const BF & aSignal);

	BF getSignal(Modifier::DIRECTION_KIND ioDirection, const BF & aSignal);


	/**
	 * Serialization
	 */
	void strHeader(OutStream & out) const
	{
		out << str_indent( this );
	}

	void toStream(OutStream & out) const;

};


} /* namespace sep */

#endif /* CHANNEL_H_ */