jadex.bridge.nonfunctional.INFPropertyMetaInfo Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jadex-platform-bridge Show documentation

Jadex bridge is a base package for kernels and platforms, i.e., it is used by both and provides commonly used interfaces and classes for active components and their management.

There is a newer version: 4.0.267

Show newest version

package jadex.bridge.nonfunctional;

import jadex.bridge.ClassInfo;
import jadex.bridge.nonfunctional.INFProperty.Target;

/**
 * Meta information about a non-functional property.
 */
public interface INFPropertyMetaInfo
{
	/**
	 *  Gets the name of the property.
	 *  @return The name of the property.
	 */
	public String getName();

	/**
	 *  Gets the type of the property.
	 *  This is the Java type of the values.
	 *  @return The type of the property.
	 */
	public ClassInfo getType();
	
	/**
	 *  Gets the unit of the property.
	 *  @return The unit of the property.
	 */
	public ClassInfo getUnit();

	/**
	 *  Checks if the property is dynamic.
	 *  @return The dynamic.
	 */
	public boolean isDynamic();
	
	/**
	 *  Gets the update rate of the property, if it exists, for dynamic properties.
	 *  @return The update rate.
	 */
	public long getUpdateRate();
	
	/**
	 *  Checks if the property is real time.
	 *  @return The real time flag.
	 */
	public boolean isRealtime();
	
	/**
	 *  Get the target of the property. If the target is not
	 *  the element itself a reference will be created.
	 *  @return The target where the nf property is declared.
	 *  (This element will collect the data).
	 */
	public Target getTarget();
}