net.sf.jrtps.udds.Entity Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jrtps Show documentation

jRTPS - An implementation of RTPS protocol by OMG

There is a newer version: 1.5.1

package net.sf.jrtps.udds;

/**
 * Entity is a base class for DataReader and DataWriter.
 * 
 * @author mcr70
 * @param 
 * 
 */
public class Entity {
    private final String topicName;
    private final Participant participant;
    private final Class type;

    /**
     * Constructor
     * 
     * @param topicName
     *            name of the topic this entity is bound to.
     */
    protected Entity(Participant p, Class type, String topicName) {
        this.participant = p;
        this.type = type;
        this.topicName = topicName;
    }

    /**
     * Get the name of the topic of this entity.
     * 
     * @return topic name
     */
    public String getTopicName() {
        return topicName;
    }

    /**
     * Get the Participant that has created this Entity.
     * 
     * @return Participant
     */
    public Participant getParticipant() {
        return participant;
    }

    /**
     * Gets the type associated with this entity.
     * 
     * @return Class
     */
    public Class getType() {
        return type;
    }
}