org.opensplice.dds.core.policy.TimeBasedFilterImpl Class Reference

Inheritance diagram for org.opensplice.dds.core.policy.TimeBasedFilterImpl:

Collaboration diagram for org.opensplice.dds.core.policy.TimeBasedFilterImpl:

Public Member Functions
	TimeBasedFilterImpl (OsplServiceEnvironment environment)
	TimeBasedFilterImpl (OsplServiceEnvironment environment, Duration minimumSeparation)
boolean	equals (Object other)
ServiceEnvironment	getEnvironment ()
Duration	getMinimumSeparation ()
Class<? extends QosPolicy >	getPolicyClass ()
int	hashCode ()
TimeBasedFilter	withMinimumSeparation (Duration minimumSeparation)
	Copy this policy and override the value of the property. More...
TimeBasedFilter	withMinimumSeparation (long minimumSeparation, TimeUnit unit)
	Copy this policy and override the value of the property. More...

Protected Attributes
OsplServiceEnvironment	environment

Detailed Description

Definition at line 31 of file TimeBasedFilterImpl.java.

Constructor & Destructor Documentation

TimeBasedFilterImpl() [1/2]

org.opensplice.dds.core.policy.TimeBasedFilterImpl.TimeBasedFilterImpl

(

OsplServiceEnvironment

environment

)

Definition at line 36 of file TimeBasedFilterImpl.java.

TimeBasedFilterImpl() [2/2]

org.opensplice.dds.core.policy.TimeBasedFilterImpl.TimeBasedFilterImpl	(	OsplServiceEnvironment	environment,
		Duration	minimumSeparation
	)

Definition at line 41 of file TimeBasedFilterImpl.java.

Member Function Documentation

equals()

boolean org.opensplice.dds.core.policy.TimeBasedFilterImpl.equals

(

Object

other

)

Definition at line 75 of file TimeBasedFilterImpl.java.

getEnvironment()

ServiceEnvironment org.opensplice.dds.core.policy.QosPolicyImpl.getEnvironment ( )

inherited

Returns

the org.omg.dds.core.ServiceEnvironment object that directly or indirectly was used to create this object.

Implements org.omg.dds.core.DDSObject.

Definition at line 40 of file QosPolicyImpl.java.

getMinimumSeparation()

Duration org.opensplice.dds.core.policy.TimeBasedFilterImpl.getMinimumSeparation

(

)

Returns

the minimum separation duration.

Implements org.omg.dds.core.policy.TimeBasedFilter.

Definition at line 53 of file TimeBasedFilterImpl.java.

getPolicyClass()

Class<? extends QosPolicy> org.opensplice.dds.core.policy.TimeBasedFilterImpl.getPolicyClass

(

)

Definition at line 70 of file TimeBasedFilterImpl.java.

hashCode()

int org.opensplice.dds.core.policy.TimeBasedFilterImpl.hashCode

(

)

Definition at line 84 of file TimeBasedFilterImpl.java.

withMinimumSeparation() [1/2]

TimeBasedFilter org.opensplice.dds.core.policy.TimeBasedFilterImpl.withMinimumSeparation

(

Duration

minimumSeparation

)

Copy this policy and override the value of the property.

Parameters

minimumSeparation

Specifies a duration which is the minimum period between received samples to be passed through the filter. The default value is 0, meaning that all samples are accepted.

Returns

a new TimeBasedFilter policy

Implements org.omg.dds.core.policy.TimeBasedFilter.

Definition at line 58 of file TimeBasedFilterImpl.java.

withMinimumSeparation() [2/2]

TimeBasedFilter org.opensplice.dds.core.policy.TimeBasedFilterImpl.withMinimumSeparation	(	long	minimumSeparation,
		TimeUnit	unit
	)

Copy this policy and override the value of the property.

Parameters

minimumSeparation	Specifies a long minimumSeparation which is the minimum period between received samples to be passed through the filter. The default value is 0, meaning that all samples are accepted.
unit	The TimeUnit which the period describes (i.e. TimeUnit.SECONDS or TimeUnit.MILLISECONDS)

Returns

a new TimeBasedFilter policy

Implements org.omg.dds.core.policy.TimeBasedFilter.

Definition at line 63 of file TimeBasedFilterImpl.java.

Member Data Documentation

environment

OsplServiceEnvironment org.opensplice.dds.core.policy.QosPolicyImpl.environment

protectedinherited

Definition at line 29 of file QosPolicyImpl.java.

---

The documentation for this class was generated from the following file:

• java5/common/java/code/org/opensplice/dds/core/policy/TimeBasedFilterImpl.java